dpickett-ruby_amazon_associates 0.5.4 → 0.6

data/CHANGELOG

@@ -1,3 +1,11 @@
+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
@@ -9,7 +17,7 @@
 
 0.5.2 2007-09-08
 ----------------
-* Fixed Amazon::Element.get_unescaped error when result returned for given element path is nil
+* Fixed AmazonAssociate::Element.get_unescaped error when result returned for given element path is nil
 
 0.5.1 2007-02-08
 ----------------

data/README

@@ -1,10 +1,10 @@
-== amazon-ecs
+== 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>Amazon::Ecs</tt> to support 
+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.
 
@@ -12,21 +12,24 @@ 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.
 
-Version: 0.5.4
+Version: 0.6.1
 
+== WANTS
+ * instance based refactoring (singletons are not ideal here)
+ 
 == INSTALLATION
 
-  $ gem install amazon-ecs
+  $ gem install dpickett-amazon_associate
 
 == EXAMPLE
 
-    require 'amazon/ecs'
+    require 'amazon_associate'
 	
     # set the default options; options will be camelized and converted to REST request parameters.
-    Amazon::Ecs.options = {:aWS_access_key_id => [your developer token]}
+    AmazonAssociate::Request.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'})
+    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
@@ -36,13 +39,13 @@ Version: 0.5.4
     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)
+    # 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 Amazon::Element instance
+      # or return AmazonAssociate::Element instance
       atts = item.search_and_convert('itemattributes')
       atts.get('title')
   
@@ -59,28 +62,40 @@ Version: 0.5.4
       # traverse through Hpricot elements
       reviews.each do |review|
         # Getting hash value out of Hpricot element
-        Amazon::Element.get_hash(review) # [:source => ..., :content ==> ...]
+        AmazonAssociate::Element.get_hash(review) # [:source => ..., :content ==> ...]
     
         # Or to get unescaped HTML values
-        Amazon::Element.get_unescaped(review, 'source')
-        Amazon::Element.get_unescaped(review, 'content')
+        AmazonAssociate::Element.get_unescaped(review, 'source')
+        AmazonAssociate::Element.get_unescaped(review, 'content')
         
         # Or this way
-        el = Amazon::Element.new(review)
+        el = AmazonAssociate::Element.new(review)
         el.get_unescaped('source')
         el.get_unescaped('content')
       end
       
-      # returns Amazon::Element instead of string
+      # returns AmazonAssociate::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:
+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.options = {:aWS_access_key_id => [your developer token], :caching_strategy => :filesystem, 
+    :caching_options => {:disk_quota => 200, :cache_path => <path where you want to store requests>, :sweep_frequency => 4}
+  }
+  
+  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
@@ -90,4 +105,4 @@ http://www.awszone.com/scratchpads/aws/ecs.us/index.aws
 
 (The MIT License)
 
-Copyright (c) 2006 Herryanto Siatono, Pluit Solutions
+Copyright (c) 2008 Dan Pickett, Enlight Solutions, Inc.

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: dpickett-ruby_amazon_associates
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: "0.6"
 platform: ruby
 authors: 
-- Herryanto Siatono
 - Dan Pickett
-autorequire: name
+- Herryanto Siatono
+autorequire: ruby_amazon_associates
 bindir: bin
 cert_chain: []
 
-date: 2008-10-21 00:00:00 -07:00
+date: 2008-11-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,8 @@ dependencies:
     version: 
 description: 
 email: 
-- herryanto@pluitsolutions.com, dpickett@enlightsolutions.com
+- dpickett@enlightsolutions.com
+- herryanto@pluitsolutions.com
 executables: []
 
 extensions: []
@@ -33,7 +34,21 @@ extra_rdoc_files:
 - README
 - CHANGELOG
 files: 
+- lib/ruby_amazon_associates
+- lib/ruby_amazon_associates/cache_factory.rb
+- lib/ruby_amazon_associates/caching_strategy
+- lib/ruby_amazon_associates/caching_strategy/base.rb
+- lib/ruby_amazon_associates/caching_strategy/filesystem.rb
+- lib/ruby_amazon_associates/caching_strategy.rb
+- lib/ruby_amazon_associates/configuration_error.rb
+- lib/ruby_amazon_associates/ecs.rb
+- lib/ruby_amazon_associates/element.rb
+- lib/ruby_amazon_associates/request_error.rb
+- lib/ruby_amazon_associates/response.rb
+- lib/ruby_amazon_associates.rb
 - test/amazon/browse_node_lookup_test.rb
+- test/amazon/cache_test.rb
+- test/amazon/caching_strategy/filesystem_test.rb
 - test/amazon/cart_test.rb
 - test/amazon/ecs_test.rb
 - README
@@ -45,7 +60,7 @@ rdoc_options:
 - --line-numbers
 - --inline-source
 - --main
-- README.textile
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -69,5 +84,7 @@ specification_version: 2
 summary: Generic Amazon Associates Web Service (Formerly ECS) REST API. Supports ECS 4.0.
 test_files: 
 - test/amazon/browse_node_lookup_test.rb
+- test/amazon/cache_test.rb
+- test/amazon/caching_strategy/filesystem_test.rb
 - test/amazon/cart_test.rb
 - test/amazon/ecs_test.rb

data/test/amazon/browse_node_lookup_test.rb

@@ -1,38 +0,0 @@
-require File.dirname(__FILE__) + "/../test_helper"
-
-class Amazon::BrowseNodeLookupTest < Test::Unit::TestCase
-  
-  ## Test browse_node_lookup
-  def test_browse_node_lookup
-    resp = Amazon::Ecs.browse_node_lookup("5")
-    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 = Amazon::Ecs.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 = Amazon::Ecs.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 = Amazon::Ecs.browse_node_lookup(nil)
-    assert resp.has_error?
-    assert resp.error
-  end
-
-  def test_browse_node_lookup_with_no_result
-    resp = Amazon::Ecs.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/cart_test.rb

@@ -1,58 +0,0 @@
-require File.dirname(__FILE__) + "/../test_helper"
-
-class Amazon::CartTest < Test::Unit::TestCase
-  
-  # create a cart to store cart_id and hmac for add, get, modify, and clear tests
-  def setup
-    @asin = "0672328844"
-    resp = Amazon::Ecs.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 = Amazon::Ecs.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 = Amazon::Ecs.cart_get(@cart_id, @hmac)
-    cart_item_id = resp.doc.get_elements_by_tag_name("cartitemid").inner_text
-    resp = Amazon::Ecs.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 = Amazon::Ecs.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 = Amazon::Ecs.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
-  
-end

data/test/amazon/ecs_test.rb

@@ -1,106 +0,0 @@
-require File.dirname(__FILE__) + "/../test_helper"
-
-class Amazon::EcsTest < Test::Unit::TestCase
-  def setup
-    Amazon::Ecs.configure do |options|
-      options[:response_group] = "Large"
-      
-    end
-  end
-  ## Test item_search
-  def test_item_search
-    resp = Amazon::Ecs.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 = Amazon::Ecs.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 = Amazon::Ecs.item_search(nil)
-    assert !resp.is_valid_request?
-  end
-
-  def test_item_search_with_no_result
-    resp = Amazon::Ecs.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 = Amazon::Ecs.item_search("ruby", :country => :uk)
-    assert resp.is_valid_request?
-  end
-  
-  def test_item_search_by_author
-    resp = Amazon::Ecs.item_search("dave", :type => :author)
-    assert resp.is_valid_request?
-  end
-  
-  def test_item_get
-    resp = Amazon::Ecs.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 Amazon::Element.get_unescaped(review, "source")
-      assert Amazon::Element.get_unescaped(review, "content")
-    end
-  end
-  
-  ## Test item_lookup
-  def test_item_lookup
-    resp = Amazon::Ecs.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 = Amazon::Ecs.item_lookup(nil)
-    assert resp.has_error?
-    assert resp.error
-  end
-
-  def test_item_lookup_with_no_result
-    resp = Amazon::Ecs.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 = Amazon::Ecs.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