class Sorcery::Providers::Facebook

This class adds support for OAuth with facebook.com.

config.facebook.key = <key>
config.facebook.secret = <secret>
...

Attributes

access_permissions[RW]
api_version[RW]
auth_path[RW]
display[RW]
mode[R]
param_name[R]
parse[RW]
scope[RW]
token_url[RW]
user_info_path[RW]

Public Class Methods

new() click to toggle source
Calls superclass method Sorcery::Providers::Base::new
# File lib/sorcery/providers/facebook.rb, line 16
def initialize
  super

  @site           = 'https://graph.facebook.com'
  @auth_site      = 'https://www.facebook.com'
  @user_info_path = 'me'
  @scope          = 'email'
  @display        = 'page'
  @token_url      = 'oauth/access_token'
  @auth_path      = 'dialog/oauth'
  @mode           = :query
  @parse          = :json
  @param_name     = 'access_token'
end

Public Instance Methods

authorize_url() click to toggle source

overrides oauth2#authorize_url to allow customized scope.

# File lib/sorcery/providers/facebook.rb, line 47
def authorize_url
  # Fix: replace default oauth2 options, specially to prevent the Faraday gem which
  # concatenates with "/", removing the Facebook api version
  options = {
    site:          File.join(@site, api_version.to_s),
    authorize_url: File.join(@auth_site, api_version.to_s, auth_path),
    token_url:     token_url
  }

  @scope = access_permissions.present? ? access_permissions.join(',') : scope
  super(options)
end
get_user_hash(access_token) click to toggle source
# File lib/sorcery/providers/facebook.rb, line 31
def get_user_hash(access_token)
  response = access_token.get(user_info_path)

  auth_hash(access_token).tap do |h|
    h[:user_info] = JSON.parse(response.body)
    h[:uid] = h[:user_info]['id']
  end
end
login_url(_params, _session) click to toggle source

calculates and returns the url to which the user should be redirected, to get authenticated at the external provider's site.

# File lib/sorcery/providers/facebook.rb, line 42
def login_url(_params, _session)
  authorize_url
end
process_callback(params, _session) click to toggle source

tries to login the user from access token

# File lib/sorcery/providers/facebook.rb, line 61
def process_callback(params, _session)
  args = {}.tap do |a|
    a[:code] = params[:code] if params[:code]
  end

  get_access_token(args, token_url: token_url, mode: mode,
                         param_name: param_name, parse: parse)
end