Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.61 KB

README.md

File metadata and controls

57 lines (39 loc) · 1.61 KB
Raw

OmniAuth Clever

Unofficial OmniAuth strategy for Clever SSO OAuth2 integration.

Installation

Add this line to your application's Gemfile:

gem 'omniauth-clever', git: 'git://github.com/thinkthroughmath/omniauth-clever.git'

And then execute:

$ bundle

Usage

OmniAuth Clever is Rack Middleware in the OmniAuth convention. See the OmniAuth 1.0 docs for more information.

Follow the Clever OAuth docs to register your application, set callback URLs, and get a client ID and client secret.

Example: In config/initializers/omniauth.rb, do:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :clever, ENV['CLEVER_CLIENT_ID'], ENV['CLEVER_CLIENT_SECRET']
end

Configuring

To be able to set the optional clever_landing parameter on a per-request basis by passing clever_landing in params to your /auth/clever url, use this in the initializer instead:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :clever, ENV['CLEVER_CLIENT_ID'], ENV['CLEVER_CLIENT_SECRET'],
           :setup => lambda { |env|
             params = Rack::Utils.parse_query(env['QUERY_STRING'])
             env['omniauth.strategy'].options[:client_options][:clever_landing] = params['clever_landing']
           }
end

Contributing

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

License

MIT. See LICENSE.txt.