muffin_man 2.0.6 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d0cac4283872c9438e32917662f5c85654409bf8cea874a12eefc2b3106908e
-  data.tar.gz: c2108cb8339b7c7ad472f441c24ba1ad193bc2d73225e48a4b0cb779c122fc8a
+  metadata.gz: e76d913a68a8015a4b14b3f91083ffb0995f18f4fcb2a32561ab6ebb54606a06
+  data.tar.gz: 8c020662237e128bab18104b1e3283cc9f93f21336c952acc4a19b5741088196
 SHA512:
-  metadata.gz: 494fb99a4e25b8519d993a14e2e005e9347497b1a277a5e715f99d3ca5c111f44dc55e492dbb63f7be33873923f797aa7fb5b9ec2ca2db69fcf97d6d94c4be1d
-  data.tar.gz: f048455b4e557c6fa6a585ab711cb445b9de6927b6e14844aaa9ab9ff005f037524192339db3a773d21645b7aa7cc576e0cb420398af0c81cb086eded59cbe8c
+  metadata.gz: 29d252e4e79d7e2c548468b5b941673831ca1ff946b4d14cd9dc8ccabece39d148f76a6578aba8b4d0c3251dd83732c1cb24cf139ff76f61e8107bedd9d1cac6
+  data.tar.gz: 131ccf94eda1c1131a6f72ff937f5a2f3437278a8b60a445dca95fec48b787dd72a2110fb10a3f606b5cb386a5b0cde4e84162caf680b0b69bbac203f3f48946

data/.rubocop_todo.yml

@@ -255,7 +255,6 @@ RSpec/FilePath:
     - 'spec/muffin_man/solicitations_spec.rb'
     - 'spec/muffin_man/tokens_spec.rb'
 
-
 # Offense count: 15
 # This cop supports safe autocorrection (--autocorrect).
 RSpec/LeadingSubject:
@@ -363,7 +362,6 @@ Style/FrozenStringLiteralComment:
     - 'spec/muffin_man/finances_spec.rb'
     - 'spec/muffin_man/fulfillment_inbound/v0_spec.rb'
     - 'spec/muffin_man/fulfillment_inbound/v1_spec.rb'
-    - 'spec/muffin_man/listings_spec.rb'
     - 'spec/muffin_man/lwa_spec.rb'
     - 'spec/muffin_man/orders_spec.rb'
     - 'spec/muffin_man/product_fees_spec.rb'

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.1.2 [#63](https://github.com/patterninc/muffin_man/pull/63)
+
+- Support for patchListingsItem
+
+# 2.1.1 [#62](https://github.com/patterninc/muffin_man/pull/62)
+
+- SearchCatalogItems validations on keywords & identifiers
+
+# 2.1.0 [#58](https://github.com/patterninc/muffin_man/pull/58)
+
+- Support for Product Type Definitions
+
 # 2.0.6 [#54](https://github.com/patterninc/muffin_man/pull/54)
 
 - Support for getOrder

data/Gemfile

@@ -13,4 +13,4 @@ gem "rubocop", "<= 1.43"
 
 gem "rubocop-rake"
 
-gem "rubocop-rspec"
+gem "rubocop-rspec", "<=2.20"

data/README.md

@@ -56,6 +56,16 @@ JSON.parse(response.body)
 
 You can optionally use Amazon's sandbox environment by specifying `client = MuffinMan::Solicitations.new(credentials, sandbox = true)`
 
+### Set Custom Logger
+
+By default MuffinMan will log to standard out. To customize the logger used:
+
+```ruby
+MuffinMan.configure do |config|
+  config.logger = Logger.new('log/sp-api.log')
+end
+```
+
 ### Access Token Caching
 
 You can save and retrieve the LWA refresh token by defining a lambda in your initializers.
@@ -94,6 +104,10 @@ auth_code = resp['payload']['authorizationCode']
 refresh_token = MuffinMan::Lwa::AuthHelper.get_refresh_token(CLIENT_ID, CLIENT_SECRET, auth_code)
 ```
 
+### Debugging
+
+To use Typheous' verbose mode set env variable `MUFFIN_MAN_DEBUG=true`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/patterninc/muffin_man. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/patterninc/muffin_man/blob/master/CODE_OF_CONDUCT.md).

data/lib/muffin_man/catalog_items/base_api.rb

@@ -30,6 +30,7 @@ module MuffinMan
         end
         @keywords = keywords.is_a?(Array) ? keywords : [keywords]
         @identifiers = params["identifiers"].is_a?(Array) ? params["identifiers"] : [params["identifiers"]]
+        validate_keywords_and_identifiers
         @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
         @params = params
         @local_var_path = "/catalog/#{api_version}/items"
@@ -68,6 +69,11 @@ module MuffinMan
       def search_catalog_items_params
         BASE_SEARCH_CATALOG_ITEMS_PARAMS + self.class::SEARCH_CATALOG_ITEMS_PARAMS
       end
+
+      def validate_keywords_and_identifiers
+        raise MuffinMan::Error, "Keywords cannot be used with Identifiers" if @keywords.any? && @identifiers.any?
+        raise MuffinMan::Error, "Keywords or Identifiers must be present" if @keywords.none? && @identifiers.none?
+      end
     end
   end
 end

data/lib/muffin_man/enable_logger.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module EnableLogger
+    LOGGING_ENABLED = true
+
+    def log_request_and_response(level, res)
+      log_info = "REQUEST\n
+        canonical_uri:#{canonical_uri}\n\n
+        query_params:#{query_params}\n\n
+        RESPONSE\n
+        response_headers=#{res.headers}\n\n
+        response_body=#{res.body}\n\n
+      "
+      MuffinMan.logger.send(level, log_info)
+    end
+  end
+end

data/lib/muffin_man/finances/v0.rb

@@ -1,6 +1,10 @@
+require "muffin_man/enable_logger"
+
 module MuffinMan
   module Finances
     class V0 < SpApiClient
+      include EnableLogger
+
       def list_financial_event_groups(max_results_per_page = nil, financial_event_group_started_before = nil, financial_event_group_started_after = nil, next_token = nil)
         @local_var_path = "/finances/v0/financialEventGroups"
         @query_params = {}

data/lib/muffin_man/listings/v20200901.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module Listings
+    class V20200901 < SpApiClient
+      REQUIREMENTS = %w[LISTING LISTING_PRODUCT_ONLY LISTING_OFFER_ONLY].freeze
+      REQUIREMENTS_ENFORCED = %w[ENFORCED NOT_ENFORCED].freeze
+      LOCALE = %w[DEFAULT ar ar_AE de de_DE en en_AE en_AU en_CA en_GB en_IN en_SG en_US es es_ES es_MX es_US fr
+                  fr_CA fr_FR it it_IT ja ja_JP nl nl_NL pl pl_PL pt pt_BR pt_PT sv sv_SE tr tr_TR zh zh_CN zh_TW]
+               .freeze
+      PRODUCT_TYPES_PATH = "/definitions/2020-09-01/productTypes"
+
+      def search_definitions_product_types(marketplace_ids, keywords = nil)
+        @local_var_path = PRODUCT_TYPES_PATH
+        @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
+        @query_params = { "marketplaceIds" => @marketplace_ids.join(",") }
+        @query_params["keywords"] = keywords if keywords.present?
+        @request_type = "GET"
+        call_api
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def get_definitions_product_type(product_type, marketplace_ids, options = {})
+        options = options.with_indifferent_access
+        @local_var_path = "#{PRODUCT_TYPES_PATH}/#{product_type}"
+        @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
+        @query_params = { "marketplaceIds" => @marketplace_ids.join(",") }
+        @query_params["sellerId"] = options["sellerId"] if options["sellerId"]
+        @query_params["productTypeVersion"] = options["productTypeVersion"].upcase if options["productTypeVersion"]
+        if REQUIREMENTS.include?(options["requirements"]&.upcase)
+          @query_params["requirements"] = options["requirements"].upcase
+        end
+
+        if REQUIREMENTS_ENFORCED.include?(options["requirementsEnforced"]&.upcase)
+          @query_params["requirementsEnforced"] = options["requirementsEnforced"].upcase
+        end
+
+        @query_params["locale"] = options["locale"] if LOCALE.include?(options["locale"])
+
+        @request_type = "GET"
+        call_api
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+    end
+  end
+end

data/lib/muffin_man/listings/v20210801.rb

@@ -47,6 +47,24 @@ module MuffinMan
         @request_type = "DELETE"
         call_api
       end
+
+      def patch_listings_item(seller_id, sku, marketplace_ids, product_type, patches, included_data: [], mode: nil,
+                              issue_locale: nil)
+        @local_var_path = "/listings/2021-08-01/items/#{seller_id}/#{sku}"
+        @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
+        @query_params = {
+          "marketplaceIds" =>  @marketplace_ids.join(",")
+        }
+        @query_params["includedData"] = included_data.join(",") if included_data.any?
+        @query_params["mode"] = mode if mode
+        @query_params["issueLocale"] = issue_locale if issue_locale
+        @request_body = {
+          "productType" => product_type,
+          "patches" => patches
+        }
+        @request_type = "PATCH"
+        call_api
+      end
     end
   end
 end

data/lib/muffin_man/reports/v20210630.rb

@@ -57,6 +57,7 @@ module MuffinMan
         report_id = sandbox ? SANDBOX_REPORT_ID : report_id
         @local_var_path = "/reports/2021-06-30/reports/#{report_id}"
         @request_type = "GET"
+        @request_body = nil
         call_api
       end
 

data/lib/muffin_man/sp_api_client.rb

@@ -42,14 +42,20 @@ module MuffinMan
     private
 
     def call_api
-      Typhoeus.send(request_type.downcase.to_sym, request.url, request_opts)
+      res = Typhoeus.send(request_type.downcase.to_sym, request.url, request_opts)
+      if self.class.const_defined?("LOGGING_ENABLED")
+        level = res.code.to_s.match?(/2\d{2}/) ? :info : :error
+        log_request_and_response(level, res)
+      end
+      res
     rescue SpApiAuthError => e
       e.auth_response
     end
 
     def request_opts
       opts = { headers: headers }
-      opts[:body] = request_body.to_json if request_body
+      opts[:verbose] = true if ENV.fetch("MUFFIN_MAN_DEBUG", nil) == "true"
+      opts[:body] = request_body.to_json if request_body && request_type != "GET" && request_type != "HEAD"
       opts
     end
 

data/lib/muffin_man/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MuffinMan
-  VERSION = "2.0.6"
+  VERSION = "2.1.2"
 end

data/lib/muffin_man.rb

@@ -12,6 +12,7 @@ require "muffin_man/authorization/v1"
 require "muffin_man/tokens/v20210301"
 require "muffin_man/product_pricing/v0"
 require "muffin_man/listings/v20210801"
+require "muffin_man/listings/v20200901"
 require "muffin_man/fulfillment_inbound/v0"
 require "muffin_man/fulfillment_inbound/v1"
 require "muffin_man/fulfillment_outbound/v20200701"
@@ -34,15 +35,19 @@ module MuffinMan
   end
 
   class << self
-    attr_accessor :configuration
+    attr_accessor :configuration, :logger
   end
 
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
+    self.logger = configuration.logger if configuration.logger
   end
 
   class Configuration
-    attr_accessor :save_access_token, :get_access_token
+    attr_accessor :save_access_token, :get_access_token, :logger
   end
 end
+
+# Set default logger
+MuffinMan.logger = Logger.new($stdout)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: muffin_man
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.1.2
 platform: ruby
 authors:
 - Gavin
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2024-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -157,12 +157,14 @@ files:
 - lib/muffin_man/catalog_items/base_api.rb
 - lib/muffin_man/catalog_items/v20201201.rb
 - lib/muffin_man/catalog_items/v20220401.rb
+- lib/muffin_man/enable_logger.rb
 - lib/muffin_man/fba_inventory/v1.rb
 - lib/muffin_man/feeds/v20210630.rb
 - lib/muffin_man/finances/v0.rb
 - lib/muffin_man/fulfillment_inbound/v0.rb
 - lib/muffin_man/fulfillment_inbound/v1.rb
 - lib/muffin_man/fulfillment_outbound/v20200701.rb
+- lib/muffin_man/listings/v20200901.rb
 - lib/muffin_man/listings/v20210801.rb
 - lib/muffin_man/lwa/auth_helper.rb
 - lib/muffin_man/merchant_fulfillment/v0.rb