muffin_man 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42a69a2af21b2348c9ef63c2d514c5edc4d03ee1c970e6c0295f9ddbb4f57c01
+  data.tar.gz: 9f0d990ad87181cdd0575b8d79f018aab3bd4fe3740290b3ab1247385539b43e
+SHA512:
+  metadata.gz: 15f2eaae1864b2a91286656457419c729b60c4feee643a1da34af06316b048ea5a6a9ed70d21d1caabd18bb572b31881a08a6e60bdde48365c9f2ad01d40e9e6
+  data.tar.gz: 6cd9d7182c2e8ec16a053fba1890e8b00259e1b19f45652a14ad122399df04725691abae28ba64cd985347529a577953a71ce28ea6fc9d52f0c8047bc586e968

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:2.6.3
+    steps:
+      - checkout
+      - run:
+          name: Run the default task
+          command: |
+            gem install bundler -v 2.2.5
+            bundle install
+            bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## 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.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in muffin_man.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Gavin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# MuffinMan
+
+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)
+
+As of now, this gem only supports the `create_product_review_and_seller_feedback_solicitation` model, likely with more to come.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'muffin_man'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install muffin_man
+
+## Usage
+
+To make a call to the Amazon Selling Partner API, define your credentials and make a call as shown:
+
+```ruby
+require 'muffin_man'
+credentials = {
+  refresh_token: LWA_REFRESH_TOKEN,
+  client_id: CLIENT_ID,
+  client_secret: CLIENT_SECRET,
+  aws_access_key_id: AWS_ACCESS_KEY_ID,
+  aws_secret_access_key: AWS_SECRET_ACCESS_KEY,
+  region: REGION, # This can be one of ['na', 'eu', 'fe'] and defaults to 'na'
+  sts_iam_role_arn: STS_IAM_ROLE_ARN, # Optional
+}
+client = MuffinMan::Solicitations.new(credentials)
+response = client.create_product_review_and_seller_feedback_solicitation(amazon_order_id, marketplace_ids, region)
+JSON.parse(response.body)
+```
+
+You can optionally use Amazon's sandbox environment by specifying `client = MuffinMan::Solicitations.new(credentials, sandbox = true)`
+
+You can save and retrieve the LWA refresh token by defining a lambda in your initializers.
+
+For example, if you are using Redis as your cache you could define:
+
+```ruby
+@@redis = Redis.new
+MuffinMan.configure do |config|
+  config.save_access_token = -> (client_id, token) do
+    @@redis.set("SP-TOKEN-#{client_id}", token['access_token'], ex: token['expires_in'])
+  end
+
+  config.get_access_token = -> (client_id) { @@redis.get("SP-TOKEN-#{client_id}") }
+end
+```
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MuffinMan project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/muffin_man/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "muffin_man"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/muffin_man.rb

@@ -0,0 +1,20 @@
+require_relative "muffin_man/version"
+require "muffin_man/sp_api_client"
+require "muffin_man/solicitations"
+
+module MuffinMan
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :save_access_token, :get_access_token
+  end
+end

data/lib/muffin_man/solicitations.rb

@@ -0,0 +1,19 @@
+module MuffinMan
+  class Solicitations < SpApiClient
+    SANDBOX_AMAZON_ORDER_ID = "123-1234567-1234567"
+    SANDBOX_MARKETPLACE_IDS = "ATVPDKIKX0DER"
+    attr_reader :amazon_order_id, :marketplace_ids, :request_type, :local_var_path, :query_params
+
+    # Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
+    # @param amazon_order_id An Amazon order identifier. This specifies the order for which a solicitation is sent.
+    # @param marketplace_ids A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+    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)
+      @query_params = { "marketplaceIds" => @marketplace_ids }
+      @request_type = 'POST'
+      call_api
+    end
+  end
+end

data/lib/muffin_man/sp_api_client.rb

@@ -0,0 +1,128 @@
+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
+    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'
+    }.freeze
+
+    def initialize(credentials, sandbox = false)
+      @refresh_token = credentials[:refresh_token]
+      @client_id = credentials[:client_id]
+      @client_secret = credentials[:client_secret]
+      @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'
+      @sandbox = sandbox
+      Typhoeus::Config.user_agent = ''
+      @config = MuffinMan.configuration
+    end
+
+    private
+
+    def call_api
+      Typhoeus.send(request_type.downcase.to_sym, request.url, headers: headers)
+    end
+
+    def sp_api_host
+      hostname = "sellingpartnerapi-#{region}.amazon.com"
+      sandbox ? hostname.prepend("sandbox.") : hostname
+    end
+
+    def sp_api_url
+      "https://#{sp_api_host}"
+    end
+
+    def canonical_uri
+      # local_var_path is defined in subclasses
+      "#{sp_api_url}#{local_var_path}"
+    end
+
+    def request
+      @request ||= Typhoeus::Request.new(
+        canonical_uri,
+        params: query_params
+      )
+    end
+
+    def retrieve_lwa_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']
+      else
+        return stored_token
+      end
+    end
+
+    def request_lwa_access_token
+      body = {
+        grant_type: 'refresh_token',
+        refresh_token: refresh_token,
+        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)
+    end
+
+    def request_sts_token
+      client = Aws::STS::Client.new(
+        region: derive_aws_region,
+        access_key_id: aws_access_key_id,
+        secret_access_key: aws_secret_access_key
+      )
+      client.assume_role(role_arn: sts_iam_role_arn, role_session_name: SecureRandom.uuid)
+    end
+
+    def signed_request
+      request_config = {
+        service: SERVICE_NAME,
+        region: derive_aws_region,
+        endpoint: sp_api_host
+      }
+      if sts_iam_role_arn.nil?
+        request_config[:access_key_id] = aws_access_key_id
+        request_config[:secret_access_key] = aws_secret_access_key
+      else
+        request_config[:credentials_provider] = request_sts_token
+      end
+      signer = Aws::Sigv4::Signer.new(request_config)
+      signer.sign_request(http_method: request_type, url: request.url)
+    end
+
+    def headers
+      headers = {
+        'x-amz-access-token' => retrieve_lwa_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
+      @aws_region
+    end
+  end
+end

data/lib/muffin_man/version.rb

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

data/muffin_man.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/muffin_man/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "muffin_man"
+  spec.version       = MuffinMan::VERSION
+  spec.authors       = ["Gavin", "Jason", "Nate"]
+  spec.email         = ["gavin@pattern.com", "jason@pattern.com", "nate.salisbury@pattern.com"]
+
+  spec.summary       = "Amazon Selling Partner API client"
+  spec.homepage      = "https://github.com/patterninc/muffin_man"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'mock_redis', '>=0.14'
+  spec.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  spec.add_runtime_dependency 'aws-sigv4', '~> 1.2', '>= 1.2.2'
+  spec.add_runtime_dependency 'aws-sdk-core', '~> 2.4', '>= 2.4.4'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: muffin_man
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gavin
+- Jason
+- Nate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+description: 
+email:
+- gavin@pattern.com
+- jason@pattern.com
+- nate.salisbury@pattern.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/muffin_man.rb
+- lib/muffin_man/solicitations.rb
+- lib/muffin_man/sp_api_client.rb
+- lib/muffin_man/version.rb
+- muffin_man.gemspec
+homepage: https://github.com/patterninc/muffin_man
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Amazon Selling Partner API client
+test_files: []