Class: FaradayMiddleware::OAuth

Inherits:
Faraday::Middleware
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/faraday_middleware/request/oauth.rb

Overview

Public: Uses the simple_oauth library to sign requests according the OAuth protocol.

The options for this middleware are forwarded to SimpleOAuth::Header: :consumer_key, :consumer_secret, :token, :token_secret. All these parameters are optional.

The signature is added to the “Authorization” HTTP request header. If the value for this header already exists, it is not overriden.

If no Content-Type header is specified, this middleware assumes that request body parameters should be included while signing the request. Otherwise, it only includes them if the Content-Type is “application/x-www-form-urlencoded”, as per OAuth 1.0.

For better performance while signing requests, this middleware should be positioned before UrlEncoded middleware on the stack, but after any other body-encoding middleware (such as EncodeJson).

Constant Summary collapse

AUTH_HEADER = 
'Authorization'
CONTENT_TYPE = 
'Content-Type'
TYPE_URLENCODED = 
'application/x-www-form-urlencoded'

Instance Method Summary collapse

Constructor Details

#initialize(app, options) ⇒ OAuth

Returns a new instance of OAuth.



35
36
37
38
 
# File 'lib/faraday_middleware/request/oauth.rb', line 35

def initialize(app, options)
  super(app)
  @options = options
end

Instance Method Details

#body_params(env) ⇒ Object 



64
65
66
67
68
69
70
71
72
 
# File 'lib/faraday_middleware/request/oauth.rb', line 64

def body_params(env)
  if include_body_params?(env)
    if env[:body].respond_to?(:to_str)
      parse_nested_query env[:body]
    else
      env[:body]
    end
  end || {}
end

#call(env) ⇒ Object 



40
41
42
43
 
# File 'lib/faraday_middleware/request/oauth.rb', line 40

def call(env)
  env[:request_headers][AUTH_HEADER] ||= oauth_header(env).to_s if sign_request?(env)
  @app.call(env)
end

#include_body_params?(env) ⇒ Boolean

Returns:

  • (Boolean) 


74
75
76
77
 
# File 'lib/faraday_middleware/request/oauth.rb', line 74

def include_body_params?(env)
  # see RFC 5849, section 3.4.1.3.1 for details
  !(type = env[:request_headers][CONTENT_TYPE]) || (type == TYPE_URLENCODED)
end

#oauth_header(env) ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/faraday_middleware/request/oauth.rb', line 45

def oauth_header(env)
  SimpleOAuth::Header.new env[:method],
                          env[:url].to_s,
                          signature_params(body_params(env)),
                          oauth_options(env)
end

#oauth_options(env) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/faraday_middleware/request/oauth.rb', line 56

def oauth_options(env)
  if (extra = env[:request][:oauth]) && extra.is_a?(Hash) && !extra.empty?
    @options.merge extra
  else
    @options
  end
end

#sign_request?(env) ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/faraday_middleware/request/oauth.rb', line 52

def sign_request?(env)
  !!env[:request].fetch(:oauth, true)
end

#signature_params(params) ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/faraday_middleware/request/oauth.rb', line 79

def signature_params(params)
  if params.empty?
    params
  else
    params.reject { |_k, v| v.respond_to?(:content_type) }
  end
end