Class: Restforce::Middleware::Authentication

Inherits:
Restforce::Middleware show all
Defined in:
lib/restforce/middleware/authentication.rb,
lib/restforce/middleware/authentication/jwt_bearer.rb,
lib/restforce/middleware/authentication/client_credential.rb

Overview

Faraday middleware that allows for on the fly authentication of requests. When a request fails (a status of 401 is returned), the middleware will attempt to either reauthenticate (username and password) or refresh the oauth access token (if a refresh token is present).

Direct Known Subclasses

ClientCredential, JWTBearer, Password, Token

Defined Under Namespace

Classes: ClientCredential, JWTBearer, Password, Token

Instance Method Summary collapse

Methods inherited from Restforce::Middleware

#client, #initialize

Constructor Details

This class inherits a constructor from Restforce::Middleware

Instance Method Details

#authenticate! ⇒ Object

Internal: Performs the authentication and returns the response body.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/restforce/middleware/authentication.rb', line 24

def authenticate!
  response = connection.post '/services/oauth2/token' do |req|
    req.body = encode_www_form(params)
  end

  if response.status >= 500
    raise Restforce::ServerError, error_message(response)
  elsif response.status != 200
    raise Restforce::AuthenticationError, error_message(response)
  end

  @options[:instance_url] = response.body['instance_url']
  @options[:oauth_token]  = response.body['access_token']

  @options[:authentication_callback]&.call(response.body)

  response.body
end

#call(env) ⇒ Object

Rescue from 401’s, authenticate then raise the error again so the client can reissue the request.



16
17
18
19
20
21
 
# File 'lib/restforce/middleware/authentication.rb', line 16

def call(env)
  @app.call(env)
rescue Restforce::UnauthorizedError
  authenticate!
  raise
end

#connection ⇒ Object

Internal: Faraday connection to use when sending an authentication request.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/restforce/middleware/authentication.rb', line 49

def connection
  @connection ||= Faraday.new(faraday_options) do |builder|
    builder.use Faraday::Request::UrlEncoded
    builder.use Restforce::Middleware::Mashify, nil, @options
    builder.use Faraday::FollowRedirects::Middleware
    builder.response :restforce_json

    if Restforce.log?
      builder.use Restforce::Middleware::Logger,
                  Restforce.configuration.logger,
                  @options
    end

    builder.adapter @options[:adapter]
  end
end

#encode_www_form(params) ⇒ Object

Featured detect form encoding. URI in 1.8 does not include encode_www_form



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/restforce/middleware/authentication.rb', line 76

def encode_www_form(params)
  if URI.respond_to?(:encode_www_form)
    URI.encode_www_form(params)
  else
    params.map do |k, v|
      k = CGI.escape(k.to_s)
      v = CGI.escape(v.to_s)
      "#{k}=#{v}"
    end.join('&')
  end
end

#error_message(response) ⇒ Object

Internal: The parsed error response.



67
68
69
70
71
72
 
# File 'lib/restforce/middleware/authentication.rb', line 67

def error_message(response)
  return response.status.to_s unless response.body

  "#{response.body['error']}: #{response.body['error_description']} " \
    "(#{response.status})"
end

#params ⇒ Object

Internal: The params to post to the OAuth service.

Raises:

  • (NotImplementedError) 


44
45
46
 
# File 'lib/restforce/middleware/authentication.rb', line 44

def params
  raise NotImplementedError
end