peddler 1.2.0 → 1.3.0

data/lib/mws/webstore/client.rb

@@ -13,7 +13,7 @@ module MWS
     # that your Webstore tracks, can help you determine how many notifications
     # were converted into sales.
     class Client < ::Peddler::Client
-      version "2014-09-01"
+      version '2014-09-01'
       path "/Webstore/#{version}/"
 
       # Lists subscription counts of subscriptions in a specified state,
@@ -21,8 +21,8 @@ module MWS
       #
       # @see http://docs.developer.amazonservices.com/en_US/webstore/Webstore_ListSubscriptionsCount.html
       # @overload list_subscriptions_count(subscription_state, opts = { marketplace_id: primary_marketplace_id })
-      #   @param subscription_state [String]
-      #   @param opts [Hash]
+      #   @param [String] subscription_state
+      #   @param [Hash] opts
       #   @option opts [String] :marketplace_id
       #   @option opts [String, #iso8601] :date_range_start
       #   @option opts [String, #iso8601] :date_range_end
@@ -43,7 +43,7 @@ module MWS
       # Lists the next page of subscription counts
       #
       # @see http://docs.developer.amazonservices.com/en_US/webstore/Webstore_ListSubscriptionsCountByNextToken.html
-      # @param next_token [String]
+      # @param [String] next_token
       # @return [Peddler::XMLParser]
       def list_subscriptions_count_by_next_token(next_token)
         operation('ListSubscriptionsCountByNextToken')
@@ -57,10 +57,10 @@ module MWS
       #
       # @see http://docs.developer.amazonservices.com/en_US/webstore/Webstore_ListSubscriptionsCount.html
       # @overload get_subscription_details(seller_sku, subscription_state, date_range_start, opts = { marketplace_id: marketplace_id })
-      #   @param seller_sku [String]
-      #   @param subscription_state [String]
-      #   @param date_range_start [String, #iso8601]
-      #   @param opts [Hash]
+      #   @param [String] seller_sku
+      #   @param [String] subscription_state
+      #   @param [String, #iso8601] date_range_start
+      #   @param [Hash] opts
       #   @option opts [String] :marketplace_id
       #   @option opts [String, #iso8601] :date_range_end
       # @return [Peddler::XMLParser]

data/lib/peddler/client.rb

@@ -25,7 +25,7 @@ module Peddler
     # @return [String]
     attr_reader :body
 
-    alias_method :configure, :tap
+    alias configure tap
 
     def_delegators :marketplace, :host, :encoding
 
@@ -57,8 +57,8 @@ module Peddler
       end
 
       # Sets an error handler
-      # @yieldparam request [Excon::Request]
-      # @yieldparam response [Excon::Response]
+      # @yieldparam [Excon::Request] request
+      # @yieldparam [Excon::Response] response
       def on_error(&blk)
         @error_handler = blk
       end
@@ -77,7 +77,7 @@ module Peddler
 
     # Creates a new client instance
     #
-    # @param opts [Hash]
+    # @param [Hash] opts
     # @option opts [String] :primary_marketplace_id
     # @option opts [String] :merchant_id
     # @option opts [String] :aws_access_key_id
@@ -155,8 +155,8 @@ module Peddler
     end
 
     # Sets an error handler
-    # @yieldparam request [Excon::Request]
-    # @yieldparam response [Excon::Response]
+    # @yieldparam [Excon::Request] request
+    # @yieldparam [Excon::Response] response
     def on_error(&blk)
       @error_handler = blk
     end
@@ -224,7 +224,7 @@ module Peddler
 
     def deprecate_error_handler_arguments(e)
       if error_handler.parameters.size == 2
-        warn "[DEPRECATION] Error handler now expects exception as argument."
+        warn '[DEPRECATION] Error handler now expects exception as argument.'
         [e.request, e.response]
       else
         [e]

data/lib/peddler/flat_file_parser.rb

@@ -6,7 +6,7 @@ module Peddler
   # @api private
   class FlatFileParser < SimpleDelegator
     # http://stackoverflow.com/questions/8073920/importing-csv-quoting-error-is-driving-me-nuts
-    OPTIONS = { col_sep: "\t", quote_char: "\x00", headers: true }
+    OPTIONS = { col_sep: "\t", quote_char: "\x00", headers: true }.freeze
 
     attr_reader :content, :summary, :encoding
 

data/lib/peddler/marketplace.rb

@@ -13,14 +13,14 @@ module Peddler
       'A1VC38T7YXB528' => 'mws.amazonservices.jp',
       'A1AM78C64UM0Y8' => 'mws.amazonservices.com.mx',
       'ATVPDKIKX0DER'  => 'mws.amazonservices.com'
-    }
+    }.freeze
 
     BadId = Class.new(StandardError)
 
     attr_reader :id
 
     def initialize(id)
-      @id = id or fail BadId, 'missing MarketplaceId'
+      @id = id || fail(BadId, 'missing MarketplaceId')
     end
 
     def host

data/lib/peddler/operation.rb

@@ -21,20 +21,15 @@ module Peddler
       self
     end
 
-    def store(key, val)
+    def store(key, val, parent: '')
       key = camelize(key) if key.is_a?(Symbol)
+      key = "#{parent}.#{key}" unless parent.empty?
 
-      if val.respond_to?(:iso8601)
-        val = val.iso8601
-      elsif val.is_a?(Struct)
-        val = val.to_h
-      end
+      val = val.iso8601 if val.respond_to?(:iso8601)
+      val = val.to_h if val.is_a?(Struct)
 
       if val.is_a?(Hash)
-        val.each do |subkey, subval|
-          subkey = camelize(subkey) if subkey.is_a?(Symbol)
-          store([key, subkey].join('.'), subval)
-        end
+        val.each { |keyval| store(*keyval, parent: key) }
       else
         __getobj__.store(key, val)
       end
@@ -45,7 +40,7 @@ module Peddler
       self
     end
 
-    alias_method :add, :update
+    alias add update
 
     private
 
@@ -53,7 +48,7 @@ module Peddler
       sym
         .to_s
         .split('_')
-        .map { |token| token == "sku" ? "SKU" : token.capitalize }
+        .map { |token| token == 'sku' ? 'SKU' : token.capitalize }
         .join
     end
   end

data/lib/peddler/vcr_matcher.rb

@@ -1,12 +1,14 @@
 module Peddler
+  # A custom matcher that can be used to record MWS interactions when
+  # integration-testing
   class VCRMatcher
     TRANSIENT_PARAMS = %w(
       Signature Timestamp StartDate CreatedAfter QueryStartDateTime
-    )
+    ).freeze
 
     SELLER_PARAMS = %w(
       AWSAccessKeyId SellerId
-    )
+    ).freeze
 
     class << self
       def call(*requests)
@@ -14,7 +16,7 @@ module Peddler
       end
 
       def ignored_params
-        @ignored_params ||= TRANSIENT_PARAMS
+        @ignored_params ||= TRANSIENT_PARAMS.dup
       end
 
       def ignore_seller!

data/lib/peddler/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Peddler
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'.freeze
 end

data/test/helper.rb

@@ -1,6 +1,5 @@
 require 'simplecov'
 require 'coveralls'
-require 'peddler/vcr_matcher'
 
 SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
@@ -9,10 +8,11 @@ SimpleCov.formatters = [
 
 SimpleCov.start do
   add_filter '/test/'
-  minimum_coverage(99.62)
 end
 
+require 'dig_rb'
 require 'minitest/autorun'
+require 'peddler/vcr_matcher'
 require 'yaml'
 require 'vcr'
 begin
@@ -71,6 +71,8 @@ VCR.configure do |c|
   c.hook_into :excon
   c.cassette_library_dir = 'test/vcr_cassettes'
 
+  ::Peddler::VCRMatcher.ignore_seller!
+
   # HTTP errors are not Peddler's concern, so ignore them to ease development.
   c.before_record do |interaction|
     code = interaction.response.status.code
@@ -85,5 +87,12 @@ VCR.configure do |c|
   Accounts.each do |account|
     c.filter_sensitive_data('MERCHANT_ID') { account['merchant_id'] }
     c.filter_sensitive_data('AWS_ACCESS_KEY_ID') { account['aws_access_key_id'] }
+    c.before_record do |interaction|
+      %w(
+        BuyerName BuyerEmail Name AddressLine1 PostalCode Phone Amount
+      ).each do |key|
+        interaction.response.body.gsub!(/<#{key}>[^<]+</, "<#{key}>FILTERED<")
+      end
+    end
   end
 end

data/test/integration/test_fulfillment_inbound_shipment.rb

@@ -24,7 +24,7 @@ class TestFulfillmentInboundShipment < IntegrationTest
 
   def test_handles_large_requests
     address = Address.new('John', '1 Main St', 'New York', 'NY', '10001', 'US')
-    items = 100.times.map { |count| Item.new(count, 1) }
+    items = Array.new(100) { |i| Item.new(i, 1) }
     clients.each do |client|
       res = client.create_inbound_shipment_plan(address, items)
       assert_equal 200, res.status

data/test/integration/test_merchant_fulfillment.rb

@@ -0,0 +1,11 @@
+require 'helper'
+require 'mws/merchant_fulfillment'
+
+class TestMerchantFulfillment < IntegrationTest
+  def test_gets_service_status
+    clients.each do |client|
+      res = client.get_service_status
+      refute_empty res.parse
+    end
+  end
+end

data/test/integration/test_orders.rb

@@ -2,6 +2,26 @@ require 'helper'
 require 'mws/orders'
 
 class TestOrders < IntegrationTest
+  def test_gets_orders
+    clients.each do |client|
+      order_ids = client
+        .list_orders(
+          created_after: Date.new(2015),
+          max_results_per_page: 5
+        )
+        .parse
+        .dig('Orders', 'Order')
+        .map { |order| order['AmazonOrderId'] }
+
+      orders = client
+        .get_order(*order_ids)
+        .parse
+        .dig('Orders', 'Order')
+
+      assert_equal order_ids.count, orders.count
+    end
+  end
+
   def test_gets_service_status
     clients.each do |client|
       res = client.get_service_status

data/test/unit/mws/test_merchant_fulfillment_client.rb

@@ -0,0 +1,83 @@
+require 'helper'
+require 'mws/merchant_fulfillment/client'
+
+class TestMWSMerchantFulfillmentClient < MiniTest::Test
+  def setup
+    @client = MWS::MerchantFulfillment::Client.new
+  end
+
+  def test_gets_eligible_shipping_services
+    operation = {
+      'Action' => 'GetEligibleShippingServices',
+      'ShipmentRequestDetails.Id' => '123',
+      'ShipmentRequestDetails.Foo.Bar' => 'baz'
+    }
+
+    @client.stub(:run, nil) do
+      shipment_request_details = {
+        id: '123',
+        foo: { bar: 'baz' }
+      }
+      @client.get_eligible_shipping_services(shipment_request_details)
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_creates_shipment
+    operation = {
+      'Action' => 'CreateShipment',
+      'ShipmentRequestDetails.Id' => '123',
+      'ShipmentRequestDetails.Foo.Bar' => 'baz',
+      'ShippingServiceId' => 'FOO'
+    }
+
+    @client.stub(:run, nil) do
+      shipment_request_details = {
+        id: '123',
+        foo: { bar: 'baz' }
+      }
+      @client.create_shipment(shipment_request_details, 'FOO')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_shipment
+    operation = {
+      'Action' => 'GetShipment',
+      'ShipmentId' => '123'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_shipment('123')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_cancels_shipment
+    operation = {
+      'Action' => 'CancelShipment',
+      'ShipmentId' => '123'
+    }
+
+    @client.stub(:run, nil) do
+      @client.cancel_shipment('123')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_service_status
+    operation = {
+      'Action' => 'GetServiceStatus'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_service_status
+    end
+
+    assert_equal operation, @client.operation
+  end
+end

data/test/unit/peddler/test_client.rb

@@ -51,11 +51,11 @@ class TestPeddlerClient < MiniTest::Test
   end
 
   def test_params_include_seller_id
-    assert @klass.params.key?("SellerId")
+    assert @klass.params.key?('SellerId')
   end
 
   def test_params_include_auth_token
-    @klass.params.key?("MWSAuthToken")
+    @klass.params.key?('MWSAuthToken')
   end
 
   def test_configures
@@ -114,9 +114,8 @@ class TestPeddlerClient < MiniTest::Test
     assert_equal @body, chunks
   end
 
-  def test_request_preserves_user_agent
-    instrumentor = Class.new
-    class << instrumentor
+  class Instrumentor
+    class << self
       attr_accessor :events
 
       def instrument(name, params = {})
@@ -124,11 +123,14 @@ class TestPeddlerClient < MiniTest::Test
         yield if block_given?
       end
     end
-    instrumentor.events = {}
 
-    @client.defaults.update(instrumentor: instrumentor)
+    @events = {}
+  end
+
+  def test_request_preserves_user_agent
+    @client.defaults.update(instrumentor: Instrumentor)
     @client.run
-    headers = instrumentor.events['excon.request'][:headers]
+    headers = Instrumentor.events['excon.request'][:headers]
 
     assert headers.key?('User-Agent')
   end
@@ -214,8 +216,8 @@ class TestPeddlerClient < MiniTest::Test
 
   def test_deprecated_marketplace_id_accessor
     refute_nil @client.marketplace_id
-    @client.marketplace_id = "123"
-    assert_equal "123", @client.marketplace_id
+    @client.marketplace_id = '123'
+    assert_equal '123', @client.marketplace_id
     assert_equal @client.primary_marketplace_id, @client.marketplace_id
   end
 end

data/test/unit/peddler/test_vcr_matcher.rb

@@ -17,20 +17,20 @@ class TestPeddlerVCRMatcher < MiniTest::Test
   end
 
   def test_matches_recorded_post_with_body
-    client.body = "content"
+    client.body = 'content'
     client.run
   end
 
   def test_wont_match_unrecorded_post_with_different_query_and_same_body
     client.operation.add(foo: 'bar')
-    client.body = "content"
+    client.body = 'content'
     assert_raises(VCR::Errors::UnhandledHTTPRequestError) do
       client.run
     end
   end
 
   def test_wont_match_unrecorded_post_with_same_query_and_different_body
-    client.body = "other content"
+    client.body = 'other content'
     assert_raises(VCR::Errors::UnhandledHTTPRequestError) do
       client.run
     end