peddler 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 989f5bec7dce426405b687e65c4677fe8b359b355d815df799a048ef1907809f
-  data.tar.gz: eec2f1236bf285bf00c7d32e1482ae2fadaadeb2db9f0bc0a9beb64cf3ec7072
+  metadata.gz: 7677959689b208211817ca535b18ec25d495df736d1e502e8b758cdb2c826603
+  data.tar.gz: c4c4f26d97ab8bcbb18e2ee0bbac890e7e2284b475a0d19286ea1c15e456b942
 SHA512:
-  metadata.gz: 361ce5ea21116bbc09efb9590d080db5275f35dbc6717ccd318c291eb32e4b122b24d06ad4f78c9c693298d8e6e70fc81f3d7a128b843b7949579a601683bf91
-  data.tar.gz: 956ad0c6b2b7d1a490dffbf846a4c4415e1323510ac52c0eebdb2b42835f5a2f14354f2e0d16fa19099d0823ed47f09218255e98973735e7ccfa1579f08ccefa
+  metadata.gz: cc020ae6bda468c2d82044b8a7b226f6101ea141b63d3cd8731ae1c58507b93f11c9e8e18040cb8a31ff0c8dcef40617bdc080f76346f029ddab1b35076027e3
+  data.tar.gz: 9e8d25fbdfe70c203331fa4ffda8147000b59e66b0ec0658b99d17a25342e975706d9366d6b7c2d6d9314593cfc6a4fbd7e4bc50b4ff5613aaf452337b7b1061

data/README.md

@@ -22,7 +22,7 @@ To begin using the Amazon SP-API, you must [register as a developer][register-as
 Add this line to your Gemfile.
 
 ```ruby
-gem "peddler", "~> 3.0"
+gem "peddler", "~> 4.0"
 ```
 
 And then execute:
@@ -102,10 +102,24 @@ end
 
 ### Rate limiting
 
-Amazon’s Selling Partner API (SP-API) imposes [rate limits][rate-limits] on most operations. Peddler respects these limits and automatically backs off when throttled. To override the default rate limit, pass a `:rate_limit` argument when running an operation.
+Amazon’s Selling Partner API (SP-API) imposes [rate limits][rate-limits] on most operations. Peddler respects these limits and will automatically back off when throttled. You can override the default rate limit by passing a `:rate_limit` to the operation.
+
+You can also provide an optional `:retries` argument when initializing an API to specify the number of retries if throttled. By default, this is set to 0, meaning no retries will be attempted. If set to a positive value, Peddler will retry the request that many times if throttled, backing off based on the specified rate limit.
 
 **Note:** This functionality requires version 6 of the underlying [HTTP library][httprb]. As of writing, this is not released yet. To use rate limiting, point to their main branch on GitHub.
 
+Example usage:
+
+```ruby
+api = Peddler.orders_v0(aws_region, access_token, retries: 3)
+api.get_orders(
+  marketplaceIds: ["ATVPDKIKX0DER"],
+  createdAfter: "2023-01-01T00:00:00Z"
+)
+```
+
+In this example, if the request to `get_orders` is throttled, Peddler will retry the request up to 3 times, backing off according to the rate limit specified by Amazon.
+
 ### The APIs
 
 Peddler provides a class for each API version under an eponymous namespace. Below is a list of the more important APIs, along with brief descriptions and code examples to help you get started.
@@ -493,10 +507,10 @@ response.parse
 
 ## TODO
 
-- Code generate models to parse payload. Consider using `dry-struct`.
-- Code generate the APIs section—descriptions and code examples—in this README here.
-- Schedule code generation with GitHub Actions. Push new gem when models change.
-- Review and consider applying [these patches][patches].
+- [ ] Code generate payload parsers.
+- [ ] Code generate the APIs section—descriptions and code examples—in this README here.
+- [ ] Schedule code generation with GitHub Actions. Push new gem when models change.
+- [ ] Review and consider applying [these patches][patches].
 
 [build]: https://github.com/hakanensari/peddler/actions
 [maintainability]: https://codeclimate.com/github/hakanensari/peddler/maintainability

data/lib/peddler/api.rb

@@ -25,11 +25,17 @@ module Peddler
     # @return [String]
     attr_reader :access_token
 
+    # Number of retries if throttled (default: 0)
+    #
+    # @return [Integer]
+    attr_reader :retries
+
     # @param [String] aws_region
     # @param [String] access_token
-    def initialize(aws_region, access_token)
+    def initialize(aws_region, access_token, retries: 0)
       @endpoint = Endpoint.find(aws_region)
       @access_token = access_token
+      @retries = retries
       @sandbox = false
     end
 
@@ -66,13 +72,15 @@ module Peddler
 
     # Throttles with a rate limit and retries when the API returns a 429
     #
-    # @param [Float] rate_limit The delay in seconds before retrying
+    # @param [Float] requests_per_second
     # @return [self]
-    def meter(rate_limit)
+    def meter(requests_per_second)
+      return self if retries.zero?
+
       # HTTP v6.0 will implement retriable. Until then, point to their GitHub repo, or it's a no-op.
       # https://github.com/httprb/http/pull/790
-      delay = sandbox? ? 0.2 : 1.0 / rate_limit
-      retriable(delay: delay, retry_statuses: [429])
+      delay = sandbox? ? 0.2 : 1.0 / requests_per_second
+      retriable(delay:, tries: retries + 1, retry_statuses: [429])
 
       self
     end
@@ -96,8 +104,8 @@ module Peddler
     #   @param (see Performer#initialize)
     #   @return [self]
     [:via, :use, :retriable].each do |method|
-      define_method(method) do |*args, &block|
-        @http = http.send(method, *args, &block) if http.respond_to?(method)
+      define_method(method) do |*args, **kwargs, &block|
+        @http = http.send(method, *args, **kwargs, &block) if http.respond_to?(method)
         self
       end
     end

data/lib/peddler/apis/catalog_items_v0.rb

@@ -39,10 +39,9 @@ module Peddler
       # @param isbn [String] The unique commercial book identifier used to identify books internationally.
       # @param jan [String] A Japanese article number that uniquely identifies the product, manufacturer, and its
       #   attributes.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
       def list_catalog_items(marketplace_id, query: nil, query_context_id: nil, seller_sku: nil, upc: nil, ean: nil,
-        isbn: nil, jan: nil, rate_limit: nil)
+        isbn: nil, jan: nil)
         path = "/catalog/v0/items"
         params = {
           "MarketplaceId" => marketplace_id,
@@ -68,9 +67,8 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for the item.
       # @param asin [String] The Amazon Standard Identification Number (ASIN) of the item.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_catalog_item(marketplace_id, asin, rate_limit: nil)
+      def get_catalog_item(marketplace_id, asin)
         path = "/catalog/v0/items/#{asin}"
         params = {
           "MarketplaceId" => marketplace_id,

data/lib/peddler/apis/fba_inventory_v1.rb

@@ -68,9 +68,8 @@ module Peddler
       #
       # @note This operation can make a dynamic sandbox call.
       # @param create_inventory_item_request_body [Hash] CreateInventoryItem Request Body Parameter.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def create_inventory_item(create_inventory_item_request_body, rate_limit: nil)
+      def create_inventory_item(create_inventory_item_request_body)
         must_sandbox!
 
         path = "/fba/inventory/v1/items"
@@ -86,9 +85,8 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param seller_sku [String] A single seller SKU used for querying the specified seller SKU inventory summaries.
       # @param marketplace_id [String] The marketplace ID for the marketplace for which the sellerSku is to be deleted.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def delete_inventory_item(seller_sku, marketplace_id, rate_limit: nil)
+      def delete_inventory_item(seller_sku, marketplace_id)
         must_sandbox!
 
         path = "/fba/inventory/v1/items/#{seller_sku}"
@@ -107,9 +105,8 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param x_amzn_idempotency_token [String] A unique token/requestId provided with each call to ensure idempotency.
       # @param add_inventory_request_body [Hash] List of items to add to Sandbox inventory.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def add_inventory(x_amzn_idempotency_token, add_inventory_request_body, rate_limit: nil)
+      def add_inventory(x_amzn_idempotency_token, add_inventory_request_body)
         must_sandbox!
 
         path = "/fba/inventory/v1/items/inventory"

data/lib/peddler/apis/fulfillment_outbound_2020_07_01.rb

@@ -184,9 +184,8 @@ module Peddler
       # @param seller_fulfillment_order_id [String] The identifier assigned to the item by the seller when the
       #   fulfillment order was created.
       # @param body [Hash] The identifier assigned to the item by the seller when the fulfillment order was created.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def submit_fulfillment_order_status_update(seller_fulfillment_order_id, body, rate_limit: nil)
+      def submit_fulfillment_order_status_update(seller_fulfillment_order_id, body)
         must_sandbox!
 
         path = "/fba/outbound/2020-07-01/fulfillmentOrders/#{seller_fulfillment_order_id}/status"

data/lib/peddler/apis/messaging_v1.rb

@@ -258,9 +258,8 @@ module Peddler
       # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
       #   order was placed. Only one marketplace can be specified.
       # @param body [Hash]
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def send_invoice(amazon_order_id, marketplace_ids, body, rate_limit: nil)
+      def send_invoice(amazon_order_id, marketplace_ids, body)
         path = "/messaging/v1/orders/#{amazon_order_id}/messages/invoice"
         params = {
           "marketplaceIds" => marketplace_ids,

data/lib/peddler/apis/supply_sources_2020_07_01.rb

@@ -19,9 +19,8 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param next_page_token [String] The pagination token to retrieve a specific page of results.
       # @param page_size [Number] The number of supply sources to return per paginated request.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_supply_sources(next_page_token: nil, page_size: 10, rate_limit: nil)
+      def get_supply_sources(next_page_token: nil, page_size: 10)
         path = "/supplySources/2020-07-01/supplySources"
         params = {
           "nextPageToken" => next_page_token,
@@ -35,9 +34,8 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param payload [Hash] A request to create a supply source.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def create_supply_source(payload, rate_limit: nil)
+      def create_supply_source(payload)
         path = "/supplySources/2020-07-01/supplySources"
         body = payload
 
@@ -48,9 +46,8 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param supply_source_id [String] The unique identifier of a supply source.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_supply_source(supply_source_id, rate_limit: nil)
+      def get_supply_source(supply_source_id)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
 
         get(path)
@@ -61,9 +58,8 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param supply_source_id [String] The unique identitier of a supply source.
       # @param payload [Hash]
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def update_supply_source(supply_source_id, payload: nil, rate_limit: nil)
+      def update_supply_source(supply_source_id, payload: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
         body = payload
 
@@ -74,9 +70,8 @@ module Peddler
       #
       # @note This operation can make a static sandbox call.
       # @param supply_source_id [String] The unique identifier of a supply source.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def archive_supply_source(supply_source_id, rate_limit: nil)
+      def archive_supply_source(supply_source_id)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}"
 
         delete(path)
@@ -87,9 +82,8 @@ module Peddler
       # @note This operation can make a static sandbox call.
       # @param supply_source_id [String] The unique identifier of a supply source.
       # @param payload [Hash]
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def update_supply_source_status(supply_source_id, payload: nil, rate_limit: nil)
+      def update_supply_source_status(supply_source_id, payload: nil)
         path = "/supplySources/2020-07-01/supplySources/#{supply_source_id}/status"
         body = payload
 

data/lib/peddler/apis/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.rb

@@ -19,9 +19,8 @@ module Peddler
       #
       # @note This operation can make a dynamic sandbox call.
       # @param body [Hash] The request payload containing parameters for generating test order data scenarios.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def generate_order_scenarios(body, rate_limit: nil)
+      def generate_order_scenarios(body)
         path = "/vendor/directFulfillment/sandbox/2021-10-28/orders"
 
         post(path, body:)
@@ -33,9 +32,8 @@ module Peddler
       # @note This operation can make a dynamic sandbox call.
       # @param transaction_id [String] The transaction identifier returned in the response to the generateOrderScenarios
       #   operation.
-      # @param rate_limit [Float] Requests per second
       # @return [Peddler::Response] The API response
-      def get_order_scenarios(transaction_id, rate_limit: nil)
+      def get_order_scenarios(transaction_id)
         path = "/vendor/directFulfillment/sandbox/2021-10-28/transactions/#{transaction_id}"
 
         get(path)

data/lib/peddler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Peddler
-  VERSION = "4.0.0"
+  VERSION = "4.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http