omniauth-bigcommerce 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae29ba3aca8d409d3dd30d0701c87dd328d98657
+  data.tar.gz: f0adc06fd7a179cd2d1010667890204b8d8d0ce7
+SHA512:
+  metadata.gz: a9656528f068f1c5b7d31e4c69571727d52b16bed0c851a5b1e2205d3f5d5a571d389657a34d1561bef8a0d42ac19a2c2fd960d17ad7953b0f489085ec2f7fd0
+  data.tar.gz: 8145de6b8825c9762b6f0120532b4d4625a740809c7746f42d6673059abaf64b73e05c19db87e6a33537c8c57e5f37bf5f1da93a185707c2f6c2313be2237596

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,13 @@
+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/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('omniauth-bigcommerce.gemspec')
+end

data/README.md

@@ -0,0 +1,67 @@
+# OmniAuth Bigcommerce Strategy
+[![Build Status](https://travis-ci.org/bigcommerce/omniauth-bigcommerce.png?branch=master)](https://travis-ci.org/bigcommerce/omniauth-bigcommerce)
+
+This gem provides a dead simple way to authenticate to Bigcommerce using OmniAuth.
+
+## Installation
+
+Add to your application's Gemfile:
+
+```
+gem 'omniauth-bigcommerce'
+```
+
+## Usage
+
+First, you will need to [register an application](https://developer.bigcommerce.com).
+
+Create a `config/initializers/omniauth.rb` initializer:
+```
+use OmniAuth::Builder do
+  provider :bigcommerce, ENV['BC_CLIENT_ID'], ENV['BC_CLIENT_SECRET'], 'users_basic_information store_v2_settings store_v2_orders'
+end
+```
+
+You may also overwrite default config options:
+```
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :bigcommerce, ENV['BC_CLIENT_ID'], ENV['BC_CLIENT_SECRET'],
+           {
+             scope: "users_basic_information store_v2_products store_v2_information",
+             client_options: {
+               site: 'https://login.bigcommerce.com'
+             }
+           }
+end
+```
+See the [Omniauth Wiki](https://github.com/intridea/omniauth/wiki) for more information.
+
+## Environment Variables
+The gem will look for the bigcommerce oauth provider URL in the `BC_AUTH_SERVICE` environment variable.
+It defaults to https://login.bigcommerce.com if the env variable is not defined.
+
+## Auth Hash Schema
+
+The following information is provided back to you for this provider:
+
+```
+{
+  uid: '12345',
+  info: {
+    name: 'Philip Muir',
+    email: 'philip.muir@example.com'
+  },
+  credentials: {
+    token: 'xyz123abc'
+  },
+  extra: {
+    raw_info: {},
+    scopes: 'requested_scopes store_v2_settings'
+    context: 'store/xyz123'
+  }
+}
+```
+
+## Contributing
+
+Fork & submit a pull request.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/lib/omniauth-bigcommerce.rb

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

data/lib/omniauth/bigcommerce/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Bigcommerce
+    VERSION = "0.2.0"
+  end
+end

data/lib/omniauth/strategies/bigcommerce.rb

@@ -0,0 +1,50 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Bigcommerce < OmniAuth::Strategies::OAuth2
+      option :name, "bigcommerce"
+
+      option :provider_ignores_state, true
+
+      option :scope, "users_basic_information"
+
+      option :client_options,
+      {
+        site: ENV['BC_AUTH_SERVICE'] || 'https://login.bigcommerce.com',
+        authorize_url: '/oauth2/authorize',
+        token_url: '/oauth2/token'
+      }
+
+      uid { access_token.params['user']['id'] }
+
+      info do
+        {
+          name: access_token.params['user']['username'],
+          email: access_token.params['user']['email'],
+        }
+      end
+
+      credentials do
+        {
+          :token => access_token
+        }
+      end
+
+      extra do
+        {
+          raw_info: raw_info,
+          scopes: raw_info['scope'],
+          context: raw_info['context']
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.params
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'bigcommerce', 'Bigcommerce'

data/omniauth-bigcommerce.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-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.homepage      = "https://github.com/bigcommerce/omniauth-bigcommerce"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  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.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_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/bigcommerce_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Bigcommerce do
+
+  subject do
+    OmniAuth::Strategies::Bigcommerce.new({})
+  end
+
+  context 'client 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
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('/oauth2/authorize')
+    end
+
+    it 'should have correct token url' do
+      expect(subject.options.client_options.token_url).to eq('/oauth2/token')
+    end
+  end
+
+  context 'oauth2 settings' do
+    it 'should ignore state' do
+      expect(subject.options.provider_ignores_state).to eq true
+    end
+  end
+
+  context 'callback url' do
+    it 'should have the correct path' do
+      subject.callback_path.should eq('/auth/bigcommerce/callback')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+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
+end
+

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-bigcommerce
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Tom Allen, Phil Muir, Sasha Gerrand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-01 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: 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:
+    - - '>='
+      - !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'
+description: Official OmniAuth strategy for Bigcommerce.
+email:
+- developer@bigcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/omniauth-bigcommerce.rb
+- lib/omniauth/bigcommerce/version.rb
+- lib/omniauth/strategies/bigcommerce.rb
+- omniauth-bigcommerce.gemspec
+- spec/omniauth/strategies/bigcommerce_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bigcommerce/omniauth-bigcommerce
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Official OmniAuth strategy for Bigcommerce.
+test_files:
+- spec/omniauth/strategies/bigcommerce_spec.rb
+- spec/spec_helper.rb