peddler 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1496350487deacc5345571d16968c6a0c9dca63692e2f915decb8b28ab613344
-  data.tar.gz: 68bc82232267280f4d1c07ee70299c2167d97f5e736d2a74116af6bb7256489b
+  metadata.gz: 7f41b36a62c193efceb4d464ce3447e4934c8ca97907ca6940c431914f0b1406
+  data.tar.gz: f28498baf2e3c8aa67bd983e74f9c4ca4daffcb15424a25ededee6b72fa3606a
 SHA512:
-  metadata.gz: 8cd79c46a5272e0aeb344d08c3f2e7d484dda9b037d1994ea113359a18fec63ee83a6e6f22a0997d60681751eb41f7d889096af2be9b1caa984b9a9ddd80afd7
-  data.tar.gz: 7af09716baa2480fb55e0a70984e7d9d1cc738e3d2ee1bd1ccfcb52868d7d7be953d4dfbcca5c7eb68de19abf4a0794a3b095e6177d7cbf1dd0faf549aa1ff3e
+  metadata.gz: b62d1f3d5eec15b6e2a7d3fee02445a3edc2596a6c8bafbf25deac633a01f401467cbe7d4214a4e1bf6a3b8958ec437b4ac1ed1f7d5a1c7f3638cdfcb80815ba
+  data.tar.gz: d5c7e57ed43bdf7f1aeba013a499d10b5bdf18361b1f5edf2e25eb82703ddec81eafe596aa0ae57fc920a1591d5ab399ef2c7093bb350c1f319e3e3709a857f8

data/README.md

@@ -8,9 +8,7 @@
 
 To use Amazon MWS, you must have an eligible seller account and register as an [application developer](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Registering.html#DG_Registering__RegisteringAsADeveloper).
 
-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.
+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)
 
@@ -22,7 +20,7 @@ Require the library.
 require "peddler"
 ```
 
-A client requires the AWS credentials of the application developer. If you are working within a single MWS region, you can set them globally in your shell.
+A client requires the AWS credentials of the application developer. If you are working in a single MWS region, you can set them globally.
 
 
 ```bash
@@ -30,32 +28,28 @@ export AWS_ACCESS_KEY_ID=YOUR_AWS_ACCESS_KEY_ID
 export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY
 ```
 
-Now, you can create a client with the Amazon marketplace you as application developer signed up on and a merchant ID. Peddler provides a class for each API section under an eponymous namespace.
+Now, create a client with the Amazon marketplace you signed up on and a merchant ID. Peddler provides a class for each API section under an eponymous namespace.
 
 ```ruby
-MWS::Orders::Client.new(marketplace: "ATVPDKIKX0DER",
-                        merchant_id: "123")
-
-# or the shorthand
-MWS.orders(marketplace: "ATVPDKIKX0DER",
-           merchant_id: "123")
+client = MWS.orders(marketplace: "ATVPDKIKX0DER",
+                    merchant_id: "123")
 
-# another shortcut
-MWS.orders(marketplace: "US",
-           merchant_id: "123")
+# or a shorthand
+client = MWS.orders(marketplace: "US",
+                    merchant_id: "123")
 ```
 
 If you are creating a [client for another seller](https://developer.amazonservices.com/gp/mws/faq.html#developForSeller), pass an MWS Auth Token as well.
 
 ```ruby
-MWS.orders(marketplace: "ATVPDKIKX0DER",
-           merchant_id: "123",
-           auth_token: "123")
+client = MWS.orders(marketplace: "ATVPDKIKX0DER",
+                    merchant_id: "123",
+                    auth_token: "123")
 ```
 
 You won't be able to create a client for another seller if you are in different regions.
 
-If you are working with sellers across multiple regions, a single set of credentials will not be enough. In that case, you can skip using global environment variables and pass your AWS credentials when creating the client.
+If you are working with sellers across multiple regions, a single set of credentials will not be enough. In that case, do not use global environment variables and pass your AWS credentials when creating the client.
 
 ```ruby
 client = MWS.orders(marketplace: "ATVPDKIKX0DER",

data/lib/mws/fulfillment_inbound_shipment/client.rb

@@ -152,6 +152,14 @@ module MWS
           .structure!('ASINList', 'Id')
 
         run
+      # Work around a bug upstream
+      #
+      # @see https://github.com/hakanensari/peddler/issues/122
+      rescue Peddler::Errors::Error => error
+        raise unless error.message.include?("Value null at 'asinList'")
+
+        get_prep_instructions_for_asin_with_bad_params(ship_to_country_code,
+                                                       *asin_list)
       end
 
       # Sends transportation information to Amazon about an inbound shipment
@@ -365,6 +373,16 @@ module MWS
           .structure!('InboundShipmentItems', 'member')
           .structure!('PrepDetailsList', 'member')
       end
+
+      def get_prep_instructions_for_asin_with_bad_params(_ship_to_country_code,
+                                                         *asin_list)
+        operation
+          .add('AsinList' => asin_list)
+          .structure!('AsinList', 'Id')
+          .delete_if { |key, _val| key.include?('ASINList') }
+
+        run
+      end
     end
   end
 end

data/lib/mws/fulfillment_outbound_shipment/client.rb

@@ -28,12 +28,6 @@ module MWS
       # @option opts [Boolean] :include_cod_fulfillment_preview
       # @return [Peddler::XMLParser]
       def get_fulfillment_preview(address, items, opts = {})
-        opts = opts.dup
-        if opts.key?(:include_cod_fulfillment_preview)
-          opts['IncludeCODFulfillmentPreview'] =
-            opts.delete(:include_cod_fulfillment_preview)
-        end
-
         operation('GetFulfillmentPreview')
           .add(opts)
           .add('Address' => address, 'Items' => items)
@@ -66,11 +60,6 @@ module MWS
                                    displayable_order_comment,
                                    shipping_speed_category,
                                    destination_address, items, opts = {})
-        opts = opts.dup
-        if opts.key?(:cod_settings)
-          opts['CODSettings'] = opts.delete(:cod_settings)
-        end
-
         operation('CreateFulfillmentOrder')
           .add(opts)
           .add('SellerFulfillmentOrderId' => seller_fulfillment_order_id,

data/lib/mws/reports/parser.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'peddler/flat_file_parser'
+require 'peddler/xml_response_parser'
+
+module MWS
+  module Reports
+    # @api private
+    module Parser
+      class << self
+        # We're massaging data produced by a motley army of developers. It's
+        # messy.
+        def new(res, encoding)
+          # Don't parse if there's no body
+          return res unless res.body
+
+          if xml?(res)
+            XMLResponseParser.new(res)
+          else
+            # Amazon returns a variety of content types for flat files. I simply
+            # assume anything not XML is a flat file.
+            FlatFileParser.new(res, encoding)
+          end
+        end
+
+        def xml?(res)
+          return true if res.headers['Content-Type'].start_with?('text/xml')
+          return true if res.body.start_with?('<?xml')
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/peddler/errors/builder.rb

@@ -11,7 +11,7 @@ module Peddler
     class Builder
       extend Forwardable
 
-      DIGIT_AS_FIRST_CHAR = /^\d/
+      DIGIT_AS_FIRST_CHAR = /^\d/.freeze
       private_constant :DIGIT_AS_FIRST_CHAR
 
       def_delegator :error, :response
@@ -29,6 +29,7 @@ module Peddler
       def build
         parse_original_response
         return if bad_class_name?
+
         error_class.new(error_message, error)
       end
 

data/lib/peddler/errors/class_generator.rb

@@ -20,6 +20,7 @@ module Peddler
       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

data/lib/peddler/flat_file_parser.rb

@@ -38,6 +38,7 @@ module Peddler
 
     def scrub_body!(encoding)
       return if body.encoding == Encoding::UTF_8
+
       self.body = body.dup.force_encoding(encoding)
     end
 

data/lib/peddler/headers.rb

@@ -7,6 +7,7 @@ module Peddler
     # @return [Integer, nil]
     def mws_quota_max
       return unless headers['x-mws-quota-max']
+
       headers['x-mws-quota-max'].to_i
     end
 
@@ -14,6 +15,7 @@ module Peddler
     # @return [Integer, nil]
     def mws_quota_remaining
       return unless headers['x-mws-quota-remaining']
+
       headers['x-mws-quota-remaining'].to_i
     end
 
@@ -21,6 +23,7 @@ module Peddler
     # @return [Time, nil]
     def mws_quota_resets_on
       return unless headers['x-mws-quota-resetsOn']
+
       Time.parse(headers['x-mws-quota-resetsOn'])
     end
 
@@ -34,6 +37,7 @@ module Peddler
     # @return [Time, nil]
     def mws_timestamp
       return unless headers['x-mws-timestamp']
+
       Time.parse(headers['x-mws-timestamp'])
     end
 

data/lib/peddler/marketplace.rb

@@ -63,6 +63,7 @@ module Peddler
       ['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'],
       ['A39IBJ37TRP1C6', 'AU', 'mws.amazonservices.com.au'],
       ['A1VC38T7YXB528', 'JP', 'mws.amazonservices.jp'],

data/lib/peddler/operation.rb

@@ -7,7 +7,9 @@ require 'peddler/structured_list'
 module Peddler
   # @api private
   class Operation < SimpleDelegator
-    CAPITAL_LETTERS = /[A-Z]/
+    CAPITAL_LETTERS = /[A-Z]/.freeze
+    ALL_CAPS = %w[sku cod].freeze
+    private_constant :CAPITAL_LETTERS, :ALL_CAPS
 
     def initialize(action)
       super('Action' => action)
@@ -55,8 +57,16 @@ module Peddler
       sym
         .to_s
         .split('_')
-        .map { |token| token == 'sku' ? 'SKU' : token.capitalize }
+        .map { |token| capitalize(token) }
         .join
     end
+
+    def capitalize(word)
+      if ALL_CAPS.any? { |val| val == word }
+        word.upcase
+      else
+        word.capitalize
+      end
+    end
   end
 end

data/lib/peddler/version.rb

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

data/lib/peddler/xml_parser.rb

@@ -25,6 +25,7 @@ module Peddler
 
     def valid?
       return unless headers['Content-Length']
+
       headers['Content-Length'].to_i == body.size
     end
 

data/lib/peddler/xml_response_parser.rb

@@ -5,7 +5,7 @@ require 'peddler/xml_parser'
 module Peddler
   # @api private
   class XMLResponseParser < XMLParser
-    MATCHER = /^Message$|Report|Result/
+    MATCHER = /^Message$|Report|Result/.freeze
     private_constant :MATCHER
 
     def next_token

data/test/helper.rb

@@ -11,4 +11,5 @@ require 'minitest/focus'
 begin
   require 'pry'
 rescue LoadError
+  nil
 end

data/test/integration/test_feeds.rb

@@ -4,21 +4,21 @@ require 'integration_helper'
 require 'mws/feeds'
 
 class TestFeeds < IntegrationTest
-  def test_gets_feed_submission_count
+  def test_getting_feed_submission_count
     clients.each do |client|
       res = client.get_feed_submission_count
       refute_empty res.parse
     end
   end
 
-  def test_gets_feed_submission_list
+  def test_getting_feed_submission_list
     clients.each do |client|
       res = client.get_feed_submission_list
       refute_empty res.parse
     end
   end
 
-  def test_submits_feeds
+  def test_submitting_feeds
     feed_content = "sku\tprice\tquantity\nwidget\t\t0\n"
     feed_type = '_POST_FLAT_FILE_PRICEANDQUANTITYONLY_UPDATE_DATA_'
 

data/test/integration/test_fulfillment_inbound_shipment.rb

@@ -8,7 +8,7 @@ class TestFulfillmentInboundShipment < IntegrationTest
                        :postal_code, :country_code)
   Item = Struct.new(:seller_sku, :quantity)
 
-  def test_creates_inbound_shipment_plan
+  def test_creating_inbound_shipment_plan
     address = Address.new('John', '1 Main St', 'New York', 'NY', '10001', 'US')
     item = Item.new('123', 1)
     clients.each do |client|
@@ -17,14 +17,14 @@ class TestFulfillmentInboundShipment < IntegrationTest
     end
   end
 
-  def test_gets_service_status
+  def test_getting_service_status
     clients.each do |client|
       res = client.get_service_status
       refute_empty res.parse
     end
   end
 
-  def test_handles_large_requests
+  def test_handling_large_requests
     address = Address.new('John', '1 Main St', 'New York', 'NY', '10001', 'US')
     items = Array.new(100) { |i| Item.new(i, 1) }
     clients.each do |client|

data/test/integration/test_fulfillment_inventory.rb

@@ -4,14 +4,14 @@ require 'integration_helper'
 require 'mws/fulfillment_inventory'
 
 class TestFulfillmentInventory < IntegrationTest
-  def test_lists_inventory_supply
+  def test_listing_inventory_supply
     clients.each do |client|
       res = client.list_inventory_supply(query_start_date_time: Date.today - 30)
       refute_empty res.parse
     end
   end
 
-  def test_gets_service_status
+  def test_getting_service_status
     clients.each do |client|
       res = client.get_service_status
       refute_empty res.parse

data/test/integration/test_fulfillment_outbound_shipment.rb

@@ -4,7 +4,7 @@ require 'integration_helper'
 require 'mws/fulfillment_outbound_shipment'
 
 class TestFulfillmentOutboundShipment < IntegrationTest
-  def test_gets_service_status
+  def test_getting_service_status
     clients.each do |client|
       res = client.get_service_status
       refute_empty res.parse

data/test/integration/test_merchant_fulfillment.rb

@@ -4,10 +4,66 @@ require 'integration_helper'
 require 'mws/merchant_fulfillment'
 
 class TestMerchantFulfillment < IntegrationTest
-  def test_gets_service_status
+  def test_getting_eligible_shipments_in_the_us
+    client = clients.us
+    res = client.get_eligible_shipping_services(shipment_request_details)
+    refute res.dig('ShippingServiceList', 'ShippingService').count.zero?
+  end
+
+  def test_shipping_in_the_us
+    client = clients.us
+    res = client.create_shipment(shipment_request_details, 'UPS_PTP_GND')
+    label = res.dig('Shipment', 'Label')
+    data_compressed = Base64.decode64(label['FileContents']['Contents'])
+    # data = Zlib.gunzip(data_compressed)
+    data = Zlib::GzipReader.new(StringIO.new(data_compressed)).read
+    assert_equal label['FileContents']['Checksum'], Digest::MD5.base64digest(data)
+    res = client.cancel_shipment(res.dig('Shipment', 'ShipmentId'))
+    assert_equal 'RefundPending', res.dig('Shipment', 'Status')
+  end
+
+  def test_getting_service_status
     clients.each do |client|
       res = client.get_service_status
       refute_empty res.parse
     end
   end
+
+  private
+
+  def shipment_request_details
+    {
+      amazon_order_id: '123-1234567-1234567',
+      item_list: [
+        {
+          order_item_id: '12345678901234',
+          quantity: 1
+        }
+      ],
+      ship_from_address: {
+        name: 'John Doe',
+        address_line_1: '10 Jay St',
+        email: 'john@example.com',
+        city: 'Brooklyn',
+        state_or_province_code: 'NY',
+        postal_code: '11201',
+        country_code: 'US',
+        phone: '7181231234'
+      },
+      package_dimensions: {
+        length: 40,
+        width: 30,
+        height: 10,
+        unit: 'centimeters'
+      },
+      weight: {
+        value: 1000,
+        unit: 'grams'
+      },
+      shipping_service_options: {
+        carrier_will_pick_up: false,
+        delivery_experience: 'DeliveryConfirmationWithoutSignature'
+      }
+    }
+  end
 end