Class: OAuth2::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/oauth2/client.rb

Overview

The OAuth2::Client class

Constant Summary collapse

RESERVED_PARAM_KEYS =

rubocop:disable Metrics/ClassLength

%w[headers parse].freeze
DEFAULT_EXTRACT_ACCESS_TOKEN = 
proc do |client, hash|
  token = hash.delete('access_token') || hash.delete(:access_token)
  token && AccessToken.new(client, token, hash)
end

Instance Attribute Summary collapse

Instance Method Summary collapse

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.

Parameters:

  • client_id (String) —

    the client_id value

  • client_secret (String) —

    the client_secret value

  • opts (Hash) —

    the options to create the client with

Yields:

  • (builder) —

    The Faraday connection builder



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oauth2/client.rb', line 31

def initialize(client_id, client_secret, options = {}, &block)
  opts = options.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,
    :extract_access_token => DEFAULT_EXTRACT_ACCESS_TOKEN,
  }.merge(opts)
  @options[:connection_opts][:ssl] = ssl if ssl
end

Instance Attribute Details

#connection ⇒ Object

The Faraday connection object



61
62
63
64
65
66
67
68
 
# File 'lib/oauth2/client.rb', line 61

def connection
  @connection ||=
    Faraday.new(site, options[:connection_opts]) do |builder|
      if options[:connection_build]
        options[:connection_build].call(builder)
      end
    end
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



9
10
11
 
# File 'lib/oauth2/client.rb', line 9

def id
  @id
end

#options ⇒ Object

Returns the value of attribute options.



10
11
12
 
# File 'lib/oauth2/client.rb', line 10

def options
  @options
end

#secret ⇒ Object (readonly)

Returns the value of attribute secret.



9
10
11
 
# File 'lib/oauth2/client.rb', line 9

def secret
  @secret
end

#site ⇒ Object

Returns the value of attribute site.



9
10
11
 
# File 'lib/oauth2/client.rb', line 9

def site
  @site
end

Instance Method Details

#assertion ⇒ Object 



204
205
206
 
# File 'lib/oauth2/client.rb', line 204

def assertion
  @assertion ||= OAuth2::Strategy::Assertion.new(self)
end

#auth_code ⇒ Object

The Authorization Code strategy

See Also:



179
180
181
 
# File 'lib/oauth2/client.rb', line 179

def auth_code
  @auth_code ||= OAuth2::Strategy::AuthCode.new(self)
end

#authorize_url(params = {}) ⇒ Object

The authorize endpoint URL of the OAuth2 provider

Parameters:

  • params (Hash) (defaults to: {}) —

    additional query parameters



73
74
75
76
 
# File 'lib/oauth2/client.rb', line 73

def authorize_url(params = {})
  params = (params || {}).merge(redirection_params)
  connection.build_url(options[:authorize_url], params).to_s
end

#client_credentials ⇒ Object

The Client Credentials strategy

See Also:



200
201
202
 
# File 'lib/oauth2/client.rb', line 200

def client_credentials
  @client_credentials ||= OAuth2::Strategy::ClientCredentials.new(self)
end

#get_token(params, access_token_opts = {}, extract_access_token = ) ⇒ AccessToken

Initializes an AccessToken by making a request to the token endpoint

Parameters:

  • params (Hash) —

    a Hash of params for the token endpoint

  • access (Hash) —

    token options, to pass to the AccessToken object

  • class (Class) —

    of access token for easier subclassing OAuth2::AccessToken

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oauth2/client.rb', line 140

def get_token(params, access_token_opts = {}, extract_access_token = options[:extract_access_token]) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  params = params.map do |key, value|
    if RESERVED_PARAM_KEYS.include?(key)
      [key.to_sym, value]
    else
      [key, value]
    end
  end
  params = Hash[params]

  params = Authenticator.new(id, secret, options[:auth_scheme]).apply(params)
  opts = {:raise_errors => options[:raise_errors], :parse => params.delete(:parse)}
  headers = params.delete(:headers) || {}
  if options[: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(options[:token_method], token_url, opts)

  access_token = begin
    build_access_token(response, access_token_opts, extract_access_token)
  rescue StandardError
    nil
  end

  if options[:raise_errors] && !access_token
    error = Error.new(response)
    raise(error)
  end
  access_token
end

#implicit ⇒ Object

The Implicit strategy

See Also:



186
187
188
 
# File 'lib/oauth2/client.rb', line 186

def implicit
  @implicit ||= OAuth2::Strategy::Implicit.new(self)
end

#password ⇒ Object

The Resource Owner Password Credentials strategy

See Also:



193
194
195
 
# File 'lib/oauth2/client.rb', line 193

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.

Returns:

  • (Hash) —

    the params to add to a request or URL

See Also:



224
225
226
227
228
229
230
 
# File 'lib/oauth2/client.rb', line 224

def redirection_params
  if options[:redirect_uri]
    {'redirect_uri' => options[:redirect_uri]}
  else
    {}
  end
end

#request(verb, url, opts = {}) {|req| ... } ⇒ Object

Makes a request relative to the specified site root.

Parameters:

  • verb (Symbol) —

    one of :get, :post, :put, :delete

  • url (String) —

    URL path of request

  • opts (Hash) (defaults to: {}) —

    the options to make the request with

Options Hash (opts):

  • :params (Hash) —

    additional query parameters for the URL of the request

  • :body (Hash, String) —

    the body of the request

  • :headers (Hash) —

    http request headers

  • :raise_errors (Boolean) —

    whether or not to raise an OAuth2::Error on 400+ status code response for this request. Will default to client option

  • :parse (Symbol) —

    @see Response::initialize

Yields:

  • (req) —

    The Faraday request



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
127
128
129
130
131
132
 
# File 'lib/oauth2/client.rb', line 97

def request(verb, url, opts = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
  connection.response :logger, ::Logger.new($stdout) if ENV['OAUTH_DEBUG'] == 'true'

  url = connection.build_url(url).to_s

  response = connection.run_request(verb, url, opts[:body], opts[:headers]) do |req|
    req.params.update(opts[:params]) if opts[:params]
    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] > options[: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, options[: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

Parameters:

  • params (Hash) (defaults to: nil) —

    additional query parameters



81
82
83
 
# File 'lib/oauth2/client.rb', line 81

def token_url(params = nil)
  connection.build_url(options[:token_url], params).to_s
end