muffin_man 1.0.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01a263a02506880dbfef45399e3294486b858cc72d5a9fc370f155128de17d0a
-  data.tar.gz: d8fdd99a82562bcc2c354fb8c59d2c7c366802fbdf41b8b45c1f9f0ab9b596d8
+  metadata.gz: 82c3118e9e61b82872329714fbfbaf80fd7613ff98ce126992f2ac3b834e3a51
+  data.tar.gz: 201afe55ba25967d8e519ff5f6a0ac9a66e452462cc4fe805ab2a34b61edec9a
 SHA512:
-  metadata.gz: ad0248e2f1020a243bdb2901d7c0331d377733c01490875a64e2e92f380702fabfd34abc5aafcaf6c39244891380551d0d9e20b35197d969ed09d93ab551a06e
-  data.tar.gz: cac4177e290055336395d095936236f48449df8f56cee789a4201c5dd6e3eb9afecae7f2923c4ec6964515eb6a492ac5bbc597f1fcd35bda0d6fab56cf392e11
+  metadata.gz: 9411d153ce20efc02882b456a9b6be233cf88e691472d35bbca5b8890fc422395d5a925a66996c129a1a5835883ac66153415043a94e37ad2d9c6e7e3b17baf5
+  data.tar.gz: 7859bc864e708516ce37087a32791a1fbbae140af2307fbc8d7c530933517e1d914faf704151b7269c290853cfa3a44c741c552a8aadf06bf605cc5ba2745d28

data/.rubocop.yml

@@ -11,3 +11,6 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/MethodLength:
+  Max: 30

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at gavin@iserve.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at opensource@pattern.com. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

data/README.md

@@ -2,7 +2,7 @@
 
 [![Ruby CI](https://github.com/patterninc/muffin_man/actions/workflows/ci.yml/badge.svg)](https://github.com/patterninc/muffin_man/actions)
 
-MuffinMan is a ruby interface to the Amazon Selling Partner API. For more information on registering to use the Selling Partner API, see [Amazon's documentation](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/developer-guide/SellingPartnerApiDeveloperGuide.md)
+MuffinMan is a ruby interface to the Amazon Selling Partner API. For more information on registering to use the Selling Partner API, see [Amazon's documentation](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md)
 
 As of now, this gem only supports portions of the following APIs with more to come:
 
@@ -63,6 +63,27 @@ MuffinMan.configure do |config|
 end
 ```
 
+### Retrieiving the refresh token
+
+To retrieve the refresh token from an LWA Website authorization workflow, you can use the LWA helper:
+
+```ruby
+# Get your auth code first, either through the Website oauth flow or Authorization API
+credentials = {
+  client_id: CLIENT_ID,
+  client_secret: CLIENT_SECRET,
+  aws_access_key_id: AWS_ACCESS_KEY_ID,
+  aws_secret_access_key: AWS_SECRET_ACCESS_KEY,
+  sts_iam_role_arn: STS_IAM_ROLE_ARN, # Optional
+  scope: 'sellingpartnerapi::migration' # Grantless scope for MWS migration
+}
+client = MuffinMan::Authorization::V1.new(credentials)
+resp = JSON.parse(client.get_authorization_code(seller_id, developer_id, mws_auth_token).body)
+auth_code = resp['payload']['authorizationCode']
+# Then query retrieve the refresh token to store
+refresh_token = MuffinMan::Lwa::AuthHelper.get_refresh_token(CLIENT_ID, CLIENT_SECRET, auth_code)
+```
+
 ## 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/authorization/v1.rb

@@ -0,0 +1,16 @@
+module MuffinMan
+  module Authorization
+    class V1 < SpApiClient
+      def get_authorization_code(selling_partner_id, developer_id, mws_auth_token)
+        @query_params = {
+          "sellingPartnerId" => selling_partner_id,
+          "developerId" => developer_id,
+          "mwsAuthToken" => mws_auth_token
+        }
+        @request_type = "GET"
+        @local_var_path = "/authorization/v1/authorizationCode"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/finances/v0.rb

@@ -0,0 +1,33 @@
+module MuffinMan
+  module Finances
+    class V0 < SpApiClient
+      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 = {}
+        @query_params["MaxResultsPerPage"] = max_results_per_page unless max_results_per_page.nil?
+        unless financial_event_group_started_before.nil?
+          @query_params["FinancialEventGroupStartedBefore"] =
+            financial_event_group_started_before
+        end
+        unless financial_event_group_started_after.nil?
+          @query_params["FinancialEventGroupStartedAfter"] =
+            financial_event_group_started_after
+        end
+        @query_params["NextToken"] = next_token unless next_token.nil?
+        @request_type = "GET"
+        call_api
+      end
+
+      def list_financial_events_by_group_id(event_group_id, max_results_per_page = nil, posted_after = nil, posted_before = nil, next_token = nil)
+        @local_var_path = "/finances/v0/financialEventGroups/#{event_group_id}/financialEvents"
+        @query_params = {}
+        @query_params["MaxResultsPerPage"] = max_results_per_page unless max_results_per_page.nil?
+        @query_params["PostedAfter"] = posted_after unless posted_after.nil?
+        @query_params["PostedBefore"] = posted_before unless posted_before.nil?
+        @query_params["NextToken"] = next_token unless next_token.nil?
+        @request_type = "GET"
+        call_api
+      end
+    end
+  end
+end

data/lib/muffin_man/lwa/auth_helper.rb

@@ -0,0 +1,27 @@
+module MuffinMan::Lwa
+  class AuthHelper
+    ACCESS_TOKEN_URL = "https://api.amazon.com/auth/o2/token".freeze
+
+    def self.get_refresh_token(client_id, client_secret, auth_code)
+      body = {
+        grant_type: "authorization_code",
+        code: auth_code,
+        client_id: client_id,
+        client_secret: client_secret
+      }
+      response = Typhoeus.post(
+        ACCESS_TOKEN_URL,
+        body: URI.encode_www_form(body),
+        headers: {
+          "Content-Type" => "application/x-www-form-urlencoded;charset=UTF-8"
+        }
+      )
+      if response.code != 200
+        error_body = JSON.parse(response.body)
+        error = "#{error_body["error"]}: #{error_body["error_description"]}"
+        raise MuffinMan::Error, error
+      end
+      JSON.parse(response.body)["refresh_token"]
+    end
+  end
+end

data/lib/muffin_man/reports/v20210630.rb

@@ -1,12 +1,40 @@
 module MuffinMan
   module Reports
     class V20210630 < SpApiClient
-      SANDBOX_REPORT_TYPE = "GET_MERCHANT_LISTINGS_ALL_DATA"
-      SANDBOX_START_TIME = "2019-12-10T20:11:24.000Z"
-      SANDBOX_MARKETPLACE_IDS = [
-        "A1PA6795UKMFR9",
-        "ATVPDKIKX0DER"
-      ]
+      SANDBOX_REPORT_TYPES = "FEE_DISCOUNTS_REPORT,GET_AFN_INVENTORY_DATA".freeze
+      SANDBOX_PROCESSING_STATUSES = "IN_QUEUE,IN_PROGRESS".freeze
+      SANDBOX_REPORT_TYPE = "GET_MERCHANT_LISTINGS_ALL_DATA".freeze
+      SANDBOX_START_TIME = "2019-12-10T20:11:24.000Z".freeze
+      SANDBOX_CANCEL_REPORT_ID = "ID".freeze
+      SANDBOX_MARKETPLACE_IDS = %w[
+        A1PA6795UKMFR9
+        ATVPDKIKX0DER
+      ].freeze
+      SANDBOX_REPORT_ID = "ID323".freeze
+      SANDBOX_REPORT_DOCUMENT_ID = "0356cf79-b8b0-4226-b4b9-0ee058ea5760".freeze
+
+      GET_REPORTS_PARAMS = %w[
+        reportTypes
+        processingStatuses
+        marketplaceIds
+        pageSize
+        createdSince
+        createdUntil
+        nextToken
+      ].freeze
+
+      def get_reports(params = {})
+        @local_var_path = "/reports/2021-06-30/reports"
+        if sandbox
+          params = {
+            "reportTypes" => SANDBOX_REPORT_TYPES,
+            "processingStatuses" => SANDBOX_PROCESSING_STATUSES
+          }
+        end
+        @query_params = params.slice(*GET_REPORTS_PARAMS)
+        @request_type = "GET"
+        call_api
+      end
 
       def create_report(report_type, marketplace_ids, start_time = nil, end_time = nil, report_options = {})
         report_type = sandbox ? SANDBOX_REPORT_TYPE : report_type
@@ -16,12 +44,33 @@ module MuffinMan
         @local_var_path = "/reports/2021-06-30/reports"
         @request_body = {
           "reportType" => report_type,
-          "marketplaceIds" => marketplace_ids,
+          "marketplaceIds" => marketplace_ids
         }
         @request_body["dataStartTime"] = start_time unless start_time.nil?
         @request_body["dataEndTime"] = end_time unless end_time.nil?
         @request_body["reportOptions"] = report_options unless report_options.empty?
-        @request_type = 'POST'
+        @request_type = "POST"
+        call_api
+      end
+
+      def get_report(report_id)
+        report_id = sandbox ? SANDBOX_REPORT_ID : report_id
+        @local_var_path = "/reports/2021-06-30/reports/#{report_id}"
+        @request_type = "GET"
+        call_api
+      end
+
+      def cancel_report(report_id)
+        report_id = sandbox ? SANDBOX_CANCEL_REPORT_ID : report_id
+        @local_var_path = "/reports/2021-06-30/reports/#{report_id}"
+        @request_type = "DELETE"
+        call_api
+      end
+
+      def get_report_document(report_document_id)
+        report_document_id = sandbox ? SANDBOX_REPORT_DOCUMENT_ID : report_document_id
+        @local_var_path = "/reports/2021-06-30/documents/#{report_document_id}"
+        @request_type = "GET"
         call_api
       end
     end

data/lib/muffin_man/solicitations/v1.rb

@@ -11,9 +11,11 @@ module MuffinMan
       def create_product_review_and_seller_feedback_solicitation(amazon_order_id, marketplace_ids)
         @amazon_order_id = sandbox ? SANDBOX_AMAZON_ORDER_ID : amazon_order_id
         @marketplace_ids = sandbox ? SANDBOX_MARKETPLACE_IDS : marketplace_ids
-        @local_var_path = '/solicitations/v1/orders/{amazonOrderId}/solicitations/productReviewAndSellerFeedback'.sub('{' + 'amazonOrderId' + '}', @amazon_order_id)
+        @local_var_path = "/solicitations/v1/orders/{amazonOrderId}/solicitations/productReviewAndSellerFeedback".sub(
+          "{" + "amazonOrderId" + "}", @amazon_order_id
+        )
         @query_params = { "marketplaceIds" => @marketplace_ids }
-        @request_type = 'POST'
+        @request_type = "POST"
         call_api
       end
     end

data/lib/muffin_man/sp_api_client.rb

@@ -1,20 +1,21 @@
-require 'aws-sigv4'
-require 'uri'
-require 'aws-sdk-core'
-require 'typhoeus'
-require 'securerandom'
+require "aws-sigv4"
+require "uri"
+require "aws-sdk-core"
+require "typhoeus"
+require "securerandom"
 
 module MuffinMan
   class SpApiClient
     attr_reader :refresh_token, :client_id, :client_secret, :aws_access_key_id,
-      :aws_secret_access_key, :sts_iam_role_arn, :sandbox, :config, :region, :request_type,
-      :local_var_path, :query_params, :request_body
-    ACCESS_TOKEN_URL = 'https://api.amazon.com/auth/o2/token'.freeze
-    SERVICE_NAME = 'execute-api'.freeze
+                :aws_secret_access_key, :sts_iam_role_arn, :sandbox, :config, :region, :request_type,
+                :local_var_path, :query_params, :request_body, :scope
+
+    ACCESS_TOKEN_URL = "https://api.amazon.com/auth/o2/token".freeze
+    SERVICE_NAME = "execute-api".freeze
     AWS_REGION_MAP = {
-      'na' => 'us-east-1',
-      'eu' => 'eu-west-1',
-      'fe' => 'us-west-2'
+      "na" => "us-east-1",
+      "eu" => "eu-west-1",
+      "fe" => "us-west-2"
     }.freeze
 
     def initialize(credentials, sandbox = false)
@@ -24,9 +25,10 @@ module MuffinMan
       @aws_access_key_id = credentials[:aws_access_key_id]
       @aws_secret_access_key = credentials[:aws_secret_access_key]
       @sts_iam_role_arn = credentials[:sts_iam_role_arn]
-      @region = credentials[:region] || 'na'
+      @region = credentials[:region] || "na"
+      @scope = credentials[:scope]
       @sandbox = sandbox
-      Typhoeus::Config.user_agent = ''
+      Typhoeus::Config.user_agent = ""
       @config = MuffinMan.configuration
     end
 
@@ -38,9 +40,7 @@ module MuffinMan
 
     def request_opts
       opts = { headers: headers }
-      if request_body
-        opts[:body] = request_body.to_json
-      end
+      opts[:body] = request_body.to_json if request_body
       opts
     end
 
@@ -63,20 +63,21 @@ module MuffinMan
     end
 
     def retrieve_lwa_access_token
-      return request_lwa_access_token['access_token'] unless defined?(config.get_access_token)
+      return request_lwa_access_token["access_token"] unless defined?(config.get_access_token)
+
       stored_token = config.get_access_token.call(client_id)
       if stored_token.nil?
         new_token = request_lwa_access_token
         config.save_access_token.call(client_id, new_token) if defined?(config.save_access_token)
-        return new_token['access_token']
+        new_token["access_token"]
       else
-        return stored_token
+        stored_token
       end
     end
 
     def request_lwa_access_token
       body = {
-        grant_type: 'refresh_token',
+        grant_type: "refresh_token",
         refresh_token: refresh_token,
         client_id: client_id,
         client_secret: client_secret
@@ -85,7 +86,29 @@ module MuffinMan
         ACCESS_TOKEN_URL,
         body: URI.encode_www_form(body),
         headers: {
-          'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8'
+          "Content-Type" => "application/x-www-form-urlencoded;charset=UTF-8"
+        }
+      )
+      JSON.parse(response.body)
+    end
+
+    def retrieve_grantless_access_token
+      # No storage of this type for now
+      request_grantless_access_token["access_token"]
+    end
+
+    def request_grantless_access_token
+      body = {
+        grant_type: "client_credentials",
+        scope: scope,
+        client_id: client_id,
+        client_secret: client_secret
+      }
+      response = Typhoeus.post(
+        ACCESS_TOKEN_URL,
+        body: URI.encode_www_form(body),
+        headers: {
+          "Content-Type" => "application/x-www-form-urlencoded;charset=UTF-8"
         }
       )
       JSON.parse(response.body)
@@ -117,17 +140,22 @@ module MuffinMan
     end
 
     def headers
+      access_token = scope ? retrieve_grantless_access_token : retrieve_lwa_access_token
       headers = {
-        'x-amz-access-token' => retrieve_lwa_access_token,
-        'user-agent' => "MuffinMan/#{VERSION} (Language=Ruby)",
-        'content-type' => "application/json"
+        "x-amz-access-token" => access_token,
+        "user-agent" => "MuffinMan/#{VERSION} (Language=Ruby)",
+        "content-type" => "application/json"
       }
       signed_request.headers.merge(headers)
     end
 
     def derive_aws_region
       @aws_region ||= AWS_REGION_MAP[region]
-      raise MuffinMan::Error.new("#{region} is not supported or does not exist. Region must be one of the following: #{AWS_REGION_MAP.keys.join(', ')}") unless @aws_region
+      unless @aws_region
+        raise MuffinMan::Error,
+              "#{region} is not supported or does not exist. Region must be one of the following: #{AWS_REGION_MAP.keys.join(", ")}"
+      end
+
       @aws_region
     end
   end

data/lib/muffin_man/version.rb

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

data/lib/muffin_man.rb

@@ -1,8 +1,11 @@
 require "muffin_man/version"
 require "muffin_man/sp_api_client"
+require "muffin_man/lwa/auth_helper"
 require "muffin_man/solicitations/v1"
 require "muffin_man/reports/v20210630"
 require "muffin_man/catalog_items/v20201201"
+require "muffin_man/finances/v0"
+require "muffin_man/authorization/v1"
 
 module MuffinMan
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: muffin_man
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Gavin
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -123,7 +123,10 @@ files:
 - bin/console
 - bin/setup
 - lib/muffin_man.rb
+- lib/muffin_man/authorization/v1.rb
 - lib/muffin_man/catalog_items/v20201201.rb
+- lib/muffin_man/finances/v0.rb
+- lib/muffin_man/lwa/auth_helper.rb
 - lib/muffin_man/reports/v20210630.rb
 - lib/muffin_man/solicitations/v1.rb
 - lib/muffin_man/sp_api_client.rb