Class: OAuth::Client::Helper

Inherits:
Object
  • Object
show all
Includes:
Helper
Defined in:
lib/oauth/client/helper.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helper

#_escape, #escape, #generate_key, #generate_timestamp, #normalize, #normalize_nested_query, #parse_header, #stringify_keys, #unescape

Constructor Details

#initialize(request, options = {}) ⇒ Helper

Returns a new instance of Helper.



11
12
13
14
15
 
# File 'lib/oauth/client/helper.rb', line 11

def initialize(request, options = {})
  @request = request
  @options = options
  @options[:signature_method] ||= "HMAC-SHA1"
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



17
18
19
 
# File 'lib/oauth/client/helper.rb', line 17

def options
  @options
end

Instance Method Details

#amend_user_agent_header(headers) ⇒ Object 



70
71
72
73
74
75
76
77
78
 
# File 'lib/oauth/client/helper.rb', line 70

def amend_user_agent_header(headers)
  @oauth_ua_string ||= "OAuth gem v#{OAuth::VERSION}"
  # Net::HTTP in 1.9 appends Ruby
  if headers["User-Agent"] && headers["User-Agent"] != "Ruby"
    headers["User-Agent"] += " (#{@oauth_ua_string})"
  else
    headers["User-Agent"] = @oauth_ua_string
  end
end

#hash_body ⇒ Object 



66
67
68
 
# File 'lib/oauth/client/helper.rb', line 66

def hash_body
  @options[:body_hash] = OAuth::Signature.body_hash(@request, parameters: oauth_parameters)
end

#header ⇒ Object 



80
81
82
83
84
85
86
87
88
 
# File 'lib/oauth/client/helper.rb', line 80

def header
  parameters = oauth_parameters
  parameters["oauth_signature"] = signature(options.merge(parameters: parameters))

  header_params_str = parameters.sort.map { |k, v| "#{k}=\"#{escape(v)}\"" }.join(", ")

  realm = "realm=\"#{options[:realm]}\", " if options[:realm]
  "OAuth #{realm}#{header_params_str}"
end

#nonce ⇒ Object 



19
20
21
 
# File 'lib/oauth/client/helper.rb', line 19

def nonce
  options[:nonce] ||= generate_key
end

#oauth_parameters ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oauth/client/helper.rb', line 27

def oauth_parameters
  out = {
    "oauth_body_hash"        => options[:body_hash],
    "oauth_callback"         => options[:oauth_callback],
    "oauth_consumer_key"     => options[:consumer].key,
    "oauth_token"            => options[:token] ? options[:token].token : "",
    "oauth_signature_method" => options[:signature_method],
    "oauth_timestamp"        => timestamp,
    "oauth_nonce"            => nonce,
    "oauth_verifier"         => options[:oauth_verifier],
    "oauth_version"          => (options[:oauth_version] || "1.0"),
    "oauth_session_handle"   => options[:oauth_session_handle]
  }
  allowed_empty_params = options[:allow_empty_params]
  if allowed_empty_params != true && !allowed_empty_params.is_a?(Array)
    allowed_empty_params = allowed_empty_params == false ? [] : [allowed_empty_params]
  end
  out.select! { |k, v| v.to_s != "" || allowed_empty_params == true || allowed_empty_params.include?(k) }
  out
end

#parameters ⇒ Object 



90
91
92
 
# File 'lib/oauth/client/helper.rb', line 90

def parameters
  OAuth::RequestProxy.proxy(@request).parameters
end

#parameters_with_oauth ⇒ Object 



94
95
96
 
# File 'lib/oauth/client/helper.rb', line 94

def parameters_with_oauth
  oauth_parameters.merge(parameters)
end

#signature(extra_options = {}) ⇒ Object 



48
49
50
51
52
53
 
# File 'lib/oauth/client/helper.rb', line 48

def signature(extra_options = {})
  OAuth::Signature.sign(@request, { uri: options[:request_uri],
                                    consumer: options[:consumer],
                                    token: options[:token],
                                    unsigned_parameters: options[:unsigned_parameters] }.merge(extra_options))
end

#signature_base_string(extra_options = {}) ⇒ Object 



55
56
57
58
59
60
 
# File 'lib/oauth/client/helper.rb', line 55

def signature_base_string(extra_options = {})
  OAuth::Signature.signature_base_string(@request, { uri: options[:request_uri],
                                                     consumer: options[:consumer],
                                                     token: options[:token],
                                                     parameters: oauth_parameters }.merge(extra_options))
end

#timestamp ⇒ Object 



23
24
25
 
# File 'lib/oauth/client/helper.rb', line 23

def timestamp
  options[:timestamp] ||= generate_timestamp
end

#token_request? ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/oauth/client/helper.rb', line 62

def token_request?
  @options[:token_request].eql?(true)
end