peddler 0.12.5 → 0.12.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4211dcab3a4f1c013f7fe9ab4faf010df8c57115
-  data.tar.gz: 17e694bcc21a74005d63f1ff6eb238dadb68d5e0
+  metadata.gz: 30436cbe660437bbf9bd37c50f71e97cd5ea3dba
+  data.tar.gz: daf21940a611131fb3fe34a12d4bad5d25fabca1
 SHA512:
-  metadata.gz: 0073a4510d9d067a4916bff357cbfe66909857ef112f94b207343d880784a5a25183ba9749f8236bd96e2c1434e83cb955de8ec90be0c4170bc847e53eaaab9b
-  data.tar.gz: 19dd1e5f4a79ef387e3445348ce6b6ff68b5bb09f50dbb4e104023cc4e4f1b26139317098e4fe647d5e835d4940055bc911a6370b3d96f9ad4fb754d2de6f27c
+  metadata.gz: fcd83c8e7ce9ff05bacdf5344acaae8537a64fcd3f34aa43ab9e115cca5518691ce9daa07b6520ed5229f7f6b5703be7f8c4c8668865ac85ce3f33f574668be6
+  data.tar.gz: 69af1faee5272ec880e01bc835e6c88e771b44cdc6f43c6f2b549d9798dcb59d69a0a40d6427ba981bc984b22b106dfad2b9867ec64fe20f2b1dcdf06b2c33e8

data/README.md

@@ -2,8 +2,8 @@
 # Peddler
 
 [![Build Status](https://travis-ci.org/hakanensari/peddler.svg)](https://travis-ci.org/hakanensari/peddler)
-[![Code Climate](http://img.shields.io/codeclimate/github/hakanensari/peddler.svg)](https://codeclimate.com/github/hakanensari/peddler)
-[![Coverage Status](http://img.shields.io/coveralls/hakanensari/peddler/master.svg)](https://coveralls.io/r/hakanensari/peddler)
+[![Code Climate](https://codeclimate.com/github/hakanensari/peddler/badges/gpa.svg)](https://codeclimate.com/github/hakanensari/peddler)
+[![Coverage Status](https://coveralls.io/repos/hakanensari/peddler/badge.svg?branch=master)](https://coveralls.io/r/hakanensari/peddler?branch=master)
 
 **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.
 
@@ -49,9 +49,11 @@ If instantiating a client for another seller, you have to provide the `MWSAuthTo
 
 ```ruby
 client = MWS.orders(
-  marketplace_id: "...",
-  merchant_id:    "...",
-  auth_token:     "..."
+  marketplace_id:        "...",
+  merchant_id:           "...",
+  aws_access_key_id:     "...",
+  aws_secret_access_key: "...",
+  auth_token:            "..."
 )
 ```
 

data/lib/mws/fulfillment_inbound_shipment/client.rb

@@ -82,6 +82,7 @@ module MWS
             'ShipmentType' => shipment_type,
             'TransportDetails' => transport_details
           )
+          .structure!('PackageList', 'member')
 
         run
       end

data/lib/mws/subscriptions/client.rb

@@ -137,7 +137,7 @@ module MWS
       # @param marketplace_id [String]
       # @return [Peddler::XMLParser]
       def update_subscription(notification_type, sqs_queue_url, enabled, marketplace_id = marketplace_id())
-        operation('CreateSubscription')
+        operation('UpdateSubscription')
           .add('MarketplaceId' => marketplace_id)
           .add(build_subscription(notification_type, sqs_queue_url, enabled))
 

data/lib/peddler/client.rb

@@ -84,10 +84,10 @@ module Peddler
       action ? @operation = Operation.new(action) : @operation
     end
 
-    def run(&blk)
+    def run
       opts = defaults.merge(query: operation, headers: headers)
       opts.store(:body, body) if body
-      opts.store(:response_block, blk) if block_given?
+      opts.store(:response_block, Proc.new) if block_given?
       res = post(opts)
 
       parser.parse(res, encoding)

data/lib/peddler/flat_file_response.rb

@@ -0,0 +1,53 @@
+require 'delegate'
+require 'csv'
+require 'digest/md5'
+
+module Peddler
+  # @api private
+  class FlatFileResponse < SimpleDelegator
+    # http://stackoverflow.com/questions/8073920/importing-csv-quoting-error-is-driving-me-nuts
+    OPTIONS = { col_sep: "\t", quote_char: "\x00", headers: true }
+
+    attr_reader :content, :summary, :encoding
+
+    def initialize(res, encoding)
+      super(res)
+      @encoding = encoding
+      extract_content
+    end
+
+    def parse
+      CSV.parse(scrub_content, OPTIONS) if content
+    end
+
+    def records_count
+      summarize if summary?
+    end
+
+    def valid?
+      headers['Content-MD5'] == Digest::MD5.base64digest(body)
+    end
+
+    private
+
+    def extract_content
+      if summary?
+        @summary, @content = body.split("\n\n")
+      else
+        @content = body.dup
+      end
+    end
+
+    def scrub_content
+      content.force_encoding(encoding).encode('UTF-8')
+    end
+
+    def summary?
+      body.start_with?('Feed Processing Summary')
+    end
+
+    def summarize
+      Hash[summary.split("\n\t")[1, 2].map { |line| line.split("\t\t") }]
+    end
+  end
+end

data/lib/peddler/operation.rb

@@ -10,11 +10,11 @@ module Peddler
     end
 
     def structure!(*list_keys)
-      list_key = list_keys.first
+      list_key = list_keys.shift
 
-      if key?(list_key)
-        builder = StructuredList.new(*list_keys)
-        vals = delete(list_key)
+      if found_key = keys.find { |key| key.end_with?(list_key) }
+        builder = StructuredList.new(found_key, *list_keys)
+        vals = delete(found_key)
         update(builder.build(vals))
       end
 

data/lib/peddler/response.rb

@@ -0,0 +1,24 @@
+require 'peddler/flat_file_response'
+require 'peddler/xml_response'
+
+module Peddler
+  # @api private
+  module Response
+    # The inevitable messiness of massaging data produced by a motley army of
+    # Amazon developers
+    def self.new(response, encoding = 'ISO-8859-1')
+      # Don't parse if there's no body
+      return response unless response.body
+
+      content_type = response.headers['Content-Type']
+      if content_type.start_with?('text/xml')
+        XMLResponse.new(response)
+      else
+        # Amazon returns a variety of content types for flat files, so we
+        # simply assume that anything not XML is a flat file rather than code
+        # defensively and check content type again.
+        FlatFileResponse.new(response, encoding)
+      end
+    end
+  end
+end

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '0.12.5'
+  VERSION = '0.12.7'
 end

data/lib/peddler/xml_response.rb

@@ -0,0 +1,30 @@
+require 'delegate'
+require 'multi_xml'
+
+module Peddler
+  # @api private
+  class XMLResponse < SimpleDelegator
+    def next_token
+      parse.fetch('NextToken', false)
+    end
+
+    def parse
+      @result ||= find_result
+    end
+
+    def document
+      MultiXml.parse(body)
+    end
+
+    def valid?
+      headers['Content-Length'].to_i == body.size if headers['Content-Length']
+    end
+
+    private
+
+    def find_result
+      results = document.values[0].find { |k, _| k.include?('Result') }
+      results ? results.last : nil
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,74 @@
+require 'coveralls'
+Coveralls.wear!
+require 'minitest/autorun'
+require 'yaml'
+require 'vcr'
+begin
+  require 'pry'
+rescue LoadError
+end
+
+# Wraps MWS credentials to run integration tests against
+#
+# Replace entries in the fixture file with real credentials if adding new tests
+# or otherwise testing against live data.
+module Accounts
+  extend Enumerable
+
+  def self.each(&blk)
+    @data.each(&blk)
+  end
+
+  @data = YAML.load_file(File.expand_path('../mws.yml', __FILE__))
+end
+
+# Sets up clients and bootstraps VCR for integration tests
+class IntegrationTest < MiniTest::Test
+  def setup
+    ENV['LIVE'] ? VCR.turn_off! : VCR.insert_cassette(api)
+  end
+
+  def teardown
+    VCR.eject_cassette if VCR.turned_on?
+  end
+
+  def clients
+    Accounts.map do |account|
+      klass = MWS.const_get("#{api}::Client")
+      klass.new(account)
+    end
+  end
+
+  private
+
+  def api
+    self.class.name.sub('Test', '')
+  end
+end
+
+VCR.configure do |c|
+  c.hook_into :excon
+  c.cassette_library_dir = 'test/vcr_cassettes'
+
+  # HTTP errors are not Peddler's concern, so ignore them to ease development.
+  c.before_record do |interaction|
+    interaction.ignore! if interaction.response.status.code >= 400
+  end
+
+  # Ignore transient params when building VCR fixtures.
+  matcher = VCR.request_matchers.uri_without_param(
+    'AWSAccessKeyId', 'SellerId', 'Signature', 'Timestamp', 'StartDate',
+    'CreatedAfter', 'QueryStartDateTime'
+  )
+
+  c.default_cassette_options = {
+    match_requests_on: [:host, :path, matcher],
+    record: :none
+  }
+
+  # So that fixtures do not depend on merchant credentials
+  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'] }
+  end
+end

data/test/integration/test_cart_information.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/cart_information'
 
 class TestCartInformation < IntegrationTest

data/test/integration/test_customer_information.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/customer_information'
 
 class TestCustomerInformation < IntegrationTest

data/test/integration/test_feeds.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/feeds'
 
 class TestFeeds < IntegrationTest

data/test/integration/test_fulfillment_inbound_shipment.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/fulfillment_inbound_shipment'
 
 class TestFulfillmentInboundShipment < IntegrationTest

data/test/integration/test_fulfillment_inventory.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/fulfillment_inventory'
 
 class TestFulfillmentInventory < IntegrationTest

data/test/integration/test_fulfillment_outbound_shipment.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/fulfillment_outbound_shipment'
 
 class TestFulfillmentOutboundShipment < IntegrationTest

data/test/integration/test_off_amazon_payments.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/off_amazon_payments'
 
 class TestOffAmazonPayments < IntegrationTest

data/test/integration/test_orders.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/orders'
 
 class TestOrders < IntegrationTest

data/test/integration/test_products.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/products'
 
 class TestProducts < IntegrationTest

data/test/integration/test_recommendations.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/recommendations'
 
 class TestRecommendations < IntegrationTest

data/test/integration/test_reports.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/reports'
 
 class TestReports < IntegrationTest

data/test/integration/test_sellers.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/sellers'
 
 class TestSellers < IntegrationTest

data/test/integration/test_subscriptions.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/subscriptions'
 
 class TestSubscriptions < IntegrationTest

data/test/integration/test_webstore.rb

@@ -1,4 +1,4 @@
-require 'integration_test_helper'
+require 'helper'
 require 'mws/webstore'
 
 class TestWebstore < IntegrationTest

data/test/unit/mws/test_cart_information_client.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require 'helper'
 require 'mws/cart_information/client'
 
-class TestCartInformationClient < MiniTest::Test
+class TestMWSCartInformationClient < MiniTest::Test
   def setup
     @client = MWS::CartInformation::Client.new
   end

data/test/unit/mws/test_customer_information_client.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require 'helper'
 require 'mws/customer_information/client'
 
-class TestCustomerInformationClient < MiniTest::Test
+class TestMWSCustomerInformationClient < MiniTest::Test
   def setup
     @client = MWS::CustomerInformation::Client.new
   end

data/test/unit/mws/test_feeds_client.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require 'helper'
 require 'mws/feeds/client'
 
-class TestFeedsClient < MiniTest::Test
+class TestMWSFeedsClient < MiniTest::Test
   def setup
     @client = MWS::Feeds::Client.new
   end

data/test/unit/mws/test_fulfillment_inbound_shipment_client.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require 'helper'
 require 'mws/fulfillment_inbound_shipment/client'
 
-class TestFulfillmentInboundShipmentClient < MiniTest::Test
+class TestMWSFulfillmentInboundShipmentClient < MiniTest::Test
   def setup
     @client = MWS::FulfillmentInboundShipment::Client.new
   end
@@ -51,16 +51,24 @@ class TestFulfillmentInboundShipmentClient < MiniTest::Test
   end
 
   def test_puts_transport_content
+    transport_details = {
+      'ParcelData' => {
+        'PackageList' => {
+          'TrackingId' => '123'
+        }
+      }
+    }
+
     operation = {
       'Action' => 'PutTransportContent',
       'ShipmentId' => '1',
       'IsPartnered' => true,
       'ShipmentType' => 'Foo',
-      'TransportDetails.Foo' => '1'
+      'TransportDetails.ParcelData.PackageList.TrackingId' => '123'
     }
 
     @client.stub(:run, nil) do
-      @client.put_transport_content('1', true, 'Foo', { 'Foo' => '1' })
+      @client.put_transport_content('1', true, 'Foo', transport_details)
     end
 
     assert_equal operation, @client.operation

data/test/unit/mws/test_fulfillment_inventory_client.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require 'helper'
 require 'mws/fulfillment_inventory/client'
 
-class TestFulfillmentInventoryClient < MiniTest::Test
+class TestMWSFulfillmentInventoryClient < MiniTest::Test
   def setup
     @client = MWS::FulfillmentInventory::Client.new
   end

data/test/unit/mws/test_fulfillment_outbound_shipment_client.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require 'helper'
 require 'mws/fulfillment_outbound_shipment/client'
 
-class TestFulfillmentOutboundShipmentClient < MiniTest::Test
+class TestMWSFulfillmentOutboundShipmentClient < MiniTest::Test
   def setup
     @client = MWS::FulfillmentOutboundShipment::Client.new
   end

data/test/unit/mws/test_off_amazon_payments_client.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'helper'
 require 'mws/off_amazon_payments/client'
 
 class TestMWSOffAmazonPaymentsClient < MiniTest::Test

data/test/unit/mws/test_orders_client.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require 'helper'
 require 'mws/orders/client'
 
-class TestOrdersClient < MiniTest::Test
+class TestMWSOrdersClient < MiniTest::Test
   def setup
     @client = MWS::Orders::Client.new
   end

data/test/unit/mws/test_products_client.rb

@@ -1,14 +1,165 @@
-require 'test_helper'
+require 'helper'
 require 'mws/products/client'
 
-class TestProductsClient < MiniTest::Test
+class TestMWSProductsClient < MiniTest::Test
   def setup
     @client = MWS::Products::Client.new
+    @client.marketplace_id = '123'
   end
 
-  def test_operation_includes_marketplace_id
-    client = MWS::Products::Client.new
-    assert client.operation_with_marketplace('Foo').has_key?('MarketplaceId')
+  def test_lists_matching_products
+    operation = {
+      'Action' => 'ListMatchingProducts',
+      'MarketplaceId' => '123',
+      'Query' => 'foo'
+    }
+
+    @client.stub(:run, nil) do
+      @client.list_matching_products('foo')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_matching_product_for_id
+    operation = {
+      'Action' => 'GetMatchingProductForId',
+      'MarketplaceId' => '123',
+      'IdType' => 'foo',
+      'IdList.Id.1' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_matching_product_for_id('foo', '1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_matching_product
+    operation = {
+      'Action' => 'GetMatchingProduct',
+      'MarketplaceId' => '123',
+      'ASINList.ASIN.1' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_matching_product('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_competitive_pricing_for_sku
+    operation = {
+      'Action' => 'GetCompetitivePricingForSKU',
+      'MarketplaceId' => '123',
+      'SellerSKUList.SellerSKU.1' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_competitive_pricing_for_sku('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_competitive_pricing_for_asin
+    operation = {
+      'Action' => 'GetCompetitivePricingForASIN',
+      'MarketplaceId' => '123',
+      'ASINList.ASIN.1' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_competitive_pricing_for_asin('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_lowest_offer_listings_for_sku
+    operation = {
+      'Action' => 'GetLowestOfferListingsForSKU',
+      'MarketplaceId' => '123',
+      'SellerSKUList.SellerSKU.1' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_lowest_offer_listings_for_sku('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_lowest_offer_listings_for_asin
+    operation = {
+      'Action' => 'GetLowestOfferListingsForASIN',
+      'MarketplaceId' => '123',
+      'ASINList.ASIN.1' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_lowest_offer_listings_for_asin('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_my_price_for_sku
+    operation = {
+      'Action' => 'GetMyPriceForSKU',
+      'MarketplaceId' => '123',
+      'SellerSKUList.SellerSKU.1' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_my_price_for_sku('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_my_price_for_asin
+    operation = {
+      'Action' => 'GetMyPriceForASIN',
+      'MarketplaceId' => '123',
+      'ASINList.ASIN.1' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_my_price_for_asin('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_product_categories_for_sku
+    operation = {
+      'Action' => 'GetProductCategoriesForSKU',
+      'MarketplaceId' => '123',
+      'SellerSKU' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_product_categories_for_sku('1')
+    end
+
+    assert_equal operation, @client.operation
+  end
+
+  def test_gets_product_categories_for_asin
+    operation = {
+      'Action' => 'GetProductCategoriesForASIN',
+      'MarketplaceId' => '123',
+      'ASIN' => '1'
+    }
+
+    @client.stub(:run, nil) do
+      @client.get_product_categories_for_asin('1')
+    end
+
+    assert_equal operation, @client.operation
   end
 
   def test_gets_service_status
@@ -22,6 +173,4 @@ class TestProductsClient < MiniTest::Test
 
     assert_equal operation, @client.operation
   end
-
-  # FIXME Fill in tests for operations
 end