dpickett-amazon_associate 0.6.5 → 0.7.0

data/.gitignore

@@ -1 +1,2 @@
 *.swp
+tags

data/README.rdoc

@@ -12,6 +12,9 @@ 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.
 
+NOTE: You must now specify a secret key to support request signing as 
+required by Amazon.
+
 Version: 0.6.1
 
 == WANTS
@@ -28,6 +31,7 @@ Version: 0.6.1
     # set the default options; options will be camelized and converted to REST request parameters.
     AmazonAssociate::Request.configure do |options|
       options[:aWS_access_key_id] = [your developer token]
+      options[:secrety_key] = [your secret key]
     end
 
     # options provided on method call will merge with the default options
@@ -92,6 +96,7 @@ Filesystem caching is now available.
   
   AmazonAssociate::Request.configure do |options| 
     options[:aWS_access_key_id] = [your developer token]
+    options[:scret_key] = [your secret key]
     options[:caching_strategy] = :filesystem
     options[:caching_options] = {
       :disk_quota      => 200, 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 5
+:patch: 0
 :major: 0
-:minor: 6
+:minor: 7

data/amazon_associate.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amazon_associate}
-  s.version = "0.6.5"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Pickett"]
-  s.date = %q{2009-06-30}
+  s.date = %q{2009-08-01}
   s.description = %q{interfaces with Amazon Associate's API using Hpricot}
   s.email = %q{dpickett@enlightsolutions.com}
   s.extra_rdoc_files = [
@@ -40,11 +40,10 @@ Gem::Specification.new do |s|
      "test/test_helper.rb",
      "test/utilities/filesystem_test_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/dpickett/amazon_associate}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.2}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Amazon Associates API Interface using Hpricot}
   s.test_files = [
     "test/amazon_associate/browse_node_lookup_test.rb",

data/lib/amazon_associate.rb

@@ -1,5 +1,10 @@
 $:.unshift(File.dirname(__FILE__))
 
+require "base64"
+require "hmac-sha2"
+require "digest/sha1"
+require "digest/sha2"
+
 require "amazon_associate/request"
 require "amazon_associate/element"
 require "amazon_associate/response"

data/lib/amazon_associate/caching_strategy/filesystem.rb

@@ -17,7 +17,7 @@ module AmazonAssociate
 
         def cache(request, response)
           path = self.cache_path
-          cached_filename = Digest::SHA1.hexdigest(response.request_url)
+          cached_filename = Digest::SHA1.hexdigest(request)
           cached_folder = cached_filename[0..2]
         
           FileUtils.mkdir_p(File.join(path, cached_folder, cached_folder))

data/lib/amazon_associate/request.rb

@@ -9,7 +9,7 @@ rescue LoadError
 end
 
 #--
-# Copyright (c) 2006 Herryanto Siatono, Pluit Solutions
+# Copyright (c) 2009 Dan Pickett, Enlight Solutions
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -33,12 +33,12 @@ end
 module AmazonAssociate
   class Request
     
-    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",
+        :uk => "http://webservices.amazon.co.uk",
+        :ca => "http://webservices.amazon.ca",
+        :de => "http://webservices.amazon.de",
+        :jp => "http://webservices.amazon.co.jp",
+        :fr => "http://webservices.amazon.fr"
     }
   
     # The sort types available to each product search index.
@@ -229,29 +229,38 @@ module AmazonAssociate
     # 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
-      request_url = prepare_url(opts)
+      unsigned_url = prepare_unsigned_url(opts)
       response = nil
 
       if caching_enabled?
         AmazonAssociate::CacheFactory.sweep(self.options[:caching_strategy])
         
-        res = AmazonAssociate::CacheFactory.get(request_url, self.options[:caching_strategy]) 
-        response = Response.new(res, request_url) unless res.nil?
+        res = AmazonAssociate::CacheFactory.get(unsigned_url, self.options[:caching_strategy]) 
+        response = Response.new(res, unsigned_url) unless res.nil?
       end
       
       if !caching_enabled? || response.nil?
+        request_url = prepare_signed_url(opts)
         log "Request URL: #{request_url}"
         res = Net::HTTP.get_response(URI::parse(request_url))
+
         unless res.kind_of? Net::HTTPSuccess
           raise AmazonAssociate::RequestError, "HTTP Response: #{res.code} #{res.message}"
         end
+
         response = Response.new(res.body, request_url)
-        cache_response(request_url, response, self.options[:caching_strategy]) if caching_enabled?
+        response.unsigned_url = unsigned_url
+
+        if caching_enabled?
+          cache_response(unsigned_url, response, self.options[:caching_strategy]) 
+        end
       end
         
       response
     end
   
+    attr_accessor :request_url, :unsigned_url
+
     protected
       def self.log(s)
         return unless self.debug
@@ -264,21 +273,70 @@ module AmazonAssociate
         end
       end
     
-    private 
-      def self.prepare_url(opts)
+    private
+      def self.get_service_url(opts)
         country = opts.delete(:country)
         country = (country.nil?) ? "us" : country
-        request_url = SERVICE_URLS[country.to_sym]
-        raise AmazonAssociate::RequestError, "Invalid country \"#{country}\"" unless request_url
+        url = SERVICE_URLS[country.to_sym]
+
+        raise AmazonAssociate::RequestError, "Invalid country \"#{country}\"" unless url
+        url
+      end 
+
+      def self.prepare_unsigned_url(opts)
+        url = get_service_url(opts) + "/onca/xml"
       
         qs = ""
         opts.each {|k,v|
           next unless v
-          next if [:caching_options, :caching_strategy].include?(k)
+          next if [:caching_options, :caching_strategy, :secret_key].include?(k)
           v = v.join(",") if v.is_a? Array
           qs << "&#{camelize(k.to_s)}=#{URI.encode(v.to_s)}"
         }
-        "#{request_url}#{qs}"
+
+        @unsigned_url = "#{url}#{qs}"
+      end
+
+      def self.prepare_signed_url(opts)
+        url = get_service_url(opts) + "/onca/xml"
+        
+        unencoded_key_value_strings = []
+        encoded_key_value_strings = []
+        opts[:timestamp] = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S") + ".000Z"
+        opts[:service] = "AWSECommerceService"
+        opts[:version] = "2009-01-01"
+        sort_parameters(opts).each do |p|
+          next if p[1].nil?
+          next if [:caching_options, :caching_strategy, :secret_key].include?(p[0])
+
+
+          encoded_value = CGI.escape(p[1].to_s)
+          
+          encoded_key_value_strings << camelize(p[0].to_s ) + "=" + encoded_value
+        end
+
+        string_to_sign = 
+"GET
+#{get_service_url(opts).gsub("http://", "")}
+/onca/xml
+#{encoded_key_value_strings.join("&")}"
+
+        signature = sign_string(string_to_sign)
+        encoded_key_value_strings << "Signature=" + signature
+
+        "#{url}?#{encoded_key_value_strings.join("&")}"
+      end
+
+      def self.sort_parameters(opts)
+        key_value_strings = []
+        opts.sort {|a, b| camelize(a) <=> camelize(b) }
+      end
+
+      def self.sign_string(string_to_sign)
+        sha1 = HMAC::SHA256.digest(self.options[:secret_key], string_to_sign)
+
+        #Base64 encoding adds a linefeed to the end of the string so chop the last character!
+        CGI.escape(Base64.encode64(sha1).chomp)
       end
     
       def self.camelize(s)

data/lib/amazon_associate/response.rb

@@ -2,7 +2,7 @@ module AmazonAssociate
   # Response object returned after a REST call to Amazon service.
   class Response
     
-    attr_accessor :request_url
+    attr_accessor :request_url, :unsigned_url
     # XML input is in string format
     def initialize(xml, request_url)
       @doc = Hpricot(xml)
@@ -71,4 +71,4 @@ module AmazonAssociate
       @total_pages
     end
   end
-end
+end

data/test/amazon_associate/caching_strategy/filesystem_test.rb

@@ -74,7 +74,7 @@ class AmazonAssociate::CachingStrategy::FilesystemTest < Test::Unit::TestCase
       get_cache_directory
       get_valid_caching_options
       @resp = AmazonAssociate::Request.item_lookup("0974514055")
-      @filename = Digest::SHA1.hexdigest(@resp.request_url)
+      @filename = Digest::SHA1.hexdigest(@resp.unsigned_url)
     end
     
     teardown do
@@ -122,11 +122,6 @@ class AmazonAssociate::CachingStrategy::FilesystemTest < Test::Unit::TestCase
       do_request
     end
     
-    should "return the same response as the original request" do
-      original = @resp.doc.to_s
-      do_request
-      assert_equal(original, @resp.doc.to_s)
-    end
   end
   
   context "sweeping cached requests" do

data/test/test_helper.rb

@@ -11,6 +11,7 @@ require 'amazon_associate'
 
 AmazonAssociate::Request.configure do |options|
   options[:aWS_access_key_id] = ENV["AWS_ACCESS_KEY"] || ""
+  options[:secret_key] = ENV["AWS_SECRET_KEY"] || ""
   
   #raise exception if user has not entered their access key
   if options[:aWS_access_key_id] == ""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dpickett-amazon_associate
 version: !ruby/object:Gem::Version 
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors: 
 - Dan Pickett
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-30 00:00:00 -07:00
+date: 2009-08-01 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -48,8 +48,9 @@ files:
 - test/amazon_associate/request_test.rb
 - test/test_helper.rb
 - test/utilities/filesystem_test_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/dpickett/amazon_associate
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -70,7 +71,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: 3
 summary: Amazon Associates API Interface using Hpricot