Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

StackExchange OAuth strategy for OmniAuth

branch: master
Octocat-spinner-32 lib version bump July 16, 2012
Octocat-spinner-32 test initial June 27, 2012
Octocat-spinner-32 .gitignore initial June 27, 2012
Octocat-spinner-32 .travis.yml add travis June 27, 2012
Octocat-spinner-32 CHANGELOG.md version bump July 16, 2012
Octocat-spinner-32 Gemfile initial June 27, 2012
Octocat-spinner-32 LICENSE initial June 27, 2012
Octocat-spinner-32 README.md Modified to handle GET parameter for site July 16, 2012
Octocat-spinner-32 Rakefile initial June 27, 2012
Octocat-spinner-32 omniauth-stackexchange.gemspec initial June 27, 2012
README.md

OmniAuth StackExchange TravisCI

This gem contains the StackExchange strategy for OmniAuth.

StackExchange uses the OAuth2 flow, you can read about it here: https://api.stackexchange.com/docs/authentication

How To Use It

So let's say you're using Rails, you need to add the strategy to your Gemfile:

gem 'omniauth-stackexchange'

You can pull them in directly from github e.g.:

gem 'omniauth-stackexchange', :git => 'https://github.com/nashby/omniauth-stackexchange.git'

Once these are in, you need to add the following to your config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :stackexchange, "client_id", "client_secret", public_key: "key", site: 'stackoverflow'
end

You will obviously have to put in your client_id, client_secret and public_key, which you get when you register your app with StackExchange (they call them Client Id, Client Secret and Key).

You will also need to specify a site option to uniquely identify the StackExchange site (e.g. stackoverflow or superuser) you wish to authenticate against. A list of valid site api keys can be found at https://api.stackexchange.com/docs/sites. It's stackoverflow by default.

If your application needs to be able to support multiple StackExchange sites, you can pass the site api key as the value for a GET parameter named sites (e.g. /auth/stackexchange?site=superuser)

Now just follow the README at: https://github.com/intridea/omniauth

Supported Rubies

OmniAuth StackExchange is tested under 1.9.3.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Copyright (c) 2012 by Vasiliy Ermolovich

Something went wrong with that request. Please try again.