amazon-ecs 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 90f10db26290415039bd4ab1d9251cebfd3fa27e
-  data.tar.gz: 563deba5317a1bd94dfa641f5ed216cb8463654e
+SHA256:
+  metadata.gz: 293020f2c842d45f159daf0c0479a7acc50c00e513baf60523e1c64ba6f4194a
+  data.tar.gz: 7006f32167b832f9d13ad87825779a0e9b34b5efe17cace5d675addbeeddf169
 SHA512:
-  metadata.gz: 522f2e3a0ff2ea59cd61048e0c7275f5ff89d3daaeed71507570d41a119486ac4f9387dc9188d595fc490ed9f59ad1499e9e9bb8cd4f9adc7b9da7cecc14c495
-  data.tar.gz: f8d41a6bc7e22037647066797ebb2786516ad3a35e05cf27dc3b80b468ed7b87d447315bf70d8860a6ef32b2b4f0cb42cc27cc433701fe4c9c433ae6037fa9bb
+  metadata.gz: e7b7c409eba77b66b8b99bf58dc711a05ea2246564dc17ea82c80875cefd28a3989639b56271a1215aef8aaabf348e77e7acd22737b97830fbb36bd9fa063dbb
+  data.tar.gz: bb6dc4f05976990f9ab19e51817355b55ad0596622fcecacac1129d431b4b069e399ef245359ba4b50307ed9ad065c4857b69cdfbe27e989e98e664db714241c

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+ - 2.1
+ - 2.2
+ - 2.3.3
+ - 2.4.0
+script: rake test

data/CHANGELOG

@@ -1,3 +1,8 @@
+2.6.0 2019-05-20
+----------------
+* Upgrade nokogiri dependency
+* Remove ruby-hmac support
+
 2.5.0 2016-07-09
 ----------------
 * Turn on debug mode with DEBUG_AMAZON_ECS=1

data/README.md

@@ -1,5 +1,7 @@
 # amazon-ecs
 
+[![Travis CI](https://travis-ci.org/jugend/amazon-ecs.svg?branch=master)](https://travis-ci.org/jugend/amazon-ecs)
+
 `amazon-ecs` is a generic Ruby wrapper to access Amazon Product Advertising API.
 
 The library wraps around [Nokogiri](http://www.nokogiri.org/) element object. It provides an easy access to the XML response elements and attributes.
@@ -18,7 +20,7 @@ gem install amazon-ecs
 ```ruby
 require 'amazon/ecs'
 
-# default options:
+# Default options:
 #  options[:version] => "2013-08-01"
 #  options[:service] => "AWSECommerceService"
 Amazon::Ecs.configure do |options|
@@ -27,16 +29,16 @@ Amazon::Ecs.configure do |options|
   options[:associate_tag] = '[your associate tag]'
 end
 
-# to overwrite the whole options
+# To replace default options
 # Amazon::Ecs.options = { ... }
 
-# options will be merged with the default options
+# To override default options
 res = Amazon::Ecs.item_search('ruby', {:response_group => 'Medium', :sort => 'salesrank'})
 
-# search amazon uk
+# Search Amazon UK
 res = Amazon::Ecs.item_search('ruby', :country => 'uk')
 
-# search all items, default search index: Books
+# Search all items, default search index: Books
 res = Amazon::Ecs.item_search('ruby', :search_index => 'All')
 
 res.is_valid_request?
@@ -46,13 +48,13 @@ res.total_pages
 res.total_results
 res.item_page                             # current page no if :item_page option is provided
 
-# find elements matching 'Item' in response object
+# Find elements matching 'Item' in response object
 res.items.each do |item|
-  # retrieve string value using XML path
+  # Retrieve string value using XML path
   item.get('ASIN')
   item.get('ItemAttributes/Title')
 
-  # return Amazon::Element instance
+  # Return Amazon::Element instance
   item_attributes = item.get_element('ItemAttributes')
   item_attributes.get('Title')
 
@@ -60,14 +62,14 @@ res.items.each do |item|
   item_attributes.get_array('Author')    # ['Author 1', 'Author 2', ...]
   item_attributes.get('Author')          # 'Author 1'
 
-  # return a hash object with the element names as the keys
+  # Return a hash object with the element names as the keys
   item.get_hash('SmallImage') # {:url => ..., :width => ..., :height => ...}
 
-  # return the first matching path
+  # Return the first matching path
   item_height = item.get_element('ItemDimensions/Height')
   item_height.attributes['Units']        # 'hundredths-inches'
 
-  # there are two ways to find elements:
+  # There are two ways to find elements:
   # 1) return an array of Amazon::Element
   reviews = item.get_elements('EditorialReview')
   reviews.each do |review|
@@ -88,7 +90,7 @@ end
 ```ruby
 # Item lookup
 res = Amazon::Ecs.item_lookup("0974514055")
-item = resp.get_element("Item")
+item = res.get_element("Item")
 
 # Browse node lookup
 res = Amazon::Ecs.browse_node_lookup("17")

data/amazon-ecs.gemspec

@@ -11,24 +11,9 @@ Gem::Specification.new do |gem|
   gem.homepage = %q{https://github.com/jugend/amazon-ecs}
   gem.summary = %q{Generic Amazon Product Advertising Ruby API.}
   gem.description = %q{Generic Amazon Product Advertising Ruby API.}
-
+  gem.required_ruby_version = '>= 2.3'
   gem.files = `git ls-files`.split("\n")
   gem.test_files = `git ls-files -- test/*`.split("\n")
   gem.require_paths = ["lib"]
- 
-  if gem.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    gem.specification_version = 2
- 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      gem.add_runtime_dependency("nokogiri", "~> 1.4")
-      gem.add_runtime_dependency("ruby-hmac", "~> 0.3")
-    else
-      gem.add_dependency("nokogiri", "~> 1.4")
-      gem.add_dependency("ruby-hmac", "~> 0.3")
-    end
-  else
-    gem.add_dependency("nokogiri", "~> 1.4")
-    gem.add_dependency("ruby-hmac", "~> 0.3")
-  end
-end
+  gem.add_runtime_dependency("nokogiri", "~> 1.10")
+end

data/lib/amazon/ecs.rb

@@ -24,7 +24,6 @@
 require 'net/http'
 require 'nokogiri'
 require 'cgi'
-require 'hmac-sha2'
 require 'base64'
 require 'openssl'
 
@@ -32,7 +31,7 @@ module Amazon
   class RequestError < StandardError; end
 
   class Ecs
-    VERSION = '2.5.0'
+    VERSION = '2.6.0'
 
     SERVICE_URLS = {
         :us => 'http://webservices.amazon.com/onca/xml',
@@ -46,14 +45,10 @@ module Amazon
         :es => 'http://webservices.amazon.es/onca/xml',
         :in => 'http://webservices.amazon.in/onca/xml',
         :br => 'http://webservices.amazon.com.br/onca/xml',
-        :mx => 'http://webservices.amazon.com.mx/onca/xml'
+        :mx => 'http://webservices.amazon.com.mx/onca/xml',
+        :au => 'http://webservices.amazon.com.au/onca/xml'
     }
 
-    OPENSSL_DIGEST_SUPPORT = OpenSSL::Digest.constants.include?( 'SHA256' ) ||
-                             OpenSSL::Digest.constants.include?( :SHA256 )
-
-    OPENSSL_DIGEST = OpenSSL::Digest.new( 'sha256' ) if OPENSSL_DIGEST_SUPPORT
-
     @@options = {
       :version => "2013-08-01",
       :service => "AWSECommerceService"
@@ -61,6 +56,9 @@ module Amazon
 
     @@debug = ENV['DEBUG_AMAZON_ECS'] || false
 
+    # Error response from Amazon API may contain Access key ID
+    @@hideAPIError = ENV['HIDE_AMAZON_ECS_API_ERROR'] || false
+
     # Default search options
     def self.options
       @@options
@@ -142,7 +140,7 @@ module Amazon
       ecs_res = Response.new(res.body)
       unless res.kind_of? Net::HTTPSuccess
         err_msg = "HTTP Response: #{res.code} #{res.message}"
-        err_msg += " - #{ecs_res.error}" if ecs_res.error
+        err_msg += " - #{ecs_res.error}" if ecs_res.error && !@@hideAPIError
         raise Amazon::RequestError, err_msg
       end
       ecs_res
@@ -305,15 +303,7 @@ module Amazon
 
       def self.sign_request(url, key)
         return nil if key.nil?
-
-        if OPENSSL_DIGEST_SUPPORT
-          signature = OpenSSL::HMAC.digest(OPENSSL_DIGEST, key, url)
-          signature = [signature].pack('m').chomp
-        else
-          signature = Base64.encode64(HMAC::SHA256.digest(key, url)).strip
-        end
-        signature = CGI.escape(signature)
-        return signature
+        return CGI.escape(Base64.strict_encode64(OpenSSL::HMAC.digest("SHA256", key, url)))
       end
   end
 

data/test/amazon/ecs_test.rb

@@ -19,52 +19,54 @@ class Amazon::EcsTest < Test::Unit::TestCase
     options[:associate_tag] = 'bookjetty-20'
   end
 
+  # Amazon throwing an error if requests are submitted too quickly
+  AMAZON_ECS_REQUEST_DELAY = ENV['AMAZON_ECS_REQUEST_DELAY'] || 0
+
+  def throttle_request(delay = AMAZON_ECS_REQUEST_DELAY.to_i)
+      sleep(delay) if delay > 0
+  end
+
   # To print debug information
   # Amazon::Ecs.debug = true
 
+  def setup
+    throttle_request
+  end
+
   # Test item_search
   def test_item_search
     resp = Amazon::Ecs.item_search('ruby')
-    assert resp.is_valid_request?,
-      "Not a valid request"
-    assert (resp.total_results >= 3600),
-      "Results returned (#{resp.total_results}) were < 3600"
-    assert (resp.total_pages >= 360),
-      "Pages returned (#{resp.total_pages}) were < 360"
+    assert resp.is_valid_request?, "Not a valid request"
+    assert (resp.total_results >= 3600), "Results returned (#{resp.total_results}) were < 3600"
+    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"
+    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?,
-      "Not a valid request"
-    assert_equal 2, resp.item_page,
-      "Page returned (#{resp.item_page}) different from expected (2)"
+    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?,
-      "Expected invalid request error"
+    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?,
-      "Not a valid request"
+    assert resp.is_valid_request?, "Not a valid request"
     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?,
-      "Not a 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")
@@ -72,8 +74,7 @@ class Amazon::EcsTest < Test::Unit::TestCase
 
   def test_item_search_by_author
     resp = Amazon::Ecs.item_search('dave', :type => :author)
-    assert resp.is_valid_request?,
-      "Not a valid request"
+    assert resp.is_valid_request?, "Not a valid request"
   end
 
   def test_item_get
@@ -82,13 +83,11 @@ class Amazon::EcsTest < Test::Unit::TestCase
 
     # test get
     assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition",
-      item.get("ItemAttributes/Title"),
-      "Title different from expected"
+      item.get("ItemAttributes/Title"), "Title different from expected"
 
     # test get_array
     assert_equal ['Dave Thomas', 'Chad Fowler', 'Andy Hunt'],
-      item.get_array("Author"),
-      "Authors Array different from expected"
+      item.get_array("Author"), "Authors Array different from expected"
 
     # test get_hash
     small_image = item.get_hash("SmallImage")
@@ -117,22 +116,18 @@ class Amazon::EcsTest < Test::Unit::TestCase
   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"),
-      "Title different from expected"
+      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?,
-      "Response should have been invalid"
-    assert resp.error,
-      "Response should have contained an error"
+    assert resp.has_error?, "Response should have been invalid"
+    assert resp.error, "Response should have contained an error"
   end
 
   def test_item_lookup_with_no_result
     resp = Amazon::Ecs.item_lookup('abc')
-    assert resp.is_valid_request?,
-      "Not a valid request"
+    assert resp.is_valid_request?, "Not a valid request"
     assert_match(/ABC is not a valid value for ItemId/, resp.error,
       "Error Message for lookup of ASIN = ABC different from expected")
   end
@@ -142,20 +137,16 @@ class Amazon::EcsTest < Test::Unit::TestCase
     item = resp.first_item
 
     authors = item.get_elements("Author")
-    assert_instance_of Array, authors,
-      "Authors should be an Array"
-    assert_equal 3, authors.size,
-      "Author array size (#{authors.size}) different from expected (3)"
+    assert_instance_of Array, authors, "Authors should be an Array"
+    assert_equal 3, authors.size, "Author array size (#{authors.size}) different from expected (3)"
     assert_instance_of Amazon::Element, authors.first,
       "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)"
+    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
@@ -176,8 +167,7 @@ class Amazon::EcsTest < Test::Unit::TestCase
 
   def test_multibyte_search
     resp = Amazon::Ecs.item_search("パソコン")
-    assert resp.is_valid_request?,
-      "Not a valid request"
+    assert resp.is_valid_request?, "Not a valid request"
   end
 
   def test_marshal_dump_and_load
@@ -192,11 +182,11 @@ class Amazon::EcsTest < Test::Unit::TestCase
   end
 
   def test_browse_node_lookup
-    resp = Amazon::Ecs.browse_node_lookup("17")
+    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
+    assert items.size.between?(15, 25)
   end
 
   def test_similarity_lookup
@@ -204,19 +194,25 @@ class Amazon::EcsTest < Test::Unit::TestCase
     assert resp.is_valid_request?, "Not a valid request"
 
     items = resp.get_elements("Item")
-    assert_equal 10, items.size
+    assert items.size.between?(5, 15)
   end
 
   def test_other_service_urls
+    test_regions = ENV['AWS_REGIONS']&.split&.collect(&:to_sym) || Amazon::Ecs::SERVICE_URLS.keys
+
     Amazon::Ecs::SERVICE_URLS.each do |key, value|
-      next if key == :us
+      next unless test_regions.include?(key)
 
       begin
+        throttle_request
         resp = Amazon::Ecs.item_search('ruby', :country => key)
         assert resp, "#{key} service url (#{value}) is invalid"
       rescue => e
-        assert false, "'#{key}' service url (#{value}) is invalid. Error: #{e}"
-        puts e.backtrace
+        if e.message.match(/503 Service Unavailable/)
+            puts "Unable to test '#{key}' service url (#{value}) is unavailable: #{e}"
+        else
+            assert false, "'#{key}' service url (#{value}) is invalid. Error: #{e}"
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazon-ecs
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Herryanto Siatono
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-09 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: ruby-hmac
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.10'
 description: Generic Amazon Product Advertising Ruby API.
 email: herryanto@gmail.com
 executables: []
@@ -45,6 +31,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - MIT-LICENSE
@@ -65,17 +52,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.1
 signing_key: 
-specification_version: 2
+specification_version: 4
 summary: Generic Amazon Product Advertising Ruby API.
 test_files:
 - test/amazon/ecs_test.rb