Project

muffin_man

0.0
The project is in a healthy, maintained state
Amazon Selling Partner API client
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

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

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:

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:

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:

@@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.

License

The gem is available as open source under the terms of the MIT License.

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.