omniauth-scientist 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60103e1cd9f35d1c4536365b3b174581ce4e1b58e4314cc50f2b501f28931720
+  data.tar.gz: dec823994918653c5e8d563d128679ef192cd257468d6385e59a841478fbd08d
+SHA512:
+  metadata.gz: 12fc82e60833aed5d672a8decb29fc2b49e3d6f04969eb480f6e0e540a01e12ed7a3283b3c522e368ecb90f2383838932ad0996d8772e0bc1a9e5dd5c13c0b07
+  data.tar.gz: 395f62e98a7572ac5e5c3011040dc3c76281d344f4a80391eead74c8dc8486d04c36912493cf43199f40a9bf952040f24853754272582dcbe7e343e05c9de82e

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/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-scientist.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2019 Chris Petersen and Assay Depot Inc. d/b/a Scientist.com
+
+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,32 @@
+# OmniAuth Scientist
+
+## Basic Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :scientist, ENV['SCIENTIST_ID'], ENV['SCIENTIST_SECRET']
+end
+```
+
+## Enterprise Usage
+
+```ruby
+provider :scientist, ENV['SCIENTIST_ID'], ENV['SCIENTIST_SECRET'],
+  {
+    client_options: {
+      site: 'https://<YOURSUBDOMAIN>.scientist.com',
+      authorize_url: 'https://<YOURSUBDOMAIN>.scientist.com/oauth/authorize',
+      token_url: 'https://<YOURSUBDOMAIN>.scientist.com/oauth/token'
+    }
+  }
+```
+
+## License
+
+Copyright (c) 2019 Assay Depot Inc. d/b/a Scientist.com
+
+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/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-scientist.rb

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

data/lib/omniauth-scientist/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Scientist
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/strategies/scientist.rb

@@ -0,0 +1,66 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Scientist < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        :site => 'https://app.scientist.com',
+        :authorize_url => 'https://app.scientist.com/oauth/authorize',
+        :token_url => 'https://app.scientist.com/oauth/token'
+      }
+
+      def request_phase
+        super
+      end
+
+      def authorize_params
+        super.tap do |params|
+          %w[scope client_options].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+        end
+      end
+
+      uid { user_attribute('id') }
+
+      info do
+        {
+          'provider' => 'scientist',
+          'uid' => uid,
+          'email' => email,
+          'name' => "#{user_attribute('first_name')} #{user_attribute('last_name')}",
+          'first_name' => user_attribute('first_name'),
+          'last_name' => user_attribute('last_name'),
+          'title' => user_attribute('title'),
+          'company' => user_attribute('company'),
+          'site' => user_attribute('site')
+        }
+      end
+
+      extra do
+        { raw_info: raw_info }
+      end
+
+      def raw_info
+        access_token.options[:mode] = :header
+        @raw_info ||= { 'user' => access_token['user'] }
+      end
+
+      def email
+        user_attribute('email')
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      protected
+
+      def user_attribute(attribute)
+        raw_info['user'][attribute] if raw_info['user']
+      end
+    end
+  end
+end

data/omniauth-scientist.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-scientist/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Petersen"]
+  gem.email         = ["chris@scientist.com"]
+  gem.description   = %q{Official OmniAuth strategy for Scientist.}
+  gem.summary       = %q{Official OmniAuth strategy for Scientist.}
+  gem.homepage      = "https://github.com/assaydepot/omniauth-scientist"
+  gem.license       = "MIT"
+
+  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-scientist"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::Scientist::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.9'
+  gem.add_dependency 'omniauth-oauth2', '>= 1.6.0', '< 2.0'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/scientist_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Scientist do
+  let(:access_token) { instance_double('AccessToken', :options => {}) }
+  let(:parsed_response) { instance_double('ParsedResponse') }
+  let(:response) { instance_double('Response', :parsed => parsed_response) }
+
+  let(:enterprise_site)          { 'https://some.other.site.com/' }
+  let(:enterprise_authorize_url) { 'https://some.other.site.com/oauth/authorize' }
+  let(:enterprise_token_url)     { 'https://some.other.site.com/oauth/token' }
+  let(:enterprise) do
+    OmniAuth::Strategies::Scientist.new('SCIENTIST_ID', 'SCIENTIST_SECRET',
+      {
+        :client_options => {
+          :site => enterprise_site,
+          :authorize_url => enterprise_authorize_url,
+          :token_url => enterprise_token_url
+        }
+      }
+    )
+  end
+
+  subject do
+    OmniAuth::Strategies::Scientist.new({})
+  end
+
+  before(:each) do
+    allow(subject).to receive(:access_token).and_return(access_token)
+  end
+
+  context 'client options' do
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://app.scientist.com')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('https://app.scientist.com/oauth/authorize')
+    end
+
+    it 'should have correct token url' do
+      expect(subject.options.client_options.token_url).to eq('https://app.scientist.com/oauth/token')
+    end
+
+    describe 'should be overrideable' do
+      it 'for site' do
+        expect(enterprise.options.client_options.site).to eq(enterprise_site)
+      end
+
+      it 'for authorize url' do
+        expect(enterprise.options.client_options.authorize_url).to eq(enterprise_authorize_url)
+      end
+
+      it 'for token url' do
+        expect(enterprise.options.client_options.token_url).to eq(enterprise_token_url)
+      end
+    end
+  end
+
+  context '#email' do
+    it 'should return email from raw_info if available' do
+      allow(subject).to receive(:raw_info).and_return({ 'email' => 'you@example.com' })
+      expect(subject.email).to eq('you@example.com')
+    end
+
+    it 'should return nil if there is no raw_info and email access is not allowed' do
+      allow(subject).to receive(:raw_info).and_return({})
+      expect(subject.email).to be_nil
+    end
+
+    it 'should not return the primary email if there is no raw_info and email access is allowed' do
+      emails = [
+        { 'email' => 'secondary@example.com', 'primary' => false },
+        { 'email' => 'primary@example.com',   'primary' => true }
+      ]
+      allow(subject).to receive(:raw_info).and_return({})
+      subject.options['scope'] = 'user'
+      allow(subject).to receive(:emails).and_return(emails)
+      expect(subject.email).to be_nil
+    end
+
+    it 'should not return the first email if there is no raw_info and email access is allowed' do
+      emails = [
+        { 'email' => 'first@example.com',   'primary' => false },
+        { 'email' => 'second@example.com',  'primary' => false }
+      ]
+      allow(subject).to receive(:raw_info).and_return({})
+      subject.options['scope'] = 'user'
+      allow(subject).to receive(:emails).and_return(emails)
+      expect(subject.email).to be_nil
+    end
+  end
+
+  context '#raw_info' do
+    it 'should use relative paths' do
+      expect(access_token).to receive(:get).with('user').and_return(response)
+      expect(subject.raw_info).to eq(parsed_response)
+    end
+  end
+
+  context '#info.email' do
+    it 'should use any available email' do
+      allow(subject).to receive(:raw_info).and_return({})
+      allow(subject).to receive(:email).and_return('you@example.com')
+      expect(subject.info['email']).to eq('you@example.com')
+    end
+  end
+
+  describe '#callback_url' do
+    it 'is a combination of host, script name, and callback path' do
+      allow(subject).to receive(:full_host).and_return('https://example.com')
+      allow(subject).to receive(:script_name).and_return('/sub_uri')
+
+      expect(subject.callback_url).to eq('https://example.com/sub_uri/auth/scientist/callback')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.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-scientist'
+
+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,148 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-scientist
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Petersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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 Scientist.
+email:
+- chris@scientist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-scientist.rb
+- lib/omniauth-scientist/version.rb
+- lib/omniauth/strategies/scientist.rb
+- omniauth-scientist.gemspec
+- spec/omniauth/strategies/scientist_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/assaydepot/omniauth-scientist
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Official OmniAuth strategy for Scientist.
+test_files:
+- spec/omniauth/strategies/scientist_spec.rb
+- spec/spec_helper.rb