Class: OAuth::RequestProxy::Base

Inherits:
Object
  • Object
show all
Includes:
Helper
Defined in:
lib/oauth/request_proxy/base.rb

Direct Known Subclasses

ActionControllerRequest, Curl::Easy, EventMachine::HttpRequest, JabberRequest, MockRequest, Net::HTTP::HTTPRequest, RackRequest, Typhoeus::Request

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Helper

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

Constructor Details

- (Base) initialize(request, options = {})

A new instance of Base



14
15
16
17
18
 
# File 'lib/oauth/request_proxy/base.rb', line 14

def initialize(request, options = {})
  @request = request
  @unsigned_parameters = (options[:unsigned_parameters] || []).map {|param| param.to_s}
  @options = options
end

Instance Attribute Details

- (Object) options

Returns the value of attribute options



12
13
14
 
# File 'lib/oauth/request_proxy/base.rb', line 12

def options
  @options
end

- (Object) request

Returns the value of attribute request



12
13
14
 
# File 'lib/oauth/request_proxy/base.rb', line 12

def request
  @request
end

- (Object) unsigned_parameters

Returns the value of attribute unsigned_parameters



12
13
14
 
# File 'lib/oauth/request_proxy/base.rb', line 12

def unsigned_parameters
  @unsigned_parameters
end

Class Method Details

+ (Object) proxies(klass) 



8
9
10
 
# File 'lib/oauth/request_proxy/base.rb', line 8

def self.proxies(klass)
  OAuth::RequestProxy.available_proxies[klass] = self
end

Instance Method Details

- (Object) non_oauth_parameters 



86
87
88
 
# File 'lib/oauth/request_proxy/base.rb', line 86

def non_oauth_parameters
  parameters.reject { |k,v| OAuth::PARAMETERS.include?(k) }
end

- (Object) normalized_parameters

See 9.1.1. in specs Normalize Request Parameters



97
98
99
 
# File 'lib/oauth/request_proxy/base.rb', line 97

def normalized_parameters
  normalize(parameters_for_signature)
end

- (Object) normalized_uri

See 9.1.2 in specs



91
92
93
94
 
# File 'lib/oauth/request_proxy/base.rb', line 91

def normalized_uri
  u = URI.parse(uri)
  "#{u.scheme.downcase}://#{u.host.downcase}#{(u.scheme.downcase == 'http' && u.port != 80) || (u.scheme.downcase == 'https' && u.port != 443) ? ":#{u.port}" : ""}#{(u.path && u.path != '') ? u.path : '/'}"
end

- (Object) oauth_callback

OAuth parameters



22
23
24
 
# File 'lib/oauth/request_proxy/base.rb', line 22

def oauth_callback
  parameters['oauth_callback']
end

- (Object) oauth_consumer_key Also known as: consumer_key 



26
27
28
 
# File 'lib/oauth/request_proxy/base.rb', line 26

def oauth_consumer_key
  parameters['oauth_consumer_key']
end

- (Object) oauth_header(options = {})

Authorization header for OAuth



138
139
140
141
142
143
 
# File 'lib/oauth/request_proxy/base.rb', line 138

def oauth_header(options = {})
  header_params_str = oauth_parameters.map { |k,v| "#{k}=\"#{escape(v)}\"" }.join(', ')

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

- (Object) oauth_nonce Also known as: nonce 



30
31
32
 
# File 'lib/oauth/request_proxy/base.rb', line 30

def oauth_nonce
  parameters['oauth_nonce']
end

- (Object) oauth_parameters 



82
83
84
 
# File 'lib/oauth/request_proxy/base.rb', line 82

def oauth_parameters
  parameters.select { |k,v| OAuth::PARAMETERS.include?(k) }.reject { |k,v| v == "" }
end

- (Object) oauth_signature Also known as: signature 



34
35
36
37
 
# File 'lib/oauth/request_proxy/base.rb', line 34

def oauth_signature
  # TODO can this be nil?
  [parameters['oauth_signature']].flatten.first || ""
end

- (Object) oauth_signature_method Also known as: signature_method 



39
40
41
42
43
44
45
46
 
# File 'lib/oauth/request_proxy/base.rb', line 39

def oauth_signature_method
  case parameters['oauth_signature_method']
  when Array
    parameters['oauth_signature_method'].first
  else
    parameters['oauth_signature_method']
  end
end

- (Object) oauth_timestamp Also known as: timestamp 



48
49
50
 
# File 'lib/oauth/request_proxy/base.rb', line 48

def oauth_timestamp
  parameters['oauth_timestamp']
end

- (Object) oauth_token Also known as: token 



52
53
54
 
# File 'lib/oauth/request_proxy/base.rb', line 52

def oauth_token
  parameters['oauth_token']
end

- (Object) oauth_verifier 



56
57
58
 
# File 'lib/oauth/request_proxy/base.rb', line 56

def oauth_verifier
  parameters['oauth_verifier']
end

- (Object) oauth_version 



60
61
62
 
# File 'lib/oauth/request_proxy/base.rb', line 60

def oauth_version
  parameters["oauth_version"]
end

- (Object) parameters

Parameter accessors

Raises:

  • (NotImplementedError) 


74
75
76
 
# File 'lib/oauth/request_proxy/base.rb', line 74

def parameters
  raise NotImplementedError, "Must be implemented by subclasses"
end

- (Object) parameters_for_signature 



78
79
80
 
# File 'lib/oauth/request_proxy/base.rb', line 78

def parameters_for_signature
  parameters.reject { |k,v| k == "oauth_signature" || unsigned_parameters.include?(k)}
end

- (Boolean) query_string_blank?

Returns:

  • (Boolean) 


145
146
147
148
149
150
151
 
# File 'lib/oauth/request_proxy/base.rb', line 145

def query_string_blank?
  if uri = request.request_uri
    uri.split('?', 2)[1].nil?
  else
    request.query_string.blank?
  end
end

- (Object) sign(options = {}) 



101
102
103
 
# File 'lib/oauth/request_proxy/base.rb', line 101

def sign(options = {})
  OAuth::Signature.sign(self, options)
end

- (Object) sign!(options = {}) 



105
106
107
108
109
 
# File 'lib/oauth/request_proxy/base.rb', line 105

def sign!(options = {})
  parameters["oauth_signature"] = sign(options)
  @signed = true
  signature
end

- (Object) signature_base_string

See 9.1 in specs



112
113
114
115
 
# File 'lib/oauth/request_proxy/base.rb', line 112

def signature_base_string
  base = [method, normalized_uri, normalized_parameters]
  base.map { |v| escape(v) }.join("&")
end

- (Boolean) signed?

Has this request been signed yet?

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/oauth/request_proxy/base.rb', line 118

def signed?
  @signed
end

- (Object) signed_uri(with_oauth = true)

URI, including OAuth parameters



123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oauth/request_proxy/base.rb', line 123

def signed_uri(with_oauth = true)
  if signed?
    if with_oauth
      params = parameters
    else
      params = non_oauth_parameters
    end

    [uri, normalize(params)] * "?"
  else
    STDERR.puts "This request has not yet been signed!"
  end
end