peddler 2.3.0 → 2.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15634f7228f32bf92ba757d456f66a8c42e46082c0e516a65cf8e2b5e53c7ef6
-  data.tar.gz: bc20e8700266c6207f738ca7bc6fb2e9927eb07a6a2e1488f3011b062753231b
+  metadata.gz: d6d04cca2ae15bfa1b30a6cc0d12c2635144395a3981ef0f81fbade475433a1e
+  data.tar.gz: 5572b66b7ac592fe3ac9beea26d89068699c33116b91c80e422a5e699638711c
 SHA512:
-  metadata.gz: 307a816a9baaa8d1309f6f941e1a6ffa56010dc94a3efa237c32db8d0c9bd7f30765434ef1206b12048f938e676e1870d7815ccbe54b09383b7ac95979809b33
-  data.tar.gz: 9e2275da4ce370ae82a4d70f2080a676c30dcc7800f9323fdbd924048491ff45bf05ab33ce10dbc1248b8a925710c1b6d287cd12791d478900fca391f0fdbdbe
+  metadata.gz: e0293f38c3193aa0f9a8258c2620cf27f7fbc206a4240ccf4b483e51c312db71bcbc10d42ad829174ab1aa83c8017b3b08bc2c082a669e9040c503bf71747fab
+  data.tar.gz: ec5af682f45f8c6c7fcf2be530549bc0aeff921d7b8ba6a27ba9a977f26a31734fba3055901c3f1269759a92619a55cf0bd02e6f447f6bd9f0b4c386d641d4e2

data/README.md

@@ -4,13 +4,15 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/281e6176048f3c0a1ed3/maintainability)](https://codeclimate.com/github/hakanensari/peddler/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/281e6176048f3c0a1ed3/test_coverage)](https://codeclimate.com/github/hakanensari/peddler/test_coverage)
 
+> :boom: Amazon is migrating to the newly-launched Selling Partner API (SP-API) and is no longer granting new users access to the MWS APIs. I hope to add support in Peddler in due course.
+
 **Peddler** is a Ruby interface to the [Amazon MWS API](https://developer.amazonservices.com/), a collection of web services that help Amazon sellers programmatically exchange data on their listings, orders, payments, reports, and more.
 
 To use Amazon MWS, you must have an eligible seller account and [register as a developer](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Registering.html#DG_Registering__RegisteringAsADeveloper). You can then access your own selling account using its merchant ID—note that Amazon also refers to this as seller ID or merchant token in different places.
 
 Amazon has [multiple regions](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Endpoints.html). Each region requires application developers to register individually. Some MWS API sections may require additional authorisation from Amazon.
 
-![Peddler](http://f.cl.ly/items/1G1N0A0a0v3a3h241c1Q/peddler.jpg)
+![Peddler](https://github.com/hakanensari/peddler/blob/main/images/peddler.jpg?raw=true)
 
 ## Usage
 
@@ -143,14 +145,14 @@ You can access the same attributes on `error.response`. See <a href="#throttling
 With the Easy Ship API, you can build applications that help sellers in India manage and ship their Amazon Easy Ship orders. Your Amazon Easy Ship applications can get available pickup slots; schedule, reschedule, and cancel pickups; and print labels, invoices, and warranties.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/easy_ship/EasyShip_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/EasyShip/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/EasyShip/Client)
 
 ### Feeds
 
 The MWS Feeds API lets you upload inventory and order data to Amazon. You can also use this API to get information about the processing of feeds.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/feeds/Feeds_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Feeds/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/Feeds/Client)
 - [XML schema docs](https://sellercentral.amazon.com/gp/help/help-page.html?itemID=1611)
 
 ### Finances
@@ -158,21 +160,21 @@ The MWS Feeds API lets you upload inventory and order data to Amazon. You can al
 The MWS Finances API enables you to obtain financial information relevant to your business with Amazon. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/finances/Finances_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Finances/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/Finances/Client)
 
 ### Fulfillment Inbound Shipment
 
 With the MWS Fulfillment Inbound Shipment API, you can create and update inbound shipments of inventory in the Amazon Fulfillment Network. You can also also request lists of inbound shipments or inbound shipment items based on criteria that you specify.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentInboundShipment/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/FulfillmentInboundShipment/Client)
 
 ### Fulfillment Inventory
 
 The MWS Fulfillment Inventory API can help you stay up-to-date on the availability of your inventory in the Amazon Fulfillment Network. The Fulfillment Inventory API reports real-time availability information for your Amazon Fulfillment Network inventory regardless of whether you are selling your inventory on Amazon's retail web site or through other retail channels.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_inventory/FBAInventory_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentInventory/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/FulfillmentInventory/Client)
 
 ### Fulfillment Outbound Shipment
 
@@ -181,49 +183,49 @@ The MWS Fulfillment Outbound Shipment API enables you to fulfill orders placed t
 Support for creating and cancelling fulfillment orders has been implemented, but the rest of the API is not supported yet.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/FulfillmentOutboundShipment/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/FulfillmentOutboundShipment/Client)
 
 ### Merchant Fulfillment
 
 The Merchant Fulfillment API provides programmatic access to Amazon’s fulfillment shipping services for sellers, including competitive rates with Amazon-partnered carriers. Sellers can find out what shipping services are available by submitting information about a proposed fulfillment shipment, such as package size and weight; shipment origin and destination; and delivery date requirements. Sellers can choose from the shipping service options returned by Amazon, and then receive shipping labels for fulfilling their orders.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/merch_fulfill/MerchFulfill_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/MerchantFulfillment/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/MerchantFulfillment/Client)
 
 ### Orders
 
 With the MWS Orders API, you can list orders created or updated during a time frame you specify or retrieve information about specific orders.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/Orders_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Orders/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/Orders/Client)
 
 ### Products
 
 The MWS Products API helps you get information to match your products to existing product listings on Amazon Marketplace websites and to make sourcing and pricing decisions for listing those products on Amazon Marketplace websites.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/products/Products_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Products/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/Products/Client)
 
 ### Recommendations
 
 The Recommendations API enables you to programmatically retrieve Amazon Selling Coach recommendations by recommendation category. A recommendation is an actionable, timely, and personalized opportunity to increase your sales and performance.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Recommendations/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/Recommendations/Client)
 
 ### Reports
 
 The Reports API lets you request reports about your inventory and orders.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/reports/Reports_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Reports/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/Reports/Client)
 
 ### Sellers
 
 The Sellers API lets sellers retrieve information about their seller account, such as the marketplaces they participate in.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Sellers/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/Sellers/Client)
 
 ### Shipment Invoicing
 
@@ -232,11 +234,11 @@ With the Shipment Invoicing API section (in conjunction with the FBAOutboundShip
 This functionality is available only in the Brazil marketplace.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/shipment_invoicing/ShipmentInvoicing_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/ShipmentInvoicing/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/ShipmentInvoicing/Client)
 
 ### Subscriptions
 
 The Amazon MWS Subscriptions API section enables you to subscribe to receive notifications that are relevant to your business with Amazon. With the operations in the Subscriptions API section, you can register to receive important information from Amazon without having to poll the Amazon MWS service. Instead, the information is sent directly to you when an event occurs to which you are subscribed.
 
 - [Amazon references](https://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_Overview.html)
-- [Peddler API docs](https://www.rubydoc.info/gems/peddler/MWS/Subscriptions/Client)
+- [Peddler API docs](https://www.rubydoc.info/github/hakanensari/peddler/MWS/Subscriptions/Client)

data/lib/mws/orders/client.rb

@@ -34,9 +34,7 @@ module MWS
       def list_orders(*marketplace_id)
         marketplace_id = marketplace_id.dup
         opts = extract_options(marketplace_id)
-        if opts.key?(:tfm_shipment_status)
-          opts['TFMShipmentStatus'] = opts.delete(:tfm_shipment_status)
-        end
+        opts['TFMShipmentStatus'] = opts.delete(:tfm_shipment_status) if opts.key?(:tfm_shipment_status)
 
         operation('ListOrders')
           .add(opts)

data/lib/mws/subscriptions/client.rb

@@ -139,7 +139,7 @@ module MWS
                               marketplace_id)
         operation('UpdateSubscription')
           .add('MarketplaceId' => marketplace_id)
-          .add(build_subscription(notification_type, sqs_queue_url, enabled))
+          .add(build_subscription(notification_type, sqs_queue_url, enabled: enabled))
 
         run
       end
@@ -163,7 +163,7 @@ module MWS
         }
       end
 
-      def build_subscription(notification_type, sqs_queue_url, enabled = true)
+      def build_subscription(notification_type, sqs_queue_url, enabled: true)
         {
           'Subscription.IsEnabled' => enabled,
           'Subscription.NotificationType' => notification_type,

data/lib/peddler/client.rb

@@ -22,6 +22,7 @@ module Peddler
       private
 
       def inherited(base)
+        super
         base.parser = parser
         base.params params
       end
@@ -112,7 +113,7 @@ module Peddler
     # @!visibility private
     def run(&block)
       opts = build_options
-      opts.store(:response_block, block) if block_given?
+      opts.store(:response_block, block) if block
       res = post(opts)
       self.body = nil if res.status == 200
 
@@ -129,13 +130,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/class_generator.rb

@@ -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
@@ -27,8 +32,8 @@ module Peddler
 
       private
 
-      def with_mutex
-        @mutex.synchronize { yield }
+      def with_mutex(&block)
+        @mutex.synchronize(&block)
       end
     end
   end

data/lib/peddler/flat_file_parser.rb

@@ -50,7 +50,7 @@ module Peddler
     end
 
     def summarize
-      Hash[summary.split("\n\t")[1, 2].map { |line| line.split("\t\t") }]
+      summary.split("\n\t")[1, 2].map { |line| line.split("\t\t") }.to_h
     end
   end
 end

data/lib/peddler/headers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'time'
+
 module Peddler
   # Parses useful metadata returned in response headers
   module Headers
@@ -47,7 +49,10 @@ module Peddler
       match_data = headers['Content-Type']&.match(/charset=(.*);?/)
       return unless match_data
 
-      Encoding.find(match_data[1])
+      string = match_data[1].upcase
+      string = 'UTF-8' if string == 'UTF8'
+
+      Encoding.find(string)
     end
 
     # The max hourly request quota for the requested operation

data/lib/peddler/marketplace.rb

@@ -64,11 +64,14 @@ module Peddler
       ['A1F83G8C2ARO7P', 'GB', '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'],
+      ['A2NODRKZP88ZB9', 'SE', 'mws-eu.amazonservices.com'],
       ['A19VAU5U5O7RUS', 'SG', 'mws-fe.amazonservices.com'],
       ['A39IBJ37TRP1C6', 'AU', 'mws.amazonservices.com.au'],
-      ['A1VC38T7YXB528', 'JP', 'mws.amazonservices.jp']
+      ['A1VC38T7YXB528', 'JP', 'mws.amazonservices.jp'],
+      ['A1C3SOZRARQ6R3', 'PL', 'mws-eu.amazonservices.com']
     ].map do |values|
       new(*values)
     end

data/lib/peddler/operation.rb

@@ -60,7 +60,7 @@ module Peddler
     end
 
     def capitalize(word)
-      if ALL_CAPS.any? { |val| val == word }
+      if ALL_CAPS.any?(word)
         word.upcase
       else
         word.capitalize

data/lib/peddler/version.rb

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

data/lib/peddler/xml_response_parser.rb

@@ -5,7 +5,7 @@ require 'peddler/xml_parser'
 module Peddler
   # @!visibility private
   class XMLResponseParser < XMLParser
-    MATCHER = /^Message$|Report|Result/.freeze
+    MATCHER = /^Message$|^Node$|Report|Result/.freeze
     private_constant :MATCHER
 
     def next_token
@@ -14,6 +14,7 @@ module Peddler
 
     private
 
+    # FIXME: In next major version bump, stop assuming we know report internals.
     def find_data
       payload = xml.values.first
       found = payload.find { |k, _| k.match(MATCHER) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.5
 platform: ruby
 authors:
 - Hakan Ensari
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
-description: 
+description:
 email:
 - me@hakanensari.com
 executables: []
@@ -93,7 +93,6 @@ files:
 - lib/mws/subscriptions/client.rb
 - lib/peddler.rb
 - lib/peddler/client.rb
-- lib/peddler/content.rb
 - lib/peddler/errors/builder.rb
 - lib/peddler/errors/class_generator.rb
 - lib/peddler/errors/error.rb
@@ -101,7 +100,6 @@ files:
 - lib/peddler/flat_file_parser.rb
 - lib/peddler/headers.rb
 - lib/peddler/marketplace.rb
-- lib/peddler/mws.rb
 - lib/peddler/operation.rb
 - lib/peddler/parser.rb
 - lib/peddler/structured_list.rb
@@ -113,7 +111,7 @@ homepage: https://github.com/hakanensari/peddler
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,15 +119,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper to the Amazon MWS API
 test_files: []

data/lib/peddler/content.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Peddler
-  # Parses content metadata provided in the headers of a response
-  class Content
-    # @!visibility private
-    attr_reader :headers
-
-    # @!visibility private
-    def initialize(headers)
-      @headers = headers.select { |key| key.start_with?('Content') }
-    end
-
-    # The size of the response body in bytes
-    # @return [String, nil]
-    def length
-      return unless headers['Content-Length']
-
-      headers['Content-Length'].to_i
-    end
-
-    # The MD5 digest of the response body
-    # @return [String, nil]
-    def md5
-      headers['Content-MD5']
-    end
-
-    # The MIME type of the response
-    # @return [String, nil]
-    def 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 type
-      return unless media_type
-
-      media_type.split('/').first
-    end
-
-    # The exact kind of data of the specified type the MIME type represents
-    # @return [String, nil]
-    def subtype
-      return unless media_type
-
-      media_type.split('/').last
-    end
-
-    # The character encoding of the response
-    # @return [Encoding, nil]
-    def charset
-      match_data = headers['Content-Type']&.match(/charset=(.*);?/)
-      return unless match_data
-
-      Encoding.find(match_data[1])
-    end
-
-    # Whether the response is an XML document
-    # @return [Boolean, nil]
-    def xml?
-      return unless subtype
-
-      subtype == 'xml'
-    end
-  end
-end

data/lib/peddler/mws.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Peddler
-  # Parses MWS metadata provided in the headers of a response
-  class MWS
-    # @!visibility private
-    attr_reader :headers
-
-    # @!visibility private
-    def initialize(headers)
-      @headers = headers.select { |key| key.start_with?('x-mws') }
-    end
-
-    # The max hourly request quota for the requested operation
-    # @return [Integer, nil]
-    def quota_max
-      return unless headers['x-mws-quota-max']
-
-      headers['x-mws-quota-max'].to_i
-    end
-
-    # The remaining hourly request quota for the requested operation
-    # @return [Integer, nil]
-    def quota_remaining
-      return unless headers['x-mws-quota-remaining']
-
-      headers['x-mws-quota-remaining'].to_i
-    end
-
-    # When the hourly request quota for the requested operation resets
-    # @return [Time, nil]
-    def quota_resets_on
-      return unless headers['x-mws-quota-resetsOn']
-
-      Time.parse(headers['x-mws-quota-resetsOn'])
-    end
-
-    # The ID of the request
-    # @return [String, nil]
-    def request_id
-      headers['x-mws-request-id']
-    end
-
-    # The timestamp of the request
-    # @return [Time, nil]
-    def timestamp
-      return unless headers['x-mws-timestamp']
-
-      Time.parse(headers['x-mws-timestamp'])
-    end
-
-    # The context of the response
-    # @return [String, nil]
-    def response_context
-      headers['x-mws-response-context']
-    end
-  end
-end