dpickett-ruby_amazon_associates 0.5.4

data/CHANGELOG

@@ -0,0 +1,26 @@
+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 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/README

@@ -0,0 +1,93 @@
+== amazon-ecs
+
+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 
+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.
+
+Version: 0.5.4
+
+== INSTALLATION
+
+  $ gem install amazon-ecs
+
+== EXAMPLE
+
+    require 'amazon/ecs'
+	
+    # 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.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 (Amazon::Element)
+    res.items.each do |item|
+      # retrieve string value using XML path
+      item.get('asin')
+      item.get('itemattributes/title')
+
+      # or return Amazon::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
+        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) 2006 Herryanto Siatono, Pluit Solutions

data/test/amazon/browse_node_lookup_test.rb

@@ -0,0 +1,38 @@
+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

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1,106 @@
+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

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: dpickett-ruby_amazon_associates
+version: !ruby/object:Gem::Version 
+  version: 0.5.4
+platform: ruby
+authors: 
+- Herryanto Siatono
+- Dan Pickett
+autorequire: name
+bindir: bin
+cert_chain: []
+
+date: 2008-10-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+description: 
+email: 
+- herryanto@pluitsolutions.com, dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+files: 
+- test/amazon/browse_node_lookup_test.rb
+- test/amazon/cart_test.rb
+- test/amazon/ecs_test.rb
+- README
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/dpickett/ruby_amazon_associates/tree/master
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+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/cart_test.rb
+- test/amazon/ecs_test.rb