peddler 1.6.7 → 2.0.0

data/lib/peddler/errors/builder.rb

@@ -1,33 +1,59 @@
 # frozen_string_literal: true
 
-require 'singleton'
-require 'peddler/errors/error'
+require 'excon'
+require 'forwardable'
+require 'peddler/errors/class_generator'
+require 'peddler/errors/parser'
 
 module Peddler
   module Errors
     # @api private
     class Builder
-      include Singleton
+      extend Forwardable
 
-      def self.build(name)
-        instance.build(name)
+      DIGIT_AS_FIRST_CHAR = /^\d/
+      private_constant :DIGIT_AS_FIRST_CHAR
+
+      def_delegator :error, :response
+
+      def self.call(error)
+        new(error).build
       end
 
-      def initialize
-        @mutex = Mutex.new
+      attr_reader :error
+
+      def initialize(error)
+        @error = error
       end
 
-      def build(name)
-        with_mutex do
-          return Errors.const_get(name) if Errors.const_defined?(name)
-          Errors.const_set(name, Class.new(Error))
-        end
+      def build
+        parse_original_response
+        return if bad_class_name?
+        error_class.new(error_message, error)
       end
 
       private
 
-      def with_mutex
-        @mutex.synchronize { yield }
+      def bad_class_name?
+        error_name =~ DIGIT_AS_FIRST_CHAR
+      end
+
+      def error_class
+        Errors.const_get(error_name)
+      rescue NameError
+        ClassGenerator.call(error_name)
+      end
+
+      def error_name
+        response.code
+      end
+
+      def error_message
+        response.message
+      end
+
+      def parse_original_response
+        error.instance_variable_set :@response, Parser.new(error.response)
       end
     end
   end

data/lib/peddler/errors/class_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'peddler/errors/error'
+
+module Peddler
+  module Errors
+    # @api private
+    class ClassGenerator
+      include Singleton
+
+      def self.call(name)
+        instance.generate(name)
+      end
+
+      def initialize
+        @mutex = Mutex.new
+      end
+
+      def generate(name)
+        with_mutex do
+          return Errors.const_get(name) if Errors.const_defined?(name)
+          Errors.const_set(name, Class.new(Error))
+        end
+      end
+
+      private
+
+      def with_mutex
+        @mutex.synchronize { yield }
+      end
+    end
+  end
+end

data/lib/peddler/errors/error.rb

@@ -1,27 +1,37 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+
 module Peddler
   # @api private
   module Errors
-    # Here I curate error classes I see value in creating up front so we can use
-    # them for control flow. All other errors will be created at runtime.
+    # These error codes are common to all Amazon MWS API sections.
+    #
+    # @see https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Errors.html
     CODES = %w[
       AccessDenied
+      InputStreamDisconnected
       InternalError
       InvalidAccessKeyId
-      InvalidMarketplace
+      InvalidAddress
+      InvalidParameterValue
       QuotaExceeded
       RequestThrottled
+      SignatureDoesNotMatch
     ].freeze
 
     # @api private
     class Error < StandardError
+      extend Forwardable
+
       attr_reader :cause
 
       def initialize(msg = nil, cause = nil)
         @cause = cause
         super msg
       end
+
+      def_delegator :cause, :response
     end
 
     CODES.each do |name|

data/lib/peddler/headers.rb

@@ -3,27 +3,43 @@
 module Peddler
   # Parses MWS-specific headers
   module Headers
-    Quota = Struct.new(:max, :remaining, :resets_on)
+    # The max hourly request quota for the requested operation
+    # @return [Integer, nil]
+    def mws_quota_max
+      return unless headers['x-mws-quota-max']
+      headers['x-mws-quota-max'].to_i
+    end
 
-    def quota
-      return if headers.keys.none? { |key| key.include?('quota') }
+    # The remaining hourly request quota for the requested operation
+    # @return [Integer, nil]
+    def mws_quota_remaining
+      return unless headers['x-mws-quota-remaining']
+      headers['x-mws-quota-remaining'].to_i
+    end
 
-      Quota.new(
-        headers['x-mws-quota-max'].to_i,
-        headers['x-mws-quota-remaining'].to_i,
-        Time.parse(headers['x-mws-quota-resetsOn'])
-      )
+    # When the hourly request quota for the requested operation resets
+    # @return [Time, nil]
+    def mws_quota_resets_on
+      return unless headers['x-mws-quota-resetsOn']
+      Time.parse(headers['x-mws-quota-resetsOn'])
     end
 
-    def request_id
+    # The ID of the request
+    # @return [String, nil]
+    def mws_request_id
       headers['x-mws-request-id']
     end
 
-    def timestamp
+    # The timestamp of the request
+    # @return [Time, nil]
+    def mws_timestamp
+      return unless headers['x-mws-timestamp']
       Time.parse(headers['x-mws-timestamp'])
     end
 
-    def response_context
+    # The context of the response
+    # @return [String, nil]
+    def mws_response_context
       headers['x-mws-response-context']
     end
   end

data/lib/peddler/marketplace.rb

@@ -7,16 +7,35 @@ module Peddler
     class << self
       attr_reader :all
 
-      def find(id)
-        all.find { |marketplace| marketplace.id == id } || begin
-          message = if id
-                      %("#{id}" is not a valid MarketplaceId)
-                    else
-                      'missing MarketplaceId'
-                    end
-
-          raise ArgumentError, message
-        end
+      def find(key)
+        marketplace = if key.nil?
+                        missing_key!
+                      elsif key.size == 2
+                        find_by_country_code(key)
+                      else
+                        find_by_id(key)
+                      end
+
+        marketplace || not_found!(key)
+      end
+
+      private
+
+      def find_by_country_code(country_code)
+        country_code = 'GB' if country_code == 'UK'
+        all.find { |marketplace| marketplace.country_code == country_code }
+      end
+
+      def find_by_id(id)
+        all.find { |marketplace| marketplace.id == id }
+      end
+
+      def missing_key!
+        raise ArgumentError, 'missing marketplace'
+      end
+
+      def not_found!(country_code)
+        raise ArgumentError, %("#{country_code}" is not a valid marketplace)
       end
     end
 
@@ -44,7 +63,7 @@ module Peddler
       ['A1RKKUPIHCS9HS', 'ES', 'mws-eu.amazonservices.com'],
       ['A13V1IB3VIYZZH', 'FR', 'mws-eu.amazonservices.com'],
       ['APJ6JRA9NG5V4', 'IT', 'mws-eu.amazonservices.com'],
-      ['A1F83G8C2ARO7P', 'UK', 'mws-eu.amazonservices.com'],
+      ['A1F83G8C2ARO7P', 'GB', 'mws-eu.amazonservices.com'],
       ['A21TJRUUN4KGV', 'IN', 'mws.amazonservices.in'],
       ['A39IBJ37TRP1C6', 'AU', 'mws.amazonservices.com.au'],
       ['A1VC38T7YXB528', 'JP', 'mws.amazonservices.jp'],

data/lib/peddler/vcr_matcher.rb

@@ -2,36 +2,46 @@
 
 module Peddler
   # A custom matcher that can be used to record MWS interactions when
-  # integration-testing
+  # writing integration tests
   class VCRMatcher
+    # @api private
     TRANSIENT_PARAMS = %w[
       Signature Timestamp StartDate CreatedAfter QueryStartDateTime
     ].freeze
 
+    # @api private
     SELLER_PARAMS = %w[
       AWSAccessKeyId SellerId
     ].freeze
 
     class << self
+      # @api private
       def call(*requests)
         new(*requests).compare
       end
 
+      # @api private
       def ignored_params
         @ignored_params ||= TRANSIENT_PARAMS.dup
       end
 
+      # Ignore seller specific attributes when recording
+      # @return [void]
       def ignore_seller!
         ignored_params.concat(SELLER_PARAMS)
+        ignored_params.uniq!
       end
     end
 
+    # @api private
     attr_reader :requests
 
+    # @api private
     def initialize(*requests)
       @requests = requests
     end
 
+    # @api private
     def compare
       compare_uris && compare_bodies
     end

data/lib/peddler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Peddler
-  VERSION = '1.6.7'
+  VERSION = '2.0.0'
 end

data/lib/peddler/xml_parser.rb

@@ -11,12 +11,14 @@ module Peddler
     extend Forwardable
     include Headers
 
-    def_delegator :parse, :dig if Hash.method_defined?(:dig)
+    def_delegator :parse, :dig
 
-    def parse
+    def data
       @data ||= find_data
     end
 
+    alias parse data
+
     def xml
       MultiXml.parse(body)
     end

data/lib/peddler/xml_response_parser.rb

@@ -18,7 +18,7 @@ module Peddler
       payload = xml.values.first
       found = payload.find { |k, _| k.match(MATCHER) }
 
-      found.last if found
+      found&.last
     end
   end
 end

data/test/helper.rb

@@ -6,7 +6,6 @@ SimpleCov.start do
   add_filter '/test/'
 end
 
-require 'backports/2.3.0/hash/dig'
 require 'minitest/autorun'
 require 'minitest/focus'
 begin

data/test/integration/test_errors.rb

@@ -2,25 +2,13 @@
 
 require 'integration_helper'
 require 'mws/orders'
-require 'peddler/errors/handler'
 
 class TestErrors < IntegrationTest
   use 'Orders'
 
-  def setup
-    @previous_error_handler = MWS::Orders::Client.error_handler
-    MWS::Orders::Client.error_handler = Peddler::Errors::Handler
-    super
-  end
-
-  def teardown
-    MWS::Orders::Client.error_handler = @previous_error_handler
-    super
-  end
-
   def test_invalid_key
     clients.each do |client|
-      assert_raises(Peddler::Errors::InvalidAccessKeyId) do
+      assert_raises Peddler::Errors::InvalidAccessKeyId do
         client.aws_access_key_id = 'foo'
         client.get_order('bar')
       end
@@ -29,7 +17,7 @@ class TestErrors < IntegrationTest
 
   def test_request_throttled
     clients.each do |client|
-      assert_raises(Peddler::Errors::RequestThrottled) do
+      assert_raises Peddler::Errors::RequestThrottled do
         client.get_order('foo')
       end
     end

data/test/integration/test_feeds.rb

@@ -27,9 +27,6 @@ class TestFeeds < IntegrationTest
       feed_submission_id = res.dig('FeedSubmissionInfo', 'FeedSubmissionId')
       assert feed_submission_id
 
-      res = client.get_feed_submission_result(feed_submission_id)
-      assert res.records_count
-
       # Clean up
       client.cancel_feed_submissions(
         feed_submission_id: feed_submission_id,

data/test/integration/test_multibyte_queries.rb

@@ -8,7 +8,7 @@ class TestMultibyteQueries < IntegrationTest
 
   def test_posts_multibyte_queries_properly
     ret = clients.map do |client|
-      res = client.list_matching_products('félix guattari machinic eros')
+      res = client.list_matching_products(client.marketplace.id, 'félix guattari machinic eros')
       res.body.force_encoding 'UTF-8' if defined? Ox # Ox workaround
       res.parse
     end

data/test/integration/test_mws_headers.rb

@@ -8,8 +8,9 @@ class TestMWSHeaders < IntegrationTest
 
   def test_parses_headers
     clients.each do |client|
-      res = client.get_lowest_priced_offers_for_asin('1780935374', 'New')
-      refute_nil res.quota
+      res = client.get_lowest_priced_offers_for_asin(client.marketplace.id,
+                                                     '1780935374', 'New')
+      refute_nil res.mws_quota_max
     end
   end
 end

data/test/integration/test_orders.rb

@@ -6,7 +6,8 @@ require 'mws/orders'
 class TestOrders < IntegrationTest
   def test_gets_orders
     clients.each do |client|
-      order_ids = client.list_orders(created_after: Date.new(2015),
+      order_ids = client.list_orders(client.marketplace.id,
+                                     created_after: Date.new(2015),
                                      max_results_per_page: 5)
                         .dig('Orders', 'Order')
                         .map { |order| order['AmazonOrderId'] }

data/test/integration/test_products.rb

@@ -6,49 +6,49 @@ require 'mws/products'
 class TestProducts < IntegrationTest
   def test_lists_matching_products
     clients.each do |client|
-      res = client.list_matching_products('architecture')
+      res = client.list_matching_products(client.marketplace.id, 'architecture')
       refute_empty res.parse
     end
   end
 
   def test_gets_matching_product
     clients.each do |client|
-      res = client.get_matching_product('1780935374')
+      res = client.get_matching_product(client.marketplace.id, '1780935374')
       refute_empty res.parse
     end
   end
 
   def test_gets_matching_product_for_id
     clients.each do |client|
-      res = client.get_matching_product_for_id('ISBN', '9781780935379')
+      res = client.get_matching_product_for_id(client.marketplace.id, 'ISBN', '9781780935379')
       refute_empty res.parse
     end
   end
 
   def test_gets_competitive_pricing_for_asin
     clients.each do |client|
-      res = client.get_competitive_pricing_for_asin('1780935374')
+      res = client.get_competitive_pricing_for_asin(client.marketplace.id, '1780935374')
       refute_empty res.parse
     end
   end
 
   def test_gets_lowest_offer_listings_for_asin
     clients.each do |client|
-      res = client.get_lowest_offer_listings_for_asin('1780935374')
+      res = client.get_lowest_offer_listings_for_asin(client.marketplace.id, '1780935374')
       refute_empty res.parse
     end
   end
 
   def test_gets_lowest_priced_offers_for_asin
     clients.each do |client|
-      res = client.get_lowest_priced_offers_for_asin('1780935374', 'New')
+      res = client.get_lowest_priced_offers_for_asin(client.marketplace.id, '1780935374', 'New')
       refute_empty res.parse
     end
   end
 
   def test_gets_product_categories_for_asin
     clients.each do |client|
-      res = client.get_product_categories_for_asin('1780935374')
+      res = client.get_product_categories_for_asin(client.marketplace.id, '1780935374')
       refute_empty res.parse
     end
   end
@@ -56,12 +56,12 @@ class TestProducts < IntegrationTest
   def test_gets_my_fees_estimate
     clients.each do |client|
       res = client.get_my_fees_estimate(
-        marketplace_id: client.primary_marketplace_id,
+        marketplace_id: client.marketplace.id,
         id_type: 'ASIN',
         id_value: '1780935374',
         price_to_estimate_fees: {
           listing_price: {
-            currency_code: currency_code_for(client.primary_marketplace_id),
+            currency_code: currency_code_for(client.marketplace.id),
             amount: 100
           }
         },