completelynovel-amazon-product-advertising-api 0.1.0 → 0.2.0

data/EXAMPLE.txt

@@ -3,8 +3,10 @@ Basic usage
 
 require 'rubygems'
 require 'amazon_product_advertising_api'
-# Setup your API key - in an initializer or something like that
+
+# Setup your API keys - in an initializer or something like that
 AmazonProductAdvertisingApi::Base.access_key_id = "<insert api key here>"
+AmazonProductAdvertisingApi::Base.secret_access_key = "<insert secret access key here>"
 
 # Setup Associates IDs for whichever regions you're selling to
 AmazonProductAdvertisingApi::Base.associate_ids.uk = "<insert UK Associate ID here>"

data/README.rdoc

@@ -77,7 +77,6 @@ intended rules.
 = TODO
 - Implement the rest of the Operations (Cart*, Customer*, Help, List*, Seller*,
   Tag*, Transaction* and Vehicle*).
-- Implement HMAC before the authentication requirement kicks in in August 2009.
 - Implement batch and multiple operation requests, abstracted away from the
   user within the dsl.
 - Some sort of internal caching mechanism.
@@ -88,8 +87,8 @@ intended rules.
 = Obtaining
 The main repository is at github but there is also a rubyforge project.
 
-https://github.com/completelynovel/amazon-product-advertising-api/tree
-http://amazon-pa-api.rubyforge.org/
+- https://github.com/completelynovel/amazon-product-advertising-api/tree
+- http://amazon-pa-api.rubyforge.org/
 
 
 = Credits

data/Rakefile

@@ -14,12 +14,14 @@ end
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "amazon-product-advertising-api"
-    gemspec.summary = "A nice rubyish interface to the Amazon Product Advertising API."
-    gemspec.email = "jon@completelynovel.com"
-    gemspec.homepage = "http://github.com/completelynovel/amazon-product-advertising-api"
+    gemspec.name        = "amazon-product-advertising-api"
+    gemspec.summary     = "A nice rubyish interface to the Amazon Product Advertising API."
+    gemspec.email       = "jon@completelynovel.com"
+    gemspec.homepage    = "http://github.com/completelynovel/amazon-product-advertising-api"
     gemspec.description = "A nice rubyish interface to the Amazon Product Advertising API, formerly known as the Associates Web Service and before that the Amazon E-Commerce Service."
-    gemspec.authors = ["Jon Gilbraith"]
+    gemspec.authors     = ["Jon Gilbraith"]
+    gemspec.add_dependency("hpricot")
+    gemspec.add_dependency("ruby-hmac")
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/amazon-product-advertising-api.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amazon-product-advertising-api}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jon Gilbraith"]
-  s.date = %q{2009-07-06}
+  s.date = %q{2009-07-30}
   s.description = %q{A nice rubyish interface to the Amazon Product Advertising API, formerly known as the Associates Web Service and before that the Amazon E-Commerce Service.}
   s.email = %q{jon@completelynovel.com}
   s.extra_rdoc_files = [
@@ -40,8 +40,14 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
+      s.add_runtime_dependency(%q<ruby-hmac>, [">= 0"])
     else
+      s.add_dependency(%q<hpricot>, [">= 0"])
+      s.add_dependency(%q<ruby-hmac>, [">= 0"])
     end
   else
+    s.add_dependency(%q<hpricot>, [">= 0"])
+    s.add_dependency(%q<ruby-hmac>, [">= 0"])
   end
 end

data/lib/amazon_product_advertising_api/base.rb

@@ -1,8 +1,8 @@
 module AmazonProductAdvertisingApi #:nodoc:
   
   # This is the main base class where you define your config data. Setup like so:
-  #   AmazonProductAdvertisingApi.base.access_key_id = <your Amazon AccessKeyId>
-  # There is no support for the secret key yet, so it's just your access key for now.
+  #   AmazonProductAdvertisingApi.base.access_key_id     = <your Amazon AccessKeyId>
+  #   AmazonProductAdvertisingApi.base.secret_access_key = <your Amazon SecretAccessKey>
   #
   # You also setup your Associates codes for different regions here (the right one is supplied)
   # based on what region you are requesting for.
@@ -11,6 +11,8 @@ module AmazonProductAdvertisingApi #:nodoc:
   class Base
     
     cattr_accessor :access_key_id
+
+    cattr_accessor :secret_access_key
     
     cattr_accessor :associate_ids
     @@associate_ids = Struct.new(:ca, :de, :fr, :jp, :uk, :us).new

data/lib/amazon_product_advertising_api/operations/base.rb

@@ -41,13 +41,15 @@ module AmazonProductAdvertisingApi #:nodoc:
         attr_accessor :errors
     
         SERVICE_URLS = {
-            :us => 'http://ecs.amazonaws.com/onca/xml?Service=AWSECommerceService',
-            :uk => 'http://ecs.amazonaws.co.uk/onca/xml?Service=AWSECommerceService',
-            :ca => 'http://ecs.amazonaws.ca/onca/xml?Service=AWSECommerceService',
-            :de => 'http://ecs.amazonaws.de/onca/xml?Service=AWSECommerceService',
-            :jp => 'http://ecs.amazonaws.jp/onca/xml?Service=AWSECommerceService',
-            :fr => 'http://ecs.amazonaws.fr/onca/xml?Service=AWSECommerceService'
+            :us => 'http://ecs.amazonaws.com/onca/xml',
+            :uk => 'http://ecs.amazonaws.co.uk/onca/xml',
+            :ca => 'http://ecs.amazonaws.ca/onca/xml',
+            :de => 'http://ecs.amazonaws.de/onca/xml',
+            :jp => 'http://ecs.amazonaws.jp/onca/xml',
+            :fr => 'http://ecs.amazonaws.fr/onca/xml'
         }
+        
+        API_VERSION = "2009-01-06"
     
         def initialize
           self.response = AmazonProductAdvertisingApi::Operations::Base::Element.new
@@ -57,16 +59,31 @@ module AmazonProductAdvertisingApi #:nodoc:
         # This takes care of building request, performing it, storing the results, checking for errors then parsing the data (if the request was valid).
         def query_amazon(params)
           request_params = {}
-          request_params["AWSAccessKeyId"] = AmazonProductAdvertisingApi::Base.access_key_id
-          request_params["Operation"]      = self.operation
-          request_params["AssociateTag"]   = AmazonProductAdvertisingApi::Base.associate_ids.send(self.region) unless AmazonProductAdvertisingApi::Base.associate_ids.send(self.region).nil?
+          request_params["Service"]          = "AWSECommerceService"
+          request_params["SignatureVersion"] = 2
+          request_params["SignatureMethod"]  = "HmacSHA256"
+          request_params["Timestamp"]        = Time.now.gmtime.iso8601
+          request_params["AWSAccessKeyId"]   = AmazonProductAdvertisingApi::Base.access_key_id
+          request_params["Operation"]        = self.operation
+          request_params["AssociateTag"]     = AmazonProductAdvertisingApi::Base.associate_ids.send(self.region) unless AmazonProductAdvertisingApi::Base.associate_ids.send(self.region).nil?
+          request_params["Version"]          = API_VERSION
           request_params.merge!(params)
+
+          # Process all params - make sure they're all strings, camelize and escape (where appropriate)
+          request_params = request_params.collect { |var, val| [var.to_s.camelize, val.to_s] }
+          request_params = request_params.collect { |var, val| [var, CGI::escape(val).gsub('+', '%20')] }
           
-          self.request_uri = "#{SERVICE_URLS[self.region]}&#{request_params.collect { |var, val| var.to_s.camelize + "=" + val.to_s }.join("&")}"
-          self.request_uri = URI.parse(URI.escape(self.request_uri))
-      
+          # Assemble into a full request string
+          unsigned_uri = URI.parse("#{SERVICE_URLS[self.region]}?#{request_params.sort { |a, b| a[0] <=> b[0] }.collect { |var, val| var + "=" + val }.join("&")}")
+
+          # Generate hmac
+          hmac = HMAC::SHA256.new(AmazonProductAdvertisingApi::Base.secret_access_key)
+          hmac.update("GET\n#{unsigned_uri.host}\n#{unsigned_uri.path}\n#{unsigned_uri.query}")
+
+          self.request_uri = URI.parse("#{unsigned_uri}&Signature=#{Base64.encode64(hmac.digest).chomp}")
+
           result = Net::HTTP::get_response(self.request_uri)
-          raise("Error connecting to Amazon") if !result.kind_of?(Net::HTTPSuccess)
+          raise("Error connecting to Amazon - #{result.to_s}") if !result.kind_of?(Net::HTTPSuccess)
       
           # Store away the raw data for debugging or if more direct access is required
           self.raw_data     = result.body

data/lib/amazon_product_advertising_api/support.rb

@@ -1,67 +1,67 @@
 module AmazonProductAdvertisingApi #:nodoc:
-  
-  # Some extensions to the Class class.
-  class Class
+  module CoreExtensions
+    module Class
     
-    # Pleasant syntax for Class attribute readers.
-    def cattr_reader(sym)
-      class_eval(<<-EOS, __FILE__, __LINE__)
-        unless defined? @@#{sym}  # unless defined? @@hair_colors
-          @@#{sym} = nil          #   @@hair_colors = nil
-        end                       # end
-                                  #
-        def self.#{sym}           # def self.hair_colors
-          @@#{sym}                #   @@hair_colors
-        end                       # end
-                                  #
-        def #{sym}                # def hair_colors
-          @@#{sym}                #   @@hair_colors
-        end                       # end
-      EOS
-    end
+      # Pleasant syntax for Class attribute readers.
+      def cattr_reader(sym)
+        class_eval(<<-EOS, __FILE__, __LINE__)
+          unless defined? @@#{sym}  # unless defined? @@hair_colors
+            @@#{sym} = nil          #   @@hair_colors = nil
+          end                       # end
+                                    #
+          def self.#{sym}           # def self.hair_colors
+            @@#{sym}                #   @@hair_colors
+          end                       # end
+                                    #
+          def #{sym}                # def hair_colors
+            @@#{sym}                #   @@hair_colors
+          end                       # end
+        EOS
+      end
 
-    # Pleasant syntax for Class attribute writers.
-    def cattr_writer(sym)
-      class_eval(<<-EOS, __FILE__, __LINE__)
-        unless defined? @@#{sym}                       # unless defined? @@hair_colors
-          @@#{sym} = nil                               #   @@hair_colors = nil
-        end                                            # end
-                                                       #
-        def self.#{sym}=(obj)                          # def self.hair_colors=(obj)
-          @@#{sym} = obj                               #   @@hair_colors = obj
-        end                                            # end
-      EOS
-    end
+      # Pleasant syntax for Class attribute writers.
+      def cattr_writer(sym)
+        class_eval(<<-EOS, __FILE__, __LINE__)
+          unless defined? @@#{sym}                       # unless defined? @@hair_colors
+            @@#{sym} = nil                               #   @@hair_colors = nil
+          end                                            # end
+                                                         #
+          def self.#{sym}=(obj)                          # def self.hair_colors=(obj)
+            @@#{sym} = obj                               #   @@hair_colors = obj
+          end                                            # end
+        EOS
+      end
+
+      # Pleasant syntax for Class attribute accessors.
+      def cattr_accessor(sym)
+        cattr_reader(sym)
+        cattr_writer(sym)
+      end
 
-    # Pleasant syntax for Class attribute accessors.
-    def cattr_accessor(sym)
-      cattr_reader(sym)
-      cattr_writer(sym)
     end
 
-  end
+    # Some extensions to the String class.
+    module String
 
-  # Some extensions to the String class.
-  class String
+      # Converts strings from under_score format to CamelCase
+      def camelize(first_letter_in_uppercase = true)
+        if first_letter_in_uppercase
+          self.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+        else
+          self.first + camelize(self)[1..-1]
+        end
+      end
 
-    # Converts strings from under_score format to CamelCase
-    def camelize(first_letter_in_uppercase = true)
-      if first_letter_in_uppercase
-        self.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
-      else
-        self.first + camelize(self)[1..-1]
+      # Converts strings from CamelCase format to under_score.
+      def underscore
+        self.to_s.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
       end
-    end
 
-    # Converts strings from CamelCase format to under_score.
-    def underscore
-      self.to_s.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
     end
-
-  end
     
+  end
 end

data/lib/amazon_product_advertising_api.rb

@@ -1,7 +1,16 @@
 require 'net/http'
+require 'cgi'
 require 'hpricot'
+require 'time'
+require 'hmac'
+require 'hmac-sha2'
+require 'base64'
 
 require 'amazon_product_advertising_api/support'
+
+Class.send(:include, AmazonProductAdvertisingApi::CoreExtensions::Class)
+String.send(:include, AmazonProductAdvertisingApi::CoreExtensions::String)
+
 require 'amazon_product_advertising_api/base'
 require 'amazon_product_advertising_api/response_elements'
 require 'amazon_product_advertising_api/operations/base'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: completelynovel-amazon-product-advertising-api
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jon Gilbraith
@@ -9,10 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-06 00:00:00 -07:00
+date: 2009-07-30 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    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"
+    version: 
 description: A nice rubyish interface to the Amazon Product Advertising API, formerly known as the Associates Web Service and before that the Amazon E-Commerce Service.
 email: jon@completelynovel.com
 executables: []
@@ -38,6 +57,7 @@ files:
 - lib/amazon_product_advertising_api/support.rb
 has_rdoc: true
 homepage: http://github.com/completelynovel/amazon-product-advertising-api
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -58,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: A nice rubyish interface to the Amazon Product Advertising API.