1
0
Fork 0
mirror of https://github.com/simi/omniauth-facebook.git synced 2022-11-09 12:32:45 -05:00
Facebook OAuth2 Strategy for OmniAuth
Find a file
2011-11-19 14:28:02 -08:00
example update README in preparation for 1.0. allow passing of display via option 2011-11-19 14:20:23 -08:00
lib update README in preparation for 1.0. allow passing of display via option 2011-11-19 14:20:23 -08:00
spec fix ten_mins_from_now calculation 2011-11-15 14:10:56 +02:00
.gitignore add example app. useful for manual integration testing 2011-10-15 20:57:45 -07:00
.travis.yml add 1.9.3 to travis config 2011-11-19 13:34:33 -08:00
Gemfile remove github url from Gemfile for omniauth-oauth2 now it is released 2011-11-19 14:28:02 -08:00
omniauth-facebook.gemspec bump omniauth depedency to 1.0.0 release 2011-11-10 22:27:20 -08:00
Rakefile initial commit 2011-10-15 00:36:27 -07:00
README.md update README in preparation for 1.0. allow passing of display via option 2011-11-19 14:20:23 -08:00

OmniAuth Facebook  Build Status

This gem contains the Facebook strategy for OmniAuth 1.0.

Supports the OAuth 2.0 server-side flow. Read the Facebook docs for more details: http://developers.facebook.com/docs/authentication

Installing

Add to your Gemfile:

gem 'omniauth-facebook'

Then bundle install.

Usage

OmniAuth::Strategies::Facebook is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.

Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :facebook, ENV['FACEBOOK_KEY'], ENV['FACEBOOK_SECRET'], :scope => 'email', :display => 'popup'
end

Configuring

You can configure several options, which you pass in to the provider method via a Hash:

For example, to request email, offline_access and read_stream permissions and display the authentication page in a popup window:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :facebook, ENV['FACEBOOK_KEY'], ENV['FACEBOOK_SECRET'], :scope => 'email,offline_access,read_stream', :display => 'popup'
end

NB. If you want to set the display format on a per-request basis, you can just pass it to the OmniAuth request phase URL, for example: /auth/facebook?display=popup.

Authentication Hash

Here's an example Authentication Hash available in request.env['omniauth.auth']:

{
  :provider => 'facebook',
  :uid => '1234567',
  :info => {
    :nickname => 'jbloggs',
    :email => 'joe@bloggs.com',
    :name => 'Joe Bloggs',
    :first_name => 'Joe',
    :last_name => 'Bloggs',
    :image => 'http://graph.facebook.com/1234567/picture?type=square',
    :urls => { :Facebook => 'http://www.facebook.com/jbloggs' },
    :location => 'Palo Alto, California'
  },
  :credentials => {
    :token => 'ABCDEF...',
    :expires_at => 1321747205, # when the access token expires
    :expires => true # if you request `offline_access` this will be false
  },
  :extra => {
    :raw_info => {
      :id => '1234567',
      :name => 'Joe Bloggs',
      :first_name => 'Joe',
      :last_name => 'Bloggs',
      :link => 'http://www.facebook.com/jbloggs',
      :username => 'jbloggs',
      :location => { :id => '123456789', :name => 'Palo Alto, California' },
      :gender => 'male',
      :email => 'joe@bloggs.com',
      :timezone => -8,
      :locale => 'en_US',
      :verified => true,
      :updated_time => '2011-11-11T06:21:03+0000'
    }
  }
}

The precise information available may depend on the permissions which you request.

Supported Rubies

Actively tested with the following Ruby versions:

  • MRI 1.9.3
  • MRI 1.9.2
  • MRI 1.8.7
  • JRuby 1.6.5

License

Copyright (c) 2011 by Mark Dodwell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.