omniauth-gorgias-oauth2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e78d3a7049ce83a305edfd0227d169598628645d6d998975cf990cdd5a933712
+  data.tar.gz: 8acd4aa212fe634ed26a72e895e728c2517f4c90a51e5245c878d278b954261e
+SHA512:
+  metadata.gz: 4a7b9f791182445720bae6b4f712480179cdf31b6ad4898b7b323d5c34e8b443ab22a5fcd467f84f347cbafeeccba233ce2c664f767dbebe413689e28cbb7c4f
+  data.tar.gz: c0abf63ab2f231351d9270d68eece2a17ffaac8e3bec4748684e2cfe9c6001b2262c48147d40c699124f245ac1f985d8a8a7e4323d53b5726b80d9677ab4f279

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in omniauth-gorgias-oauth2.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    omniauth-gorgias-oauth2 (0.1.0)
+      omniauth-oauth2 (~> 1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hashie (5.0.0)
+    jwt (2.3.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (2.1.0)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.7.2)
+      oauth2 (~> 1.4)
+      omniauth (>= 1.9, < 3)
+    rack (2.2.3)
+    rack-protection (2.2.0)
+      rack
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  omniauth-gorgias-oauth2!
+  rake (~> 10.0)
+  rspec (~> 3.9, >= 3.9.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Fera Commerce Inc
+
+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,40 @@
+# OmniAuth::Gorgias::Oauth2
+Gorgias OAuth2 Strategy for OmniAuth
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/gorgias/oauth2`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-gorgias-oauth2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-gorgias-oauth2
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/azemoh/omniauth-gorgias-oauth2.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task default: :test

data/lib/omniauth/gorgias/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Gorgias
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/gorgias.rb

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

data/lib/omniauth/strategies/gorgias.rb

@@ -0,0 +1,60 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Gorgias < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        authorize_url: '/oauth/authorize',
+        token_url: '/oauth/token'
+      }
+
+      option :gorgias_domain, 'gorgias.com'
+
+      option :setup, (proc { |env|
+        strategy = env['omniauth.strategy']
+        site = "https://#{strategy.account}.#{strategy.options[:gorgias_domain]}"
+
+        strategy.options[:client_options][:site] = site
+      })
+
+      def request_phase
+        return fail!(:account_missing) unless account_present?
+
+        options[:scope] ||= 'openid'
+        options[:response_type] ||= 'code'
+
+        super
+      end
+
+      uid { account }
+
+      def authorize_params
+        nonce = SecureRandom.hex(16)
+        session['omniauth.nonce'] = nonce
+
+        super.merge(nonce: nonce)
+      end
+
+      def callback_url
+        full_host + script_name + callback_path + "?account=#{account}"
+      end
+
+      def token_params
+        super.merge(
+          headers: {
+            'Authorization' => "Basic #{Base64.strict_encode64("#{options.client_id}:#{options.client_secret}")}"
+          },
+          redirect_uri: callback_url
+        )
+      end
+
+      def account
+        @account ||= request.params['account']
+      end
+
+      def account_present?
+        !!(account =~ /\A[a-z0-9]+\z/i)
+      end
+    end
+  end
+end

data/lib/omniauth-gorgias-oauth2.rb

@@ -0,0 +1 @@
+require 'omniauth/gorgias'

data/omniauth-gorgias-oauth2.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/gorgias/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-gorgias-oauth2'
+  spec.version       = OmniAuth::Gorgias::VERSION
+  spec.authors       = ['Joshua Azemoh', 'Fera Commerce Inc.']
+  spec.email         = ['joshua@fera.ai', 'dev@feracommerce.com']
+
+  spec.summary       = 'Gorgias OAuth2 strategy for OmniAuth'
+  spec.homepage      = 'https://github.com/feracommerce/omniauth-gorgias-oauth2'
+  spec.license       = 'MIT'
+
+  spec.files                 = `git ls-files`.split("\n")
+  spec.executables           = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths         = ['lib']
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
+  
+end

data/spec/omniauth/strategies/gorgias_spec.rb

@@ -0,0 +1,110 @@
+require 'omniauth-gorgias-oauth2'
+
+describe OmniAuth::Strategies::Gorgias do # rubocop:disable Metrics/BlockLength
+  let(:request) { double('Request', env: {}, params: { 'account' => 'test' }, cookies: {}) }
+  let(:client_id) { 'aBc123' }
+  let(:client_secret) { 'a1B2c3' }
+
+  subject do
+    args = [client_id, client_secret, {}].compact
+    OmniAuth::Strategies::Gorgias.new(nil, *args).tap do |strategy|
+      env = strategy.env || {}
+      env['omniauth.strategy'] = strategy
+
+      allow(strategy).to receive(:request) { request }
+      allow(strategy).to receive(:session) { {} }
+
+      strategy.options[:setup].call(env)
+    end
+  end
+
+  describe '::setup' do
+    it 'should set the site' do
+      expect(subject.options.client_options.site).to eq('https://test.gorgias.com')
+    end
+  end
+
+  describe '#client' do
+    it 'has correct gorgias site' do
+      expect(subject.client.site).to eq('https://test.gorgias.com')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.client.options[:authorize_url]).to eq('/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      expect(subject.client.options[:token_url]).to eq('/oauth/token')
+    end
+  end
+
+  describe '#callback_url' do
+    let(:base_url) { 'http://auth.myapp.com' }
+
+    it 'returns callback with account' do
+      allow(request).to receive(:scheme) { 'http' }
+      allow(request).to receive(:url) { "#{base_url}/path" }
+
+      allow(subject).to receive(:script_name) { '' } # to not depend from Rack env
+
+      expect(subject.callback_url).to eq("#{base_url}/auth/gorgias/callback?account=test")
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'adds nonce' do
+      expect(subject.authorize_params).to be_a(Hash)
+      expect(subject.authorize_params[:nonce]).to be_a(String)
+    end
+  end
+
+  describe '#uid' do
+    it 'returns the account username' do
+      expect(subject.uid).to eq('test')
+    end
+  end
+
+  describe '#credentials' do
+    let(:access_token) { double('OAuth2::AccessToken') }
+
+    before :each do
+      allow(access_token).to receive(:token)
+      allow(access_token).to receive(:expires?)
+      allow(access_token).to receive(:expires_at)
+      allow(access_token).to receive(:refresh_token)
+
+      allow(subject).to receive(:access_token) { access_token }
+    end
+
+    it 'returns a Hash' do
+      expect(subject.credentials).to be_a(Hash)
+    end
+
+    it 'returns the token' do
+      allow(access_token).to receive(:token) { '123' }
+      expect(subject.credentials['token']).to eq('123')
+    end
+
+    it 'returns the expiry status' do
+      allow(access_token).to receive(:expires?) { true }
+      expect(subject.credentials['expires']).to eq(true)
+
+      allow(access_token).to receive(:expires?) { false }
+      expect(subject.credentials['expires']).to eq(false)
+    end
+  end
+
+  describe '#account_present?' do
+    it 'returns true if account query param is present' do
+      expect(subject.account_present?).to eq(true)
+    end
+
+    context 'when account is missing in the URL' do
+      let(:request) { double('Request', params: {}) }
+
+      it 'returns false' do
+        expect(subject.account_present?).to eq(false)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-gorgias-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Azemoh
+- Fera Commerce Inc.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-19 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.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description:
+email:
+- joshua@fera.ai
+- dev@feracommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-gorgias-oauth2.rb
+- lib/omniauth/gorgias.rb
+- lib/omniauth/gorgias/version.rb
+- lib/omniauth/strategies/gorgias.rb
+- omniauth-gorgias-oauth2.gemspec
+- spec/omniauth/strategies/gorgias_spec.rb
+homepage: https://github.com/feracommerce/omniauth-gorgias-oauth2
+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: Gorgias OAuth2 strategy for OmniAuth
+test_files: []