amazon_associate 0.7.0

data/lib/amazon_associate/request_error.rb

@@ -0,0 +1,4 @@
+module AmazonAssociate
+  class RequestError < RuntimeError
+  end
+end

data/lib/amazon_associate/response.rb

@@ -0,0 +1,74 @@
+module AmazonAssociate
+  # Response object returned after a REST call to Amazon service.
+  class Response
+    
+    attr_accessor :request_url, :unsigned_url
+    # XML input is in string format
+    def initialize(xml, request_url)
+      @doc = Hpricot(xml)
+      @items = nil
+      @item_page = nil
+      @total_results = nil
+      @total_pages = nil
+    
+      self.request_url = request_url
+    end
+
+    # Return Hpricot object.
+    def doc
+      @doc
+    end
+
+    # Return true if request is valid.
+    def is_valid_request?
+      (@doc/"isvalid").inner_html == "True"
+    end
+
+    # Return true if response has an error.
+    def has_error?
+      !(error.nil? || error.empty?)
+    end
+
+    # Return error message.
+    def error
+      Element.get(@doc, "error/message")
+    end
+
+    # Return an array of AmazonAssociate::Element item objects.
+    def items
+      unless @items
+        @items = (@doc/"item").collect {|item| Element.new(item)}
+      end
+      @items
+    end
+
+    # Return the first item (AmazonAssociate::Element)
+    def first_item
+      items.first
+    end
+
+    # Return current page no if :item_page option is when initiating the request.
+    def item_page
+      unless @item_page
+        @item_page = (@doc/"itemsearchrequest/itempage").inner_html.to_i
+      end
+      @item_page
+    end
+
+    # Return total results.
+    def total_results
+      unless @total_results
+        @total_results = (@doc/"totalresults").inner_html.to_i
+      end
+      @total_results
+    end
+
+    # Return total pages.
+    def total_pages
+      unless @total_pages
+        @total_pages = (@doc/"totalpages").inner_html.to_i
+      end
+      @total_pages
+    end
+  end
+end

data/test/amazon_associate/browse_node_lookup_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+class AmazonAssociate::BrowseNodeLookupTest < Test::Unit::TestCase
+  
+  ## Test browse_node_lookup
+  def test_browse_node_lookup
+    resp = AmazonAssociate::Request.browse_node_lookup("5", :response_group => "TopSellers")
+    assert resp.is_valid_request?
+    browse_node_tags = resp.doc.get_elements_by_tag_name("browsenodeid")
+    browse_node_tags.each { |node| assert_equal("5", node.inner_text) }
+    assert_equal "TopSellers", resp.doc.get_elements_by_tag_name("responsegroup").inner_text
+  end
+  
+  def test_browse_node_lookup_with_browse_node_info_response
+    resp = AmazonAssociate::Request.browse_node_lookup("5", :response_group => "BrowseNodeInfo")
+    assert resp.is_valid_request?
+    assert_equal "BrowseNodeInfo", resp.doc.get_elements_by_tag_name("responsegroup").inner_text
+  end
+  
+  def test_browse_node_lookup_with_new_releases_response
+    resp = AmazonAssociate::Request.browse_node_lookup("5", :response_group => "NewReleases")
+    assert resp.is_valid_request?
+    assert_equal "NewReleases", resp.doc.get_elements_by_tag_name("responsegroup").inner_text
+  end
+  
+  def test_browse_node_lookup_with_invalid_request
+    resp = AmazonAssociate::Request.browse_node_lookup(nil)
+    assert resp.has_error?
+    assert resp.error
+  end
+
+  def test_browse_node_lookup_with_no_result
+    resp = AmazonAssociate::Request.browse_node_lookup("abc")
+    
+    assert resp.is_valid_request?
+    assert_match(/abc is not a valid value for BrowseNodeId/, resp.error)
+  end
+end

data/test/amazon_associate/cache_test.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+class AmazonAssociate::CacheTest < Test::Unit::TestCase
+  include FilesystemTestHelper
+  context "caching get" do
+    setup do
+      get_cache_directory
+      get_valid_caching_options
+    end
+    
+    teardown do
+      destroy_cache_directory
+      destroy_caching_options
+    end
+    
+    should "optionally allow for a caching strategy in configuration" do
+      assert_nothing_raised do
+        AmazonAssociate::Request.configure do |options|
+          options[:caching_strategy] = :filesystem
+        end
+      end
+    end
+    
+    should "raise an exception if a caching strategy is specified that is not found" do
+      assert_raises(AmazonAssociate::ConfigurationError) do
+        AmazonAssociate::Request.configure do |options|
+          options[:caching_strategy] = "foo"
+        end
+      end
+    end
+    
+  end
+end

data/test/amazon_associate/caching_strategy/filesystem_test.rb

@@ -0,0 +1,193 @@
+require File.dirname(__FILE__) + "/../../test_helper"
+
+class AmazonAssociate::CachingStrategy::FilesystemTest < Test::Unit::TestCase
+  include FilesystemTestHelper
+  context "setting up filesystem caching" do
+    teardown do
+      AmazonAssociate::Request.configure do |options|
+        options[:caching_strategy] = nil
+        options[:caching_options] = nil
+      end
+    end
+    
+    should "require a caching options hash with a cache_path key" do
+      assert_raises(AmazonAssociate::ConfigurationError) do
+        AmazonAssociate::Request.configure do |options|
+          options[:caching_strategy] = :filesystem
+          options[:caching_options] = nil
+        end
+      end
+    end
+    
+    should "raise an exception when a cache_path is specified that doesn't exist" do
+      assert_raises(AmazonAssociate::ConfigurationError) do
+        AmazonAssociate::Request.configure do |options|
+          options[:caching_strategy] = :filesystem
+          options[:caching_options] = {:cache_path => "foo123"}
+        end
+      end
+    end
+
+    should "raise an exception when a cache_path is nil" do
+      assert_raise(AmazonAssociate::ConfigurationError) do
+        AmazonAssociate::Request.configure do |options|
+          options[:caching_strategy] = :filesystem
+          options[:caching_options] = {}
+        end
+      end
+    end
+    
+    should "set default values for disk_quota and sweep_frequency" do
+      AmazonAssociate::Request.configure do |options|
+        options[:caching_strategy] = :filesystem
+        options[:caching_options] = {:cache_path => "."}
+      end
+      
+      assert_equal AmazonAssociate::CachingStrategy::Filesystem.disk_quota, AmazonAssociate::CachingStrategy::Filesystem.disk_quota
+      assert_equal AmazonAssociate::CachingStrategy::Filesystem.sweep_frequency, AmazonAssociate::CachingStrategy::Filesystem.sweep_frequency
+    end
+    
+    should "override the default value for disk quota if I specify one" do
+      quota = 400
+      AmazonAssociate::Request.configure do |options|
+        options[:caching_strategy] = :filesystem
+        options[:caching_options] = {:cache_path => ".", :disk_quota => quota}
+      end
+      
+      assert_equal quota, AmazonAssociate::CachingStrategy::Filesystem.disk_quota
+    end
+    
+    should "override the default value for cache_frequency if I specify one" do
+      frequency = 4
+      AmazonAssociate::Request.configure do |options|
+        options[:caching_strategy] = :filesystem
+        options[:caching_options] = {:cache_path => ".", :sweep_frequency => frequency}
+      end
+      
+      assert_equal frequency, AmazonAssociate::CachingStrategy::Filesystem.sweep_frequency
+    end
+  end
+  
+  context "caching a request" do
+    
+    setup do
+      get_cache_directory
+      get_valid_caching_options
+      @resp = AmazonAssociate::Request.item_lookup("0974514055")
+      @filename = Digest::SHA1.hexdigest(@resp.unsigned_url)
+    end
+    
+    teardown do
+      destroy_cache_directory
+      destroy_caching_options
+    end
+    
+    should "create a folder in the cache path with the first three letters of the digested filename" do
+      filename = Digest::SHA1.hexdigest(@resp.request_url)
+      FileTest.exists?(File.join(@@cache_path, @filename[0..2]))      
+    end
+    
+    should "create a file in the cache path with a digested version of the url " do
+      
+      filename = Digest::SHA1.hexdigest(@resp.request_url)
+      assert FileTest.exists?(File.join(@@cache_path, @filename[0..2], @filename))
+    end
+    
+    should "create a file in the cache path with the response inside it" do
+      assert FileTest.exists?(File.join(@@cache_path + @filename[0..2], @filename))
+      assert_equal @resp.doc.to_s, File.read(File.join(@@cache_path + @filename[0..2], @filename)).chomp
+    end
+
+    should "not send cache parameters in the request" do
+      [:caching_strategy].each do |param|
+        assert_no_match /#{param.to_s}/, @resp.request_url
+      end
+    end
+  end
+  
+  context "getting a cached request" do
+    setup do
+      get_cache_directory
+      get_valid_caching_options
+      do_request
+    end
+    
+    teardown do
+      destroy_cache_directory
+      destroy_caching_options
+    end
+    
+    should "not do an http request the second time the lookup is performed due a cached copy" do
+      Net::HTTP.expects(:get_response).never
+      do_request
+    end
+    
+  end
+  
+  context "sweeping cached requests" do
+    setup do
+      get_cache_directory
+      get_valid_caching_options
+      do_request
+    end
+    
+    teardown do
+      destroy_cache_directory
+      destroy_caching_options
+    end
+    
+    should "not perform the sweep if the timestamp is within the range of the sweep frequency and quota is not exceeded" do
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:sweep_time_expired?).returns(false)
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:disk_quota_exceeded?).returns(false)
+      
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:perform_sweep).never
+      
+      do_request
+    end
+    
+    should "perform a sweep if the quota is exceeded" do
+      AmazonAssociate::CachingStrategy::Filesystem.stubs(:sweep_time_expired?).returns(false)
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:disk_quota_exceeded?).once.returns(true)
+      
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:perform_sweep).once
+      
+      do_request
+    end
+    
+    should "perform a sweep if the sweep time is expired" do
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:sweep_time_expired?).once.returns(true)
+      AmazonAssociate::CachingStrategy::Filesystem.stubs(:disk_quota_exceeded?).returns(false)
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:perform_sweep).once
+      
+      do_request
+    end
+    
+    should "create a timestamp file after performing a sweep" do
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:sweep_time_expired?).once.returns(true)
+      
+      do_request
+      assert FileTest.exists?(File.join(@@cache_path, ".amz_timestamp"))
+    end
+    
+    should "purge the cache when performing a sweep" do
+      (0..9).each do |n| 
+        test = File.open(File.join(@@cache_path, "test_file_#{n}"), "w")
+        test.puts Time.now
+        test.close
+      end
+      
+      AmazonAssociate::CachingStrategy::Filesystem.expects(:sweep_time_expired?).once.returns(true)
+      do_request
+      
+      (0..9).each do |n|
+        assert !FileTest.exists?(File.join(@@cache_path, "test_file_#{n}"))
+      end
+    end
+    
+  end
+
+  protected
+  def do_request
+    @resp = AmazonAssociate::Request.item_lookup("0974514055")
+  end
+end

data/test/amazon_associate/cart_test.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+class AmazonAssociate::CartTest < Test::Unit::TestCase
+  
+  # create a cart to store cart_id and hmac for add, get, modify, and clear tests
+  def setup
+    sleep(2)
+    @asin = "0672328844"
+    resp = AmazonAssociate::Request.cart_create(@asin)
+    @cart_id = resp.doc.get_elements_by_tag_name("cartid").inner_text
+    @hmac = resp.doc.get_elements_by_tag_name("hmac").inner_text
+    item = resp.first_item
+    # run tests for cart_create with default quantity while we"re at it
+    assert resp.is_valid_request?
+    assert_equal @asin, item.get("asin")
+    assert_equal "1", item.get("quantity")
+    assert_not_nil @cart_id
+    assert_not_nil @hmac
+  end
+  
+  # Test cart_get
+  def test_cart_get
+    resp = AmazonAssociate::Request.cart_get(@cart_id, @hmac)
+    assert resp.is_valid_request?
+    assert_not_nil resp.doc.get_elements_by_tag_name("purchaseurl").inner_text
+  end
+  
+  # Test cart_modify
+  def test_cart_modify
+    resp = AmazonAssociate::Request.cart_get(@cart_id, @hmac)
+    cart_item_id = resp.doc.get_elements_by_tag_name("cartitemid").inner_text
+    resp = AmazonAssociate::Request.cart_modify(cart_item_id, @cart_id, @hmac, 2)
+    item = resp.first_item
+
+    assert resp.is_valid_request?
+    assert_equal "2", item.get("quantity")
+    assert_not_nil resp.doc.get_elements_by_tag_name("purchaseurl").inner_text
+  end
+  
+  # Test cart_clear
+  def test_cart_clear
+    resp = AmazonAssociate::Request.cart_clear(@cart_id, @hmac)
+    assert resp.is_valid_request?
+  end
+  
+  ## Test cart_create with a specified quantity
+  ## note this will create a separate cart
+  def test_cart_create_with_quantity
+    asin = "0672328844"
+    resp = AmazonAssociate::Request.cart_create(asin, :quantity => 2)
+    assert resp.is_valid_request?
+    item = resp.first_item
+    assert_equal asin, item.get("asin")
+    assert_equal "2", item.get("quantity")
+    assert_not_nil resp.doc.get_elements_by_tag_name("cartid").inner_text
+    assert_not_nil resp.doc.get_elements_by_tag_name("hmac").inner_text
+  end
+  
+  # Test cart_create with an array of hashes representing multiple items
+  def test_cart_create_with_multiple_items
+    items = [ { :asin => "0974514055", :quantity => 2 }, { :asin => "0672328844", :quantity => 3 } ]
+    resp = AmazonAssociate::Request.cart_create(items)
+    assert resp.is_valid_request?
+    first_item, second_item = resp.items.reverse[0], resp.items.reverse[1]
+    
+    assert_equal items[0][:asin], first_item.get("asin")
+    assert_equal items[0][:quantity].to_s, first_item.get("quantity")
+    
+    assert_equal items[1][:asin], second_item.get("asin")
+    assert_equal items[1][:quantity].to_s, second_item.get("quantity")
+    
+    assert_not_nil resp.doc.get_elements_by_tag_name("cartid").inner_text
+    assert_not_nil resp.doc.get_elements_by_tag_name("hmac").inner_text
+  end
+  
+  # Test cart_create with offer_listing_id instead of asin
+  def test_cart_create_with_offer_listing_id
+    items = [ { :offer_listing_id => "MCK%2FnCXIges8tpX%2B222nOYEqeZ4AzbrFyiHuP6pFf45N3vZHTm8hFTytRF%2FLRONNkVmt182%2BmeX72n%2BbtUcGEtpLN92Oy9Y7", :quantity => 2 } ]
+    resp = AmazonAssociate::Request.cart_create(items)
+    assert resp.is_valid_request?
+    first_item = resp.items.first
+    
+    assert_equal items[0][:offer_listing_id], first_item.get("offerlistingid")
+    assert_equal items[0][:quantity].to_s, first_item.get("quantity")
+    
+    assert_not_nil resp.doc.get_elements_by_tag_name("cartid").inner_text
+    assert_not_nil resp.doc.get_elements_by_tag_name("hmac").inner_text
+  end
+  
+end

data/test/amazon_associate/request_test.rb

@@ -0,0 +1,108 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+class AmazonAssociate::RequestTest < Test::Unit::TestCase
+  def setup
+    sleep(1)
+    AmazonAssociate::Request.configure do |options|
+      options[:response_group] = "Large"
+    end
+  end
+  
+  ## Test item_search
+  def test_item_search
+    resp = AmazonAssociate::Request.item_search("ruby")
+    assert(resp.is_valid_request?)
+    assert(resp.total_results >= 3600)
+    assert(resp.total_pages >= 360)
+  end
+
+  def test_item_search_with_paging
+    resp = AmazonAssociate::Request.item_search("ruby", :item_page => 2)
+    assert resp.is_valid_request?
+    assert 2, resp.item_page
+  end
+
+  def test_item_search_with_invalid_request
+    resp = AmazonAssociate::Request.item_search(nil)
+    assert !resp.is_valid_request?
+  end
+
+  def test_item_search_with_no_result
+    resp = AmazonAssociate::Request.item_search("afdsafds")
+    
+    assert resp.is_valid_request?
+    assert_equal "We did not find any matches for your request.", 
+      resp.error
+  end
+  
+  def test_item_search_uk
+    resp = AmazonAssociate::Request.item_search("ruby", :country => :uk)
+    assert resp.is_valid_request?
+  end
+  
+  def test_item_search_by_author
+    resp = AmazonAssociate::Request.item_search("dave", :type => :author)
+    assert resp.is_valid_request?
+  end
+  
+  def test_item_get
+    resp = AmazonAssociate::Request.item_search("0974514055")
+    item = resp.first_item
+        
+    # test get
+    assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition", 
+      item.get("itemattributes/title")
+      
+    # test get_array
+    assert_equal ["Dave Thomas", "Chad Fowler", "Andy Hunt"], 
+      item.get_array("author")
+
+    # test get_hash
+    small_image = item.get_hash("smallimage")
+    
+    assert_equal 3, small_image.keys.size
+    assert small_image[:url] != nil
+    assert_equal "75", small_image[:height]
+    assert_equal "59", small_image[:width]
+    
+    # test /
+    reviews = item/"editorialreview"
+    reviews.each do |review|
+      # returns unescaped HTML content, Hpricot escapes all text values
+      assert AmazonAssociate::Element.get_unescaped(review, "source")
+      assert AmazonAssociate::Element.get_unescaped(review, "content")
+    end
+  end
+  
+  ## Test item_lookup
+  def test_item_lookup
+    resp = AmazonAssociate::Request.item_lookup("0974514055")
+    assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition", 
+    resp.first_item.get("itemattributes/title")
+  end
+  
+  def test_item_lookup_with_invalid_request
+    resp = AmazonAssociate::Request.item_lookup(nil)
+    assert resp.has_error?
+    assert resp.error
+  end
+
+  def test_item_lookup_with_no_result
+    resp = AmazonAssociate::Request.item_lookup("abc")
+    
+    assert resp.is_valid_request?
+    assert_match(/ABC is not a valid value for ItemId/, resp.error)
+  end  
+  
+  def test_search_and_convert
+    resp = AmazonAssociate::Request.item_lookup("0974514055")
+    title = resp.first_item.get("itemattributes/title")
+    authors = resp.first_item.search_and_convert("author")
+    
+    assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition", title
+    assert authors.is_a?(Array)
+    assert 3, authors.size
+    assert_equal "Dave Thomas", authors.first.get
+  end
+  
+end