omniauth-amazon-sp-api 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 262bb72940b3ee5ee101604beebc60d2a97fc3d153818b7a70970fea418cd161
+  data.tar.gz: ea3390764afd5ac8424d4f951924aaee7eccc98987fd892536b84962539e6f03
+SHA512:
+  metadata.gz: 3d706e43f790d844434391d23b983f2fc6703d65a6ddf1f6c18e57b3305ea898e05610f46a7e6d74f21d54fe35fcc91420c445428efbb436fb2b472486587ea4
+  data.tar.gz: 380db0e148ef4dd778ddefbc66e7f510cab3c9de1b65f771cde56df84cb9646f3221b491382fcf4b21ea44922b90f0da9e44e887ecf81e8a14256fc91175fbd6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,4 @@
+sudo: false
+rvm:
+  - 3.0.2
+  - 2.7.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-amazon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License
+
+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,47 @@
+# OmniAuth::AmazonSpApi
+
+Website authorization flow for Amazon Selling Partner APIs.
+
+https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#website-authorization-workflow
+
+# Configuration
+
+Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :amazon_sp_api, ENV['AMAZON_SP_API_CLIENT_ID'], ENV['AMAZON_SP_API_CLIENT_SECRET'],
+           redirect_uri: "https://example.com/auth/amazon_sp_api/callback", # if you need to override the default URL generated by the gem
+           authorize_params: {
+             application_id: ENV['AMAZON_SP_API_APPLICATION_ID'],
+             version: 'beta', # If you app is in Draft state, this is required.
+           },
+           client_options: {
+             authorize_url: 'https://sellercentral.amazon.com/apps/authorize/consent',
+             site: Rails.env.production? ? 'https://sellingpartnerapi-na.amazon.com' : 'https://sandbox.sellingpartnerapi-na.amazon.com'
+           }
+end
+```
+
+## Using devise
+
+Here's an example if you are using Devise. Add this to `config/initializers/devise.rb`:
+
+```ruby
+  config.omniauth :amazon_sp_api, ENV['AMAZON_SP_API_CLIENT_ID'], ENV['AMAZON_SP_API_CLIENT_SECRET'], {
+    redirect_uri: "https://example.com/auth/amazon_sp_api/callback", # if you need to override the default URL generated by the gem
+    authorize_params: {
+      application_id: ENV['AMAZON_SP_API_APPLICATION_ID'],
+      version: 'beta', # If you app is in Draft state, this is required.
+    },
+  }
+```
+
+Then update your `User` model:
+
+```ruby
+  devise(
+    # Other Devise options
+    omniauth_providers: [:amazon_sp_api],
+  )
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/omniauth/amazon-sp-api/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module AmazonSpApi
+    VERSION = '1.0.2'.freeze
+  end
+end

data/lib/omniauth/amazon-sp-api.rb

@@ -0,0 +1,3 @@
+require "omniauth/amazon-sp-api/version"
+require "omniauth/strategies/amazon-sp-api"
+

data/lib/omniauth/strategies/amazon-sp-api.rb

@@ -0,0 +1,46 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class AmazonSpApi < OmniAuth::Strategies::OAuth2
+      attr_reader :selling_partner_id, :mws_auth_token
+
+      option :name, 'amazon_sp_api'
+
+      option :client_options,
+             {
+               site: 'https://sellingpartnerapi-na.amazon.com',
+               authorize_url: 'https://sellercentral.amazon.com/apps/authorize/consent',
+               token_url: 'https://api.amazon.com/auth/o2/token'
+             }
+
+      extra do
+        {
+          'selling_partner_id' => selling_partner_id,
+          'mws_auth_token' => mws_auth_token
+        }
+      end
+
+      def callback_phase
+        @selling_partner_id = request.params['selling_partner_id']
+        @mws_auth_token = request.params['mws_auth_token']
+        super
+      end
+
+      def build_access_token
+        verifier = request.params['spapi_oauth_code']
+        client.auth_code.get_token(
+          verifier,
+          { redirect_uri: callback_url }.merge(
+            token_params.to_hash(symbolize_keys: true)
+          ),
+          deep_symbolize(options.auth_token_params)
+        )
+      end
+
+      def callback_url
+        options[:redirect_uri] || full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/lib/omniauth-amazon-sp-api.rb

@@ -0,0 +1 @@
+require 'omniauth/amazon-sp-api'

data/omniauth-amazon-sp-api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/amazon-sp-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-amazon-sp-api"
+  spec.version       = OmniAuth::AmazonSpApi::VERSION
+  spec.authors       = ["Dropstream"]
+  spec.email         = ["karl.falconer@getdropstream.com"]
+  spec.description   = %q{Amazon Selling Partner API strategy}
+  spec.summary       = %q{Amazon Selling Partner API strategy}
+  spec.homepage      = "https://github.com/dropstream/omniauth-amazon-sp-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'omniauth', '~> 1.0'
+  spec.add_dependency 'omniauth-oauth2', '~> 1.1'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry-byebug'
+end

data/spec/omniauth/strategies/amazon-sp-api_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'support/shared_examples'
+
+describe OmniAuth::Strategies::AmazonSpApi do
+  subject(:strategy) do
+    strategy = OmniAuth::Strategies::AmazonSpApi.new(nil, nil, options)
+    strategy.stub(:session) { {} }
+    strategy
+  end
+
+  let(:options) { {} }
+
+  include_examples 'an oauth2 strategy'
+
+  describe '#client' do
+    subject(:client) { strategy.client }
+
+    it 'should have the correct Amazon site' do
+      expect(client.site).to eq 'https://sellingpartnerapi-na.amazon.com'
+    end
+
+    it 'should have the correct authorization url' do
+      expect(client.options[:authorize_url]).to eq(
+        'https://sellercentral.amazon.com/apps/authorize/consent'
+      )
+    end
+
+    it 'should have the correct token url' do
+      expect(client.options[:token_url]).to eq(
+        'https://api.amazon.com/auth/o2/token'
+      )
+    end
+  end
+
+  describe '#callback_path' do
+    subject(:callback_path) { strategy.callback_path }
+
+    it 'should have the correct callback path' do
+      expect(callback_path).to eq '/auth/amazon_sp_api/callback'
+    end
+  end
+
+  describe '#callback_url' do
+    subject(:callback_url) { strategy.callback_url }
+
+    it 'does not include query parameters' do
+      allow(strategy).to receive(:full_host).and_return('https://example.com')
+      allow(strategy).to receive(:script_name).and_return('/sub_uri')
+      allow(strategy).to receive(:query_string).and_return('?foo=bar')
+
+      expect(callback_url).to eq 'https://example.com/sub_uri/auth/amazon_sp_api/callback'
+    end
+
+    context 'when a redirect_uri option is informed' do
+      let(:options) { { redirect_uri: "https://example.com/auth/amazon_sp_api/callback" } }
+
+      it 'returns the redirect_uri' do
+        expect(callback_url).to eq options[:redirect_uri]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-amazon-sp-api'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,72 @@
+# Courtesy omniauth-37signals:
+# https://github.com/tallgreentree/omniauth-37signals/blob/master/spec/support/shared_examples.rb
+
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    subject(:client) { strategy.client}
+
+    context  'with client_options informed' do
+      let(:options) do
+        {
+          client_options: { 'authorize_url' => 'https://example.com' }
+        }
+      end
+
+      it 'should be initialized with symbolized client_options' do
+        expect(client.options[:authorize_url]).to eq 'https://example.com'
+      end
+    end
+  end
+
+  describe '#authorize_params' do
+    subject(:authorize_params) { strategy.authorize_params}
+
+    context 'with authorized_params option' do
+      let(:options) do
+        { authorize_params: { foo: 'bar', baz: 'zip' } }
+      end
+
+      it 'should include any authorize params passed in the :authorize_params option' do
+        expect(authorize_params['foo']).to eq 'bar'
+        expect(authorize_params['baz']).to eq 'zip'
+      end
+    end
+
+    context 'with top-level options marked as authorized_options' do
+      let(:options) do
+        { authorize_options: %i[scope foo], scope: 'bar', foo: 'baz' }
+      end
+
+      it 'should include top-level options that are marked as :authorize_options' do
+        expect(authorize_params['scope']).to eq 'bar'
+        expect(authorize_params['foo']).to eq 'baz'
+      end
+    end
+  end
+
+  describe '#token_params' do
+    subject(:token_params) { strategy.token_params}
+
+    context 'with token_params option' do
+      let(:options) do
+        { token_params: { foo: 'bar', baz: 'zip' } }
+      end
+
+      it 'should include any authorize params passed in the :token_params option' do
+        expect(token_params['foo']).to eq 'bar'
+        expect(token_params['baz']).to eq 'zip'
+      end
+    end
+
+    context 'with top-level options marked as authorized_options' do
+      let(:options) do
+        { token_options: %i[scope foo], scope: 'bar', foo: 'baz' }
+      end
+
+      it 'should include top-level options that are marked as :token_options' do
+        expect(token_params['scope']).to eq 'bar'
+        expect(token_params['foo']).to eq 'baz'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-amazon-sp-api
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Dropstream
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: simplecov
+  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: webmock
+  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: pry-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'
+description: Amazon Selling Partner API strategy
+email:
+- karl.falconer@getdropstream.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-amazon-sp-api.rb
+- lib/omniauth/amazon-sp-api.rb
+- lib/omniauth/amazon-sp-api/version.rb
+- lib/omniauth/strategies/amazon-sp-api.rb
+- omniauth-amazon-sp-api.gemspec
+- spec/omniauth/strategies/amazon-sp-api_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/dropstream/omniauth-amazon-sp-api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Amazon Selling Partner API strategy
+test_files:
+- spec/omniauth/strategies/amazon-sp-api_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb