omniauth-bigcommerce 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae29ba3aca8d409d3dd30d0701c87dd328d98657
-  data.tar.gz: f0adc06fd7a179cd2d1010667890204b8d8d0ce7
+  metadata.gz: 2fd32cd52747a4e99dbeb7fa6ac4b940f4efd540
+  data.tar.gz: a02adf6795281e1b97256aa74ac14641e4995668
 SHA512:
-  metadata.gz: a9656528f068f1c5b7d31e4c69571727d52b16bed0c851a5b1e2205d3f5d5a571d389657a34d1561bef8a0d42ac19a2c2fd960d17ad7953b0f489085ec2f7fd0
-  data.tar.gz: 8145de6b8825c9762b6f0120532b4d4625a740809c7746f42d6673059abaf64b73e05c19db87e6a33537c8c57e5f37bf5f1da93a185707c2f6c2313be2237596
+  metadata.gz: d7d4e9e0b458833e6ac4266669b1716f2c19998fee1ebe81eaac9362b10dfe208b15e0c53ac1827273b6d38d5a3f45c21eb25cdcf835375460b2191e8bbde6a0
+  data.tar.gz: cacc7e225d778745ea2d50a4eb1131263ef78d7b58244ec4ea50d8aa11e367d5d24de626d44461357ffe597a2766d257e27f18dfd120e00003b6294be5a6b9b1

data/.gitignore

@@ -1,6 +1,6 @@
-# Ignore lockfiles
-/Gemfile.lock
-
-# Ignore test output
-/spec/coverage
-/spec/reports
+.bundle
+Gemfile.lock
+coverage
+reports
+pkg
+vendor/bundle

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 rvm:
   - ruby-head
-  - 2.1.1
-  - 2.0.0
-  - 1.9.3
+  - 2.3.1
+  - 2.2.5
+  - 2.1.10
 matrix:
   allow_failures:
     - rvm: ruby-head

data/Gemfile

@@ -1,13 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in omniauth-bigcommerce.gemspec
 gemspec
-
-group :development, :test do
-  gem 'rake'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'guard-bundler'
-  gem 'rb-fsevent'
-  gem 'growl'
-end

data/lib/omniauth-bigcommerce.rb

@@ -1,2 +1,2 @@
-require "omniauth/bigcommerce/version"
+require 'omniauth/bigcommerce/version'
 require 'omniauth/strategies/bigcommerce'

data/lib/omniauth/bigcommerce/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
-  module Bigcommerce
-    VERSION = "0.2.0"
+  module BigCommerce
+    VERSION = '0.3.0'
   end
 end

data/lib/omniauth/strategies/bigcommerce.rb

@@ -2,15 +2,13 @@ require 'omniauth-oauth2'
 
 module OmniAuth
   module Strategies
-    class Bigcommerce < OmniAuth::Strategies::OAuth2
-      option :name, "bigcommerce"
-
+    class BigCommerce < OmniAuth::Strategies::OAuth2
+      option :name, 'bigcommerce'
       option :provider_ignores_state, true
-
-      option :scope, "users_basic_information"
-
-      option :client_options,
-      {
+      option :scope, 'users_basic_information'
+      option :authorize_options, [:scope, :context]
+      option :token_options, [:scope, :context]
+      option :client_options, {
         site: ENV['BC_AUTH_SERVICE'] || 'https://login.bigcommerce.com',
         authorize_url: '/oauth2/authorize',
         token_url: '/oauth2/token'
@@ -27,7 +25,7 @@ module OmniAuth
 
       credentials do
         {
-          :token => access_token
+          token: access_token
         }
       end
 
@@ -43,8 +41,32 @@ module OmniAuth
         @raw_info ||= access_token.params
       end
 
+      # Exclude query string in callback url. This used to be part of omniauth-oauth2, but was
+      # removed in 1.4.0: https://github.com/intridea/omniauth-oauth2/pull/70
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      # Make sure to pass scope and context through to the authorize call
+      # https://github.com/zquestz/omniauth-google-oauth2/blob/master/lib/omniauth/strategies/google_oauth2.rb#L26
+      def authorize_params
+        super.tap do |params|
+          options[:authorize_options].each do |k|
+            params[k] = request.params[k.to_s] unless [nil, ''].include?(request.params[k.to_s])
+          end
+        end
+      end
+
+      # Make sure to pass scope and context through to the token exchange call
+      def token_params
+        super.tap do |params|
+          options[:token_options].each do |k|
+            params[k] = request.params[k.to_s] unless [nil, ''].include?(request.params[k.to_s])
+          end
+        end
+      end
     end
   end
 end
 
-OmniAuth.config.add_camelization 'bigcommerce', 'Bigcommerce'
+OmniAuth.config.add_camelization 'bigcommerce', 'BigCommerce'

data/omniauth-bigcommerce.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/omniauth/bigcommerce/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Tom Allen, Phil Muir, Sasha Gerrand"]
   gem.email         = ["developer@bigcommerce.com"]
-  gem.description   = %q{Official OmniAuth strategy for Bigcommerce.}
-  gem.summary       = %q{Official OmniAuth strategy for Bigcommerce.}
+  gem.description   = %q{Official OmniAuth strategy for BigCommerce.}
+  gem.summary       = %q{Official OmniAuth strategy for BigCommerce.}
   gem.homepage      = "https://github.com/bigcommerce/omniauth-bigcommerce"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -13,13 +13,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "omniauth-bigcommerce"
   gem.require_paths = ["lib"]
-  gem.version       = OmniAuth::Bigcommerce::VERSION
+  gem.required_ruby_version = '>= 2.1'
+  gem.version       = OmniAuth::BigCommerce::VERSION
 
-  gem.add_dependency 'omniauth', '~> 1.0'
-  gem.add_dependency 'omniauth-oauth2', '~> 1.1'
-  gem.add_development_dependency 'rake', '~> 2.7'
-  gem.add_development_dependency 'rspec', '~> 2.7'
-  gem.add_development_dependency 'rack-test'
+  gem.add_dependency 'omniauth'
+  gem.add_dependency 'omniauth-oauth2', '>= 1.1.1'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'webmock'
 end

data/spec/omniauth/strategies/bigcommerce_spec.rb

@@ -1,40 +1,76 @@
 require 'spec_helper'
 
-describe OmniAuth::Strategies::Bigcommerce do
+RSpec.describe OmniAuth::Strategies::BigCommerce do
+  let(:store_hash) { 'abcdefg' }
+  let(:context) { "stores/#{store_hash}" }
+  let(:scope) { 'store_v2_products' }
+  let(:request) { double('Request', :params => { 'context' => context, 'scope' => scope }, :cookies => {}, :env => {}) }
 
-  subject do
-    OmniAuth::Strategies::Bigcommerce.new({})
+  before do
+    OmniAuth.config.test_mode = true
+    allow(subject).to receive(:request).and_return(request)
   end
+  after { OmniAuth.config.test_mode = false }
+  subject { OmniAuth::Strategies::BigCommerce.new({}) }
 
-  context 'client options' do
+  describe 'options' do
     it 'should have correct name' do
       expect(subject.options.name).to eq('bigcommerce')
     end
 
-    it 'should have correct site' do
-      # env variable set in spec_helper.rb
-      # TODO: change this once we have bigcommerceapp.com url
-      expect(subject.options.client_options.site).to eq('https://example.com')
-    end
+    describe 'client options' do
+      it 'should have correct site' do
+        # env variable set in spec_helper.rb
+        # TODO: change this once we have bigcommerceapp.com url
+        expect(subject.options.client_options.site).to eq('https://example.com')
+      end
+
+      it 'should have correct authorize url' do
+        expect(subject.options.client_options.authorize_url).to eq('/oauth2/authorize')
+      end
 
-    it 'should have correct authorize url' do
-      expect(subject.options.client_options.authorize_url).to eq('/oauth2/authorize')
+      it 'should have correct token url' do
+        expect(subject.options.client_options.token_url).to eq('/oauth2/token')
+      end
     end
 
-    it 'should have correct token url' do
-      expect(subject.options.client_options.token_url).to eq('/oauth2/token')
+    describe 'OAuth2 settings' do
+      it 'should ignore state' do
+        expect(subject.options.provider_ignores_state).to eq true
+      end
     end
   end
 
-  context 'oauth2 settings' do
-    it 'should ignore state' do
-      expect(subject.options.provider_ignores_state).to eq true
+  describe 'callback url' do
+    it 'should have the correct path' do
+      expect(subject.callback_path).to eq('/auth/bigcommerce/callback')
+    end
+
+    context 'when callback url has a query string' do
+      let(:host) { 'https://example.com' }
+      let(:query_string) { 'foo=bar' }
+      before do
+        allow(subject).to receive(:full_host).and_return(host)
+        allow(subject).to receive(:script_name).and_return('')
+        allow(subject).to receive(:query_string).and_return(query_string)
+      end
+
+      it 'query string should not be included in the callback url' do
+        expect(subject.callback_url).to eq("#{host}#{subject.callback_path}")
+        expect(subject.callback_url).to_not include(query_string)
+      end
     end
   end
 
-  context 'callback url' do
-    it 'should have the correct path' do
-      subject.callback_path.should eq('/auth/bigcommerce/callback')
+  describe 'extra params for authorize and token exchange' do
+    it 'should set the context and scope parameters in the authorize request' do
+      expect(subject.authorize_params['context']).to eq(context)
+      expect(subject.authorize_params['scope']).to eq(scope)
+    end
+
+    it 'should set the context and scope parameters in the token request' do
+      expect(subject.token_params['context']).to eq(context)
+      expect(subject.token_params['scope']).to eq(scope)
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,15 +2,12 @@ ENV['BC_AUTH_SERVICE'] = 'https://example.com'
 
 require 'simplecov'
 SimpleCov.start
-require 'rspec'
-require 'rack/test'
-require 'webmock/rspec'
-require 'omniauth'
+
 require 'omniauth-bigcommerce'
 
 RSpec.configure do |config|
-  config.include WebMock::API
-  config.include Rack::Test::Methods
-  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.color = true
+  config.order = :random
+  Kernel.srand config.seed
 end
 

metadata

@@ -1,73 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-bigcommerce
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tom Allen, Phil Muir, Sasha Gerrand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2016-05-05 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'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -81,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -108,7 +80,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Official OmniAuth strategy for Bigcommerce.
+description: Official OmniAuth strategy for BigCommerce.
 email:
 - developer@bigcommerce.com
 executables: []
@@ -138,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -149,7 +121,7 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Official OmniAuth strategy for Bigcommerce.
+summary: Official OmniAuth strategy for BigCommerce.
 test_files:
 - spec/omniauth/strategies/bigcommerce_spec.rb
 - spec/spec_helper.rb