Login with Amazon OAuth2 strategy for OmniAuth 1.0
Ruby
Switch branches/tags
Nothing to show
Latest commit 35a4325 Oct 6, 2016 @wingrunr21 committed on GitHub Merge pull request #11 from jamesa/profile-user-id-scope
Add documentation for the profile:user_id scope
Permalink
Failed to load latest commit information.
lib
spec
.gitignore Initial commit May 29, 2013
.rspec
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
omniauth-amazon.gemspec

README.md

OmniAuth::Amazon

Build Status Gem Version

Login with Amazon OAuth2 strategy for OmniAuth 1.0

Installation

Add this line to your application's Gemfile:

gem 'omniauth-amazon'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-amazon

Prereqs

You must create an application via the Amazon App Console. Once that is complete, register two URLs under Web Settings -> Allowed Return URLs:

http://localhost:3000/auth/amazon/callback
https://your_website_here/auth/amazon/callback

Amazon requires HTTPS for the whitelisted callback URL (except localhost). They don't appear to like .dev domains too much but happily accept localhost.

Usage

Usage is similar to other OAuth2 based OmniAuth strategies:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :amazon, ENV['AMAZON_CLIENT_ID'], ENV['AMAZON_CLIENT_SECRET'],
    {
      :scope => 'profile postal_code' # default scope
    }
end

Configuration

Config options can be passed to provider via a Hash:

  • scope: A space-separated list of permissions. Can be profile, postal_code, profile:user_id, or a combination of options.
    Defaults to: profile postal_code
    • Requesting the profile:user_id scope will not display an additional consent screen the first time the user logs in.

Resources

Todo

  1. Fix raw_info to see why client.request has to be used in query mode

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

Bitdeli Badge