omniauth/oa-basic
Erik Michaels-Ober 7b2f240f75 Specify yard from git source 2011-05-09 21:33:59 -07:00
..
lib Bump version to 0.2.5 2011-04-28 18:28:40 -07:00
spec Replace watchr with autotest 2011-04-22 13:13:24 -05:00
.gemtest Gem dependency refactor 2011-04-22 02:52:52 -05:00
.rspec Made in America. 2011-04-22 02:37:29 -05:00
.yardopts Gem dependency refactor 2011-04-22 02:52:52 -05:00
Gemfile Specify yard from git source 2011-05-09 21:33:59 -07:00
LICENSE Update licenses throughout the gems. 2011-01-05 09:53:29 -06:00
README.rdoc READMEs and CHANGELOGs updated. 2010-05-01 15:22:25 -04:00
Rakefile Gem dependency refactor 2011-04-22 02:52:52 -05:00
oa-basic.gemspec Specify yard from git source 2011-05-09 21:33:59 -07:00

README.rdoc

= OmniAuth::Basic

OmniAuth stratgies for APIs that have HTTP Basic authentication (such as Campfire and Basecamp).

== Installation

To get just HTTP Basic functionality:

    gem install oa-basic
    
For the full auth suite:

    gem install omniauth
    
== Stand-Alone Example

Use the strategy as a middleware in your application:

    require 'omniauth/basic'
    
    use OmniAuth::Strategies::Campfire
    
Then simply direct users to '/auth/campfire' to prompt them for their Campfire credentials. You may also pre-set the credentials by POSTing to the URL with appropriate parameters (in the case of Campfire and Basecamp, the parameters are <tt>subdomain</tt>, <tt>user</tt>, and <tt>password</tt>).

== OmniAuth Builder

If you want to allow multiple providers, use the OmniAuth Builder:

    require 'omniauth/basic'
    
    use OmniAuth::Builder do
      provider :campfire
      provider :basecamp
    end