1
0
Fork 0
mirror of https://github.com/omniauth/omniauth.git synced 2022-11-09 12:31:49 -05:00
omniauth--omniauth/oa-basic
2010-06-12 22:36:21 -04:00
..
lib/omniauth Bringing HTTP Basic back to the fold, starting with Campfire and Basecamp. 2010-05-01 14:14:46 -04:00
spec added stub specs to oa-basic sub-project 2010-06-12 22:36:21 -04:00
.rspec added stub specs to oa-basic sub-project 2010-06-12 22:36:21 -04:00
CHANGELOG.rdoc READMEs and CHANGELOGs updated. 2010-05-01 15:22:25 -04:00
LICENSE.rdoc Adds lots of stuff. Facebook is broken, beware. 2010-04-09 21:30:16 -04:00
oa-basic.gemspec used Bundler's Gemspec#add_bundler_dependencies to reduce duplication betwen Gemfile and gemspecs 2010-06-12 21:52:30 -04:00
Rakefile using Bundler to declare dependencies 2010-06-12 21:29:31 -04:00
README.rdoc READMEs and CHANGELOGs updated. 2010-05-01 15:22:25 -04:00

= 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