peddler 2.1.0 → 2.4.2

data/lib/mws/shipment_invoicing.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'mws/shipment_invoicing/client'

data/lib/mws/shipment_invoicing/client.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'peddler/client'
+
+module MWS
+  module ShipmentInvoicing
+    # With the Shipment Invoicing API section, you can integrate invoicing into
+    # Amazon's shipping process for a seller's FBA order.
+    #
+    # @note This functionality is available only in the Brazil marketplace.
+    class Client < ::Peddler::Client
+      self.version = '2018-09-01'
+      self.path = "/ShipmentInvoicing/#{version}"
+
+      # Returns the information required to generate an invoice for the shipment
+      # of a Fulfillment by Amazon order
+      #
+      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetFBAOutboundShipmentDetail.html
+      # @param [String] marketplace_id
+      # @param [String] amazon_shipment_id
+      # @return [Peddler::XMLParser]
+      def get_fba_outbound_shipment_detail(marketplace_id, amazon_shipment_id)
+        operation('GetFBAOutboundShipmentDetail')
+          .add('MarketplaceId' => marketplace_id,
+               'AmazonShipmentId' => amazon_shipment_id)
+
+        run
+      end
+
+      # Submits shipment invoice data for a given shipment
+      #
+      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_SubmitFBAOutboundShipmentInvoice.html
+      # @param [String] marketplace_id
+      # @param [String] amazon_shipment_id
+      # @param [String] invoice_content
+      # @return [Peddler::XMLParser]
+      def submit_fba_outbound_shipment_invoice(marketplace_id,
+                                               amazon_shipment_id,
+                                               invoice_content)
+        self.body = invoice_content
+
+        operation('SubmitFBAOutboundShipmentInvoice')
+          .add('MarketplaceId' => marketplace_id,
+               'AmazonShipmentId' => amazon_shipment_id)
+
+        run
+      end
+
+      # Gets the invoice processing status for the shipments that you specify
+      #
+      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetFBAOutboundShipmentInvoiceStatus.html
+      # @param [String] marketplace_id
+      # @param [String] amazon_shipment_id
+      # @return [Peddler::XMLParser]
+      def get_fba_outbound_shipment_invoice_status(marketplace_id,
+                                                   amazon_shipment_id)
+        operation('GetFBAOutboundShipmentInvoiceStatus')
+          .add('MarketplaceId' => marketplace_id,
+               'AmazonShipmentId' => amazon_shipment_id)
+
+        run
+      end
+
+      # Gets the operational status of the API
+      #
+      # @see https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_GetServiceStatus.html
+      # @return [Peddler::XMLParser]
+      def get_service_status
+        operation('GetServiceStatus')
+        run
+      end
+    end
+  end
+end

data/lib/peddler/client.rb

@@ -16,7 +16,7 @@ module Peddler
     include Jeff
 
     class << self
-      # @api private
+      # @!visibility private
       attr_accessor :parser, :path, :version
 
       private
@@ -52,6 +52,7 @@ module Peddler
     attr_accessor :auth_token
 
     # The seller's Merchant ID
+    # @note Amazon also refers to this as Seller ID or Merchant Token
     # @return [String]
     attr_accessor :merchant_id
 
@@ -80,44 +81,44 @@ module Peddler
       str ? add_content(str) : clear_content!
     end
 
-    # @api private
+    # @!visibility private
     attr_writer :path
 
-    # @api private
+    # @!visibility private
     def path
       @path ||= self.class.path
     end
 
-    # @api private
+    # @!visibility private
     def defaults
       @defaults ||= { expects: 200 }
     end
 
-    # @api private
+    # @!visibility private
     def headers
       @headers ||= {}
     end
 
-    # @api private
+    # @!visibility private
     def aws_endpoint
       "https://#{host}#{path}"
     end
 
-    # @api private
+    # @!visibility private
     def operation(action = nil)
       action ? @operation = Operation.new(action) : @operation
     end
 
-    # @api private
-    def run
+    # @!visibility private
+    def run(&block)
       opts = build_options
-      opts.store(:response_block, Proc.new) if block_given?
+      opts.store(:response_block, block) if block_given?
       res = post(opts)
       self.body = nil if res.status == 200
 
       parser.new(res, encoding)
-    rescue ::Excon::Error::HTTPStatus => error
-      handle_http_status_error(error)
+    rescue ::Excon::Error::HTTPStatus => e
+      handle_http_status_error(e)
     end
 
     private
@@ -128,13 +129,15 @@ module Peddler
     end
 
     def add_content(content)
-      if content.start_with?('<?xml')
+      @body = content
+      if content.encoding.names.include?('BINARY')
+        headers['Content-Type'] = 'application/octet-stream'
+      elsif content.start_with?('<?xml')
         headers['Content-Type'] = 'text/xml'
-        @body = content
       else
         headers['Content-Type'] =
           "text/tab-separated-values; charset=#{encoding}"
-        @body = content.encode(encoding)
+        @body = @body.encode(encoding)
       end
     end
 

data/lib/peddler/errors/builder.rb

@@ -7,7 +7,7 @@ require 'peddler/errors/parser'
 
 module Peddler
   module Errors
-    # @api private
+    # @!visibility private
     class Builder
       extend Forwardable
 
@@ -28,6 +28,7 @@ module Peddler
 
       def build
         parse_original_response
+        return if no_error_response?
         return if bad_class_name?
 
         error_class.new(error_message, error)
@@ -36,7 +37,11 @@ module Peddler
       private
 
       def bad_class_name?
-        error_name =~ DIGIT_AS_FIRST_CHAR
+        error_name.match?(DIGIT_AS_FIRST_CHAR)
+      end
+
+      def no_error_response?
+        response.parse.nil?
       end
 
       def error_class

data/lib/peddler/errors/class_generator.rb

@@ -5,7 +5,7 @@ require 'peddler/errors/error'
 
 module Peddler
   module Errors
-    # @api private
+    # @!visibility private
     class ClassGenerator
       include Singleton
 
@@ -19,7 +19,12 @@ module Peddler
 
       def generate(name)
         with_mutex do
-          return Errors.const_get(name) if Errors.const_defined?(name)
+          if Errors.const_defined?(name)
+            error = Errors.const_get(name)
+            return error if error <= Error
+
+            raise TypeError, "#{name} must be a Peddler::Errors::Error"
+          end
 
           Errors.const_set(name, Class.new(Error))
         end

data/lib/peddler/errors/error.rb

@@ -3,11 +3,15 @@
 require 'forwardable'
 
 module Peddler
-  # @api private
+  # @!visibility private
   module Errors
     # These error codes are common to all Amazon MWS API sections.
     #
     # @see https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Errors.html
+    #
+    # There are quite a few other error types they do not explicitly document
+    # above. I decided not to define any for the sake of consistency and future
+    # maintenance.
     CODES = %w[
       AccessDenied
       InputStreamDisconnected
@@ -20,7 +24,7 @@ module Peddler
       SignatureDoesNotMatch
     ].freeze
 
-    # @api private
+    # @!visibility private
     class Error < StandardError
       extend Forwardable
 

data/lib/peddler/errors/parser.rb

@@ -4,7 +4,7 @@ require 'peddler/xml_parser'
 
 module Peddler
   module Errors
-    # @api private
+    # @!visibility private
     class Parser < XMLParser
       def message
         parse['Message']

data/lib/peddler/flat_file_parser.rb

@@ -6,7 +6,7 @@ require 'digest/md5'
 require 'peddler/headers'
 
 module Peddler
-  # @api private
+  # @!visibility private
   class FlatFileParser < SimpleDelegator
     include Headers
 
@@ -23,7 +23,7 @@ module Peddler
     end
 
     def parse(&blk)
-      CSV.parse(content, OPTIONS, &blk) unless content.empty?
+      CSV.parse(content, **OPTIONS, &blk) unless content.empty?
     end
 
     def records_count
@@ -39,12 +39,14 @@ module Peddler
     def scrub_body!(encoding)
       return if body.encoding == Encoding::UTF_8
 
-      self.body = body.dup.force_encoding(encoding)
+      self.body = body.dup.force_encoding(content_charset || encoding)
     end
 
     def extract_content_and_summary
       @content = body.encode('UTF-8', invalid: :replace, undef: :replace)
-      @summary, @content = @content.split("\n\n", 2) if @content =~ /\t\t.*\n\n/
+      return unless @content.match?(/\t\t.*\n\n/)
+
+      @summary, @content = @content.split("\n\n", 2)
     end
 
     def summarize

data/lib/peddler/headers.rb

@@ -1,8 +1,60 @@
 # frozen_string_literal: true
 
+require 'time'
+
 module Peddler
-  # Parses MWS-specific headers
+  # Parses useful metadata returned in response headers
   module Headers
+    # The size of the response body in bytes
+    # @return [String, nil]
+    def content_length
+      return unless headers['Content-Length']
+
+      headers['Content-Length'].to_i
+    end
+
+    # The MD5 digest of the response body
+    # @return [String, nil]
+    def content_md5
+      headers['Content-MD5']
+    end
+
+    # The MIME type of the response
+    # @return [String, nil]
+    def content_media_type
+      return unless headers['Content-Type']
+
+      headers['Content-Type'].split(';').first
+    end
+
+    # The general category into which the MIME type falls
+    # @return [String, nil]
+    def content_type
+      return unless content_media_type
+
+      content_media_type.split('/').first
+    end
+
+    # The exact kind of data of the specified type the MIME type represents
+    # @return [String, nil]
+    def content_subtype
+      return unless content_media_type
+
+      content_media_type.split('/').last
+    end
+
+    # The character encoding of the response
+    # @return [Encoding, nil]
+    def content_charset
+      match_data = headers['Content-Type']&.match(/charset=(.*);?/)
+      return unless match_data
+
+      string = match_data[1].upcase
+      string = 'UTF-8' if string == 'UTF8'
+
+      Encoding.find(string)
+    end
+
     # The max hourly request quota for the requested operation
     # @return [Integer, nil]
     def mws_quota_max

data/lib/peddler/marketplace.rb

@@ -1,29 +1,24 @@
 # frozen_string_literal: true
 
 module Peddler
-  # @api private
+  # @!visibility private
   # @see https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Endpoints.html
-  Marketplace = Struct.new(:id, :country_code, :host) do
+  class Marketplace
     class << self
       attr_reader :all
 
       def find(key)
-        marketplace = if key.nil?
-                        missing_key!
-                      elsif key.size == 2
-                        find_by_country_code(key)
-                      else
-                        find_by_id(key)
-                      end
+        missing_key! unless key
+        marketplace = key.size == 2 ? find_by_country(key) : find_by_id(key)
 
         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 }
+      def find_by_country(code)
+        code = 'GB' if code == 'UK'
+        all.find { |marketplace| marketplace.country_code == code }
       end
 
       def find_by_id(id)
@@ -39,35 +34,42 @@ module Peddler
       end
     end
 
-    # Caveat: We use supersets Windows-31J and CP1252 in place of Shift_JIS and
-    # ISO 8859-1 respectively to handle some edge cases. These should be safe to
-    # drop in as replacements.
+    attr_reader :id, :country_code, :host
+
+    def initialize(id, country_code, host)
+      @id = id
+      @country_code = country_code
+      @host = host
+    end
+
     def encoding
       case country_code
       when 'JP'
         'Windows-31J'
-      when 'CN'
-        'UTF-16'
       else
         'CP1252'
       end
     end
 
     @all = [
+      ['A2Q3Y263D00KWC', 'BR', 'mws.amazonservices.com'],
       ['A2EUQ1WTGCTBG2', 'CA', 'mws.amazonservices.com'],
       ['A1AM78C64UM0Y8', 'MX', 'mws.amazonservices.com'],
       ['ATVPDKIKX0DER', 'US', 'mws.amazonservices.com'],
-      ['A2Q3Y263D00KWC', 'BR', 'mws.amazonservices.com'],
+      ['A2VIGQ35RCS4UG', 'AE', 'mws.amazonservices.ae'],
       ['A1PA6795UKMFR9', 'DE', 'mws-eu.amazonservices.com'],
+      ['ARBP9OOSHTCHU', 'EG', 'mws-eu.amazonservices.com'],
       ['A1RKKUPIHCS9HS', 'ES', 'mws-eu.amazonservices.com'],
       ['A13V1IB3VIYZZH', 'FR', 'mws-eu.amazonservices.com'],
-      ['APJ6JRA9NG5V4', 'IT', 'mws-eu.amazonservices.com'],
       ['A1F83G8C2ARO7P', 'GB', 'mws-eu.amazonservices.com'],
-      ['A33AVAJ2PDY3EV', 'TR', 'mws-eu.amazonservices.com'],
       ['A21TJRUUN4KGV', 'IN', 'mws.amazonservices.in'],
+      ['APJ6JRA9NG5V4', 'IT', 'mws-eu.amazonservices.com'],
+      ['A1805IZSGTT6HS', 'NL', 'mws-eu.amazonservices.com'],
+      ['A17E79C6D8DWNP', 'SA', 'mws-eu.amazonservices.com'],
+      ['A33AVAJ2PDY3EV', 'TR', 'mws-eu.amazonservices.com'],
+      ['A19VAU5U5O7RUS', 'SG', 'mws-fe.amazonservices.com'],
       ['A39IBJ37TRP1C6', 'AU', 'mws.amazonservices.com.au'],
-      ['A1VC38T7YXB528', 'JP', 'mws.amazonservices.jp'],
-      ['AAHKV2X7AFYLW', 'CN', 'mws.amazonservices.com.cn']
+      ['A1VC38T7YXB528', 'JP', 'mws.amazonservices.jp']
     ].map do |values|
       new(*values)
     end

data/lib/peddler/operation.rb

@@ -5,7 +5,7 @@ require 'time'
 require 'peddler/structured_list'
 
 module Peddler
-  # @api private
+  # @!visibility private
   class Operation < SimpleDelegator
     CAPITAL_LETTERS = /[A-Z]/.freeze
     ALL_CAPS = %w[sku cod].freeze
@@ -28,15 +28,12 @@ module Peddler
       self
     end
 
-    def store(key, val, parent: '')
-      key = camelize(key) if key.is_a?(Symbol)
-      key = "#{parent}.#{key}" unless parent.empty?
-
-      val = val.iso8601 if val.respond_to?(:iso8601)
-      val = val.to_h if val.is_a?(Struct)
+    def store(key, val, parent = nil)
+      key = [parent, camelize(key)].compact.join('.')
+      val = format_known_types(val)
 
       if val.is_a?(Hash)
-        val.each { |keyval| store(*keyval, parent: key) }
+        val.each { |keyval| store(*keyval, key) }
       else
         __getobj__.store(key, val)
       end
@@ -51,10 +48,11 @@ module Peddler
 
     private
 
-    def camelize(sym)
-      return sym.to_s if sym =~ CAPITAL_LETTERS
+    def camelize(key)
+      return key unless key.is_a?(Symbol)
+      return key.to_s if key.match?(CAPITAL_LETTERS)
 
-      sym
+      key
         .to_s
         .split('_')
         .map { |token| capitalize(token) }
@@ -68,5 +66,13 @@ module Peddler
         word.capitalize
       end
     end
+
+    def format_known_types(val)
+      val = val.utc.iso8601(2) if val.is_a?(Time)
+      val = val.iso8601 if val.is_a?(Date)
+      val = val.to_h if val.is_a?(Struct)
+
+      val
+    end
   end
 end