amazon_associate 0.7.0

data/.autotest

@@ -0,0 +1,8 @@
+Autotest.add_hook :initialize do |at|
+  at.clear_mappings
+ 
+  at.add_mapping(%r{^test/.*_test\.rb$}) {|f, _| [f] }
+  at.add_mapping(%r{^lib/amazon/(.*)\.rb$}) {|_, m| ["test/#{m[1]}_test.rb"] }
+  at.add_mapping(%r{^test/(test_helper)\.rb$}) { at.files_matching %r{^test/.*_test\.rb$} }
+  at.add_mapping(%r{^lib/.*\.rb$}) { at.files_matching %r{^test/.*_test\.rb$} }
+end

data/.gitignore

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

data/.project

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>amazon-ecs</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.rubypeople.rdt.core.rubybuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>com.ibm.etools.validation.validationbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.radrails.rails.ui.railsnature</nature>
+		<nature>org.rubypeople.rdt.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/CHANGELOG

@@ -0,0 +1,34 @@
+0.6.1 2008-11-10
+* renamed to amazon_associate
+
+0.6 2008-11-09
+* separated the classes in ecs.rb
+* filesystem caching available
+* more test coverage
+
+0.5.4 2008-10-21
+* include Chris Martin's patches
+* rename Gem to match Amazon's new name for ECS - Amazon Associates API
+* update to git gemspec format
+
+0.5.3 2007-09-12
+----------------
+* send_request to use default options.
+
+0.5.2 2007-09-08
+----------------
+* Fixed AmazonAssociate::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/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 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
+"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,120 @@
+== amazon-associate
+
+Generic Amazon E-commerce REST 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.
+
+It is generic, so you can easily extend <tt>AmazonAssociate::Request</tt> to support 
+other not implemented REST operations; and it is also generic because it just wraps around
+Hpricot element object, instead of providing one-to-one object/attributes to XML elements map.
+
+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
+* instance based refactoring (singletons are not ideal here)
+ 
+== INSTALLATION
+
+  $ gem install dpickett-amazon_associate
+
+== EXAMPLE
+
+    require 'amazon_associate'
+	
+    # 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
+    res = AmazonAssociate::Request.item_search('ruby', {:response_group => 'Medium', :sort => 'salesrank'})
+
+    # some common response object methods
+    res.is_valid_request?     # 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 (AmazonAssociate::Element)
+    res.items.each do |item|
+      # retrieve string value using XML path
+      item.get('asin')
+      item.get('itemattributes/title')
+
+      # or return AmazonAssociate::Element instance
+      atts = item.search_and_convert('itemattributes')
+      atts.get('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
+        AmazonAssociate::Element.get_hash(review) # [:source => ..., :content ==> ...]
+    
+        # Or to get unescaped HTML values
+        AmazonAssociate::Element.get_unescaped(review, 'source')
+        AmazonAssociate::Element.get_unescaped(review, 'content')
+        
+        # Or this way
+        el = AmazonAssociate::Element.new(review)
+        el.get_unescaped('source')
+        el.get_unescaped('content')
+      end
+      
+      # returns AmazonAssociate::Element instead of string
+      item.search_and_convert('itemattributes').
+    end
+
+Refer to Amazon Associate's 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
+
+== CACHING
+
+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, 
+      :cache_path      => <path where you want to store requests>, 
+      :sweep_frequency => 4
+    }
+  end
+  
+The above command will cache up to 200MB of requests. It will purge the cache every 4 hours or when the disk quota has been exceeded.
+  
+Every request will be stored in the cache path. On every request, AmazonAssociate::Request will check for the presence of the cached file before querying Amazon directly.
+
+== LINKS
+
+* http://amazon-ecs.rubyforge.org
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2008 Dan Pickett, Enlight Solutions, Inc.

data/Rakefile

@@ -0,0 +1,43 @@
+require "rubygems"
+require "rake"
+require "rake/testtask"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+require "date"
+
+desc "Run unit tests."
+task :default => :test
+
+desc "Test the amazon_associate library."
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*test.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+desc "Generate documentation for the amazon_associate plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "amazon_associate"
+  rdoc.options << "--line-numbers" << "--inline-source" << "--main" << "README.textile"
+  rdoc.rdoc_files.include("README.rdoc", "CHANGELOG")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "amazon_associate"
+    gemspec.summary = "Amazon Associates API Interface using Hpricot"
+    gemspec.email = "dpickett@enlightsolutions.com"
+    gemspec.homepage = "http://github.com/dpickett/amazon_associate"
+    gemspec.description = "interfaces with Amazon Associate's API using Hpricot"
+    gemspec.authors = ["Dan Pickett"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]

data/VERSION.yml

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

data/amazon_associate.gemspec

@@ -0,0 +1,67 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amazon_associate}
+  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-08-01}
+  s.description = %q{interfaces with Amazon Associate's API using Hpricot}
+  s.email = %q{dpickett@enlightsolutions.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+     ".gitignore",
+     ".project",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "amazon_associate.gemspec",
+     "lib/amazon_associate.rb",
+     "lib/amazon_associate/cache_factory.rb",
+     "lib/amazon_associate/caching_strategy.rb",
+     "lib/amazon_associate/caching_strategy/base.rb",
+     "lib/amazon_associate/caching_strategy/filesystem.rb",
+     "lib/amazon_associate/configuration_error.rb",
+     "lib/amazon_associate/element.rb",
+     "lib/amazon_associate/request.rb",
+     "lib/amazon_associate/request_error.rb",
+     "lib/amazon_associate/response.rb",
+     "test/amazon_associate/browse_node_lookup_test.rb",
+     "test/amazon_associate/cache_test.rb",
+     "test/amazon_associate/caching_strategy/filesystem_test.rb",
+     "test/amazon_associate/cart_test.rb",
+     "test/amazon_associate/request_test.rb",
+     "test/test_helper.rb",
+     "test/utilities/filesystem_test_helper.rb"
+  ]
+  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.5}
+  s.summary = %q{Amazon Associates API Interface using Hpricot}
+  s.test_files = [
+    "test/amazon_associate/browse_node_lookup_test.rb",
+     "test/amazon_associate/cache_test.rb",
+     "test/amazon_associate/caching_strategy/filesystem_test.rb",
+     "test/amazon_associate/cart_test.rb",
+     "test/amazon_associate/request_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/amazon_associate.rb

@@ -0,0 +1,14 @@
+$:.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"
+require "amazon_associate/cache_factory"
+require "amazon_associate/caching_strategy"
+require "amazon_associate/configuration_error"
+require "amazon_associate/request_error"

data/lib/amazon_associate/cache_factory.rb

@@ -0,0 +1,31 @@
+module AmazonAssociate
+  class CacheFactory
+    def self.cache(request, response, strategy)
+      strategy_class_hash[strategy].cache(request, response)
+    end
+  
+    def self.initialize_options(options)
+      #check for a valid caching strategy
+      unless self.strategy_class_hash.keys.include?(options[:caching_strategy])
+        raise AmazonAssociate::ConfigurationError, "Invalid caching strategy" 
+      end
+
+      strategy_class_hash[options[:caching_strategy]].initialize_options(options)
+    end
+  
+    def self.get(request, strategy)
+      strategy_class_hash[strategy].get(request)
+    end
+  
+    def self.sweep(strategy)
+      strategy_class_hash[strategy].sweep
+    end
+  
+    private
+    def self.strategy_class_hash
+      {
+        :filesystem => AmazonAssociate::CachingStrategy::Filesystem
+      }
+    end
+  end
+end

data/lib/amazon_associate/caching_strategy.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), "caching_strategy/base")
+require File.join(File.dirname(__FILE__), "caching_strategy/filesystem")

data/lib/amazon_associate/caching_strategy/base.rb

@@ -0,0 +1,22 @@
+#abstract class
+module AmazonAssociate
+  module CachingStrategy
+    class Base
+      def self.cache(request, response)
+        raise "This method must be overwritten by a caching strategy"
+      end
+    
+      def self.initialize_options(options)
+        raise "This method must be overwritten by a caching strategy"
+      end
+    
+      def self.get(request)
+        raise "This method must be overwritten by a caching strategy"
+      end
+    
+      def self.sweep
+        raise "This method must be overwritten by a caching strategy"
+      end
+    end
+  end
+end

data/lib/amazon_associate/caching_strategy/filesystem.rb

@@ -0,0 +1,109 @@
+require "fileutils"
+require "find"
+
+module AmazonAssociate
+  module CachingStrategy
+    class Filesystem < AmazonAssociate::CachingStrategy::Base
+      #disk quota in megabytes
+      DEFAULT_DISK_QUOTA = 200
+    
+      #frequency of sweeping in hours
+      DEFAULT_SWEEP_FREQUENCY = 2
+      
+      class << self
+        attr_accessor :cache_path
+        attr_accessor :disk_quota
+        attr_accessor :sweep_frequency
+
+        def cache(request, response)
+          path = self.cache_path
+          cached_filename = Digest::SHA1.hexdigest(request)
+          cached_folder = cached_filename[0..2]
+        
+          FileUtils.mkdir_p(File.join(path, cached_folder, cached_folder))
+        
+          cached_file = File.open(File.join(path, cached_folder, cached_filename), "w")
+          cached_file.puts response.doc.to_s
+          cached_file.close
+        end
+      
+        def 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)
+            File.read(file_path).chomp
+          else
+            nil
+          end
+        end
+      
+        def initialize_options(options)      
+          #check for required options
+          if options[:caching_options].nil? || options[:caching_options][:cache_path].nil?
+            raise AmazonAssociate::ConfigurationError, "You must specify caching options for filesystem caching: :cache_path is required"
+          end
+
+          #default disk quota to 200MB
+          Filesystem.disk_quota = options[:caching_options][:disk_quota] || DEFAULT_DISK_QUOTA
+        
+          Filesystem.sweep_frequency = options[:caching_options][:sweep_frequency] || DEFAULT_SWEEP_FREQUENCY
+        
+          Filesystem.cache_path = options[:caching_options][:cache_path]
+        
+          if Filesystem.cache_path.nil? || !File.directory?(Filesystem.cache_path)
+            raise AmazonAssociate::ConfigurationError, "You must specify a cache path for filesystem caching"
+          end
+          return options
+        end
+      
+        def sweep
+          perform_sweep if must_sweep?
+        end
+      
+        private
+        def perform_sweep
+          FileUtils.rm_rf(Dir.glob("#{Filesystem.cache_path}/*"))
+        
+          timestamp_sweep_performance
+        end
+      
+        def timestamp_sweep_performance
+          #remove the timestamp
+          FileUtils.rm_rf(timestamp_filename)
+        
+          #create a new one its place
+          timestamp = File.open(timestamp_filename, "w")
+          timestamp.puts(Time.now)
+          timestamp.close
+        end
+      
+        def must_sweep?
+          sweep_time_expired? || disk_quota_exceeded?
+        end
+      
+        def sweep_time_expired?
+          FileTest.exists?(timestamp_filename) && Time.parse(File.read(timestamp_filename).chomp) < Time.now - (sweep_frequency * 3600)
+        end
+      
+        def disk_quota_exceeded?
+          cache_size > Filesystem.disk_quota
+        end
+      
+        def timestamp_filename
+          File.join(Filesystem.cache_path, ".amz_timestamp")
+        end
+      
+        def cache_size
+          size = 0
+          Find.find(Filesystem.cache_path) do|f|
+             size += File.size(f) if File.file?(f)
+          end
+          size / 1000000
+        end
+
+      end
+
+    end
+  end
+end