Class: Remit::SignedQuery

Inherits:
Relax::Query
  • Object
show all
Defined in:
lib/remit/common.rb

Direct Known Subclasses

ApiQuery

Constant Summary collapse

UNSAFE = 
/[^A-Za-z0-9_.~-]/

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri, secret_key, query = {}) ⇒ SignedQuery

Returns a new instance of SignedQuery.



81
82
83
84
85
86
 
# File 'lib/remit/common.rb', line 81

def initialize(uri, secret_key, query = {})
  super(query)
  @uri = URI.parse(uri.to_s)
  @secret_key = secret_key
  sign
end

Class Method Details

.escape_value(value) ⇒ Object

Amazon is very specific about what chars should be escaped, and which should not.



118
119
120
121
 
# File 'lib/remit/common.rb', line 118

def escape_value(value)
  # note that URI.escape(' ') => '%20', and CGI.escape(' ') => '+'
  URI.escape(value.to_s, UNSAFE)
end

.parse(uri, secret_key, query_string) ⇒ Object 



107
108
109
110
111
112
113
114
 
# File 'lib/remit/common.rb', line 107

def parse(uri, secret_key, query_string)
  query = self.new(uri, secret_key)
  query_string.split('&').each do |parameter|
    key, value = parameter.split('=', 2)
    query[key] = unescape_value(value)
  end
  query
end

Instance Method Details

#sign ⇒ Object 



88
89
90
91
92
 
# File 'lib/remit/common.rb', line 88

def sign
  store(:signatureVersion, Remit::API::SIGNATURE_VERSION)
  store(:signatureMethod, Remit::API::SIGNATURE_METHOD)
  store(:signature, signature)
end

#signable_string ⇒ Object 



98
99
100
101
102
103
104
 
# File 'lib/remit/common.rb', line 98

def signable_string
  [ 'GET',
    @uri.host,
    @uri.path,
    to_s # the query string, sans :signature (but with :signatureVersion and :signatureMethod)
  ].join("\n")
end

#signature ⇒ Object 



94
95
96
 
# File 'lib/remit/common.rb', line 94

def signature
  Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, @secret_key, signable_string)).strip
end