Module: Sorcery::Controller::Submodules::External::Providers::Github::GithubClient

Extended by:
Sorcery::Controller::Submodules::External::Protocols::Oauth2
Defined in:
lib/sorcery/controller/submodules/external/providers/github.rb

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Sorcery::Controller::Submodules::External::Protocols::Oauth2

authorize_url, get_access_token, oauth_version

Class Attribute Details

.callback_urlObject

Returns the value of attribute callback_url.



31
32
33
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 31

def callback_url
  @callback_url
end

.keyObject

Returns the value of attribute key.



31
32
33
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 31

def key
  @key
end

.secretObject

Returns the value of attribute secret.



31
32
33
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 31

def secret
  @secret
end

.siteObject

Returns the value of attribute site.



31
32
33
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 31

def site
  @site
end

.user_info_mappingObject

Returns the value of attribute user_info_mapping.



31
32
33
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 31

def 
  @user_info_mapping
end

.user_info_pathObject

Returns the value of attribute user_info_path.



31
32
33
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 31

def 
  @user_info_path
end

Class Method Details

.get_user_hashObject



46
47
48
49
50
51
52
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 46

def get_user_hash
  user_hash = {}
  response = @access_token.get(@user_info_path)
  user_hash[:user_info] = JSON.parse(response)
  user_hash[:uid] = user_hash[:user_info]['id']
  user_hash
end

.has_callback?Boolean

Returns:

  • (Boolean)


54
55
56
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 54

def has_callback?
  true
end

.initObject



40
41
42
43
44
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 40

def init
  @site           = "https://github.com/"
  @user_info_path = "/api/v2/json/user/show"
  @user_info_mapping = {}
end

.login_url(params, session) ⇒ Object

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



60
61
62
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 60

def (params,session)
  self.authorize_url({:authorize_path => '/login/oauth/authorize'})
end

.process_callback(params, session) ⇒ Object

tries to login the user from access token



65
66
67
68
69
# File 'lib/sorcery/controller/submodules/external/providers/github.rb', line 65

def process_callback(params,session)
  args = {}
  args.merge!({:code => params[:code]}) if params[:code]
  @access_token = self.get_access_token(args)
end