peddler 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cda72505daf1765d33219d8c8f0172a896947438
-  data.tar.gz: eb4e2949c291be4ce67391e77a1c51371dbefef2
+  metadata.gz: 9fe93b1e3df4edf8e6c43dff0c345c54c810dfc2
+  data.tar.gz: 7357b893235c06ca4770e693229c2bcaf3cdfb1a
 SHA512:
-  metadata.gz: a15a7ca00095ff09099eda59af7afcfa7ee9d3bda1dd541767e8981eb5bfc2c86e6552e317af377007417e9905c1e0741dbd0d5c13b3e8e839d2b0d3c1c6ac68
-  data.tar.gz: 6df5642273624a132ee07f7308bfaf577b508140260c73df841976d7a565fcb3e1cb146898af9d16c8e60174f0f64741a9e91c4afba94ac63348eb394c39e3ae
+  metadata.gz: 1a603aeeadcfc890cb58bce2d9930811a16e464c9133e900fc546ce446ee8ffd1471abab5b2c42591fa987e6fe8e5f2b7212386ac4b32d062d25330ea27b9293
+  data.tar.gz: a4e569716f65d6269cf39e1822b44313ec543cbee0e25f8e4fb9f42eb19a1d0774ec92f688db62509ae229bb59c12a96185862ea15b304da3c841467d11261fe

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2009-2014 Hakan Ensari
+Copyright (c) Hakan Ensari
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -71,6 +71,8 @@ client = MWS.orders(
 
 Once you have a client with valid credentials, you should be able to make requests to the API. Clients map operation names in a flat structure. Methods have positional arguments for required input and keyword arguments for optional parameters. Both method and argument names are underscored but otherwise identical to the names of the corresponding operations and parameters documented in the API.
 
+### Parser
+
 Peddler wraps successful responses in a parser that handles both XML documents and flat files:
 
 ```ruby
@@ -86,7 +88,13 @@ MWS::Orders::Client.parser = MyParser
 
 For a sample implementation, see my [MWS Orders](https://github.com/hakanensari/mws-orders) library.
 
-Finally, you can handle network errors caused by throttling or other transient issues by defining an error handler.
+### Debugging
+
+To introspect requests, set the `EXCON_DEBUG` environment variable to a truthy value.
+
+### Errors
+
+Handle network errors caused by throttling or other transient issues by defining an error handler.
 
 ```ruby
 MWS::Orders::Client.on_error do |e|

data/lib/mws/fulfillment_inbound_shipment/client.rb

@@ -10,6 +10,40 @@ module MWS
       version '2010-10-01'
       path "/FulfillmentInboundShipment/#{version}"
 
+      # Returns inbound guidance for a list of items by Seller SKU
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetInboundGuidanceForSKU.html
+      # @param [String] marketplace_id
+      # @param [String] one or more seller_skus
+      # @return [Peddler::XMLParser]
+      def get_inbound_guidance_for_sku(marketplace_id, *seller_skus)
+        operation('GetInboundGuidanceForSKU')
+          .add(
+            'MarketplaceId' => marketplace_id,
+            'SellerSKUList' => seller_skus
+          )
+          .structure!('SellerSKUList', 'Id')
+
+        run
+      end
+
+      # Returns inbound guidance for a list of items by ASIN
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetInboundGuidanceForASIN.html
+      # @param [String] marketplace_id
+      # @param [String] one or more asins
+      # @return [Peddler::XMLParser]
+      def get_inbound_guidance_for_asin(marketplace_id, *asins)
+        operation('GetInboundGuidanceForASIN')
+          .add(
+            'MarketplaceId' => marketplace_id,
+            'ASINList' => asins
+          )
+          .structure!('ASINList', 'Id')
+
+        run
+      end
+
       # Returns the information required to create an inbound shipment
       #
       # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_CreateInboundShipmentPlan.html
@@ -20,10 +54,12 @@ module MWS
       # @return [Peddler::XMLParser]
       def create_inbound_shipment_plan(ship_from_address, inbound_shipment_plan_request_items, opts = {})
         operation('CreateInboundShipmentPlan')
-          .add(opts.update(
-                 'ShipFromAddress' => ship_from_address,
-                 'InboundShipmentPlanRequestItems' => inbound_shipment_plan_request_items
-          ))
+          .add(
+            opts.update(
+              'ShipFromAddress' => ship_from_address,
+              'InboundShipmentPlanRequestItems' => inbound_shipment_plan_request_items
+            )
+          )
           .structure!('InboundShipmentPlanRequestItems', 'member')
 
         run
@@ -38,7 +74,13 @@ module MWS
       # @option opts [Array<Struct, Hash>] :inbound_shipment_items
       # @return [Peddler::XMLParser]
       def create_inbound_shipment(shipment_id, inbound_shipment_header, opts = {})
-        build_inbound_shipment_operation('CreateInboundShipment', shipment_id, inbound_shipment_header, opts)
+        build_inbound_shipment_operation(
+          'CreateInboundShipment',
+          shipment_id,
+          inbound_shipment_header,
+          opts
+        )
+
         run
       end
 
@@ -51,7 +93,77 @@ module MWS
       # @option opts [Array<Struct, Hash>] :inbound_shipment_items
       # @return [Peddler::XMLParser]
       def update_inbound_shipment(shipment_id, inbound_shipment_header, opts = {})
-        build_inbound_shipment_operation('UpdateInboundShipment', shipment_id, inbound_shipment_header, opts)
+        build_inbound_shipment_operation(
+          'UpdateInboundShipment',
+          shipment_id,
+          inbound_shipment_header,
+          opts
+        )
+
+        run
+      end
+
+      # Returns pre-order information, including dates
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetPreorderInfo.html
+      # @param [String] shipment_id
+      # @return [Peddler::XMLParser]
+      def get_preorder_info(shipment_id)
+        operation('GetPreorderInfo')
+          .add(
+            'ShipmentId' => shipment_id
+          )
+
+        run
+      end
+
+      # Confirms a shipment for pre-order
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_ConfirmPreorder.html
+      # @param [String] shipment_id
+      # @param [#iso8601] need_by_date
+      # @return [Peddler::XMLParser]
+      def confirm_preorder(shipment_id, need_by_date)
+        operation('ConfirmPreorder')
+          .add(
+            'ShipmentId' => shipment_id,
+            'NeedByDate' => need_by_date
+          )
+
+        run
+      end
+
+      # Returns labeling requirements and item preparation instructions to help you prepare items for an inbound shipment
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetPrepInstructionsForSKU.html
+      # @param [String] ship_to_country_code
+      # @param [String] one or more seller_skus
+      # @return [Peddler::XMLParser]
+      def get_prep_instructions_for_sku(ship_to_country_code, *seller_skus)
+        operation('GetPrepInstructionsForSKU')
+          .add(
+            'SellerSKUList' => seller_skus,
+            'ShipToCountryCode' => ship_to_country_code
+          )
+          .structure!('SellerSKUList', 'Id')
+
+        run
+      end
+
+      # Returns item preparation instructions to help with item sourcing decisions
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetPrepInstructionsForASIN.html
+      # @param [String] ship_to_country_code
+      # @param [String] one or more asins
+      # @return [Peddler::XMLParser]
+      def get_prep_instructions_for_asin(ship_to_country_code, *asins)
+        operation('GetPrepInstructionsForASIN')
+          .add(
+            'ASINList' => asins,
+            'ShipToCountryCode' => ship_to_country_code
+          )
+          .structure!('ASINList', 'Id')
+
         run
       end
 
@@ -138,6 +250,43 @@ module MWS
         run
       end
 
+      # Returns unique package labels for faster and more accurate shipment processing at the Amazon fulfillment centre
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetUniquePackageLabels.html
+      # @param [String] shipment_id
+      # @param [String] page_type
+      # @param [Array<String>] package_labels_to_print
+      # @return [Peddler::XMLParser]
+      def get_unique_package_labels(shipment_id, page_type, package_labels_to_print)
+        operation('GetUniquePackageLabels')
+          .add(
+            'ShipmentId' => shipment_id,
+            'PageType' => page_type,
+            'PackageLabelsToPrint' => package_labels_to_print
+          )
+          .structure!('PackageLabelsToPrint', 'member')
+
+        run
+      end
+
+      # Returns pallet labels
+      #
+      # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/FBAInbound_GetPalletLabels.html
+      # @param [String] shipment_id
+      # @param [String] page_type
+      # @param [Integer] number_of_pallets
+      # @return [Peddler::XMLParser]
+      def get_pallet_labels(shipment_id, page_type, number_of_pallets)
+        operation('GetPalletLabels')
+          .add(
+            'ShipmentId' => shipment_id,
+            'PageType' => page_type,
+            'NumberOfPallets' => number_of_pallets
+          )
+
+        run
+      end
+
       # Returns PDF document data for printing a bill of lading for an inbound
       # shipment
       #

data/lib/mws/fulfillment_inventory/client.rb

@@ -19,6 +19,7 @@ module MWS
       # @option opts [Array<String>, String] :seller_skus
       # @option opts [String, #iso8601] :query_start_date_time
       # @option opts [String] :response_group
+      # @option opts [String] :marketplace_id
       # @return [Peddler::XMLParser]
       def list_inventory_supply(opts = {})
         operation('ListInventorySupply')

data/lib/mws/products/client.rb

@@ -185,6 +185,7 @@ module MWS
       # Gets the estimated fees for a list of products.
       #
       # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMyFeesEstimate.html
+      # @see http://docs.developer.amazonservices.com/en_US/products/Products_Datatypes.html#FeesEstimateRequest
       # @param [Hash] fees_estimate_request one or more fees estimate requests
       # @return [Peddler::XMLParser]
       def get_my_fees_estimate(*fees_estimate_requests)

data/lib/peddler/errors/error.rb

@@ -1,5 +1,14 @@
 module Peddler
+  # @api private
   module Errors
+    KNOWN = %w(
+      AccessDenied
+      InvalidMarketplace
+      InvalidParameterValue
+      QuotaExceeded
+      RequestThrottled
+    ).freeze
+
     # @api private
     class Error < StandardError
       attr_reader :cause
@@ -9,5 +18,9 @@ module Peddler
         super msg
       end
     end
+
+    KNOWN.each do |name|
+      const_set name, Class.new(Error)
+    end
   end
 end

data/lib/peddler/operation.rb

@@ -5,6 +5,8 @@ require 'peddler/structured_list'
 module Peddler
   # @api private
   class Operation < SimpleDelegator
+    CAPITAL_LETTERS = /[A-Z]/
+
     def initialize(action)
       super('Action' => action)
     end
@@ -45,6 +47,8 @@ module Peddler
     private
 
     def camelize(sym)
+      return sym.to_s if sym =~ CAPITAL_LETTERS
+
       sym
         .to_s
         .split('_')

data/lib/peddler/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Peddler
-  VERSION = '1.4.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/lib/peddler/xml_response_parser.rb

@@ -3,6 +3,9 @@ require 'peddler/xml_parser'
 module Peddler
   # @api private
   class XMLResponseParser < XMLParser
+    MATCHER = /Message|Report|Result/
+    private_constant :MATCHER
+
     def next_token
       parse.fetch('NextToken', false)
     end
@@ -11,8 +14,7 @@ module Peddler
 
     def find_data
       payload = xml.values.first
-      found = payload.find { |k, _| k.include?('Result') } ||
-              payload.find { |k, _| k == 'Message' }
+      found = payload.find { |k, _| k.match(MATCHER) }
 
       found.last if found
     end

data/test/helper.rb

@@ -1,13 +1,15 @@
-require 'simplecov'
-require 'coveralls'
+if RUBY_ENGINE == 'ruby'
+  require 'simplecov'
+  require 'coveralls'
 
-SimpleCov.formatters = [
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
 
-SimpleCov.start do
-  add_filter '/test/'
+  SimpleCov.start do
+    add_filter '/test/'
+  end
 end
 
 require 'minitest/autorun'

data/test/integration/test_products.rb

@@ -51,10 +51,47 @@ class TestProducts < IntegrationTest
     end
   end
 
+  def test_gets_my_fees_estimate
+    clients.each do |client|
+      res = client.get_my_fees_estimate(
+        marketplace_id: client.primary_marketplace_id,
+        id_type: 'ASIN',
+        id_value: '1780935374',
+        price_to_estimate_fees: {
+          listing_price: {
+            currency_code: currency_code_for(client.primary_marketplace_id),
+            amount: 100
+          }
+        },
+        identifier: '123',
+        is_amazon_fulfilled: false
+      )
+      assert res
+        .parse
+        .dig('FeesEstimateResultList', 'FeesEstimateResult', 'FeesEstimate')
+    end
+  end
+
   def test_gets_service_status
     clients.each do |client|
       res = client.get_service_status
       refute_empty res.parse
     end
   end
+
+  private
+
+  CURRENCY_CODES = {
+    'A2EUQ1WTGCTBG2' => 'CAD',
+    'AAHKV2X7AFYLW'  => 'CNY',
+    'A1F83G8C2ARO7P' => 'GBP',
+    'A21TJRUUN4KGV'  => 'INR',
+    'A1VC38T7YXB528' => 'JPY',
+    'A1AM78C64UM0Y8' => 'MXN',
+    'ATVPDKIKX0DER'  => 'USD'
+  }.freeze
+
+  def currency_code_for(marketplace_id)
+    CURRENCY_CODES.fetch(marketplace_id, 'EUR')
+  end
 end

data/test/unit/mws/test_fulfillment_inbound_shipment_client.rb

@@ -6,6 +6,34 @@ class TestMWSFulfillmentInboundShipmentClient < MiniTest::Test
     @client = MWS::FulfillmentInboundShipment::Client.new
   end
 
+  def test_gets_inbound_guidance_for_sku
+    operation = {
+      'Action' => 'GetInboundGuidanceForSKU',
+      'MarketplaceId' => 'ATVPDKIKX0DER',
+      'SellerSKUList.Id.1' => 'us001'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_inbound_guidance_for_sku('ATVPDKIKX0DER', 'us001')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_inbound_guidance_for_asin
+    operation = {
+      'Action' => 'GetInboundGuidanceForASIN',
+      'MarketplaceId' => 'ATVPDKIKX0DER',
+      'ASINList.Id.1' => 'B00005N5PF'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_inbound_guidance_for_asin('ATVPDKIKX0DER', 'B00005N5PF')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
   def test_creates_inbound_shipment_plan
     operation = {
       'Action' => 'CreateInboundShipmentPlan',
@@ -50,6 +78,62 @@ class TestMWSFulfillmentInboundShipmentClient < MiniTest::Test
     assert_equal operation, @client.operation
   end
 
+  def test_gets_preorder_info
+    operation = {
+      'Action' => 'GetPreorderInfo',
+      'ShipmentId' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_preorder_info('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_confirms_preorder
+    operation = {
+      'Action' => 'ConfirmPreorder',
+      'ShipmentId' => '1',
+      'NeedByDate' => '2015-12-27'
+    }
+
+    @client.stub(:run, nil) do
+      @client.confirm_preorder('1', Date.new(2015, 12, 27))
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_prep_instructions_for_sku
+    operation = {
+      'Action' => 'GetPrepInstructionsForSKU',
+      'ShipToCountryCode' => 'US',
+      'SellerSKUList.Id.1' => 'ca_001'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_prep_instructions_for_sku('US', 'ca_001')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_prep_instructions_for_asin
+    operation = {
+      'Action' => 'GetPrepInstructionsForASIN',
+      'ShipToCountryCode' => 'US',
+      'ASINList.Id.1' => 'B00005N5PF',
+      'ASINList.Id.2' => 'B0INVALIDF'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_prep_instructions_for_asin('US', 'B00005N5PF', 'B0INVALIDF')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
   def test_puts_transport_content_with_package_list
     transport_details = {
       parcel_data: {
@@ -168,6 +252,43 @@ class TestMWSFulfillmentInboundShipmentClient < MiniTest::Test
     assert_equal operation, @client.operation
   end
 
+  def test_gets_unique_package_labels
+    operation = {
+      'Action' => 'GetUniquePackageLabels',
+      'ShipmentId' => 'FBAQFGQZ',
+      'PageType' => 'PackageLabel_Letter_6',
+      'PackageLabelsToPrint.member.1' => 'CartonA',
+      'PackageLabelsToPrint.member.2' => 'CartonB',
+      'PackageLabelsToPrint.member.3' => 'CartonC',
+      'PackageLabelsToPrint.member.4' => 'CartonD'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_unique_package_labels(
+        'FBAQFGQZ',
+        'PackageLabel_Letter_6',
+        %w(CartonA CartonB CartonC CartonD)
+      )
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_pallet_labels
+    operation = {
+      'Action' => 'GetPalletLabels',
+      'ShipmentId' => 'FBAQFGQZ',
+      'PageType' => 'PackageLabel_Letter_4',
+      'NumberOfPallets' => 4
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_pallet_labels('FBAQFGQZ', 'PackageLabel_Letter_4', 4)
+    end
+
+    assert_equal operation, @client.operation
+  end
+
   def test_gets_bill_of_lading
     operation = {
       'Action' => 'GetBillOfLading',

data/test/unit/mws/test_products_client.rb

@@ -141,7 +141,9 @@ class TestMWSProductsClient < MiniTest::Test
       'Action' => 'GetMyFeesEstimate',
       'FeesEstimateRequestList.FeesEstimateRequest.1.MarketplaceId' => '123',
       'FeesEstimateRequestList.FeesEstimateRequest.1.IdType' => 'ASIN',
-      'FeesEstimateRequestList.FeesEstimateRequest.1.IdValue' => '123',
+      'FeesEstimateRequestList.FeesEstimateRequest.1.IdValue' => '1234567890',
+      'FeesEstimateRequestList.FeesEstimateRequest.1.Identifier' => 'foo',
+      'FeesEstimateRequestList.FeesEstimateRequest.1.IsAmazonFulfilled' => true,
       'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.ListingPrice.CurrencyCode' => 'USD',
       'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.ListingPrice.Amount' => 30.00,
       'FeesEstimateRequestList.FeesEstimateRequest.1.PriceToEstimateFees.Shipping.CurrencyCode' => 'USD',
@@ -153,7 +155,9 @@ class TestMWSProductsClient < MiniTest::Test
       @client.get_my_fees_estimate(
         marketplace_id: '123',
         id_type: 'ASIN',
-        id_value: '123',
+        id_value: '1234567890',
+        identifier: 'foo',
+        is_amazon_fulfilled: true,
         price_to_estimate_fees: {
           listing_price: {
             currency_code: 'USD',

data/test/unit/peddler/errors/test_error.rb

@@ -13,4 +13,10 @@ class TestPeddlerErrorsError < MiniTest::Test
   def test_sets_cause
     assert_equal 'cause', @error.cause
   end
+
+  def test_defines_common_errors
+    Peddler::Errors::KNOWN.each do |name|
+      assert ::Peddler::Errors.const_defined?(name)
+    end
+  end
 end

data/test/unit/peddler/test_operation.rb

@@ -21,12 +21,23 @@ class TestPeddlerOperation < MiniTest::Test
     assert_equal 1, @operation['Foo.Status.Bar.1']
   end
 
-  def test_store_camelizes_key
+  def test_store_camelizes_symbol_key
     @operation.store(:foo_bar, 'baz')
     assert @operation.key?('FooBar')
     refute @operation.key?(:foo_bar)
   end
 
+  def test_store_wont_camelize_string_key
+    @operation.store('foo_bar', 'baz')
+    assert @operation.key?('foo_bar')
+    refute @operation.key?('FooBar')
+  end
+
+  def test_store_wont_camelize_symbol_key_with_capital_letter
+    @operation.store('MarketplaceId'.to_sym, '1')
+    assert @operation.key?('MarketplaceId')
+  end
+
   def test_store_upcases_sku
     @operation.store(:seller_sku, 'baz')
     assert @operation.key?('SellerSKU')

data/test/unit/peddler/test_xml_response_parser.rb

@@ -2,32 +2,36 @@ require 'helper'
 require 'peddler/xml_response_parser'
 
 class TestPeddlerXMLResponseParser < MiniTest::Test
-  def setup
-    body = '<Response><Result><NextToken>123</NextToken>'\
-           '<Foo>Bar</Foo></Result></Response>'
-
-    @parser = Peddler::XMLResponseParser.new(response(body))
+  def test_parses_responses
+    body = '<Response><Result><Foo>Bar</Foo></Result></Response>'
+    parser = Peddler::XMLResponseParser.new(response(body))
+    assert_equal 'Bar', parser.parse['Foo']
   end
 
-  def response(body)
-    OpenStruct.new(
-      body: body,
-      headers: { 'Content-Type' => 'text/xml', 'Content-Length' => '78' }
-    )
+  def test_parses_messages
+    body = '<Response><Message><Foo>Bar</Foo></Message></Response>'
+    parser = Peddler::XMLResponseParser.new(response(body))
+    assert_equal 'Bar', parser.parse['Foo']
   end
 
-  def test_parses_data
-    assert_equal 'Bar', @parser.parse['Foo']
+  def test_parses_reports
+    body = '<fooReports><fooReport><foo>Bar</foo></fooReport></fooReports>'
+    parser = Peddler::XMLResponseParser.new(response(body))
+    assert_equal 'Bar', parser.parse['foo']
   end
 
-  def test_parses_message_data
-    body_with_message = '<Response><Message><NextToken>123</NextToken>'\
-           '<Foo>Bar</Foo></Message></Response>'
-    parser = Peddler::XMLResponseParser.new(response(body_with_message))
-    assert_equal 'Bar', parser.parse['Foo']
+  def test_parses_next_token
+    body = '<Response><Result><NextToken>123</NextToken></Result></Response>'
+    parser = Peddler::XMLResponseParser.new(response(body))
+    assert_equal '123', parser.next_token
   end
 
-  def test_next_token
-    assert_equal '123', @parser.next_token
+  private
+
+  def response(body)
+    OpenStruct.new(
+      body: body,
+      headers: { 'Content-Type' => 'text/xml', 'Content-Length' => '78' }
+    )
   end
 end