omniauth-basecrm 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8ae49f8aaf9d0d64d79e795987f453c6f4d26ab
+  data.tar.gz: 6c500a8753393af89b275c77c154aa5531d9d2ed
+SHA512:
+  metadata.gz: 2fdd6da3561563ebe34141fa5c7900a115c5da28c4ecf9ee504924255bbd74cea96e1662d556483f0196700097d07d4fdfa1c9e9281b64f1072bc8a68122fc15
+  data.tar.gz: fab389cae77d05d531523086824441545a560410636ca5a9852122f61c924a72979c3929a829e5e7c92743ac3379dd110c991734a3bc20f71ef5a785c0093648

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--order random

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,19 @@
+source :rubygems
+
+gemspec
+
+gem 'rake', '~> 10.4'
+gem 'rdoc', '~> 4.2'
+gem 'coveralls', '~> 0.8.10', require: false
+
+group :test do
+  gem 'memcache_mock'
+  gem 'mock_redis'
+  gem 'rspec', '~> 3.1'
+  gem 'rspec-core', '~> 3.1'
+  gem 'rspec-mocks', '~> 3.1'
+  gem 'simplecov', '~> 0.9', :require => false
+  gem 'simplecov-html', '~> 0.8', :require => false
+end
+
+gem 'jruby-openssl', :platform => :jruby

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    omniauth-basecrm (1.0.0)
+      omniauth-oauth2 (~> 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coveralls (0.8.19)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.5.5)
+    json (2.0.3)
+    jwt (1.5.6)
+    memcache_mock (0.0.14)
+    mock_redis (0.16.0)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.6.1)
+      hashie (>= 3.4.6, < 3.6.0)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.4.0)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    rack (2.0.1)
+    rake (10.5.0)
+    rdoc (4.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.13.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (~> 0.8.10)
+  jruby-openssl
+  memcache_mock
+  mock_redis
+  omniauth-basecrm!
+  rake (~> 10.4)
+  rdoc (~> 4.2)
+  rspec (~> 3.1)
+  rspec-core (~> 3.1)
+  rspec-mocks (~> 3.1)
+  simplecov (~> 0.9)
+  simplecov-html (~> 0.8)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -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,77 @@
+# OmniAuth for BaseCrm
+[![Build Status](https://travis-ci.org/berk/omniauth-basecrm.png?branch=master)](https://travis-ci.org/berk/omniauth-basecrm)
+[![Coverage Status](https://coveralls.io/repos/berk/omniauth-basecrm/badge.png?branch=master)](https://coveralls.io/r/berk/omniauth-basecrm?branch=master)
+[![Gem Version](https://badge.fury.io/rb/omniauth-basecrm.svg)](http://badge.fury.io/rb/omniauth-basecrm)
+
+BaseCrm OAuth2 Strategy for OmniAuth 1.0.
+
+Supports the OAuth 2.0 server-side. Read the BaseCrm docs for more details: 
+
+https://developers.getbase.com/docs/rest/articles/oauth2/introduction
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-basecrm'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::BaseCrm` is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :basecrm, ENV['BASECRM_CLIENT_ID'], ENV['BASECRM_SECRET']
+end
+```
+
+## Configuring
+
+You can configure several options, which you pass in to the `provider` method via a `Hash`:
+
+* `scope`: A space-separated list of scopes you want to request from the user. See the BaseCrm docs for a full list of available permissions.
+
+For example, to request `profile` permission:
+ 
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :basecrm, ENV['BASECRM_CLIENT_ID'], ENV['BASECRM_SECRET'], :scope => 'profile'
+end
+```
+
+## Authentication Hash
+
+Here's an example *Authentication Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{"provider"=>"basecrm",
+ "uid"=>33333,
+ "info"=>
+  {
+   "name"=>"Name"},
+ "credentials"=>
+  {"token"=>
+    "dfkjadlfkjasdkjflaskdjfjsldflasjdflkasdjflaskdjf",
+   "refresh_token"=>"lkfkjasldjkflaskjdflkasjdlfjkasdljfk",
+   "expires_at"=>1489053154,
+   "expires"=>true},
+ "extra"=>
+  {"user"=>
+    {
+     "id"=>33333,
+     "name"=>"name",
+     "time_format"=>"12H",
+     "timezone"=>"UTC-08:00",
+     "created_at"=>"2015-05-12T01:01:15Z",
+     "updated_at"=>"2017-03-13T17:31:22Z",
+     "currency"=>"USD",
+     "phone"=>"+1 111-111-1111"}}}
+```
+
+The precise information available may depend on the permissions which you request.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/deploy

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+gem_name = 'omniauth-basecrm'
+
+def execute(cmd)
+  puts "\n***************************************************************************\n"
+  puts "$ #{cmd}"
+  system(cmd)
+end
+
+def version_file_path
+  './lib/omniauth/base_crm/version.rb'
+end
+
+def version_file
+  @version_file ||= File.read(version_file_path)
+end
+
+def version
+  @version ||= version_file.match(/VERSION\s*=\s*'([^']*)'/)[1]
+end
+
+def increment_version
+  parts = version.split('.')
+  parts[2] = (parts[2].to_i + 1).to_s
+  new_version = parts.join('.')
+
+  version_file.gsub!(version, new_version)
+
+  File.open(version_file_path, 'w') do |file|
+    file.write(version_file)
+  end
+
+  @version_file = nil
+  @version = nil
+end
+
+puts "\nBuilding omniauth-basecrm-#{version}.gem..."
+
+if ARGV.include?('release')
+  execute('git checkout master')
+  execute('git merge develop')
+  execute('git push')
+end
+
+execute('bundle exec rspec')
+execute("gem build #{gem_name}.gemspec")
+execute("gem install #{gem_name}-#{version}.gem --no-ri --no-rdoc")
+
+if ARGV.include?('release')
+  execute("git tag #{version}")
+  execute('git push --tags')
+
+  execute("gem push #{gem_name}-#{version}.gem")
+
+  execute('git checkout develop')
+
+  increment_version
+
+  execute("git add #{version_file_path}")
+  execute("git commit -m 'Updated version to #{version}'")
+  execute('git push')
+end
+
+
+

data/example/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rack', '~> 1.3.6'
+
+gem 'sinatra'
+gem 'omniauth-basecrm', :path => '../'

data/example/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: ../
+  specs:
+    omniauth-basecrm (1.0.0)
+      omniauth-oauth2 (~> 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    faraday (0.7.6)
+      addressable (~> 2.2)
+      multipart-post (~> 1.1)
+      rack (~> 1.1)
+    hashie (1.2.0)
+    multi_json (1.0.4)
+    multipart-post (1.1.4)
+    oauth2 (0.5.2)
+      faraday (~> 0.7)
+      multi_json (~> 1.0)
+    omniauth (1.0.2)
+      hashie (~> 1.2)
+      rack
+    omniauth-oauth2 (1.0.0)
+      oauth2 (~> 0.5.0)
+      omniauth (~> 1.0)
+    rack (1.3.6)
+    rack-protection (1.2.0)
+      rack
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-basecrm!
+  rack (~> 1.3.6)
+  sinatra

data/example/config.ru

@@ -0,0 +1,31 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-basecrm'
+
+SCOPE = 'email'
+
+class App < Sinatra::Base
+
+  get '/' do
+    redirect '/auth/basecrm'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+  
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :basecrm, ENV['APP_ID'], ENV['APP_SECRET'], :scope => SCOPE
+end
+
+run App.new

data/lib/omniauth-basecrm.rb

@@ -0,0 +1,22 @@
+#--
+# 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.
+#++
+
+require 'omniauth/base_crm'

data/lib/omniauth/base_crm.rb

@@ -0,0 +1,23 @@
+#--
+# 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.
+#++
+
+require 'omniauth/base_crm/version'
+require 'omniauth/strategies/base_crm'

data/lib/omniauth/base_crm/version.rb

@@ -0,0 +1,26 @@
+#--
+# 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.
+#++
+
+module OmniAuth
+  module BaseCrm
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/strategies/base_crm.rb

@@ -0,0 +1,67 @@
+#--
+# 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.
+#++
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class BaseCrm < OmniAuth::Strategies::OAuth2
+
+      option :client_options, {
+        :site           => 'https://api.getbase.com',
+        :authorize_url  => '/oauth2/authorize',
+        :token_url      => '/oauth2/token'
+      }
+
+      option :name, 'basecrm'
+
+      option :authorize_options, [:scope]
+
+      uid { raw_info['id'] }
+
+      info do
+        prune!({
+          'name'            => raw_info['name']
+        })
+      end
+      
+      extra do 
+        { 'user' =>  prune!(raw_info) }
+      end
+      
+      def raw_info
+        @raw_info ||= access_token.get('/v2/accounts/self').parsed['data']
+      end
+
+      private
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'basecrm', 'BaseCrm'

data/omniauth-basecrm.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/base_crm/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-basecrm'
+  s.version  = OmniAuth::BaseCrm::VERSION
+  s.authors  = ['Michael Berkovich']
+  s.email    = ['theiceberk@gmail.com']
+  s.summary  = 'BaseCrm strategy for OmniAuth'
+  s.homepage = 'https://github.com/berk/omniauth-basecrm'
+  s.description = 'BaseCrm strategy for SSO using OmniAuth framework'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.licenses    = 'MIT-LICENSE'
+
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+end

data/spec/omniauth/strategies/base_crm_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+require 'omniauth-basecrm'
+
+describe OmniAuth::Strategies::BaseCrm do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    @request.stub(:cookies) { {} }
+    
+    @client_id = 'abc'
+    @client_secret = 'def'
+  end
+  
+  subject do
+    args = [@client_id, @client_secret, @options].compact
+    OmniAuth::Strategies::BaseCrm.new(nil, *args).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct site' do
+      subject.client.site.should eq('https://api.getbase.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/oauth2/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth2/token')
+    end
+  end
+
+  describe '#uid' do
+    before :each do
+      subject.stub(:raw_info) { { 'id' => '123' } }
+    end
+    
+    it 'returns the id from raw_info' do
+      subject.uid.should eq('123')
+    end
+  end
+  
+  describe '#info' do
+    before :each do
+      @raw_info ||= { 'name' => 'Alex' }
+      subject.stub(:raw_info) { @raw_info }
+    end
+    
+    context 'when optional data is not present in raw info' do
+      it 'has no email key' do
+        subject.info.should_not have_key('email')
+      end
+    end
+    
+    context 'when data is present in raw info' do
+      it 'returns first name' do
+        subject.info['name'].should eq('Alex')
+      end
+    end
+  end
+  
+  describe '#raw_info' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      subject.stub(:access_token) { @access_token }
+    end
+    
+    it 'performs a GET to /v2/accounts/self' do
+      @access_token.stub(:get) { double('OAuth2::Response').as_null_object }
+      @access_token.should_receive(:get).with('/v2/accounts/self')
+      subject.raw_info
+    end
+    
+    it 'returns a Hash' do
+      @access_token.stub(:get).with('/v2/accounts/self') do
+        raw_response = double('Faraday::Response')
+        raw_response.stub(:body) { '{"data": { "ohai": "thar" }}' }
+        raw_response.stub(:status) { 200 }
+        raw_response.stub(:headers) { { 'Content-Type' => 'application/json' } }
+        OAuth2::Response.new(raw_response)
+      end
+      subject.raw_info.should be_a(Hash)
+      subject.raw_info['ohai'].should eq('thar')
+    end
+  end
+
+  describe '#credentials' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      @access_token.stub(:token)
+      @access_token.stub(:expires?)
+      @access_token.stub(:expires_at)
+      @access_token.stub(:refresh_token)
+      subject.stub(:access_token) { @access_token }
+    end
+    
+    it 'returns a Hash' do
+      subject.credentials.should be_a(Hash)
+    end
+    
+    it 'returns the token' do
+      @access_token.stub(:token) { '123' }
+      subject.credentials['token'].should eq('123')
+    end
+    
+    it 'returns the expiry status' do
+      @access_token.stub(:expires?) { true }
+      subject.credentials['expires'].should eq(true)
+      
+      @access_token.stub(:expires?) { false }
+      subject.credentials['expires'].should eq(false)
+    end
+    
+    it 'returns the refresh token and expiry time when expiring' do
+      ten_mins_from_now = (Time.now + 600).to_i
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { '321' }
+      @access_token.stub(:expires_at) { ten_mins_from_now }
+      subject.credentials['refresh_token'].should eq('321')
+      subject.credentials['expires_at'].should eq(ten_mins_from_now)
+    end
+    
+    it 'does not return the refresh token when it is nil and expiring' do
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { nil }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+    
+    it 'does not return the refresh token when not expiring' do
+      @access_token.stub(:expires?) { false }
+      @access_token.stub(:refresh_token) { 'XXX' }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+  end
+  
+  describe '#extra' do
+    before :each do
+      @raw_info = { 'name' => 'Fred Smith' }
+      subject.stub(:raw_info) { @raw_info }
+    end
+    
+    it 'returns a Hash' do
+      subject.extra.should be_a(Hash)
+    end
+    
+    it 'contains raw info' do
+      subject.extra.should eq({ 'user' => @raw_info })
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,23 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-basecrm
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Berkovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: BaseCrm strategy for SSO using OmniAuth framework
+email:
+- theiceberk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- deploy
+- example/Gemfile
+- example/Gemfile.lock
+- example/config.ru
+- lib/omniauth-basecrm.rb
+- lib/omniauth/base_crm.rb
+- lib/omniauth/base_crm/version.rb
+- lib/omniauth/strategies/base_crm.rb
+- omniauth-basecrm.gemspec
+- spec/omniauth/strategies/base_crm_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/berk/omniauth-basecrm
+licenses:
+- MIT-LICENSE
+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.4.5
+signing_key: 
+specification_version: 4
+summary: BaseCrm strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/base_crm_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb