omniauth-goto 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: beb46e6950bfc736270558d1bc862c2b0493d7b56b79c8034225fe846c220740
4
+ data.tar.gz: 2c9fe4122a1eccfcd9e211790505546ae089509b6c5877d5698879678b174943
5
+ SHA512:
6
+ metadata.gz: f0580bf0b7f5676cf58328ad8c53d805ab0fb97d2dbc12d23d95293d42112ec2f7d19062d20a4897f963cc02298a29b73111a3c42a14f8c6bec633d1b9310a0b
7
+ data.tar.gz: 9615925e4a4f949d9197e959bf8983b8f2d001a7af7a3fa872f04a92bff0c05afb3978ac3899c0a12045a7ed90df0a4e02fbf2a478f4292d7e584a9d5d854f3f
@@ -0,0 +1,22 @@
1
+ name: Ruby
2
+
3
+ on: [push]
4
+
5
+ jobs:
6
+ test:
7
+ runs-on: ubuntu-latest
8
+ strategy:
9
+ matrix:
10
+ ruby-version: ["2.4", "2.5", "2.6", "2.7"]
11
+
12
+ steps:
13
+ - uses: actions/checkout@v2
14
+ - name: Set up Ruby ${{ matrix.ruby-version }}
15
+ uses: ruby/setup-ruby@v1
16
+ with:
17
+ ruby-version: ${{ matrix.ruby-version }}
18
+ - name: Build and test with Rake
19
+ run: |
20
+ gem install bundler
21
+ bundle install --jobs 4 --retry 3
22
+ bundle exec rake
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ /pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --colour
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ ruby-3.1.2
data/Gemfile ADDED
@@ -0,0 +1,14 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in omniauth-goto.gemspec
4
+ gemspec
5
+
6
+ group :development, :test do
7
+ gem 'guard'
8
+ gem 'guard-rspec'
9
+ gem 'guard-bundler'
10
+ gem 'rb-fsevent'
11
+ gem 'growl'
12
+ gem 'rake'
13
+ gem 'graphlient'
14
+ end
data/Guardfile ADDED
@@ -0,0 +1,10 @@
1
+ guard 'rspec', :version => 2 do
2
+ watch(%r{^spec/.+_spec\.rb$})
3
+ watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
4
+ watch('spec/spec_helper.rb') { "spec" }
5
+ end
6
+
7
+ guard 'bundler' do
8
+ watch('Gemfile')
9
+ watch('omniauth-goto.gemspec')
10
+ end
data/LICENSE.txt ADDED
@@ -0,0 +1,7 @@
1
+ Copyright (c) 2022 Quentin Rousseau.
2
+
3
+ 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:
4
+
5
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
+ 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 ADDED
@@ -0,0 +1,63 @@
1
+ ![Ruby](https://github.com/kwent/omniauth-goto/workflows/Ruby/badge.svg?branch=master)
2
+
3
+ # OmniAuth GoTo
4
+
5
+ This is the official OmniAuth strategy for authenticating to GoTo. To
6
+ use it, you'll need to sign up for an OAuth2 Client ID and Secret
7
+ on the [GoTo Developer Page](https://community.servicenow.com/community?id=community_blog&sys_id=56086e4fdb9014146064eeb5ca961957).
8
+
9
+ ## Installation
10
+
11
+ ```ruby
12
+ gem 'omniauth-goto'
13
+ ```
14
+
15
+ ## Basic Usage
16
+
17
+ ```ruby
18
+ use OmniAuth::Builder do
19
+ provider :goto, ENV['GOTO_CLIENT_ID'], ENV['GOTO_CLIENT_SECRET']
20
+ end
21
+ ```
22
+
23
+ ## Basic Usage Rails
24
+
25
+ In `config/initializers/goto.rb`
26
+
27
+ ```ruby
28
+ Rails.application.config.middleware.use OmniAuth::Builder do
29
+ provider :goto, ENV['GOTO_CLIENT_ID'], ENV['GOTO_CLIENT_SECRET']
30
+ end
31
+ ```
32
+
33
+ ## Dynamic client_id and client_secret
34
+
35
+ In `config/initializers/goto.rb`
36
+
37
+ ```ruby
38
+ Rails.application.config.middleware.use OmniAuth::Builder do
39
+ setup_proc = lambda do |env|
40
+ req = Rack::Request.new(env)
41
+ env['omniauth.strategy'].options[:client_id] = req.params['client_id']
42
+ env['omniauth.strategy'].options[:client_secret] = req.params['client_secret']
43
+ end
44
+ provider :goto, nil, nil, { setup: setup_proc }
45
+ end
46
+ ```
47
+
48
+ More info: https://github.com/omniauth/omniauth/wiki/Setup-Phase
49
+
50
+ ## Semver
51
+
52
+ This project adheres to Semantic Versioning 2.0.0. Any violations of this scheme are considered to be bugs.
53
+ All changes will be tracked [here](https://github.com/kwent/omniauth-goto/releases).
54
+
55
+ ## License
56
+
57
+ Copyright (c) 2022 Quentin Rousseau.
58
+
59
+ 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:
60
+
61
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
62
+
63
+ 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 ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env rake
2
+ require "bundler/gem_tasks"
3
+ require 'rspec/core/rake_task'
4
+
5
+ RSpec::Core::RakeTask.new
6
+
7
+ desc 'Run specs'
8
+ task :default => :spec
@@ -0,0 +1,88 @@
1
+ require 'omniauth-oauth2'
2
+
3
+ module OmniAuth
4
+ module Strategies
5
+ class GoTo < OmniAuth::Strategies::OAuth2
6
+
7
+ args %i[client_id client_secret]
8
+
9
+ option :name, 'goto'
10
+
11
+ option :client_options, {
12
+ site: "https://api.getgo.com",
13
+ authorize_url: "https://api.getgo.com/oauth/v2/authorize",
14
+ token_url: "https://api.getgo.com/oauth/v2/token",
15
+ response_type: 'code',
16
+ }
17
+
18
+ option :auth_token_params, {
19
+ grant_type: 'authorization_code',
20
+ }
21
+
22
+ # When `true`, client_id and client_secret are returned in extra['raw_info'].
23
+ option :extra_client_id_and_client_secret, false
24
+
25
+ # Store response
26
+ attr_accessor :token_response
27
+
28
+ def authorize_params
29
+ super.tap do |params|
30
+ %w[client_options].each do |v|
31
+ if request.params[v]
32
+ params[v.to_sym] = request.params[v]
33
+ end
34
+ end
35
+ end
36
+ end
37
+
38
+ def build_access_token
39
+ verifier = request.params["code"]
40
+ # Override regular client when using setup: proc
41
+ if env['omniauth.params']['client_id'] && env['omniauth.params']['client_secret']
42
+ client = ::OAuth2::Client.new(
43
+ env['omniauth.params']['client_id'],
44
+ env['omniauth.params']['client_secret'],
45
+ authorize_url: options.client_options.authorize_url,
46
+ token_url: options.client_options.token_url
47
+ )
48
+ @token_response = client.auth_code.get_token(verifier, {:redirect_uri => callback_url}.merge(token_params.merge!(headers: {'Authorization' => basic_auth_header(env['omniauth.params']['client_id'], env['omniauth.params']['client_secret']) }).to_hash(:symbolize_keys => true)), deep_symbolize(options.auth_token_params))
49
+ else
50
+ super
51
+ end
52
+ end
53
+
54
+ uid { raw_info["account_key"] }
55
+
56
+ extra do
57
+ { raw_info: raw_info }
58
+ end
59
+
60
+ def raw_info
61
+ @raw_info ||= begin
62
+ hash = @token_response.params.slice('account_key', 'account_type', 'email', 'firstName', 'lastName', 'organizer_key', 'version')
63
+ hash.merge!({ client_id: smart_client_id, client_secret: smart_client_secret }) if options[:extra_client_id_and_client_secret]
64
+ hash
65
+ end
66
+ end
67
+
68
+ def smart_client_id
69
+ @smart_client_id ||= env['omniauth.params']['client_id'] || env['omniauth.strategy'].options.client_id
70
+ end
71
+
72
+ def smart_client_secret
73
+ @smart_client_secret ||= env['omniauth.params']['client_secret'] || env['omniauth.strategy'].options.client_secret
74
+ end
75
+
76
+ def callback_url
77
+ full_host + script_name + callback_path
78
+ end
79
+
80
+ def basic_auth_header(client_id, client_secret)
81
+ "Basic " + Base64.strict_encode64("#{client_id}:#{client_secret}")
82
+ end
83
+ end
84
+ end
85
+ end
86
+
87
+ OmniAuth.config.add_camelization 'goto', 'GoTo'
88
+ OmniAuth.config.add_camelization 'go_to', 'GoTo'
@@ -0,0 +1,5 @@
1
+ module OmniAuth
2
+ module GoTo
3
+ VERSION = "1.0.0"
4
+ end
5
+ end
@@ -0,0 +1,2 @@
1
+ require "omniauth-goto/version"
2
+ require 'omniauth/strategies/goto'
@@ -0,0 +1,25 @@
1
+ # -*- encoding: utf-8 -*-
2
+ require File.expand_path('../lib/omniauth-goto/version', __FILE__)
3
+
4
+ Gem::Specification.new do |gem|
5
+ gem.authors = ["Quentin Rousseau"]
6
+ gem.email = ["contact@quent.in"]
7
+ gem.description = %q{Official OmniAuth strategy for GoTo.}
8
+ gem.summary = %q{Official OmniAuth strategy for GoTo.}
9
+ gem.homepage = "https://github.com/kwent/omniauth-goto"
10
+ gem.license = "MIT"
11
+
12
+ gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
13
+ gem.files = `git ls-files`.split("\n")
14
+ gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
15
+ gem.name = "omniauth-goto"
16
+ gem.require_paths = ["lib"]
17
+ gem.version = OmniAuth::GoTo::VERSION
18
+
19
+ gem.add_dependency 'omniauth', '~> 1.5'
20
+ gem.add_dependency 'omniauth-oauth2', '>= 1.4.0', '< 2.0'
21
+ gem.add_development_dependency 'rspec', '~> 3.5'
22
+ gem.add_development_dependency 'rack-test'
23
+ gem.add_development_dependency 'simplecov'
24
+ gem.add_development_dependency 'webmock'
25
+ end
@@ -0,0 +1,54 @@
1
+ require 'spec_helper'
2
+
3
+ describe OmniAuth::Strategies::GoTo do
4
+ let(:access_token) { instance_double('AccessToken', :options => {}, :[] => 'user') }
5
+ let(:parsed_response) { instance_double('ParsedResponse') }
6
+ let(:response) { instance_double('Response', :parsed => parsed_response) }
7
+
8
+ let(:enterprise_site) { 'https://some.other.site.com' }
9
+ let(:enterprise_authorize_url) { 'https://some.other.site.com/login/oauth/authorize' }
10
+ let(:enterprise_token_url) { 'https://some.other.site.com/login/oauth/token' }
11
+ let(:enterprise) do
12
+ OmniAuth::Strategies::GoTo.new('GOTO_CLIENT_ID', 'GOTO_CLIENT_SECRET',
13
+ {
14
+ :client_options => {
15
+ :site => enterprise_site,
16
+ :authorize_url => enterprise_authorize_url,
17
+ :token_url => enterprise_token_url
18
+ }
19
+ }
20
+ )
21
+ end
22
+
23
+ subject do
24
+ OmniAuth::Strategies::GoTo.new({})
25
+ end
26
+
27
+ before(:each) do
28
+ allow(subject).to receive(:access_token).and_return(access_token)
29
+ end
30
+
31
+ context 'client options' do
32
+ it 'should have correct authorize url' do
33
+ expect(subject.options.client_options.authorize_url).to eq('https://api.getgo.com/oauth/v2/authorize')
34
+ end
35
+
36
+ it 'should have correct token url' do
37
+ expect(subject.options.client_options.token_url).to eq('https://api.getgo.com/oauth/v2/token')
38
+ end
39
+
40
+ describe 'should be overrideable' do
41
+ it 'for site' do
42
+ expect(enterprise.options.client_options.site).to eq(enterprise_site)
43
+ end
44
+
45
+ it 'for authorize url' do
46
+ expect(enterprise.options.client_options.authorize_url).to eq(enterprise_authorize_url)
47
+ end
48
+
49
+ it 'for token url' do
50
+ expect(enterprise.options.client_options.token_url).to eq(enterprise_token_url)
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,16 @@
1
+ $:.unshift File.expand_path('..', __FILE__)
2
+ $:.unshift File.expand_path('../../lib', __FILE__)
3
+ require 'simplecov'
4
+ SimpleCov.start
5
+ require 'rspec'
6
+ require 'rack/test'
7
+ require 'webmock/rspec'
8
+ require 'omniauth'
9
+ require 'omniauth-goto'
10
+
11
+ RSpec.configure do |config|
12
+ config.include WebMock::API
13
+ config.include Rack::Test::Methods
14
+ config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
15
+ end
16
+
metadata ADDED
@@ -0,0 +1,150 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: omniauth-goto
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Quentin Rousseau
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-08-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: omniauth
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.5'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.5'
27
+ - !ruby/object:Gem::Dependency
28
+ name: omniauth-oauth2
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 1.4.0
34
+ - - "<"
35
+ - !ruby/object:Gem::Version
36
+ version: '2.0'
37
+ type: :runtime
38
+ prerelease: false
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: 1.4.0
44
+ - - "<"
45
+ - !ruby/object:Gem::Version
46
+ version: '2.0'
47
+ - !ruby/object:Gem::Dependency
48
+ name: rspec
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - "~>"
52
+ - !ruby/object:Gem::Version
53
+ version: '3.5'
54
+ type: :development
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: '3.5'
61
+ - !ruby/object:Gem::Dependency
62
+ name: rack-test
63
+ requirement: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - ">="
66
+ - !ruby/object:Gem::Version
67
+ version: '0'
68
+ type: :development
69
+ prerelease: false
70
+ version_requirements: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
75
+ - !ruby/object:Gem::Dependency
76
+ name: simplecov
77
+ requirement: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - ">="
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ type: :development
83
+ prerelease: false
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ - !ruby/object:Gem::Dependency
90
+ name: webmock
91
+ requirement: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: '0'
96
+ type: :development
97
+ prerelease: false
98
+ version_requirements: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ description: Official OmniAuth strategy for GoTo.
104
+ email:
105
+ - contact@quent.in
106
+ executables: []
107
+ extensions: []
108
+ extra_rdoc_files: []
109
+ files:
110
+ - ".github/workflows/ruby.yml"
111
+ - ".gitignore"
112
+ - ".rspec"
113
+ - ".ruby-version"
114
+ - Gemfile
115
+ - Guardfile
116
+ - LICENSE.txt
117
+ - README.md
118
+ - Rakefile
119
+ - lib/omniauth-goto.rb
120
+ - lib/omniauth-goto/version.rb
121
+ - lib/omniauth/strategies/goto.rb
122
+ - omniauth-goto.gemspec
123
+ - spec/omniauth/strategies/goto_spec.rb
124
+ - spec/spec_helper.rb
125
+ homepage: https://github.com/kwent/omniauth-goto
126
+ licenses:
127
+ - MIT
128
+ metadata: {}
129
+ post_install_message:
130
+ rdoc_options: []
131
+ require_paths:
132
+ - lib
133
+ required_ruby_version: !ruby/object:Gem::Requirement
134
+ requirements:
135
+ - - ">="
136
+ - !ruby/object:Gem::Version
137
+ version: '0'
138
+ required_rubygems_version: !ruby/object:Gem::Requirement
139
+ requirements:
140
+ - - ">="
141
+ - !ruby/object:Gem::Version
142
+ version: '0'
143
+ requirements: []
144
+ rubygems_version: 3.3.7
145
+ signing_key:
146
+ specification_version: 4
147
+ summary: Official OmniAuth strategy for GoTo.
148
+ test_files:
149
+ - spec/omniauth/strategies/goto_spec.rb
150
+ - spec/spec_helper.rb