amazon-ecs 0.5.4 → 0.5.5

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.5.5 2009-07-18
+----------------
+* Sign request
+
 0.5.4 2008-01-02
 ----------------
 * Add Response#error_code

data/README

@@ -1,8 +1,8 @@
 == amazon-ecs
 
-Generic Amazon E-commerce REST API using Hpricot with configurable 
+Generic Amazon E-commerce REST or Product Advertising API using Hpricot with configurable 
 default options and method call options. Uses Response and 
-Element wrapper classes for easy access to REST XML output. It supports ECS 4.0.
+Element wrapper classes for easy access to REST XML output.
 
 It is generic, so you can easily extend <tt>Amazon::Ecs</tt> to support 
 other not implemented REST operations; and it is also generic because it just wraps around
@@ -12,7 +12,7 @@ If in the future, there is a change in REST XML output structure,
 no changes will be required on <tt>amazon-ecs</tt> library, 
 instead you just need to change the element path.
 
-Version: 0.5.4
+Version: 0.5.5
 
 == INSTALLATION
 
@@ -23,7 +23,16 @@ Version: 0.5.4
     require 'amazon/ecs'
 	
     # set the default options; options will be camelized and converted to REST request parameters.
-    Amazon::Ecs.options = {:aWS_access_key_id => [your developer token]}
+    Amazon::Ecs.options = {:aWS_access_key_id => [your access key]}
+
+    # to generate signed requests include your secret key:
+    Amazon::Ecs.options = {:aWS_access_key_id => [your developer token], :aWS_secret_key => [your secret access key]}
+
+    # alternatively,
+    Amazon::Ecs.configure do |options|
+        options[:aWS_access_key_id] = [your access key]
+        options[:aWS_secret_key] = [you secret key]
+    end
 
     # options provided on method call will merge with the default options
     res = Amazon::Ecs.item_search('ruby', {:response_group => 'Medium', :sort => 'salesrank'})
@@ -87,11 +96,16 @@ http://www.awszone.com/scratchpads/aws/ecs.us/index.aws
 
 == LINKS
 
+* http://github.com/jugend/amazon-ecs
 * http://amazon-ecs.rubyforge.org
 * http://www.pluitsolutions.com/amazon-ecs
 
+== CREDITS
+
+Thanks to Dan Milne (http://da.nmilne.com/) for the signed request patch.
+
 == LICENSE
 
 (The MIT License)
 
-Copyright (c) 2006 Herryanto Siatono, Pluit Solutions
+Copyright (c) 2009 Herryanto Siatono, Pluit Solutions

data/lib/amazon/ecs.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006 Herryanto Siatono, Pluit Solutions
+# Copyright (c) 2009 Herryanto Siatono, Pluit Solutions
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -24,20 +24,26 @@
 require 'net/http'
 require 'hpricot'
 require 'cgi'
+require 'hmac-sha2'
+require 'base64'
 
 module Amazon
   class RequestError < StandardError; end
   
   class Ecs
-    SERVICE_URLS = {:us => 'http://webservices.amazon.com/onca/xml?Service=AWSECommerceService',
-        :uk => 'http://webservices.amazon.co.uk/onca/xml?Service=AWSECommerceService',
-        :ca => 'http://webservices.amazon.ca/onca/xml?Service=AWSECommerceService',
-        :de => 'http://webservices.amazon.de/onca/xml?Service=AWSECommerceService',
-        :jp => 'http://webservices.amazon.co.jp/onca/xml?Service=AWSECommerceService',
-        :fr => 'http://webservices.amazon.fr/onca/xml?Service=AWSECommerceService'
+    SERVICE_URLS = {:us => 'http://webservices.amazon.com/onca/xml?',
+        :uk => 'http://webservices.amazon.co.uk/onca/xml?',
+        :ca => 'http://webservices.amazon.ca/onca/xml?',
+        :de => 'http://webservices.amazon.de/onca/xml?',
+        :jp => 'http://webservices.amazon.co.jp/onca/xml?',
+        :fr => 'http://webservices.amazon.fr/onca/xml?'
+    }
+    
+    @@options = {
+      :version => "2009-01-06",
+      :service => "AWSECommerceService"
     }
     
-    @@options = {}
     @@debug = false
 
     # Default search options
@@ -92,6 +98,10 @@ module Amazon
     # Generic send request to ECS REST service. You have to specify the :operation parameter.
     def self.send_request(opts)
       opts = self.options.merge(opts) if self.options
+      
+      # Include other required options
+      opts[:timestamp] = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+
       request_url = prepare_url(opts)
       log "Request URL: #{request_url}"
       
@@ -190,19 +200,39 @@ module Amazon
         country = (country.nil?) ? 'us' : country
         request_url = SERVICE_URLS[country.to_sym]
         raise Amazon::RequestError, "Invalid country '#{country}'" unless request_url
+
+        secret_key = opts.delete(:aWS_secret_key)
+        request_host = URI.parse(request_url).host
         
         qs = ''
-        opts.each {|k,v|
-          next unless v
-          v = v.join(',') if v.is_a? Array
-          qs << "&#{camelize(k.to_s)}=#{URI.encode(v.to_s)}"
+        opts.collect {|a,b| [camelize(a.to_s), b.to_s] }.sort {|c,d| c[0].to_s <=> d[0].to_s}.each {|e| 
+          log "Adding #{e[0]}=#{e[1]}"
+          next unless e[1]
+          e[1] = e[1].join(',') if e[1].is_a? Array
+          v=URI.encode(e[1].to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+          qs << "&" unless qs.length == 0
+          qs << "#{e[0]}=#{v}"
         }
-        "#{request_url}#{qs}"
+        
+        signature = ''
+        unless secret_key.nil?
+          request_to_sign="GET\n#{request_host}\n/onca/xml\n#{qs}"
+          signature = "&Signature=#{sign_request(request_to_sign, secret_key)}"
+        end
+
+        "#{request_url}#{qs}#{signature}"
       end
       
       def self.camelize(s)
         s.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
       end
+      
+      def self.sign_request(url, key)
+        return nil if key.nil?
+        signature = URI.escape( Base64.encode64( HMAC::SHA256.digest(key, url) ).strip, Regexp.new("[+=]") )
+        return signature
+      end
+      
   end
 
   # Internal wrapper class to provide convenient method to access Hpricot element value.

data/test/amazon/ecs_test.rb

@@ -2,21 +2,29 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class Amazon::EcsTest < Test::Unit::TestCase
 
-  AWS_ACCESS_KEY_ID = '1ZD53WRGR730ZCVWBSG2'
+  AWS_ACCESS_KEY_ID = ''
+  AWS_SECRET_KEY = ''
+  
   raise "Please specify set your AWS_ACCESS_KEY_ID" if AWS_ACCESS_KEY_ID.empty?
+  raise "Please specify set your AWS_SECRET_KEY" if AWS_SECRET_KEY.empty?
   
   Amazon::Ecs.configure do |options|
     options[:response_group] = 'Large'
     options[:aWS_access_key_id] = AWS_ACCESS_KEY_ID
+    options[:aWS_secret_key] = AWS_SECRET_KEY
   end
 
   ## Test item_search
 
   def test_item_search
     resp = Amazon::Ecs.item_search('ruby')
+    
     assert(resp.is_valid_request?)
     assert(resp.total_results >= 3600)
     assert(resp.total_pages >= 360)
+    
+    signature_elements = (resp.doc/"arguments/argument").select {|ele| ele.attributes['name'] == 'Signature' }.length
+    assert(signature_elements == 1)
   end
 
   def test_item_search_with_paging

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: amazon-ecs
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
 - Herryanto Siatono
@@ -9,7 +9,7 @@ autorequire: name
 bindir: bin
 cert_chain: []
 
-date: 2009-01-24 00:00:00 +08:00
+date: 2009-07-18 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0.4"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+    version: 
 description: 
 email: herryanto@pluitsolutions.com
 executables: []
@@ -32,12 +42,13 @@ extra_rdoc_files:
 - README
 - CHANGELOG
 files: 
-- lib/amazon
 - lib/amazon/ecs.rb
 - README
 - CHANGELOG
 has_rdoc: true
 homepage: http://amazon-ecs.rubyforge.net/
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -58,9 +69,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.0
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Generic Amazon E-commerce Service (ECS) REST API. Supports ECS 4.0.
 test_files: 
 - test/amazon/ecs_test.rb