peddler 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7ac83135cc31198b41fceb4be3028d9944e702a
-  data.tar.gz: 5a48846777e07c4eb00cd068a81ca08586074a25
+  metadata.gz: 07a989e34449ab73ff6adc3cd7299ac218394f9e
+  data.tar.gz: cc04a47b2d89407875b67728a0067b84fa8e1e72
 SHA512:
-  metadata.gz: ff2c5463b8af1784df36c2040f1f149b8c80d9c0dc4f57ec2a1ed3a9550c72d3e9a9725a3c09061458ef33abb0bce0b7be30ad6bbbcddaf7c1c5a11a9a3c58a7
-  data.tar.gz: 9148086d4d91c67a83be7a999da65dd492b6db60d08c704ce58286fff11f7a25e73cbddd477b25957a42f329b15b4459c1e3df11590f39239554268d34ff9b0d
+  metadata.gz: 631af106e16507f94106ac30855787fc8b4dba465859863ee7fe5d057aef1ba8273aaefe8c34e985884d4ad14ce1332fad7730a19166e763072b7941a15f9cbd
+  data.tar.gz: b6db581788899e2da6f3aa24f16d9aa7a085eefc09d90ea38cbddb852f3aa8475bbd85104ac1d682d311a77a6a266ebdd7037e35c5307c130573e94b6db98b83

data/README.md

@@ -11,40 +11,46 @@ To use Amazon MWS, you must have an eligible seller account.
 
 ![Peddler](http://f.cl.ly/items/231z2m0r1Q2o2q1n0w1N/peddler.jpg)
 
-## Scope
-
-**Peddler** maps one on one to the MWS APIs and their various operations. It treats required request parameters as ordinary arguments and optional ones as keyword arguments. It parses XML responses with [**MultiXml**](https://github.com/sferik/multi_xml), which helps cast the result nodes into Ruby Hashes. Tab-delimited files are handled with Standard Library's [**CSV**](https://github.com/ruby/ruby/blob/trunk/lib/csv.rb).
-
-Further abstraction is not in the scope of this project. See [**MWS Orders**](https://github.com/hakanensari/mws-orders) for a richer interface to the same-named API, built on **Peddler**.
-
 ## Quick Start
 
 ```ruby
 require 'peddler'
 
 client = MWS.orders
-parser = client.list_orders(created_after: 1.month.ago)
+parser = client.get_service_status
 parser.parse
 ```
 
+You can handle HTTP client errors by rescuing API calls individually or defining a global handler on the client level:
+
+```ruby
+client.on_error do |request, response|
+  if response.status == 503
+    # handle throttling by backing off and retrying
+  end
+end
+```
+
+## Credentials
+
 You can set up credentials when instantiating:
 
 ```ruby
 client = MWS.orders(
-  marketplace_id:        "YOUR_MARKETPLACE_ID",
-  merchant_id:           "YOUR_MERCHANT_ID",
-  aws_access_key_id:     "YOUR_AWS_ACCESS_KEY_ID",
-  aws_secret_access_key: "YOUR_AWS_SECRET_ACCESS_KEY"
+  marketplace_id:        "...",
+  merchant_id:           "...",
+  aws_access_key_id:     "...",
+  aws_secret_access_key: "..."
 )
 ```
 
-Alternatively, you can use environment variables if you only have a single set of credentials:
+Alternatively, use environment variables:
 
 ```sh
-export MWS_MARKETPLACE_ID=YOUR_MARKETPLACE_ID
-export MWS_MERCHANT_ID=YOUR_MERCHANT_ID
-export AWS_ACCESS_KEY_ID=YOUR_AWS_ACCESS_KEY_ID
-export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY
+export MWS_MARKETPLACE_ID=...
+export MWS_MERCHANT_ID=...
+export AWS_ACCESS_KEY_ID=...
+export AWS_SECRET_ACCESS_KEY=...
 ```
 
 ## Usage
@@ -53,31 +59,31 @@ export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY
 
 With the MWS Cart Information API, you can retrieve shopping carts that your Amazon Webstore customers have created. The Cart Information API enables you to programmatically integrate Amazon Webstore cart information with your CRM systems, marketing applications, and other systems that require cart data.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/CartInformation/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/CartInformation/Client)
 
 ### Customer Information
 
 With the MWS Customer Information API, you can retrieve information from the customer accounts of your Amazon Webstore customers. This customer information includes customer name, contact information, customer account type, and associated Amazon Webstore marketplaces. The Customer Information API enables you to programmatically integrate Amazon Webstore customer account information with your CRM systems, marketing applications, and other systems that require customer data.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/CustomerInformation/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/CustomerInformation/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.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/Feeds/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/Feeds/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.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/FulfillmentInboundShipment/Client)
+[Read the API](http://www.rubydoc.info/gems/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.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/FulfillmentInventory/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentInventory/Client)
 
 ### Fulfillment Outbound Shipment
 
@@ -85,7 +91,7 @@ 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.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/FulfillmentOutboundShipment/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/FulfillmentOutboundShipment/Client)
 
 ### Off Amazon Payments
 
@@ -97,40 +103,40 @@ You can switch the client to the sandbox environment:
 client = MWS.off_amazon_payments.sandbox
 ```
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/OffAmazonPayments/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/OffAmazonPayments/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.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/Orders/Client)
+[Read the API](http://www.rubydoc.info/gems/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.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/Products/Client)
+[Read the API](http://www.rubydoc.info/gems/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.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/Recommendations/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/Recommendations/Client)
 
 ### Reports
 
 The Reports API lets you request reports about your inventory and orders.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/Reports/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/Reports/Client)
 
 ### Sellers
 
 The Sellers API lets sellers retrieve information about their seller account, such as the marketplaces they participate in.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/Sellers/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/Sellers/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.
 
-[Read the API](http://rubydoc.info/github/hakanensari/peddler/MWS/Subscriptions/Client)
+[Read the API](http://www.rubydoc.info/gems/peddler/MWS/Subscriptions/Client)

data/lib/peddler/client.rb

@@ -1,33 +1,22 @@
+require 'forwardable'
 require 'jeff'
+require 'peddler/marketplace'
 require 'peddler/operation'
 require 'peddler/parser'
 
 module Peddler
   # @abstract Subclass to implement an MWS API section.
   class Client
+    extend Forwardable
     include Jeff
 
-    BadMarketplaceId = Class.new(StandardError)
-
-    HOSTS = {
-      'A2EUQ1WTGCTBG2' => 'mws.amazonservices.ca',
-      'AAHKV2X7AFYLW'  => 'mws.amazonservices.com.cn',
-      'A1PA6795UKMFR9' => 'mws-eu.amazonservices.com',
-      'A1RKKUPIHCS9HS' => 'mws-eu.amazonservices.com',
-      'A13V1IB3VIYZZH' => 'mws-eu.amazonservices.com',
-      'A1F83G8C2ARO7P' => 'mws-eu.amazonservices.com',
-      'A21TJRUUN4KGV'  => 'mws.amazonservices.in',
-      'APJ6JRA9NG5V4'  => 'mws-eu.amazonservices.com',
-      'A1VC38T7YXB528' => 'mws.amazonservices.jp',
-      'ATVPDKIKX0DER'  => 'mws.amazonservices.com'
-    }
-
-    attr_accessor :path
-    attr_writer :merchant_id, :marketplace_id
+    attr_writer :merchant_id, :marketplace_id, :path
     attr_reader :body
 
     alias_method :configure, :tap
 
+    def_delegators :marketplace, :host, :encoding
+
     params('SellerId' => -> { merchant_id })
 
     def self.parser
@@ -51,7 +40,7 @@ module Peddler
     end
 
     def aws_endpoint
-      "https://#{host}#{path || self.class.path}"
+      "https://#{host}#{path}"
     end
 
     def marketplace_id
@@ -62,6 +51,10 @@ module Peddler
       @merchant_id ||= ENV['MWS_MERCHANT_ID']
     end
 
+    def marketplace
+      @marketplace ||= find_marketplace
+    end
+
     def defaults
       @defaults ||= { expects: 200 }
     end
@@ -70,11 +63,19 @@ module Peddler
       @headers ||= {}
     end
 
+    def path
+      @path ||= self.class.path
+    end
+
     def body=(str)
       headers['Content-Type'] = content_type(str)
       @body = str
     end
 
+    def on_error(&blk)
+      @error_handler = blk
+    end
+
     def operation(action = nil)
       action ? @operation = Operation.new(action) : @operation
     end
@@ -85,35 +86,25 @@ module Peddler
       opts.store(:response_block, blk) if block_given?
       res = post(opts)
 
-      parser.parse(res, host_encoding)
+      parser.parse(res, encoding)
+    rescue Excon::Errors::Error => ex
+      handle_error(ex) or raise
     end
 
     private
 
+    def find_marketplace
+      Marketplace.new(marketplace_id)
+    end
+
     def content_type(str)
       if str.start_with?('<?xml')
         'text/xml'
       else
-        "text/tab-separated-values; charset=#{host_encoding}"
+        "text/tab-separated-values; charset=#{encoding}"
       end
     end
 
-    def host_encoding
-      if host.end_with?('jp')
-        # Caveat: I've had one instance in the past where Shift_JIS didn't
-        # work but Windows-31J did when parsing a report.
-        'Shift_JIS'
-      elsif host.end_with?('cn')
-        'UTF-16'
-      else
-        'ISO-8859-1'
-      end
-    end
-
-    def host
-      HOSTS.fetch(marketplace_id) { raise BadMarketplaceId }
-    end
-
     def extract_options(args)
       args.last.is_a?(Hash) ? args.pop : {}
     end
@@ -121,5 +112,10 @@ module Peddler
     def parser
       self.class.parser
     end
+
+    def handle_error(ex)
+      return false unless @error_handler
+      @error_handler.call(ex.request, ex.response)
+    end
   end
 end

data/lib/peddler/marketplace.rb

@@ -0,0 +1,55 @@
+module Peddler
+  # @api private
+  class Marketplace
+    HOSTS = {
+      'A2EUQ1WTGCTBG2' => 'mws.amazonservices.ca',
+      'AAHKV2X7AFYLW'  => 'mws.amazonservices.com.cn',
+      'A1PA6795UKMFR9' => 'mws-eu.amazonservices.com',
+      'A1RKKUPIHCS9HS' => 'mws-eu.amazonservices.com',
+      'A13V1IB3VIYZZH' => 'mws-eu.amazonservices.com',
+      'A1F83G8C2ARO7P' => 'mws-eu.amazonservices.com',
+      'A21TJRUUN4KGV'  => 'mws.amazonservices.in',
+      'APJ6JRA9NG5V4'  => 'mws-eu.amazonservices.com',
+      'A1VC38T7YXB528' => 'mws.amazonservices.jp',
+      'ATVPDKIKX0DER'  => 'mws.amazonservices.com'
+    }
+
+    BadId = Class.new(StandardError)
+
+    attr_reader :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def host
+      @host ||= find_host
+    end
+
+    def encoding
+      if japanese?
+        # Caveat: I've had one instance in the past where Shift_JIS didn't
+        # work but Windows-31J did when parsing a report.
+        'Shift_JIS'
+      elsif chinese?
+        'UTF-16'
+      else
+        'ISO-8859-1'
+      end
+    end
+
+    private
+
+    def find_host
+      HOSTS.fetch(id) { raise BadId }
+    end
+
+    def japanese?
+      host.end_with?('jp')
+    end
+
+    def chinese?
+      host.end_with?('cn')
+    end
+  end
+end

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '0.9.2'
+  VERSION = '0.10.0'
 end

data/test/unit/peddler/test_client.rb

@@ -64,14 +64,6 @@ class TestPeddlerClient < MiniTest::Test
     assert_equal '123', client.aws_access_key_id
   end
 
-  def test_guards_against_bad_marketplace_id
-    assert_raises(Peddler::Client::BadMarketplaceId) do
-      client = Peddler::Client.new
-      client.marketplace_id = '123'
-      client.get
-    end
-  end
-
   def test_sets_content_type_header_for_latin_flat_file_body
     @client.body = 'foo'
     content_type = @client.headers.fetch('Content-Type')
@@ -133,4 +125,20 @@ class TestPeddlerClient < MiniTest::Test
 
     assert headers.has_key?('User-Agent')
   end
+
+  def test_error_callback
+    Excon.stub({}, { status: 503 })
+
+    assert_raises(Excon::Errors::ServiceUnavailable) do
+      @client.run
+    end
+
+    @client.on_error do |_, res|
+      assert_equal 503, res.status
+    end
+
+    @client.run
+
+    Excon.stubs.clear
+  end
 end

data/test/unit/peddler/test_marketplace.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+require 'peddler/marketplace'
+
+class TestPeddlerMarketplace < MiniTest::Test
+  def setup
+    @marketplace = Peddler::Marketplace.new('ATVPDKIKX0DER')
+  end
+
+  def test_has_a_host
+    assert @marketplace.host
+  end
+
+  def test_has_an_encoding
+    assert @marketplace.encoding
+  end
+
+  def test_guards_against_bad_marketplace_ids
+    assert_raises(Peddler::Marketplace::BadId) do
+      marketplace = Peddler::Marketplace.new('123')
+      marketplace.host
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeff
@@ -77,6 +77,7 @@ files:
 - lib/peddler.rb
 - lib/peddler/client.rb
 - lib/peddler/flat_file_parser.rb
+- lib/peddler/marketplace.rb
 - lib/peddler/operation.rb
 - lib/peddler/parser.rb
 - lib/peddler/structured_list.rb
@@ -104,6 +105,7 @@ files:
 - test/unit/mws/test_products_client.rb
 - test/unit/peddler/test_client.rb
 - test/unit/peddler/test_flat_file_parser.rb
+- test/unit/peddler/test_marketplace.rb
 - test/unit/peddler/test_operation.rb
 - test/unit/peddler/test_parser.rb
 - test/unit/peddler/test_structured_list.rb
@@ -142,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Wraps the Amazon MWS APIs
@@ -169,6 +171,7 @@ test_files:
 - test/unit/mws/test_products_client.rb
 - test/unit/peddler/test_client.rb
 - test/unit/peddler/test_flat_file_parser.rb
+- test/unit/peddler/test_marketplace.rb
 - test/unit/peddler/test_operation.rb
 - test/unit/peddler/test_parser.rb
 - test/unit/peddler/test_structured_list.rb