amazon-associates 0.6.3

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+test/utilities/cache
+.loadpath

data/CHANGELOG

@@ -0,0 +1,29 @@
+0.6.3 2010-08-16
+----------------
+* Update gem dependencies
+
+0.6.0 (?)
+----------------
+* Add signing as per the new amazon security requirements
+
+0.5.3 2007-09-12
+----------------
+* send_request to use default options.
+
+0.5.2 2007-09-08
+----------------
+* Fixed Amazon::Element.get_unescaped error when result returned for given element path is nil
+
+0.5.1 2007-02-08
+----------------
+* Fixed Amazon Japan and France URL error
+* Removed opts.delete(:search_index) from item_lookup, SearchIndex param is allowed 
+  when looking for a book with IdType other than the ASIN.
+* Check for defined? RAILS_DEFAULT_LOGGER to avoid exception for non-rails ruby app
+* Added check for LOGGER constant if RAILS_DEFAULT_LOGGER is not defined
+* Added Ecs.configure(&proc) method for easier configuration of default options
+* Added Element#search_and_convert method
+
+0.5.0 2006-09-12
+----------------
+Initial Release

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Dan Pickett, Enlight Solutions; Herryanto Siatono,
+Pluit Solutions; and Ben Woosley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,84 @@
+== amazon-associates
+
+Generic Amazon E-commerce REST API using Hpricot with configurable 
+default options and method call options. Uses Response wrapper classes
+for easy access to REST XML output. It supports ECS 4.0.
+
+== INSTALLATION
+
+  $ gem install amazon-associates
+
+== EXAMPLE
+
+    require 'amazon-associates'
+	
+    # set the default options; options will be camelized and converted to REST request parameters.
+    Amazon::Ecs.options = {:aws_access_key_id => [your developer token]}
+
+    # options provided on method call will merge with the default options
+    res = Amazon::Ecs.item_search('ruby', {:response_group => 'Medium', :sort => 'salesrank'})
+
+    # some common response object methods
+    res.request.valid?        # return true if request is valid
+    res.has_error?            # return true if there is an error
+    res.error                 # return error message if there is any
+    res.total_pages           # return total pages
+    res.total_results         # return total results
+    res.item_page             # return current page no if :item_page option is provided
+
+    # traverse through each item (Amazon::Element)
+    res.items.each do |item|
+      # retrieve string value using XML path
+      item.asin
+      item.attributes['Title']
+
+      # or return Amazon::Element instance
+      atts = item.attributes
+      atts['Title']
+  
+      # return first author or a string array of authors
+      atts.get('author')          # 'Author 1'
+      atts.get_array('author')    # ['Author 1', 'Author 2', ...]
+  
+      # return an hash of children text values with the element names as the keys
+      item.get_hash('smallimage') # {:url => ..., :width => ..., :height => ...}
+  
+      # note that '/' returns Hpricot::Elements array object, nil if not found
+      reviews = item/'editorialreview'
+  
+      # traverse through Hpricot elements
+      reviews.each do |review|
+        # Getting hash value out of Hpricot element
+        Amazon::Element.get_hash(review) # [:source => ..., :content ==> ...]
+    
+        # Or to get unescaped HTML values
+        Amazon::Element.get_unescaped(review, 'source')
+        Amazon::Element.get_unescaped(review, 'content')
+        
+        # Or this way
+        el = Amazon::Element.new(review)
+        el.get_unescaped('source')
+        el.get_unescaped('content')
+      end
+      
+      # returns Amazon::Element instead of string
+      item.search_and_convert('itemattributes').
+    end
+
+Refer to Amazon ECS documentation for more information on Amazon REST request parameters and XML output:
+http://docs.amazonwebservices.com/AWSEcommerceService/2006-09-13/
+
+To get a sample of Amazon REST response XML output, use AWSZone.com scratch pad:
+http://www.awszone.com/scratchpads/aws/ecs.us/index.aws
+
+== LINKS
+
+* http://amazon-ecs.rubyforge.org
+* http://www.pluitsolutions.com/amazon-ecs
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2008 Dan Pickett, Enlight Solutions; Herryanto Siatono,
+Pluit Solutions; and Ben Woosley

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |s|
+  s.name = "amazon-associates"
+  s.summary = "Generic Amazon Associates Web Service (Formerly ECS) REST API. Supports ECS 4.0."
+  s.email = "ben.woosley@gmail.com"
+  s.homepage = "http://github.com/Empact/amazon-associates"
+  s.description = "amazon-associates offers object-oriented access to the Amazon Associates API, built on ROXML"
+  s.authors = ["Ben Woosley", "Dan Pickett", "Herryanto Siatono"]
+  s.add_runtime_dependency("roxml", ">= 3.1.3")
+  s.add_runtime_dependency("activesupport", ">= 2.3.4")
+  s.add_runtime_dependency("ruby-hmac")
+  s.add_runtime_dependency("will_paginate")
+  s.add_development_dependency("thoughtbot-shoulda")
+  s.add_development_dependency("mocha")
+
+  # s.require_path = "lib"
+  # s.autorequire = "amazon-associates"
+  # s.test_files = FileList["test/**/*test.rb"].to_a
+  # s.files = FileList["lib/**/*"].to_a
+end
+
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'amazon-associates'
+  rdoc.options << '--line-numbers' << '--inline-source' << "--main README.rdoc"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_opts << '--format profile --backtrace'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+end
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:build: 
+:minor: 6
+:patch: 3

data/amazon-associates.gemspec

@@ -0,0 +1,118 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amazon-associates}
+  s.version = "0.6.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Woosley", "Dan Pickett", "Herryanto Siatono"]
+  s.date = %q{2010-08-16}
+  s.description = %q{amazon-associates offers object-oriented access to the Amazon Associates API, built on ROXML}
+  s.email = %q{ben.woosley@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "amazon-associates.gemspec",
+     "lib/amazon-associates.rb",
+     "lib/amazon-associates/caching/filesystem_cache.rb",
+     "lib/amazon-associates/errors.rb",
+     "lib/amazon-associates/extensions/core.rb",
+     "lib/amazon-associates/extensions/hpricot.rb",
+     "lib/amazon-associates/request.rb",
+     "lib/amazon-associates/requests/browse_node.rb",
+     "lib/amazon-associates/requests/cart.rb",
+     "lib/amazon-associates/requests/item.rb",
+     "lib/amazon-associates/responses/browse_node_lookup_response.rb",
+     "lib/amazon-associates/responses/cart_responses.rb",
+     "lib/amazon-associates/responses/item_lookup_response.rb",
+     "lib/amazon-associates/responses/item_search_response.rb",
+     "lib/amazon-associates/responses/response.rb",
+     "lib/amazon-associates/responses/similarity_lookup_response.rb",
+     "lib/amazon-associates/types/api_result.rb",
+     "lib/amazon-associates/types/browse_node.rb",
+     "lib/amazon-associates/types/cart.rb",
+     "lib/amazon-associates/types/customer_review.rb",
+     "lib/amazon-associates/types/editorial_review.rb",
+     "lib/amazon-associates/types/error.rb",
+     "lib/amazon-associates/types/image.rb",
+     "lib/amazon-associates/types/image_set.rb",
+     "lib/amazon-associates/types/item.rb",
+     "lib/amazon-associates/types/listmania_list.rb",
+     "lib/amazon-associates/types/measurement.rb",
+     "lib/amazon-associates/types/offer.rb",
+     "lib/amazon-associates/types/ordinal.rb",
+     "lib/amazon-associates/types/price.rb",
+     "lib/amazon-associates/types/requests.rb",
+     "spec/requests/browse_node_lookup_spec.rb",
+     "spec/requests/item_search_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/types/cart_spec.rb",
+     "spec/types/item_spec.rb",
+     "spec/types/measurement_spec.rb",
+     "test/amazon/browse_node_test.rb",
+     "test/amazon/cache_test.rb",
+     "test/amazon/caching/filesystem_cache_test.rb",
+     "test/amazon/item_test.rb",
+     "test/test_helper.rb",
+     "test/utilities/filesystem_test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/Empact/amazon-associates}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Generic Amazon Associates Web Service (Formerly ECS) REST API. Supports ECS 4.0.}
+  s.test_files = [
+    "spec/requests/browse_node_lookup_spec.rb",
+     "spec/requests/item_search_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/types/cart_spec.rb",
+     "spec/types/item_spec.rb",
+     "spec/types/measurement_spec.rb",
+     "test/amazon/browse_node_test.rb",
+     "test/amazon/cache_test.rb",
+     "test/amazon/caching/filesystem_cache_test.rb",
+     "test/amazon/item_test.rb",
+     "test/test_helper.rb",
+     "test/utilities/filesystem_test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<roxml>, [">= 3.1.3"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_runtime_dependency(%q<ruby-hmac>, [">= 0"])
+      s.add_runtime_dependency(%q<will_paginate>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<roxml>, [">= 3.1.3"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_dependency(%q<ruby-hmac>, [">= 0"])
+      s.add_dependency(%q<will_paginate>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<roxml>, [">= 3.1.3"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+    s.add_dependency(%q<ruby-hmac>, [">= 0"])
+    s.add_dependency(%q<will_paginate>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/lib/amazon-associates.rb

@@ -0,0 +1,90 @@
+require 'rubygems'
+require 'roxml'
+
+%w(caching/filesystem_cache requests/cart requests/browse_node requests/item).each do |file|
+  require File.join(File.dirname(__FILE__), 'amazon-associates', file)
+end
+
+module Amazon
+  module Associates
+    # Only we throw this
+    class ConfigurationError < RuntimeError; end
+
+    # Default search options
+    @options = {}
+
+    SORT_TYPES = {
+      'All' => nil,
+      'Apparel' => %w[relevancerank salesrank pricerank inverseprice -launch-date sale-flag],
+      'Automotive' => %w[salesrank price -price titlerank -titlerank],
+      'Baby' => %w[psrank salesrank price -price titlerank],
+      'Beauty' => %w[pmrank salesrank price -price -launch-date sale-flag],
+      'Books' => %w[relevancerank salesrank reviewrank pricerank inverse-pricerank daterank titlerank -titlerank],
+      'Classical' => %w[psrank salesrank price -price titlerank -titlerank orig-rel-date],
+      'DigitalMusic' => %w[songtitlerank uploaddaterank],
+      'DVD' => %w[relevancerank salesrank price -price titlerank -video-release-date],
+      'Electronics' => %w[pmrank salesrank reviewrank price -price titlerank],
+      'GourmetFood' => %w[relevancerank salesrank pricerank inverseprice launch-date sale-flag],
+      'HealthPersonalCare' => %w[pmrank salesrank pricerank inverseprice launch-date sale-flag],
+      'Jewelry' => %w[pmrank salesrank pricerank inverseprice launch-date],
+      'Kitchen' => %w[pmrank salesrank price -price titlerank -titlerank],
+      'Magazines' => %w[subslot-salesrank reviewrank price -price daterank titlerank -titlerank],
+      'Marketplace' => nil,
+      'Merchants' => %w[relevancerank salesrank pricerank inverseprice launch-date sale-flag],
+      'Miscellaneous' => %w[pmrank salesrank price -price titlerank -titlerank],
+      'Music' => %w[psrank salesrank price -price titlerank -titlerank artistrank orig-rel-date release-date],
+      'MusicalInstruments' => %w[pmrank salesrank price -price -launch-date sale-flag],
+      'MusicTracks' => %w[titlerank -titlerank],
+      'OfficeProducts' => %w[pmrank salesrank reviewrank price -price titlerank],
+      'OutdoorLiving' => %w[psrank salesrank price -price titlerank -titlerank],
+      'PCHardware' => %w[psrank salesrank price -price titlerank],
+      'PetSupplies' => %w[+pmrank salesrank price -price titlerank -titlerank],
+      'Photo' => %w[pmrank salesrank titlerank -titlerank],
+      'Restaurants' => %w[relevancerank titlerank],
+      'Software' => %w[pmrank salesrank titlerank price -price],
+      'SportingGoods' => %w[relevancerank salesrank pricerank inverseprice launch-date sale-flag],
+      'Tools' => %w[pmrank salesrank titlerank -titlerank price -price],
+      'Toys' => %w[pmrank salesrank price -price titlerank -age-min],
+      'VHS' => %w[relevancerank salesrank price -price titlerank -video-release-date],
+      'Video' => %w[relevancerank salesrank price -price titlerank -video-release-date],
+      'VideoGames' => %w[pmrank salesrank price -price titlerank],
+      'Wireless' => %w[daterank pricerank invers-pricerank reviewrank salesrank titlerank -titlerank],
+      'WirelessAccessories' => %w[psrank salesrank titlerank -titlerank]
+    }.freeze
+
+    SEARCH_INDEXES = (SORT_TYPES.keys + %w(Blended)).freeze
+    DEFAULT_SEARCH_INDEX = 'Blended'
+
+    class << self
+      def configure(&proc)
+        raise ArgumentError, "Block is required." unless block_given?
+        yield @options
+        case options[:caching_strategy]
+        when :filesystem
+          FilesystemCache.initialize_options(options)
+        when nil
+          nil
+        else
+          raise ConfigurationError, "Unrecognized caching_strategy"
+        end
+      end
+
+      def options
+        access_key = @options.delete(:aws_access_key_id)
+        @options[:aWS_access_key_id] ||= (ENV['AMAZON_ACCESS_KEY_ID'] || access_key)
+        @options
+      end
+    end
+
+  protected
+    def self.log(s)
+      if defined? RAILS_DEFAULT_LOGGER
+        RAILS_DEFAULT_LOGGER.error(s)
+      elsif defined? LOGGER
+        LOGGER.error(s)
+      else
+        puts s if @debug
+      end
+    end
+  end
+end

data/lib/amazon-associates/caching/filesystem_cache.rb

@@ -0,0 +1,121 @@
+require "fileutils"
+require "find"
+
+begin
+  require 'md5'
+rescue LoadError
+  require 'digest/md5'
+end
+
+module Amazon
+  module Associates
+    module FilesystemCache
+        #disk quota in megabytes
+        DEFAULT_DISK_QUOTA = 200
+
+        #frequency of sweeping in hours
+        DEFAULT_SWEEP_FREQUENCY = 2
+
+        def self.cache(request_url, response)
+          path = self.cache_path
+          cached_filename = Digest::SHA1.hexdigest(request_url)
+          cached_folder = File.join(path, cached_filename[0..2])
+
+          FileUtils.mkdir_p(cached_folder)
+
+          destination = File.join(cached_folder, cached_filename)
+          open(destination, "w") do |cached_file|
+            Marshal.dump(response, cached_file)
+          end
+        end
+
+        def self.get(request)
+          path = self.cache_path
+          cached_filename = Digest::SHA1.hexdigest(request)
+          file_path = File.join(path, cached_filename[0..2], cached_filename)
+          if FileTest.exists?(file_path)
+            open(file_path) {|f| Marshal.load(f) }
+          end
+        end
+
+        def self.initialize_options(options)
+          #check for required options
+          unless cache_options = options[:caching_options]
+            raise ConfigurationError, "You must specify caching options for filesystem caching: :cache_path is required"
+          end
+
+          #default disk quota to 200MB
+          @@disk_quota = cache_options[:disk_quota] || DEFAULT_DISK_QUOTA
+
+          @@sweep_frequency = cache_options[:sweep_frequency] || DEFAULT_SWEEP_FREQUENCY
+
+          @@cache_path = cache_options[:cache_path]
+
+          if @@cache_path.nil?
+            raise ConfigurationError, "You must specify a cache path for filesystem caching"
+          end
+
+          if !File.directory?(@@cache_path)
+            raise ConfigurationError, "You must specify a valid cache path for filesystem caching"
+          end
+        end
+
+        def self.sweep
+          self.perform_sweep if must_sweep?
+        end
+
+        def self.disk_quota
+          @@disk_quota
+        end
+
+        def self.sweep_frequency
+          @@sweep_frequency
+        end
+
+        def self.cache_path
+          @@cache_path
+        end
+
+        private
+        def self.perform_sweep
+          FileUtils.rm_rf(Dir.glob("#{@@cache_path}/*"))
+
+          self.timestamp_sweep_performance
+        end
+
+        def self.timestamp_sweep_performance
+          #remove the timestamp
+          FileUtils.rm_rf(self.timestamp_filename)
+
+          #create a new one its place
+          File.open(self.timestamp_filename, "w") do |timestamp|
+            timestamp.puts(Time.now)
+          end
+        end
+
+        def self.must_sweep?
+          sweep_time_expired? || disk_quota_exceeded?
+        end
+
+        def self.sweep_time_expired?
+          FileTest.exists?(timestamp_filename) && Time.parse(File.read(timestamp_filename).chomp) < Time.now - (sweep_frequency * 3600)
+        end
+
+        def self.disk_quota_exceeded?
+          cache_size > @@disk_quota
+        end
+
+        def self.timestamp_filename
+          File.join(self.cache_path, ".amz_timestamp")
+        end
+
+        def self.cache_size
+          size = 0
+          Find.find(@@cache_path) do|f|
+             size += File.size(f) if File.file?(f)
+          end
+          size / 1000000
+        end
+      end
+    end
+  end