Class: OAuth2::Client
- Inherits:
-
Object
- Object
- OAuth2::Client
- Defined in:
- lib/oauth2/client.rb
Overview
The OAuth2::Client class
Instance Attribute Summary collapse
-
#connection ⇒ Object
The Faraday connection object.
-
#id ⇒ Object
readonly
rubocop:disable Metrics/ClassLength.
-
#options ⇒ Object
Returns the value of attribute options.
-
#secret ⇒ Object
readonly
rubocop:disable Metrics/ClassLength.
-
#site ⇒ Object
rubocop:disable Metrics/ClassLength.
Instance Method Summary collapse
- #assertion ⇒ Object
-
#auth_code ⇒ Object
The Authorization Code strategy.
-
#authorize_url(params = {}) ⇒ Object
The authorize endpoint URL of the OAuth2 provider.
-
#client_credentials ⇒ Object
The Client Credentials strategy.
-
#get_token(params, access_token_opts = {}, access_token_class = AccessToken) ⇒ AccessToken
Initializes an AccessToken by making a request to the token endpoint.
-
#implicit ⇒ Object
The Implicit strategy.
-
#initialize(client_id, client_secret, options = {}) {|builder| ... } ⇒ Client
constructor
Instantiate a new OAuth 2.0 client using the Client ID and Client Secret registered to your application.
-
#password ⇒ Object
The Resource Owner Password Credentials strategy.
-
#redirection_params ⇒ Hash
The redirect_uri parameters, if configured.
-
#request(verb, url, opts = {}) {|req| ... } ⇒ Object
Makes a request relative to the specified site root.
-
#token_url(params = nil) ⇒ Object
The token endpoint URL of the OAuth2 provider.
Constructor Details
#initialize(client_id, client_secret, options = {}) {|builder| ... } ⇒ Client
Instantiate a new OAuth 2.0 client using the Client ID and Client Secret registered to your application.
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/oauth2/client.rb', line 29 def initialize(client_id, client_secret, = {}, &block) opts = .dup @id = client_id @secret = client_secret @site = opts.delete(:site) ssl = opts.delete(:ssl) @options = {:authorize_url => '/oauth/authorize', :token_url => '/oauth/token', :token_method => :post, :auth_scheme => :request_body, :connection_opts => {}, :connection_build => block, :max_redirects => 5, :raise_errors => true}.merge(opts) @options[:connection_opts][:ssl] = ssl if ssl end |
Instance Attribute Details
#connection ⇒ Object
The Faraday connection object
55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/oauth2/client.rb', line 55 def connection @connection ||= begin conn = Faraday.new(site, [:connection_opts]) if [:connection_build] conn.build do |b| [:connection_build].call(b) end end conn end end |
#id ⇒ Object (readonly)
rubocop:disable Metrics/ClassLength
7 8 9 |
# File 'lib/oauth2/client.rb', line 7 def id @id end |
#options ⇒ Object
Returns the value of attribute options.
8 9 10 |
# File 'lib/oauth2/client.rb', line 8 def @options end |
#secret ⇒ Object (readonly)
rubocop:disable Metrics/ClassLength
7 8 9 |
# File 'lib/oauth2/client.rb', line 7 def secret @secret end |
#site ⇒ Object
rubocop:disable Metrics/ClassLength
7 8 9 |
# File 'lib/oauth2/client.rb', line 7 def site @site end |
Instance Method Details
#assertion ⇒ Object
182 183 184 |
# File 'lib/oauth2/client.rb', line 182 def assertion @assertion ||= OAuth2::Strategy::Assertion.new(self) end |
#auth_code ⇒ Object
The Authorization Code strategy
157 158 159 |
# File 'lib/oauth2/client.rb', line 157 def auth_code @auth_code ||= OAuth2::Strategy::AuthCode.new(self) end |
#authorize_url(params = {}) ⇒ Object
The authorize endpoint URL of the OAuth2 provider
70 71 72 73 |
# File 'lib/oauth2/client.rb', line 70 def (params = {}) params = (params || {}).merge(redirection_params) connection.build_url([:authorize_url], params).to_s end |
#client_credentials ⇒ Object
The Client Credentials strategy
178 179 180 |
# File 'lib/oauth2/client.rb', line 178 def client_credentials @client_credentials ||= OAuth2::Strategy::ClientCredentials.new(self) end |
#get_token(params, access_token_opts = {}, access_token_class = AccessToken) ⇒ AccessToken
Initializes an AccessToken by making a request to the token endpoint
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/oauth2/client.rb', line 134 def get_token(params, access_token_opts = {}, access_token_class = AccessToken) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength params = Authenticator.new(id, secret, [:auth_scheme]).apply(params) opts = {:raise_errors => [:raise_errors], :parse => params.delete(:parse)} headers = params.delete(:headers) || {} if [:token_method] == :post opts[:body] = params opts[:headers] = {'Content-Type' => 'application/x-www-form-urlencoded'} else opts[:params] = params opts[:headers] = {} end opts[:headers].merge!(headers) response = request([:token_method], token_url, opts) if [:raise_errors] && !(response.parsed.is_a?(Hash) && response.parsed['access_token']) error = Error.new(response) raise(error) end access_token_class.from_hash(self, response.parsed.merge(access_token_opts)) end |
#implicit ⇒ Object
The Implicit strategy
164 165 166 |
# File 'lib/oauth2/client.rb', line 164 def implicit @implicit ||= OAuth2::Strategy::Implicit.new(self) end |
#password ⇒ Object
The Resource Owner Password Credentials strategy
171 172 173 |
# File 'lib/oauth2/client.rb', line 171 def password @password ||= OAuth2::Strategy::Password.new(self) end |
#redirection_params ⇒ Hash
The redirect_uri parameters, if configured
The redirect_uri query parameter is OPTIONAL (though encouraged) when requesting authorization. If it is provided at authorization time it MUST also be provided with the token exchange request.
Providing the :redirect_uri to the OAuth2::Client instantiation will take care of managing this.
202 203 204 205 206 207 208 |
# File 'lib/oauth2/client.rb', line 202 def redirection_params if [:redirect_uri] {'redirect_uri' => [:redirect_uri]} else {} end end |
#request(verb, url, opts = {}) {|req| ... } ⇒ Object
Makes a request relative to the specified site root.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/oauth2/client.rb', line 94 def request(verb, url, opts = {}) # rubocop:disable CyclomaticComplexity, MethodLength, Metrics/AbcSize connection.response :logger, ::Logger.new($stdout) if ENV['OAUTH_DEBUG'] == 'true' url = connection.build_url(url, opts[:params]).to_s response = connection.run_request(verb, url, opts[:body], opts[:headers]) do |req| yield(req) if block_given? end response = Response.new(response, :parse => opts[:parse]) case response.status when 301, 302, 303, 307 opts[:redirect_count] ||= 0 opts[:redirect_count] += 1 return response if opts[:redirect_count] > [:max_redirects] if response.status == 303 verb = :get opts.delete(:body) end request(verb, response.headers['location'], opts) when 200..299, 300..399 # on non-redirecting 3xx statuses, just return the response response when 400..599 error = Error.new(response) raise(error) if opts.fetch(:raise_errors, [:raise_errors]) response.error = error response else error = Error.new(response) raise(error, "Unhandled status code value of #{response.status}") end end |
#token_url(params = nil) ⇒ Object
The token endpoint URL of the OAuth2 provider
78 79 80 |
# File 'lib/oauth2/client.rb', line 78 def token_url(params = nil) connection.build_url([:token_url], params).to_s end |