peddler 1.6.6 → 1.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f768c3add9b97c6d2af14872792feb553197fdb8
-  data.tar.gz: f33a7fd7ca78654a866191f0d2b5ac17629d0b38
+SHA256:
+  metadata.gz: a8911af92b466d1ec833d6d1405607440ba190670893b2e4565109a4d00fe866
+  data.tar.gz: 2e9546d098f60386f2f58ea825089448f3334ab6b92c3547dc75ead634a7d808
 SHA512:
-  metadata.gz: 289d38d3d615f8f99c6695b4a665fdc6a464b104df4f23fc7bfcb4074c9689d02bead5e8418c3f8746e13ffb1f8cf0e94b021cbe9d8c65d2f614d3d946ba71d9
-  data.tar.gz: 628fdb1df72fe2e9164fb90c2dc4a7cbdd2307409e1b5ae9870756917c982474c3112ce33e212b38731e3e0412ae8b83719fef5bfe8f4b6c1f1e35b70ebe4b23
+  metadata.gz: 275440d472e985342f9f764bd1e59e975a772d9ca02baec77c05d28458679c9c9b463925fca0afacd18fe1baa31e37983625bc252d53f429a25e7162a978c1fe
+  data.tar.gz: 4709a75480e4c51d0fe86bd6d78bca3f10197d18950ffbeabd70c63d49325f7adfce62102e4eff83b05ce312954b19e51b4cddfb9da7b22aa27f447c54b38986

data/README.md

@@ -87,9 +87,27 @@ MWS::Orders::Client.parser = MyParser
 
 For a sample implementation, see my [MWS Orders](https://github.com/hakanensari/mws-orders) library.
 
+### Throttling
+
+Amazon limits the number of requests you can submit to a given operation in a given amount of time.
+
+Peddler exposes header values showing the hourly quota of the current operation:
+
+```ruby
+res = client.some_method
+puts res.quota
+#<struct Quota max=200, remaining=150, resets_on=2017-01-01 00:12:00 UTC>
+```
+
+Read Amazon's tips on how to avoid throttling [here](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Throttling.html).
+
 ### Debugging
 
-To introspect requests, set the `EXCON_DEBUG` environment variable to a truthy value when making requests.
+If you are having trouble with a request, read [Amazon documentation](https://developer.amazonservices.com/gp/mws/docs.html). Peddler's source links individual operations to their corresponding entries in the Amazon docs.
+
+Note that some optional keywords have default values.
+
+To introspect requests, set the `EXCON_DEBUG` environment variable to `1` or similar truthy value. Peddler will then log request and response internals to stdout.
 
 ### Errors
 
@@ -114,6 +132,14 @@ rescue Excon::Error::ServiceUnavailable => e
 end
 ```
 
+Peddler has an optional new error handler that raises more descriptive errors: for instance, `Peddler::Errors::RequestThrottled` instead of `Excon::Error::ServiceUnavailable`. This error handler will become the default in the next major version.
+
+To start using this now:
+
+```ruby
+require 'peddler/errors'
+```
+
 ## The APIs
 
 ### Feeds

data/lib/peddler/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'peddler/errors/handler'
+
+module Peddler
+  # @api private
+  module Errors
+    MWS.constants.each do |klass|
+      MWS.const_get(klass).const_get(:Client).error_handler = Handler
+    end
+  end
+end

data/lib/peddler/version.rb

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

data/test/unit/peddler/test_errors.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'helper'
+require 'peddler/errors'
+
+class TestPeddlerErrors < MiniTest::Test
+  def teardown
+    clients.each do |client|
+      client.error_handler = proc { raise }
+    end
+  end
+
+  def test_enables_new_error_handler
+    clients.each do |client|
+      assert_equal Peddler::Errors::Handler, client.error_handler
+    end
+  end
+
+  private
+
+  def clients
+    MWS.constants.map do |klass|
+      MWS.const_get(klass).const_get(:Client)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 1.6.6
+  version: 1.6.7
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -90,6 +90,7 @@ files:
 - lib/mws/subscriptions/client.rb
 - lib/peddler.rb
 - lib/peddler/client.rb
+- lib/peddler/errors.rb
 - lib/peddler/errors/builder.rb
 - lib/peddler/errors/error.rb
 - lib/peddler/errors/handler.rb
@@ -143,6 +144,7 @@ files:
 - test/unit/peddler/errors/test_handler.rb
 - test/unit/peddler/errors/test_parser.rb
 - test/unit/peddler/test_client.rb
+- test/unit/peddler/test_errors.rb
 - test/unit/peddler/test_flat_file_parser.rb
 - test/unit/peddler/test_headers.rb
 - test/unit/peddler/test_marketplace.rb
@@ -183,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -191,75 +193,76 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Wraps the Amazon MWS APIs
 test_files:
-- test/credentials.rb
-- test/helper.rb
-- test/integration/test_errors.rb
-- test/integration/test_feeds.rb
-- test/integration/test_fulfillment_inbound_shipment.rb
-- test/integration/test_fulfillment_inventory.rb
-- test/integration/test_fulfillment_outbound_shipment.rb
-- test/integration/test_merchant_fulfillment.rb
-- test/integration/test_multibyte_queries.rb
-- test/integration/test_mws_headers.rb
-- test/integration/test_off_amazon_payments.rb
-- test/integration/test_orders.rb
-- test/integration/test_products.rb
-- test/integration/test_recommendations.rb
-- test/integration/test_reports.rb
-- test/integration/test_sellers.rb
-- test/integration/test_subscriptions.rb
-- test/integration_helper.rb
-- test/mws.yml.example
-- test/null_client.rb
-- test/recorder.rb
-- test/unit/mws/test_feeds_client.rb
+- test/unit/peddler/test_headers.rb
+- test/unit/peddler/test_vcr_matcher.rb
+- test/unit/peddler/test_marketplace.rb
+- test/unit/peddler/test_operation.rb
+- test/unit/peddler/test_structured_list.rb
+- test/unit/peddler/test_client.rb
+- test/unit/peddler/test_xml_response_parser.rb
+- test/unit/peddler/test_xml_parser.rb
+- test/unit/peddler/test_flat_file_parser.rb
+- test/unit/peddler/test_errors.rb
+- test/unit/peddler/errors/test_error.rb
+- test/unit/peddler/errors/test_builder.rb
+- test/unit/peddler/errors/test_handler.rb
+- test/unit/peddler/errors/test_parser.rb
+- test/unit/peddler/test_parser.rb
 - test/unit/mws/test_finances_client.rb
+- test/unit/mws/test_sellers_client.rb
 - test/unit/mws/test_fulfillment_inbound_shipment_client.rb
-- test/unit/mws/test_fulfillment_inventory_client.rb
-- test/unit/mws/test_fulfillment_outbound_shipment_client.rb
 - test/unit/mws/test_merchant_fulfillment_client.rb
+- test/unit/mws/test_subscriptions_client.rb
 - test/unit/mws/test_off_amazon_payments_client.rb
+- test/unit/mws/test_reports_client.rb
+- test/unit/mws/test_fulfillment_outbound_shipment_client.rb
 - test/unit/mws/test_orders_client.rb
 - test/unit/mws/test_products_client.rb
 - test/unit/mws/test_recommendations_client.rb
-- test/unit/mws/test_reports_client.rb
-- test/unit/mws/test_sellers_client.rb
-- test/unit/mws/test_subscriptions_client.rb
-- test/unit/peddler/errors/test_builder.rb
-- test/unit/peddler/errors/test_error.rb
-- test/unit/peddler/errors/test_handler.rb
-- test/unit/peddler/errors/test_parser.rb
-- test/unit/peddler/test_client.rb
-- test/unit/peddler/test_flat_file_parser.rb
-- test/unit/peddler/test_headers.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
-- test/unit/peddler/test_vcr_matcher.rb
-- test/unit/peddler/test_xml_parser.rb
-- test/unit/peddler/test_xml_response_parser.rb
+- test/unit/mws/test_fulfillment_inventory_client.rb
+- test/unit/mws/test_feeds_client.rb
 - test/unit/test_mws.rb
-- test/vcr_cassettes/CartInformation.yml
+- test/null_client.rb
+- test/mws.yml.example
+- test/helper.rb
+- test/integration/test_orders.rb
+- test/integration/test_recommendations.rb
+- test/integration/test_multibyte_queries.rb
+- test/integration/test_feeds.rb
+- test/integration/test_fulfillment_outbound_shipment.rb
+- test/integration/test_fulfillment_inbound_shipment.rb
+- test/integration/test_mws_headers.rb
+- test/integration/test_reports.rb
+- test/integration/test_subscriptions.rb
+- test/integration/test_merchant_fulfillment.rb
+- test/integration/test_errors.rb
+- test/integration/test_sellers.rb
+- test/integration/test_products.rb
+- test/integration/test_off_amazon_payments.rb
+- test/integration/test_fulfillment_inventory.rb
+- test/integration_helper.rb
+- test/vcr_cassettes/Products.yml
+- test/vcr_cassettes/MerchantFulfillment.yml
 - test/vcr_cassettes/CustomerInformation.yml
-- test/vcr_cassettes/Errors.yml
+- test/vcr_cassettes/Recommendations.yml
 - test/vcr_cassettes/Feeds.yml
+- test/vcr_cassettes/Orders.yml
+- test/vcr_cassettes/MultibyteQueries.yml
+- test/vcr_cassettes/CartInformation.yml
 - test/vcr_cassettes/FulfillmentInboundShipment.yml
-- test/vcr_cassettes/FulfillmentInventory.yml
 - test/vcr_cassettes/FulfillmentOutboundShipment.yml
-- test/vcr_cassettes/MerchantFulfillment.yml
-- test/vcr_cassettes/MultibyteQueries.yml
-- test/vcr_cassettes/MWSHeaders.yml
-- test/vcr_cassettes/OffAmazonPayments.yml
-- test/vcr_cassettes/Orders.yml
 - test/vcr_cassettes/PeddlerVCRMatcher.yml
-- test/vcr_cassettes/Products.yml
-- test/vcr_cassettes/Recommendations.yml
-- test/vcr_cassettes/Reports.yml
+- test/vcr_cassettes/OffAmazonPayments.yml
 - test/vcr_cassettes/Sellers.yml
+- test/vcr_cassettes/FulfillmentInventory.yml
+- test/vcr_cassettes/Errors.yml
 - test/vcr_cassettes/Subscriptions.yml
+- test/vcr_cassettes/MWSHeaders.yml
+- test/vcr_cassettes/Reports.yml
+- test/recorder.rb
+- test/credentials.rb