README.md

OmniAuth: Standardized Multi-Provider Authentication

OmniAuth is a new Rack-based authentication system for multi-provider external
authentcation. OmniAuth is built from the ground up on the philosophy that
authentication is not the same as identity, and is based on two
observations:

The traditional 'sign up using a login and password' model is becoming the
exception, not the rule. Modern web applications offer external
authentication via OpenID, Facebook, and/or OAuth.

The interconnectable web is no longer a dream, it is a necessity. It is not
unreasonable to expect that one application may need to be able to connect
to one, three, or twelve other services. Modern authentication systems
should allow a user's identity to be associated with many authentications.

Now to initiate authentication you merely need to redirect the user to /auth/twitter via a link or other means. Once the user has authenticated to Twitter, they will be redirected to /auth/twitter/callback. You should build an endpoint that handles this URL, at which point you will have access to the authentication information through the omniauth.auth parameter of the Rack environment. For example, in Sinatra you would do something like this:

get '/auth/twitter/callback' do
auth_hash = request.env['omniauth.auth']
end

If something doesn't work on one of these interpreters, it should be considered
a bug.

This library may inadvertently work (or seem to work) on other Ruby
implementations, however support will only be provided for the versions listed
above.

If you would like this library to support another Ruby version, you may
volunteer to be a maintainer. Being a maintainer entails making sure all tests
run and pass on that implementation. When something breaks on your
implementation, you will be personally responsible for providing patches in a
timely fashion. If critical issues for a particular implementation exist at the
time of a major release, support for that Ruby version may be dropped.