peddler 4.3.1 → 4.5.0

data/lib/peddler/error.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "json"
+
 module Peddler
   class Error < StandardError
     attr_reader :response
@@ -7,16 +9,29 @@ module Peddler
     # @!visibility private
     class << self
       def build(response)
-        error = JSON.parse(response).dig("errors").first
-        class_name = normalize_class_name(error.dig("code"))
-        message = error.dig("message")
+        payload = begin
+          JSON.parse(response)
+        rescue JSON::ParserError
+          parse_xml_error(response)
+        end
+
+        if payload.key?("error")
+          class_name = normalize_class_name(payload["error"])
+          message = payload["error_description"]
+        elsif payload.key?("errors")
+          class_name = normalize_class_name(payload.dig("errors", 0, "code"))
+          message = payload.dig("errors", 0, "message")
+        elsif payload.key?("Code")
+          class_name = payload["Code"]
+          message = payload["Message"]
+        else
+          return
+        end
+
         klass = if Errors.const_defined?(class_name)
           Errors.const_get(class_name)
         else
-          Errors.const_set(
-            class_name,
-            Class.new(Error),
-          )
+          Errors.const_set(class_name, Class.new(Error))
         end
 
         klass.new(message, response)
@@ -26,8 +41,16 @@ module Peddler
 
       private
 
+      def parse_xml_error(response)
+        require "nokogiri"
+        doc = Nokogiri::XML(response)
+        Hash[doc.root.elements.collect { |e| [e.name, e.text] }]
+      rescue LoadError, NoMethodError
+        {}
+      end
+
       def normalize_class_name(code)
-        if code.match?(/\A[A-Z_]+\z/)
+        if code.match?(/\A([a-z_]+|[A-Z_]+)\z/)
           code.split("_").map(&:capitalize).join
         else
           code
@@ -42,9 +65,13 @@ module Peddler
   end
 
   module Errors
+    class AccessDenied < Error; end
+    class InvalidGrant < Error; end
     class InvalidInput < Error; end
+    class InvalidRequest < Error; end
     class NotFound < Error; end
     class QuotaExceeded < Error; end
     class Unauthorized < Error; end
+    class UnsupportedGrantType < Error; end
   end
 end

data/lib/peddler/helpers/feeds_2021_06_30.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
+require "http"
+
+require "peddler/response"
+
 module Peddler
   module Helpers
     module Feeds20210630
-      # Uploads feed_content to a signed upload_url previously provided by
-      # create_feed_document. The upload_url is signed, the Host and content-type
-      # headers must match the signing.
+      # Convenience method to upload feed content to a signed upload_url previously
+      # provided by create_feed_document. This is step 2 of the 6-step Feeds API workflow.
+      # See README.md for the complete workflow documentation.
+      #
+      # The upload_url is signed, the Host and content-type headers must match the signing.
       # @param upload_url [String] The signed url from the `create_feed_document` response.
       # @param feed_content [String] The body of the content to upload.
       # @param content_type [String] The content type of the upload,
@@ -14,12 +20,20 @@ module Peddler
       def upload_feed_document(upload_url, feed_content, content_type)
         response = HTTP.headers("content-type" => content_type).put(upload_url, body: feed_content)
 
-        if response.status.client_error?
-          error = Error.build(response)
-          raise error if error
-        end
+        Response.wrap(response, parser:)
+      end
+
+      # Convenience method to download result feed content from a signed download_url
+      # provided by get_feed_document. This is step 6 of the 6-step Feeds API workflow.
+      # See README.md for the complete workflow documentation.
+      #
+      # The download_url is signed and provides access to the processed feed results.
+      # @param download_url [String] The signed url from the `get_feed_document` response.
+      # @return [HTTP::Response] The API response containing the feed result document
+      def download_result_feed_document(download_url)
+        response = HTTP.get(download_url)
 
-        response
+        Response.wrap(response, parser:)
       end
     end
   end

data/lib/peddler/helpers/reports_2021_06_30.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "http"
+
+require "peddler/response"
+require "peddler/error"
+
+module Peddler
+  module Helpers
+    module Reports20210630
+      # Convenience method to download a report by its document ID or URL.
+      # This method can handle both document IDs and direct download URLs.
+      #
+      # @param report_document_id_or_url [String] The report document identifier or download URL
+      # @return [HTTP::Response] The API response containing the report content
+      def download_report_document(report_document_id_or_url)
+        # If it looks like a URL, use direct download
+        if report_document_id_or_url.start_with?("http")
+          return download_report_document_from_url(report_document_id_or_url)
+        end
+
+        # Otherwise, treat it as a document ID and get the download URL first
+        document_info = get_report_document(report_document_id_or_url)
+        download_url = document_info.dig("url")
+
+        download_report_document_from_url(download_url)
+      end
+
+      private
+
+      def download_report_document_from_url(download_url)
+        response = HTTP.get(download_url)
+
+        Response.wrap(response, parser:)
+      end
+    end
+  end
+end

data/lib/peddler/marketplace.rb

@@ -77,6 +77,20 @@ module Peddler
           new(**values, country_code: country_code)
         end
       end
+
+      # Dynamically generate shorthand methods for each country code
+      # e.g., Marketplace.us returns the US marketplace
+      MARKETPLACE_IDS.each_key do |country_code|
+        method_name = country_code.downcase
+        define_method(method_name) do
+          find(country_code)
+        end
+      end
+
+      # Special alias for GB (Great Britain) -> UK
+      define_method(:gb) do
+        find("GB")
+      end
     end
 
     # @return [Peddler::Endpoint]

data/lib/peddler/response.rb

@@ -3,6 +3,9 @@
 require "delegate"
 require "forwardable"
 
+require "peddler/config"
+require "peddler/error"
+
 module Peddler
   # Wraps HTTP::Response to allow custom parsing
   class Response < SimpleDelegator
@@ -17,16 +20,60 @@ module Peddler
     def_delegator :to_h, :dig
 
     class << self
-      # Decorates an HTTP::Response
+      # Wraps an HTTP::Response with parsing capabilities
       #
       # @param [HTTP::Response] response
       # @param [nil, #call] parser (if any)
-      # @return [ResponseDecorator]
-      def decorate(response, parser: nil)
-        new(response).tap do |decorator|
-          decorator.parser = parser
+      # @return [Response]
+      # @raise [Error] if response status indicates an error (>= 400)
+      def wrap(response, parser: nil)
+        # Check for HTTP errors and raise custom Peddler errors
+        if response.status >= 400
+          # Client errors (4xx) always raise
+          if response.status < 500
+            error = Error.build(response)
+            raise error || Error.new(response.status, response)
+          # Server errors (5xx) - check configuration
+          elsif Peddler.raise_on_server_errors
+            error = Error.build(response)
+            raise error || Error.new(response.status, response)
+          else
+            # Emit deprecation warning for v4 behavior
+            warn_about_server_error_handling
+          end
+        end
+
+        new(response).tap do |wrapper|
+          wrapper.parser = parser
         end
       end
+
+      # @deprecated Use {.wrap} instead
+      def decorate(...)
+        warn("Response.decorate is deprecated and will be removed in v5.0. Use Response.wrap instead.", uplevel: 1)
+        wrap(...)
+      end
+
+      private
+
+      def warn_about_server_error_handling
+        return if @deprecation_warned
+
+        @deprecation_warned = true
+
+        warn(<<~MSG)
+          [DEPRECATION] Peddler v4 behavior: Server errors (5xx) are returning response objects instead of raising exceptions.
+          This behavior is deprecated and will change in Peddler v5.0.
+
+          To adopt the new behavior now and silence this warning:
+
+            Peddler.configure do |config|
+              config.raise_on_server_errors = true
+            end
+
+          For more information, see: https://github.com/hakanensari/peddler/blob/main/CHANGELOG.md
+        MSG
+      end
     end
 
     # @return [#call]

data/lib/peddler/token.rb

@@ -2,6 +2,8 @@
 
 require "http"
 
+require "peddler/response"
+
 module Peddler
   # Requests refresh and access tokens that authorize your application to take actions on behalf of a selling partner.
   #
@@ -9,14 +11,7 @@ module Peddler
   #
   # @see https://developer-docs.amazon.com/sp-api/docs/connecting-to-the-selling-partner-api
   class Token
-    class Error < StandardError
-      attr_reader :response
-
-      def initialize(msg = nil, response = nil)
-        @response = response
-        super(msg)
-      end
-    end
+    Error = Class.new(Peddler::Error)
 
     URL = "https://api.amazon.com/auth/o2/token"
 
@@ -36,13 +31,7 @@ module Peddler
 
     def request
       response = HTTP.post(URL, form: params)
-
-      unless response.status.success?
-        message = response.parse["error_description"] || "Unknown token error"
-        raise Error.new(message, response)
-      end
-
-      response
+      Response.wrap(response)
     end
 
     def grant_type

data/lib/peddler/version.rb

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

data/lib/peddler.rb

@@ -7,6 +7,7 @@ require "peddler/apis/application_management_2023_11_30"
 require "peddler/apis/catalog_items_2020_12_01"
 require "peddler/apis/catalog_items_2022_04_01"
 require "peddler/apis/catalog_items_v0"
+require "peddler/apis/customer_feedback_2024_06_01"
 require "peddler/apis/data_kiosk_2023_11_15"
 require "peddler/apis/easy_ship_2022_03_23"
 require "peddler/apis/fba_inbound_eligibility_v1"
@@ -57,4 +58,57 @@ require "peddler/apis/vendor_invoices_v1"
 require "peddler/apis/vendor_orders_v1"
 require "peddler/apis/vendor_shipments_v1"
 require "peddler/apis/vendor_transaction_status_v1"
+require "peddler/config"
 require "peddler/token"
+
+module Peddler
+  class << self
+    alias_method :amazon_warehousing_and_distribution, :amazon_warehousing_and_distribution_2024_05_09
+    alias_method :aplus_content, :aplus_content_2020_11_01
+    alias_method :application_integrations, :application_integrations_2024_04_01
+    alias_method :application_management, :application_management_2023_11_30
+    alias_method :catalog_items, :catalog_items_2022_04_01
+    alias_method :customer_feedback, :customer_feedback_2024_06_01
+    alias_method :data_kiosk, :data_kiosk_2023_11_15
+    alias_method :easy_ship, :easy_ship_2022_03_23
+    alias_method :fba_inbound_eligibility, :fba_inbound_eligibility_v1
+    alias_method :fba_inventory, :fba_inventory_v1
+    alias_method :feeds, :feeds_2021_06_30
+    alias_method :finances, :finances_2024_06_19
+    alias_method :fulfillment_inbound, :fulfillment_inbound_2024_03_20
+    alias_method :fulfillment_outbound, :fulfillment_outbound_2020_07_01
+    alias_method :invoices, :invoices_2024_06_19
+    alias_method :listings_items, :listings_items_2021_08_01
+    alias_method :listings_restrictions, :listings_restrictions_2021_08_01
+    alias_method :merchant_fulfillment, :merchant_fulfillment_v0
+    alias_method :messaging, :messaging_v1
+    alias_method :notifications, :notifications_v1
+    alias_method :orders, :orders_v0
+    alias_method :product_fees, :product_fees_v0
+    alias_method :product_pricing, :product_pricing_2022_05_01
+    alias_method :product_type_definitions, :product_type_definitions_2020_09_01
+    alias_method :replenishment, :replenishment_2022_11_07
+    alias_method :reports, :reports_2021_06_30
+    alias_method :sales, :sales_v1
+    alias_method :seller_wallet, :seller_wallet_2024_03_01
+    alias_method :sellers, :sellers_v1
+    alias_method :services, :services_v1
+    alias_method :shipment_invoicing, :shipment_invoicing_v0
+    alias_method :shipping, :shipping_v2
+    alias_method :solicitations, :solicitations_v1
+    alias_method :supply_sources, :supply_sources_2020_07_01
+    alias_method :tokens, :tokens_2021_03_01
+    alias_method :uploads, :uploads_2020_11_01
+    alias_method :vehicles, :vehicles_2024_11_01
+    alias_method :vendor_direct_fulfillment_inventory, :vendor_direct_fulfillment_inventory_v1
+    alias_method :vendor_direct_fulfillment_orders, :vendor_direct_fulfillment_orders_2021_12_28
+    alias_method :vendor_direct_fulfillment_payments, :vendor_direct_fulfillment_payments_v1
+    alias_method :vendor_direct_fulfillment_sandbox_test_data, :vendor_direct_fulfillment_sandbox_test_data_2021_10_28
+    alias_method :vendor_direct_fulfillment_shipping, :vendor_direct_fulfillment_shipping_2021_12_28
+    alias_method :vendor_direct_fulfillment_transactions, :vendor_direct_fulfillment_transactions_2021_12_28
+    alias_method :vendor_invoices, :vendor_invoices_v1
+    alias_method :vendor_orders, :vendor_orders_v1
+    alias_method :vendor_shipments, :vendor_shipments_v1
+    alias_method :vendor_transaction_status, :vendor_transaction_status_v1
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.5.0
 platform: ruby
 authors:
 - Hakan Ensari
@@ -13,22 +13,16 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.3'
 email:
 - hakanensari@gmail.com
 executables: []
@@ -46,6 +40,7 @@ files:
 - lib/peddler/apis/catalog_items_2020_12_01.rb
 - lib/peddler/apis/catalog_items_2022_04_01.rb
 - lib/peddler/apis/catalog_items_v0.rb
+- lib/peddler/apis/customer_feedback_2024_06_01.rb
 - lib/peddler/apis/data_kiosk_2023_11_15.rb
 - lib/peddler/apis/easy_ship_2022_03_23.rb
 - lib/peddler/apis/fba_inbound_eligibility_v1.rb
@@ -96,12 +91,12 @@ files:
 - lib/peddler/apis/vendor_orders_v1.rb
 - lib/peddler/apis/vendor_shipments_v1.rb
 - lib/peddler/apis/vendor_transaction_status_v1.rb
+- lib/peddler/config.rb
 - lib/peddler/endpoint.rb
 - lib/peddler/error.rb
 - lib/peddler/helpers/feeds_2021_06_30.rb
+- lib/peddler/helpers/reports_2021_06_30.rb
 - lib/peddler/marketplace.rb
-- lib/peddler/parsers/openapi_parser_generator.rb
-- lib/peddler/parsers/smart_parser.rb
 - lib/peddler/response.rb
 - lib/peddler/token.rb
 - lib/peddler/version.rb