muffin_man 2.1.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42d41a72e708c859b3fba7fd92fdcae714730a8bb959d543cc74c1c44bbaa7a8
-  data.tar.gz: 66c384cee7964c5041528132e822feda6e4bc32324bfa441499f4e031e1abf5c
+  metadata.gz: 6e9269248aa6303968c89ad3f90d7a6165b249cebaa15b905ee0596b2a8916ce
+  data.tar.gz: 61dcfad92370fd8553a702976dffd4109b9e5eaf9158929c45803ca23b0af238
 SHA512:
-  metadata.gz: 2dcafda67c6adb2230feb4e71dc5120f5d26ed268b4165aa5e0cbf72782bdfb1d0a48950679b7bd6756ee2c784f0111cecc0b077eeac21ffd7911b2dfb9c4eb6
-  data.tar.gz: 4df599f9720c61ceba199a64f2a8f63dd3fb9d80a7722686bb719ea31d30612f65292eb5b25b62a005fc4afec2ca49415bf68df72b91ed2793bb5c41a3e55b42
+  metadata.gz: cb1133daaa98b531f1123985494fe1718de374e00877109a21579592758fc10f7aef91f0f76612dec83bf39357ea6ef449ca7063ef49f8515561c4598f421db6
+  data.tar.gz: b4dc27b5e26ffd6cf3d91f386225431e22006bc96217411300c2122ec8a6a3b50397399ed3c5c4bf0a29c408453943b782dc17ba8fcb938ddacdc1956cbfc962

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.1.3
+
+- Support for AWD getInboundShipment [#64](https://github.com/patterninc/muffin_man/pull/64)
+
+# 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

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/awd/v20240509.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module Awd
+    class V20240509 < SpApiClient
+      AWD_PATH = "/awd/2024-05-09"
+
+      def get_inbound_shipment(shipment_id)
+        @local_var_path = "#{AWD_PATH}/inboundShipments/#{shipment_id}"
+        @request_type = "GET"
+        call_api
+      end
+    end
+  end
+end

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/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.1.0"
+  VERSION = "2.1.3"
 end

data/lib/muffin_man.rb

@@ -21,6 +21,7 @@ require "muffin_man/request_helpers"
 require "muffin_man/feeds/v20210630"
 require "muffin_man/notifications/v1"
 require "muffin_man/merchant_fulfillment/v0"
+require "muffin_man/awd/v20240509"
 
 module MuffinMan
   class Error < StandardError; end
@@ -35,15 +36,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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: muffin_man
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Gavin
 - Jason
 - Nate
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -130,7 +130,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - gavin@pattern.com
 - jason@pattern.com
@@ -154,9 +154,11 @@ files:
 - bin/setup
 - lib/muffin_man.rb
 - lib/muffin_man/authorization/v1.rb
+- lib/muffin_man/awd/v20240509.rb
 - 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
@@ -191,7 +193,7 @@ homepage: https://github.com/patterninc/muffin_man
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -206,8 +208,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Amazon Selling Partner API client
 test_files: []