class OAuth2::Client

The OAuth2::Client class

Attributes

connection[W]
id[R]
options[RW]
secret[R]
site[R]

Public Class Methods

new(client_id, client_secret, opts = {}, &block) click to toggle source

Instantiate a new OAuth 2.0 client using the Client ID and Client Secret registered to your application.

@param [String] client_id the client_id value @param [String] client_secret the client_secret value @param [Hash] opts the options to create the client with @option opts [String] :site the OAuth2 provider site host @option opts [String] :authorize_url ('/oauth/authorize') absolute or relative URL path to the Authorization endpoint @option opts [String] :token_url ('/oauth/token') absolute or relative URL path to the Token endpoint @option opts [Symbol] :token_method (:post) HTTP method to use to request token (:get or :post) @option opts [Hash] :connection_opts ({}) Hash of connection options to pass to initialize Faraday with @option opts [FixNum] :max_redirects (5) maximum number of redirects to follow @option opts [Boolean] :raise_errors (true) whether or not to raise an OAuth2::Error

on responses with 400+ status codes

@yield [builder] The Faraday connection builder

# File lib/oauth2/client.rb, line 26
def initialize(client_id, client_secret, opts = {}, &block)
  _opts = 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,
              :connection_opts  => {},
              :connection_build => block,
              :max_redirects    => 5,
              :raise_errors     => true}.merge(_opts)
  @options[:connection_opts][:ssl] = ssl if ssl
end

Public Instance Methods

assertion() click to toggle source
# File lib/oauth2/client.rb, line 169
def assertion
  @assertion ||= OAuth2::Strategy::Assertion.new(self)
end
auth_code() click to toggle source

The Authorization Code strategy

@see tools.ietf.org/html/draft-ietf-oauth-v2-15#section-4.1

# File lib/oauth2/client.rb, line 144
def auth_code
  @auth_code ||= OAuth2::Strategy::AuthCode.new(self)
end
authorize_url(params = nil) click to toggle source

The authorize endpoint URL of the OAuth2 provider

@param [Hash] params additional query parameters

# File lib/oauth2/client.rb, line 64
def authorize_url(params = nil)
  connection.build_url(options[:authorize_url], params).to_s
end
client_credentials() click to toggle source

The Client Credentials strategy

@see tools.ietf.org/html/draft-ietf-oauth-v2-15#section-4.4

# File lib/oauth2/client.rb, line 165
def client_credentials
  @client_credentials ||= OAuth2::Strategy::ClientCredentials.new(self)
end
connection() click to toggle source

The Faraday connection object

# File lib/oauth2/client.rb, line 51
def connection
  @connection ||= begin
    conn = Faraday.new(site, options[:connection_opts])
    conn.build do |b|
      options[:connection_build].call(b)
    end if options[:connection_build]
    conn
  end
end
get_token(params, access_token_opts = {}, access_token_class = AccessToken) click to toggle source

Initializes an AccessToken by making a request to the token endpoint

@param [Hash] params a Hash of params for the token endpoint @param [Hash] access token options, to pass to the AccessToken object @param [Class] class of access token for easier subclassing OAuth2::AccessToken @return [AccessToken] the initalized AccessToken

# File lib/oauth2/client.rb, line 125
def get_token(params, access_token_opts = {}, access_token_class = AccessToken)
  opts = {:raise_errors => options[:raise_errors], :parse => params.delete(:parse)}
  if options[:token_method] == :post
    headers = params.delete(:headers)
    opts[:body] = params
    opts[:headers] =  {'Content-Type' => 'application/x-www-form-urlencoded'}
    opts[:headers].merge!(headers) if headers
  else
    opts[:params] = params
  end
  response = request(options[:token_method], token_url, opts)
  error = Error.new(response)
  fail(error) if options[:raise_errors] && !(response.parsed.is_a?(Hash) && response.parsed['access_token'])
  access_token_class.from_hash(self, response.parsed.merge(access_token_opts))
end
implicit() click to toggle source

The Implicit strategy

@see tools.ietf.org/html/draft-ietf-oauth-v2-26#section-4.2

# File lib/oauth2/client.rb, line 151
def implicit
  @implicit ||= OAuth2::Strategy::Implicit.new(self)
end
password() click to toggle source

The Resource Owner Password Credentials strategy

@see tools.ietf.org/html/draft-ietf-oauth-v2-15#section-4.3

# File lib/oauth2/client.rb, line 158
def password
  @password ||= OAuth2::Strategy::Password.new(self)
end
request(verb, url, opts = {}) { |req| ... } click to toggle source

Makes a request relative to the specified site root.

@param [Symbol] verb one of :get, :post, :put, :delete @param [String] url URL path of request @param [Hash] opts the options to make the request with @option opts [Hash] :params additional query parameters for the URL of the request @option opts [Hash, String] :body the body of the request @option opts [Hash] :headers http request headers @option opts [Boolean] :raise_errors whether or not to raise an OAuth2::Error on 400+ status

code response for this request.  Will default to client option

@option opts [Symbol] :parse @see Response::initialize @yield [req] The Faraday request

# File lib/oauth2/client.rb, line 87
def request(verb, url, opts = {}) # rubocop:disable CyclomaticComplexity, MethodLength
  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] > 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)
    fail(error) if opts.fetch(:raise_errors, options[:raise_errors])
    response.error = error
    response
  else
    error = Error.new(response)
    fail(error, "Unhandled status code value of #{response.status}")
  end
end
site=(value) click to toggle source

Set the site host

@param [String] the OAuth2 provider site host

# File lib/oauth2/client.rb, line 45
def site=(value)
  @connection = nil
  @site = value
end
token_exchange() click to toggle source
# File lib/oauth2/client.rb, line 173
def token_exchange
  @token_exchange ||= OAuth2::Strategy::TokenExchange.new(self)
end
token_url(params = nil) click to toggle source

The token endpoint URL of the OAuth2 provider

@param [Hash] params additional query parameters

# File lib/oauth2/client.rb, line 71
def token_url(params = nil)
  connection.build_url(options[:token_url], params).to_s
end