Class: Force::Middleware::Authentication

Inherits:
Force::Middleware show all
Defined in:
lib/force/middleware/authentication.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

Password, Token

Defined Under Namespace

Classes: Password, Token

Instance Method Summary collapse

Methods inherited from Force::Middleware

#client, #initialize

Constructor Details

This class inherits a constructor from Force::Middleware

Instance Method Details

#authenticate!Object

Internal: Performs the authentication and returns the response body.


20
21
22
23
24
25
26
27
28
29
# File 'lib/force/middleware/authentication.rb', line 20

def authenticate!
  response = connection.post '/services/oauth2/token' do |req|
    req.body = encode_www_form(params)
  end
  raise Force::AuthenticationError, error_message(response) if response.status != 200
  @options[:instance_url] = response.body['instance_url']
  @options[:oauth_token]  = response.body['access_token']
  @options[:authentication_callback].call(response.body) if @options[:authentication_callback]
  response.body
end

#call(env) ⇒ Object

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


12
13
14
15
16
17
# File 'lib/force/middleware/authentication.rb', line 12

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

#connectionObject

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


37
38
39
40
41
42
43
44
45
# File 'lib/force/middleware/authentication.rb', line 37

def connection
  @connection ||= Faraday.new(faraday_options) do |builder|
    builder.use Faraday::Request::UrlEncoded
    builder.use Force::Middleware::Mashify, nil, @options
    builder.response :json
    builder.use Force::Middleware::Logger, Force.configuration.logger, @options if Force.log?
    builder.adapter Faraday.default_adapter
  end
end

#encode_www_form(params) ⇒ Object

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


54
55
56
57
58
59
60
61
62
63
# File 'lib/force/middleware/authentication.rb', line 54

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

#error_message(response) ⇒ Object

Internal: The parsed error response.


48
49
50
# File 'lib/force/middleware/authentication.rb', line 48

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

#paramsObject

Internal: The params to post to the OAuth service.

Raises:

  • (NotImplementedError)

32
33
34
# File 'lib/force/middleware/authentication.rb', line 32

def params
  raise NotImplementedError
end