amazon-ecs 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 207bda3e459d08432050f5d72fcefc625a962a03
-  data.tar.gz: 28f7778b0db01f73cdbde8ec9158912a1d9940d4
+  metadata.gz: 8e39d8758a1f2aa22fcfe7f304ea30d1198d020b
+  data.tar.gz: 001438e4be846c70cd283d2f8f8d260eea37bef4
 SHA512:
-  metadata.gz: 98cd2d491d2e17a61fdd6e0a32ebdbbe9dc0a1e6b50512b5ea778f81e81a2efb8a2f7efc4e03bf27079ddd459695e8a81a3d3b6e11da861c71b874fdb2c34d09
-  data.tar.gz: ec62d34b79046694d49e5bccd975dc3d02a8af66dcc56053915e89261fa7195776864a0b22c0e59c7a6952597ee33812d9c86fcf75dc0d192883ae3298cef58b
+  metadata.gz: 736d9a9a30ab25fa2d5dc0201374fd2cc5f34244fb78ad5579745718b7e6f24414cb52c1f17d4a685641d1890e55adace4727d8ce56528794c4a57bf0194838e
+  data.tar.gz: cf3064f04d981f34aa08beffc9bb41a70c562a063424477f88830d5fdbb7aabb2b017a56cd817a563d8564ee81607c399679fc813aae2b8fa9fb136b83bce241

data/CHANGELOG

@@ -1,3 +1,9 @@
+2.4.0 2016-01-05
+----------------
+* Upgrade API version to 2013-08-01
+* Add browse_node_lookup and similarity_lookup methods on Amaon::Ecs
+* Add /, get_elements, and get_element methods on Amazon::Ecs::Response
+
 2.3.2 2015-01-04
 ----------------
 * Add support for Amazon MX

data/README.md

@@ -2,9 +2,9 @@
 
 `amazon-ecs` is a generic Ruby wrapper to access Amazon Product Advertising API.
 
-You can easily extend the library to support any of the operations supported by the API. 
+You can easily extend the library to support any of the operations supported by the API.
 
-The library wraps around Nokogiri element object. It provides an easy access to the XML response 
+The library wraps around Nokogiri element object. It provides an easy access to the XML response
 structure through an XML path instead of an object attribute. The idea is the API evolves,
 there will be changes to the XML schema. With `amazon-ecs`, your code will still work, only
 the XML path needs to be updated.
@@ -21,9 +21,9 @@ gem install amazon-ecs
 require 'amazon/ecs'
 
 # Configure your access key, secret key and other options such as the associate tag.
-# Options set in the configure block will be merged with the pre-configured default 
+# Options set in the configure block will be merged with the pre-configured default
 # options, i.e.
-#  options[:version] => "2011-08-01"
+#  options[:version] => "2013-08-01"
 #  options[:service] => "AWSECommerceService"
 Amazon::Ecs.configure do |options|
   options[:AWS_access_key_id] = '[your access key]'
@@ -76,10 +76,10 @@ res.items.each do |item|
 
   # return the first matching path as Amazon::Element
   item_height = item.get_element('ItemDimensions/Height')
-  
+
   # retrieve attributes from Amazon::Element
   item_height.attributes['Units']   # 'hundredths-inches'
-  
+
   # return an array of Amazon::Element
   authors = item.get_elements('Author')
 
@@ -94,7 +94,7 @@ res.items.each do |item|
     # 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')
@@ -103,26 +103,39 @@ res.items.each do |item|
 end
 ```
 
-For operations other than `item_search` and `item_lookup`, you could use `Amazon::Ecs.send_request`, e.g.
+Other Operations
+
 ```ruby
-Amazon::Ecs.send_request(:operation => 'BrowseNodeLookup', :browse_node_id => 123)
-Amazon::Ecs.send_request(:operation => 'SimilarityLookup',:item_id => 12345678)
+# Browse node lookup
+resp = Amazon::ECS.browse_node_lookup("17")
+
+nodes = resp.get_elements("BrowseNode")
+nodes.each do |node|
+  puts node.get_unescaped('BrowseNodeId')
+  puts node.get_unescaped('Name')
+end
+
+# Similarity lookup
+Amazon::ECS.similarity_lookup("0974514055")
+
+# Other operation
+Amazon::Ecs.send_request(:operation => '[OperationName]', :id => 123)
 ```
 
 Or you could extend `Amazon::Ecs`:
 ```ruby
 module Amazon
   class Ecs
-    def self.similarity_lookup(item_id, opts={})
-      opts[:operation] = 'SimilarityLookup'
-      opts[:item_id] = item_id
-    
+    def self.custom_method(id, opts={})
+      opts[:operation] = '[OperationName]'
+      opts[:id] = id
+
       self.send_request(opts)
     end
   end
 end
 
-Amazon::Ecs.similarity_lookup('[item_id]', :param1 => 'abc', :param2 => 'xyz')
+Amazon::Ecs.custom_method(123, :param1 => 'abc', :param2 => 'xyz')
 ```
 
 Refer to [Amazon Product Advertising API](https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html) documentation for more information on the operations and request parameters supported.

data/lib/amazon/ecs.rb

@@ -32,7 +32,7 @@ module Amazon
   class RequestError < StandardError; end
 
   class Ecs
-    VERSION = '2.3.2'
+    VERSION = '2.4.0'
 
     SERVICE_URLS = {
         :us => 'http://webservices.amazon.com/onca/xml',
@@ -55,7 +55,7 @@ module Amazon
     OPENSSL_DIGEST = OpenSSL::Digest.new( 'sha256' ) if OPENSSL_DIGEST_SUPPORT
 
     @@options = {
-      :version => "2011-08-01",
+      :version => "2013-08-01",
       :service => "AWSECommerceService"
     }
 
@@ -110,7 +110,7 @@ module Amazon
       self.send_request(opts)
     end
 
-    # Search a browse node by BrowseNodeId
+    # Browse node lookup by node ID.
     def self.browse_node_lookup(browse_node_id, opts = {})
       opts[:operation] = 'BrowseNodeLookup'
       opts[:browse_node_id] = browse_node_id
@@ -118,6 +118,14 @@ module Amazon
       self.send_request(opts)
     end
 
+    # Similarity lookup by item ID.
+    def self.similarity_lookup(item_id, opts = {})
+      opts[:operation] = 'SimilarityLookup'
+      opts[:item_id] = item_id
+
+      self.send_request(opts)
+    end
+
     # Generic send request to ECS REST service. You have to specify the :operation parameter.
     def self.send_request(opts)
       opts = self.options.merge(opts) if self.options
@@ -155,6 +163,26 @@ module Amazon
         @doc
       end
 
+      # Return a Nokogiri::XML::NodeSet of elements matching the given path.
+      def /(path)
+        elements = @doc/path
+        return nil if elements.size == 0
+        elements
+      end
+
+      # Return an array of Amazon::Element matching the given path
+      def get_elements(path)
+        elements = self./(path)
+        return unless elements
+        elements = elements.map{|element| Element.new(element)}
+      end
+
+      # Return the first element found
+      def get_element(path)
+        elements = get_elements(path)
+        elements[0] if elements
+      end
+
       # Return true if request is valid.
       def is_valid_request?
         Element.get(@doc, "//IsValid") == "True"
@@ -334,12 +362,12 @@ module Amazon
       @element = element
     end
 
-    # Returns Nokogiri::XML::Element object
+    # Return Nokogiri::XML::Element object
     def elem
       @element
     end
 
-    # Returns a Nokogiri::XML::NodeSet of elements matching the given path. Example: element/"author".
+    # Return a Nokogiri::XML::NodeSet of elements matching the given path. Example: element/"author".
     def /(path)
       elements = @element/path
       return nil if elements.size == 0

data/test/amazon/ecs_test.rb

@@ -9,23 +9,22 @@ class Amazon::EcsTest < Test::Unit::TestCase
 
   AWS_ACCESS_KEY_ID = ENV['AWS_ACCESS_KEY_ID'] || ''
   AWS_SECRET_KEY = ENV['AWS_SECRET_KEY'] || ''
-  
-  raise "Please specify set your AWS_ACCESS_KEY_ID" if AWS_ACCESS_KEY_ID.empty?
-  raise "Please specify set your AWS_SECRET_KEY" if AWS_SECRET_KEY.empty?
-  
+
+  raise "AWS_ACCESS_KEY_ID env variable is not set" if AWS_ACCESS_KEY_ID.empty?
+  raise "AWS_SECRET_KEY env variable is not set" if AWS_SECRET_KEY.empty?
+
   Amazon::Ecs.configure do |options|
-    options[:response_group] = 'Large'
     options[:AWS_access_key_id] = AWS_ACCESS_KEY_ID
     options[:AWS_secret_key] = AWS_SECRET_KEY
     options[:associate_tag] = 'bookjetty-20'
   end
-  
+
   # To print debug information
   # Amazon::Ecs.debug = true
 
   # Test item_search
   def test_item_search
-    resp = Amazon::Ecs.item_search('ruby')    
+    resp = Amazon::Ecs.item_search('ruby')
     assert resp.is_valid_request?,
       "Not a valid request"
     assert (resp.total_results >= 3600),
@@ -33,67 +32,67 @@ class Amazon::EcsTest < Test::Unit::TestCase
     assert (resp.total_pages >= 360),
       "Pages returned (#{resp.total_pages}) were < 360"
   end
-  
+
   def test_item_search_with_special_characters
     resp = Amazon::Ecs.item_search('()*&^%$')
     assert resp.is_valid_request?,
       "Not a valid request"
   end
-  
+
   def test_item_search_with_paging
     resp = Amazon::Ecs.item_search('ruby', :item_page => 2)
-    assert resp.is_valid_request?, 
+    assert resp.is_valid_request?,
       "Not a valid request"
     assert_equal 2, resp.item_page,
       "Page returned (#{resp.item_page}) different from expected (2)"
   end
-  
+
   def test_item_search_with_invalid_request
     resp = Amazon::Ecs.item_search(nil)
-    assert !resp.is_valid_request?, 
+    assert !resp.is_valid_request?,
       "Expected invalid request error"
   end
-  
+
   def test_item_search_with_no_result
-    resp = Amazon::Ecs.item_search('afdsafds')    
-    assert resp.is_valid_request?, 
+    resp = Amazon::Ecs.item_search('afdsafds')
+    assert resp.is_valid_request?,
       "Not a valid request"
-    assert_equal "We did not find any matches for your request.", resp.error, 
+    assert_equal "We did not find any matches for your request.", resp.error,
       "Error string different from expected"
   end
-  
+
   def test_utf8_encoding
     resp = Amazon::Ecs.item_search('ruby', :country => :uk)
-    assert resp.is_valid_request?, 
+    assert resp.is_valid_request?,
       "Not a valid request"
     item = resp.first_item
     assert_no_match /\A&#x.*/, item.get_unescaped("//FormattedPrice"),
       "£ sign converted to ASCII from UTF-8"
   end
-  
+
   def test_item_search_by_author
     resp = Amazon::Ecs.item_search('dave', :type => :author)
-    assert resp.is_valid_request?, 
+    assert resp.is_valid_request?,
       "Not a valid request"
   end
-  
+
   def test_item_get
-    resp = Amazon::Ecs.item_search("0974514055")
+    resp = Amazon::Ecs.item_search("0974514055", :response_group => 'Large')
     item = resp.first_item
-        
+
     # test get
-    assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition", 
-      item.get("ItemAttributes/Title"), 
+    assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition",
+      item.get("ItemAttributes/Title"),
       "Title different from expected"
-      
+
     # test get_array
-    assert_equal ['Dave Thomas', 'Chad Fowler', 'Andy Hunt'], 
-      item.get_array("Author"), 
+    assert_equal ['Dave Thomas', 'Chad Fowler', 'Andy Hunt'],
+      item.get_array("Author"),
       "Authors Array different from expected"
-  
+
     # test get_hash
     small_image = item.get_hash("SmallImage")
-    
+
     assert_equal 3, small_image.keys.size,
       "Image hash key count (#{small_image.keys.size}) different from expected (3)"
     assert_match ".jpg", small_image['URL'],
@@ -102,7 +101,7 @@ class Amazon::EcsTest < Test::Unit::TestCase
       "Image height (#{small_image['Height']}) different from expected (75)"
     assert_equal "59", small_image['Width'],
       "Image width (#{small_image['Width']}) different from expected (59)"
-  
+
     # test /
     reviews = item/"EditorialReview"
     reviews.each do |review|
@@ -113,15 +112,15 @@ class Amazon::EcsTest < Test::Unit::TestCase
         "XPath editorialreview failed to get 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", 
+    assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition",
       resp.first_item.get("ItemAttributes/Title"),
       "Title different from expected"
   end
-  
+
   def test_item_lookup_with_invalid_request
     resp = Amazon::Ecs.item_lookup(nil)
     assert resp.has_error?,
@@ -129,19 +128,19 @@ class Amazon::EcsTest < Test::Unit::TestCase
     assert resp.error,
       "Response should have contained an error"
   end
-  
+
   def test_item_lookup_with_no_result
-    resp = Amazon::Ecs.item_lookup('abc')    
+    resp = Amazon::Ecs.item_lookup('abc')
     assert resp.is_valid_request?,
       "Not a valid request"
-    assert_match /ABC is not a valid value for ItemId/, resp.error, 
+    assert_match /ABC is not a valid value for ItemId/, resp.error,
       "Error Message for lookup of ASIN = ABC different from expected"
   end
-  
+
   def test_get_elements
     resp = Amazon::Ecs.item_lookup('0974514055')
     item = resp.first_item
-  
+
     authors = item.get_elements("Author")
     assert_instance_of Array, authors,
       "Authors should be an Array"
@@ -151,24 +150,24 @@ class Amazon::EcsTest < Test::Unit::TestCase
       "Authors array first element (#{authors.first.class}) should be an Amazon::Element"
     assert_equal "Dave Thomas", authors.first.get,
       "First Author (#{authors.first.get}) different from expected (Dave Thomas)"
-    
+
     asin = item.get_elements("./ASIN")
     assert_instance_of Array, asin,
       "ASIN should be an Array"
     assert_equal 1, asin.size,
       "ASIN array size (#{asin.size}) different from expected (1)"
   end
-  
+
   def test_get_element_and_attributes
-    resp = Amazon::Ecs.item_lookup('0974514055')
+    resp = Amazon::Ecs.item_lookup('0974514055', :response_group => 'Large')
     item = resp.first_item
-  
+
     first_author = item.get_element("Author")
     assert_equal "Dave Thomas", first_author.get,
       "First Author (#{first_author.get}) different from expected (Dave Thomas)"
     assert_nil first_author.attributes['unknown'],
       "First Author 'unknown' attributes should be nil"
-    
+
     item_height = item.get_element("ItemDimensions/Height")
     units = item_height.attributes['Units'].inner_html if item_height
     assert_equal "hundredths-inches", units,
@@ -180,22 +179,38 @@ class Amazon::EcsTest < Test::Unit::TestCase
     assert resp.is_valid_request?,
       "Not a valid request"
   end
-  
+
   def test_marshal_dump_and_load
     resp = Amazon::Ecs::Response.new(File.read(File.expand_path('../../fixtures/item_search.xml', __FILE__)))
     dumped_resp = Marshal.load(Marshal.dump(resp))
-  
+
     assert_equal resp.doc.to_s,       dumped_resp.doc.to_s
     assert_equal resp.items.size,     dumped_resp.items.size
     assert_equal resp.item_page,      dumped_resp.item_page
     assert_equal resp.total_results,  dumped_resp.total_results
     assert_equal resp.total_pages,    dumped_resp.total_pages
   end
-  
+
+  def test_browse_node_lookup
+    resp = Amazon::Ecs.browse_node_lookup("17")
+    assert resp.is_valid_request?, "Not a valid request"
+
+    items = resp.get_elements("BrowseNode")
+    assert_equal 24, items.size
+  end
+
+  def test_similarity_lookup
+    resp = Amazon::Ecs.similarity_lookup("0974514055")
+    assert resp.is_valid_request?, "Not a valid request"
+
+    items = resp.get_elements("Item")
+    assert_equal 10, items.size
+  end
+
   def test_other_service_urls
     Amazon::Ecs::SERVICE_URLS.each do |key, value|
       next if key == :us
-      
+
       begin
         resp = Amazon::Ecs.item_search('ruby', :country => key)
         assert resp, "#{key} service url (#{value}) is invalid"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amazon-ecs
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Herryanto Siatono