muffin_man 1.4.4 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33ab3775741e9ae115fdd18683e7632ad1d9f0da5b5c54ee98fbfdc951cacb45
-  data.tar.gz: 57629b160dce923145c0d6784cca34b174fdb757f82e95b9d2c18359c6ee137c
+  metadata.gz: 062bcf57cb27afd95911a7bac99717cd9f4b070c429013584cddfe3cbf661886
+  data.tar.gz: 5dc42d8a414afd0d973dca6b8266b53f84a4492daf8b4b7bd3067b59f874a634
 SHA512:
-  metadata.gz: b27ea646bb4beca9038140758b1b0e8082b5beab76ec8c6af8723a5a5459e4466ef1f90bce09799f5adf5794cf71c4ee030734c8a978470ddb0e0d8bc38ff4c4
-  data.tar.gz: 15b93790c3f8d6193e0c2fdf13c2f7f90398fbe0771eb57edf6df651573cd973af630a6a4f78fd56297cf98f6119e9730fe3741883ad81ae36519c5dbdad2024
+  metadata.gz: d725f54db9a3286ee469912f636187dc5de0b2dde1e2cd7af0430b981984d6c08a1ef2ea6afe1c747b960b3a5a067b29714a6a023a00e4b31fed300700702885
+  data.tar.gz: 2a317b00e4afc4107085a2ab4c6447f8e79074a824f1b8df2e969ffffaef59ee0237deb4c1b0b3b7ee9d68df0d48dfa3d3dd85826ce63c06c5d8182f9fdfb60f

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.4.6
+
+- Support for Catalog API's of version 20220401 [#22](https://github.com/patterninc/muffin_man/pull/22)
+
+# 1.4.5
+
+- Support for GetCompetitivePricing endpoint [#19] (https://github.com/patterninc/muffin_man/pull/19)
+
 # 1.4.4
 
 - Support for Tokens API [#17](https://github.com/patterninc/muffin_man/pull/17)

data/README.md

@@ -9,6 +9,8 @@ As of now, this gem only supports portions of the following APIs with more to co
 - `create_product_review_and_seller_feedback_solicitation`
 - `catalog_items`
 - `reports`
+- `product_fees`
+- `product_pricing`
 
 ## Installation
 

data/lib/muffin_man/catalog_items/base_api.rb

@@ -0,0 +1,58 @@
+module MuffinMan
+  module CatalogItems
+    class BaseApi < SpApiClient
+      SANDBOX_KEYWORDS = "shoes".freeze
+      SANDBOX_ASIN = "B07N4M94X4".freeze
+      SANDBOX_MARKETPLACE_IDS = "ATVPDKIKX0DER".freeze
+      attr_reader :keywords, :asin, :marketplace_ids, :params
+
+      SEARCH_CATALOG_ITEMS_PARAMS = %w[
+        includedData
+        brandNames
+        classificationIds
+        pageSize
+        pageToken
+        keywordsLocale
+        locale
+      ].freeze
+      GET_CATALOG_ITEM_PARAMS = %w[includedData locale].freeze
+
+      API_VERSION = "2020-12-01".freeze
+
+      def search_catalog_items(keywords, marketplace_ids, params = {}, api_version=API_VERSION)
+        if sandbox
+          keywords = SANDBOX_KEYWORDS
+          marketplace_ids = SANDBOX_MARKETPLACE_IDS
+          params = {}
+        end
+        @keywords = keywords.is_a?(Array) ? keywords : [keywords]
+        @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
+        @params = params
+        @local_var_path = "/catalog/#{api_version}/items"
+        @query_params = {
+          "keywords" => @keywords.join(","),
+          "marketplaceIds" => @marketplace_ids.join(",")
+        }
+        @query_params.merge!(@params.slice(*SEARCH_CATALOG_ITEMS_PARAMS))
+        @request_type = "GET"
+        call_api
+      end
+
+      def get_catalog_item(asin, marketplace_ids, params = {}, api_version=API_VERSION)
+        if sandbox
+          asin = SANDBOX_ASIN
+          marketplace_ids = SANDBOX_MARKETPLACE_IDS
+          params = {}
+        end
+        @asin = asin
+        @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
+        @params = params
+        @local_var_path = "/catalog/#{api_version}/items/#{@asin}"
+        @query_params = { "marketplaceIds" => @marketplace_ids.join(",") }
+        @query_params.merge!(@params.slice(*GET_CATALOG_ITEM_PARAMS))
+        @request_type = "GET"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/catalog_items/v20201201.rb

@@ -1,55 +1,17 @@
+require "muffin_man/catalog_items/base_api"
+
 module MuffinMan
   module CatalogItems
-    class V20201201 < SpApiClient
-      SANDBOX_KEYWORDS = "shoes".freeze
-      SANDBOX_ASIN = "B07N4M94X4".freeze
-      SANDBOX_MARKETPLACE_IDS = "ATVPDKIKX0DER".freeze
-      attr_reader :keywords, :asin, :marketplace_ids, :params
+    class V20201201 < BaseApi
 
-      SEARCH_CATALOG_ITEMS_PARAMS = %w[
-        includedData
-        brandNames
-        classificationIds
-        pageSize
-        pageToken
-        keywordsLocale
-        locale
-      ].freeze
-      GET_CATALOG_ITEM_PARAMS = %w[includedData locale].freeze
+      API_VERSION = "2020-12-01".freeze
 
       def search_catalog_items(keywords, marketplace_ids, params = {})
-        if sandbox
-          keywords = SANDBOX_KEYWORDS
-          marketplace_ids = SANDBOX_MARKETPLACE_IDS
-          params = {}
-        end
-        @keywords = keywords.is_a?(Array) ? keywords : [keywords]
-        @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
-        @params = params
-        @local_var_path = "/catalog/2020-12-01/items"
-        @query_params = {
-          "keywords" => @keywords.join(","),
-          "marketplaceIds" => @marketplace_ids.join(",")
-        }
-        @query_params.merge!(@params.slice(*SEARCH_CATALOG_ITEMS_PARAMS))
-        @request_type = "GET"
-        call_api
+        super(keywords, marketplace_ids, params, API_VERSION)
       end
 
       def get_catalog_item(asin, marketplace_ids, params = {})
-        if sandbox
-          asin = SANDBOX_ASIN
-          marketplace_ids = SANDBOX_MARKETPLACE_IDS
-          params = {}
-        end
-        @asin = asin
-        @marketplace_ids = marketplace_ids.is_a?(Array) ? marketplace_ids : [marketplace_ids]
-        @params = params
-        @local_var_path = "/catalog/2020-12-01/items/#{@asin}"
-        @query_params = { "marketplaceIds" => @marketplace_ids.join(",") }
-        @query_params.merge!(@params.slice(*GET_CATALOG_ITEM_PARAMS))
-        @request_type = "GET"
-        call_api
+        super(asin, marketplace_ids, params, API_VERSION)
       end
     end
   end

data/lib/muffin_man/catalog_items/v20220401.rb

@@ -0,0 +1,18 @@
+require "muffin_man/catalog_items/base_api"
+
+module MuffinMan
+  module CatalogItems
+    class V20220401 < BaseApi
+
+      API_VERSION = "2022-04-01".freeze
+
+      def search_catalog_items(keywords, marketplace_ids, params = {})
+        super(keywords, marketplace_ids, params, API_VERSION)
+      end
+
+      def get_catalog_item(asin, marketplace_ids, params = {})
+        super(asin, marketplace_ids, params, API_VERSION)
+      end
+    end
+  end
+end

data/lib/muffin_man/fulfillment_inbound/v0.rb

@@ -0,0 +1,16 @@
+module MuffinMan
+  module FulfillmentInbound
+    class V0 < SpApiClient
+      def get_prep_instructions(ship_to_country_code, seller_sku_list: [], asin_list: [])
+        @local_var_path = "/fba/inbound/v0/prepInstructions"
+        @query_params = {
+          "ShipToCountryCode" => ship_to_country_code
+        }
+        @query_params["SellerSKUList"] = seller_sku_list.join(",") if seller_sku_list.any?
+        @query_params["ASINList"] = asin_list.join(",") if asin_list.any?
+        @request_type = "GET"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/listings/v20210801.rb

@@ -0,0 +1,24 @@
+module MuffinMan
+  module Listings
+    class V20210801 < SpApiClient
+      def get_listings_item(seller_id, sku, marketplace_ids, issue_locale: nil, included_data: [])
+        # Options for included_data:
+        #   summaries
+        #   attributes
+        #   issues
+        #   offers
+        #   fulfillmentAvailability
+        #   procurement
+        @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["issueLocale"] = issue_locale if issue_locale
+        @query_params["includedData"] = included_data.join(",") if included_data.any?
+        @request_type = "GET"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/product_fees/v0.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module ProductFees
+    require "json"
+    require "sp_api_helpers"
+    class V0 < SpApiClient
+      attr_reader :asin
+
+      def get_my_fees_estimate_for_asin(asin, marketplace_id, map_price, currency_code, shipping = nil, points = nil, identifier = SecureRandom.uuid,
+                                        is_amazon_fulfilled = true, optional_fulfillment_program = "FBA_CORE")
+        @local_var_path = "/products/fees/v0/items/#{asin}/feesEstimate"
+        @request_body = SpApiHelpers.fees_estimate_request_body(marketplace_id, map_price, currency_code, shipping, points, identifier,
+                                                                is_amazon_fulfilled, optional_fulfillment_program).to_camelize
+        @request_type = "POST"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/product_pricing/v0.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MuffinMan
+  module ProductPricing
+    class V0 < SpApiClient
+      GET_COMPETITIVE_PRICE_PARAMS = %w[Asins Skus CustomerType].freeze
+
+      def get_competitive_pricing(marketplace_id, item_type='Asin', params = {})
+        @params = params
+        @local_var_path = "/products/pricing/v0/competitivePrice"
+        @query_params = { "MarketplaceId" => marketplace_id,
+                          "ItemType" => item_type }
+        @query_params.merge!(@params.slice(*GET_COMPETITIVE_PRICE_PARAMS))
+        @request_type = "GET"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/sp_api_client.rb

@@ -127,7 +127,8 @@ module MuffinMan
       client = Aws::STS::Client.new(
         region: derive_aws_region,
         access_key_id: aws_access_key_id,
-        secret_access_key: aws_secret_access_key
+        secret_access_key: aws_secret_access_key,
+        http_wire_trace: (ENV["AWS_DEBUG"] == "true" || false)
       )
       client.assume_role(role_arn: sts_iam_role_arn, role_session_name: SecureRandom.uuid)
     end

data/lib/muffin_man/version.rb

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

data/lib/muffin_man.rb

@@ -5,9 +5,15 @@ require "muffin_man/solicitations/v1"
 require "muffin_man/orders/v0"
 require "muffin_man/reports/v20210630"
 require "muffin_man/catalog_items/v20201201"
+require "muffin_man/catalog_items/v20220401"
 require "muffin_man/finances/v0"
+require "muffin_man/product_fees/v0"
 require "muffin_man/authorization/v1"
 require "muffin_man/tokens/v20210301"
+require "muffin_man/product_pricing/v0"
+require "muffin_man/listings/v20210801"
+require "muffin_man/fulfillment_inbound/v0"
+
 
 module MuffinMan
   class Error < StandardError; end

data/lib/sp_api_helpers.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# Module to help create request body for API endpoints
+module SpApiHelpers
+  require "securerandom"
+
+  def self.fees_estimate_request_body(marketplace_id, price, fees_currency_code,
+                                      shipping = nil, points = nil, identifier = SecureRandom.uuid,
+                                      is_amazon_fulfilled = true, optional_fulfillment_program = "FBA_CORE")
+    GetMyFeesEstimateRequest.new(marketplace_id, price, fees_currency_code,
+                                 shipping, points, identifier,
+                                 is_amazon_fulfilled, optional_fulfillment_program)
+  end
+  class GetMyFeesEstimateRequest
+    attr_accessor :fees_estimate_request
+
+    def initialize(marketplace_id, price, fees_currency_code, shipping, points, identifier,
+                   is_amazon_fulfilled, optional_fulfillment_program)
+      @fees_estimate_request = FeesEstimateRequest.new(marketplace_id, price, fees_currency_code, shipping, points,
+                                                       identifier, is_amazon_fulfilled, optional_fulfillment_program)
+    end
+
+    def to_camelize
+      {
+        "FeesEstimateRequest" =>
+          fees_estimate_request.to_camelize
+      }
+    end
+  end
+
+  class FeesEstimateRequest
+    attr_accessor :marketplace_id, :price_to_estimate_fees, :identifier, :is_amazon_fulfilled,
+                  :optional_fulfillment_program
+
+    def initialize(marketplace_id, price, currency_code, shipping, points, identifier, is_amazon_fulfilled,
+                   optional_fulfillment_program)
+      @marketplace_id = marketplace_id
+      @price_to_estimate_fees = PriceToEstimateFees.new(price, currency_code, shipping, points)
+      @identifier = identifier
+      @is_amazon_fulfilled = is_amazon_fulfilled
+      @optional_fulfillment_program = optional_fulfillment_program if is_amazon_fulfilled
+    end
+
+    def to_camelize
+      {
+        "Identifier" => identifier,
+        "IsAmazonFulfilled" => is_amazon_fulfilled,
+        "MarketplaceId" => marketplace_id,
+        "OptionalFulfillmentProgram" => optional_fulfillment_program,
+        "PriceToEstimateFees" => price_to_estimate_fees.to_camelize
+      }
+    end
+  end
+
+  class PriceToEstimateFees
+    attr_accessor :listing_price, :shipping, :points
+
+    def initialize(listing_price, currency_code = MoneyType::USD, shipping = nil, points = nil)
+      @listing_price = MoneyType.new(listing_price, currency_code)
+      @shipping = MoneyType.new(shipping, currency_code) if shipping
+      @points = points if points
+    end
+
+    def to_camelize
+      { "ListingPrice" => listing_price.to_camelize }
+    end
+  end
+
+  class MoneyType
+    USD = "USD"
+    EUR = "EUR"
+    GBP = "GBP"
+    RMB = "RMB"
+    INR = "INR"
+    JPY = "JPY"
+    CAD = "CAD"
+    MXN = "MXN"
+
+    attr_accessor :amount, :currency_code
+
+    def initialize(amount, currency_code = USD)
+      @amount = amount.to_f
+      @currency_code = currency_code
+    end
+
+    def to_camelize
+      {
+        "Amount" => amount,
+        "CurrencyCode" => currency_code
+      }
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: muffin_man
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.6
 platform: ruby
 authors:
 - Gavin
 - Jason
 - Nate
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -116,7 +116,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.4
-description: 
+description:
 email:
 - gavin@pattern.com
 - jason@pattern.com
@@ -139,21 +139,28 @@ files:
 - bin/setup
 - lib/muffin_man.rb
 - lib/muffin_man/authorization/v1.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/finances/v0.rb
+- lib/muffin_man/fulfillment_inbound/v0.rb
+- lib/muffin_man/listings/v20210801.rb
 - lib/muffin_man/lwa/auth_helper.rb
 - lib/muffin_man/orders/v0.rb
+- lib/muffin_man/product_fees/v0.rb
+- lib/muffin_man/product_pricing/v0.rb
 - lib/muffin_man/reports/v20210630.rb
 - lib/muffin_man/solicitations/v1.rb
 - lib/muffin_man/sp_api_client.rb
 - lib/muffin_man/tokens/v20210301.rb
 - lib/muffin_man/version.rb
+- lib/sp_api_helpers.rb
 - muffin_man.gemspec
 homepage: https://github.com/patterninc/muffin_man
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +175,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.1.6
+signing_key:
 specification_version: 4
 summary: Amazon Selling Partner API client
 test_files: []