muffin_man 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82c3118e9e61b82872329714fbfbaf80fd7613ff98ce126992f2ac3b834e3a51
-  data.tar.gz: 201afe55ba25967d8e519ff5f6a0ac9a66e452462cc4fe805ab2a34b61edec9a
+  metadata.gz: 1034d149292cba5172729ff270ccb038a70c6dcf1b5a9d460add8b7b370f0dea
+  data.tar.gz: 4d99306ee66d36d0df05bcd46e4d71a4af2db29b3a2d5562b37d5634b7722469
 SHA512:
-  metadata.gz: 9411d153ce20efc02882b456a9b6be233cf88e691472d35bbca5b8890fc422395d5a925a66996c129a1a5835883ac66153415043a94e37ad2d9c6e7e3b17baf5
-  data.tar.gz: 7859bc864e708516ce37087a32791a1fbbae140af2307fbc8d7c530933517e1d914faf704151b7269c290853cfa3a44c741c552a8aadf06bf605cc5ba2745d28
+  metadata.gz: 9e0faedca6d800deb56277c05103859cbdc2ceaebb80ec811ecab69e49d280913e37ecd09630d35bb95ae291e446b71d054877e4b7a6ca245c59b6797e1988a0
+  data.tar.gz: 34a92f83302a0f1945f1887bbac28e97c2150d734efffcdba648f91fa42aa5ba89e164f1005460694676c100d6ead10eee9177ca1df88055066acb5efb49e204

data/.gitignore

@@ -14,3 +14,4 @@
 Gemfile.lock
 *.gem
 .ruby-version
+.byebug_history

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.4.0
+
+- Pass cache key to client for caching access tokens [#11](https://github.com/patterninc/muffin_man/pull/11)

data/README.md

@@ -40,6 +40,7 @@ credentials = {
   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
+  access_token_cache_key: SELLING_PARTNER_ID, # Optional if you want access token caching
 }
 client = MuffinMan::Solicitations::V1.new(credentials)
 response = client.create_product_review_and_seller_feedback_solicitation(amazon_order_id, marketplace_ids)
@@ -48,6 +49,8 @@ JSON.parse(response.body)
 
 You can optionally use Amazon's sandbox environment by specifying `client = MuffinMan::Solicitations.new(credentials, sandbox = true)`
 
+### Access Token Caching
+
 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:
@@ -55,11 +58,11 @@ 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'])
+  config.save_access_token = -> (access_token_cache_key, token) do
+    @@redis.set("SP-TOKEN-#{access_token_cache_key}", token['access_token'], ex: token['expires_in'])
   end
 
-  config.get_access_token = -> (client_id) { @@redis.get("SP-TOKEN-#{client_id}") }
+  config.get_access_token = -> (access_token_cache_key) { @@redis.get("SP-TOKEN-#{access_token_cache_key}") }
 end
 ```
 

data/lib/muffin_man/sp_api_client.rb

@@ -7,8 +7,9 @@ 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, :scope
+                :aws_secret_access_key, :sts_iam_role_arn, :sandbox, :config,
+                :region, :request_type, :local_var_path, :query_params,
+                :request_body, :scope, :access_token_cache_key
 
     ACCESS_TOKEN_URL = "https://api.amazon.com/auth/o2/token".freeze
     SERVICE_NAME = "execute-api".freeze
@@ -27,6 +28,7 @@ module MuffinMan
       @sts_iam_role_arn = credentials[:sts_iam_role_arn]
       @region = credentials[:region] || "na"
       @scope = credentials[:scope]
+      @access_token_cache_key = credentials[:access_token_cache_key]
       @sandbox = sandbox
       Typhoeus::Config.user_agent = ""
       @config = MuffinMan.configuration
@@ -63,18 +65,22 @@ 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 use_cache?
 
-      stored_token = config.get_access_token.call(client_id)
+      stored_token = config.get_access_token.call(access_token_cache_key)
       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)
+        config.save_access_token.call(access_token_cache_key, new_token)
         new_token["access_token"]
       else
         stored_token
       end
     end
 
+    def use_cache?
+      defined?(config.save_access_token) && defined?(config.get_access_token) && access_token_cache_key
+    end
+
     def request_lwa_access_token
       body = {
         grant_type: "refresh_token",

data/lib/muffin_man/version.rb

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

data/muffin_man.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'byebug'
   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.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: muffin_man
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Gavin
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,6 +40,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +129,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -151,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Amazon Selling Partner API client