omniauth-sageone 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4218c9f8c29f2fa4c9a2c19a7f7c8fc79777a413
-  data.tar.gz: 84749b1dc89cbc8ce2cb8b834a0acf18ffe83611
+SHA256:
+  metadata.gz: '0912ca0f1705240f0e8469e3f428fb26a5448bffdc1eba75ea95aa30ef770367'
+  data.tar.gz: 03051eacff1a4a93c9dcb592461b4b9de2d99174c314ad2c0b915bf023ba7122
 SHA512:
-  metadata.gz: 1289b2439738be83ea519add83b3c57c1c7e128488f75d1210e605b539038a637e80b54478e4fa50290005e4706b6e170c4db7d11056e0b2dbc91682c48fad10
-  data.tar.gz: 62c69de437433208dd022978a96b0c3f8d3a5c0b449729d61f63be31e6ed848a9f504f9302d251df77bc2e604ac382fce9d7c7c5296f088036ab8f39f0cda613
+  metadata.gz: fcb3bf76e057bbdde96a4b9ce5cfa5bdb9f074c37040cee31f54b191f8c6915f17a6a85d899b42beedef92e74833f71704c0a044439907b1d9158d3fecfb6aa8
+  data.tar.gz: aee4ea3b26ab27bb3840ef2f4d9e1cdc34ba1619347699726e1ce7987bb38e12280cadfdc6a1cfa0127f37680d0903d5c6e2653f1156d12eacdb02f200d95ab5

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 99
+  versioning-strategy: lockfile-only
+  rebase-strategy: disabled

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Rubocop
+      run: bundle exec rubocop
+
+    - name: RSpec
+      run: bundle exec rake

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea

data/.rubocop.yml

@@ -1,16 +1,28 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.2
+  NewCops: enable
+  TargetRubyVersion: 3.0
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
 
 Style/Documentation:
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
   Exclude:
     - 'lib/omniauth-sageone.rb'
 
 Style/RegexpLiteral:
   Exclude:
     - 'Guardfile'
+
+RSpec/DescribedClass:
+  EnforcedStyle: explicit
+
+RSpec/FilePath:
+  Exclude:
+    - 'spec/omniauth/strategies/sage_one_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+3.0.6

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 2.6
+  - 2.7
+
+notifications:
+  email: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 # Specify your gem's dependencies in omniauth-sageone.gemspec
@@ -8,5 +10,13 @@ group :development, :test do
   gem 'guard-bundler'
   gem 'guard-rspec'
   gem 'guard-rubocop'
+  gem 'rack-test'
+  gem 'rake', '~> 13.0'
   gem 'rb-fsevent'
+  gem 'rspec', '~> 3.8'
+  gem 'rubocop', '~> 1.54.0'
+  gem 'rubocop-rake', '~> 0.6.0'
+  gem 'rubocop-rspec', '~> 2.22.0'
+  gem 'simplecov'
+  gem 'webmock'
 end

data/Guardfile

@@ -1,8 +1,27 @@
+# frozen_string_literal: true
+
 guard 'bundler' do
   watch('Gemfile')
   watch('omniauth-sageone.gemspec')
 end
 
+guard :rspec, cmd: 'bin/rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
 guard :rubocop do
   watch(%r{.+\.rb$})
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }

data/README.md

@@ -1,5 +1,8 @@
 # OmniAuth SageOne
 
+[![Gem Version](https://badge.fury.io/rb/omniauth-sageone.svg)](https://badge.fury.io/rb/omniauth-sageone)
+![CI](https://img.shields.io/github/actions/workflow/status/Jetbuilt/omniauth-sageone/ci.yml?branch=main)
+
 This is an unofficial OmniAuth strategy for authenticating to SageOne. To use it, you'll need to sign up for a Sage One OAuth2 Application ID and Secret.
 
 ## Basic Usage
@@ -9,7 +12,7 @@ This is an unofficial OmniAuth strategy for authenticating to SageOne. To use it
     end
 
     # Options for `scope` are either `readonly` or `full_access`.
-    
+
 ## Auth Hash
 
 The hash in `env['omniauth.auth']` will have the following information:
@@ -22,8 +25,7 @@ The hash in `env['omniauth.auth']` will have the following information:
   - `resource_owner_id`: An ID returned by Sage One when fetching the access token. You'll need that value for API v3
     for request signing and the `X-SITE` header that is required on API requests.
 - in `info`:
-  - `country`: The user's country. Use that information to get the correct base URL (Sage One has different ones for
-    different countries).
+  - `country`: The user's country.
 - in `uid`: The `requested_by_id` returned by Sage One when fetching the token.
 
 ## See Also

data/Rakefile

@@ -1,9 +1,13 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-desc 'Default: run specs.'
-task default: :spec
+RuboCop::RakeTask.new
 
 desc 'Run specs'
 RSpec::Core::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/_guard-core

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', '_guard-core')

data/bin/autospec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/guard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/lib/omniauth/strategies/sage_one.rb

@@ -1,23 +1,17 @@
+# frozen_string_literal: true
+
 require 'omniauth-oauth2'
 
 module OmniAuth
   module Strategies
     class SageOne < OmniAuth::Strategies::OAuth2
-      TOKEN_URLS = {
-        'ca' => 'https://mysageone.ca.sageone.com/oauth2/token',
-        'de' => 'https://oauth.eu.sageone.com/token',
-        'es' => 'https://oauth.eu.sageone.com/token',
-        'fr' => 'https://oauth.eu.sageone.com/token',
-        'gb' => 'https://app.sageone.com/oauth2/token',
-        'ie' => 'https://app.sageone.com/oauth2/token',
-        'us' => 'https://mysageone.na.sageone.com/oauth2/token'
-      }.freeze
-
       option :client_options,
-             authorize_url: 'https://www.sageone.com/oauth2/auth/central'
+             authorize_url: 'https://www.sageone.com/oauth2/auth/central',
+             token_url: 'https://oauth.accounting.sage.com/token'
 
       option :authorize_params,
-             response_type: 'code'
+             response_type: 'code',
+             filter: 'apiv3.1'
 
       uid do
         access_token['requested_by_id']
@@ -35,38 +29,17 @@ module OmniAuth
         }
       end
 
-      # SageOne has different token endpoints for each available country. The country is returned in
-      # the authorization callback. Configure the OAuth client to use that information by
-      # customizing the client options
-      def client
-        ::OAuth2::Client.new(options.client_id, options.client_secret, client_options)
-      end
-
-      protected
-
       # Override this method to remove the query string from the callback_url because SageOne
       # requires an exact match
-      def build_access_token
-        client.auth_code.get_token(
-          request.params['code'],
-          {
-            redirect_uri: callback_url.split('?').first
-          }.merge(token_params.to_hash(symbolize_keys: true)),
-          deep_symbolize(options.auth_token_params)
-        )
+      def callback_url
+        super.split('?').first
       end
 
+      protected
+
       def country
         request.env ? request[:country].try(:downcase) : options.client_options[:country]
       end
-
-      # Override client_options[:token_url] using the country from ether the request or the
-      # provided country option
-      def client_options
-        hash = options.client_options
-        hash.merge!(token_url: TOKEN_URLS[country]) if country
-        deep_symbolize(hash)
-      end
     end
   end
 end

data/lib/omniauth-sageone/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module OmniAuth
   module SageOne
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.5.0'
   end
 end

data/lib/omniauth-sageone.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'omniauth-sageone/version'
 require 'omniauth/strategies/sage_one'

data/omniauth-sageone.gemspec

@@ -1,6 +1,6 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-require File.expand_path('../lib/omniauth-sageone/version', __FILE__)
+require File.expand_path('lib/omniauth-sageone/version', __dir__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ['Jared Moody']
@@ -10,17 +10,15 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://github.com/jetbuilt/omniauth-sageone'
   gem.licenses      = '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-sageone'
   gem.require_paths = ['lib']
   gem.version       = OmniAuth::SageOne::VERSION
 
+  gem.metadata['rubygems_mfa_required'] = 'true'
+
+  gem.required_ruby_version = '>= 3.0'
+
   gem.add_dependency 'omniauth', '~> 1.0'
   gem.add_dependency 'omniauth-oauth2', '~> 1.0'
-  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/sage_one_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe OmniAuth::Strategies::SageOne do
+  let(:access_token) { instance_double(OAuth2::AccessToken, options: {}) }
+
+  let(:sageone) { OmniAuth::Strategies::SageOne.new({}) }
+
+  before { allow(sageone).to receive(:access_token).and_return(access_token) }
+
+  describe 'client options' do
+    subject(:client_options) { sageone.options.client_options }
+
+    it 'has correct authorize url' do
+      expect(client_options.authorize_url).to eq('https://www.sageone.com/oauth2/auth/central')
+    end
+
+    it 'has correct token url' do
+      expect(client_options.token_url).to eq('https://oauth.accounting.sage.com/token')
+    end
+  end
+
+  describe 'authorize params' do
+    it 'contains the filter' do
+      expect(sageone.options.authorize_params['filter']).to eq('apiv3.1')
+    end
+  end
+
+  describe '#callback_url' do
+    before do
+      allow(sageone).to receive(:full_host).and_return('https://example.com')
+      allow(sageone).to receive(:script_name).and_return('/sub_uri')
+      allow(sageone).to receive(:query_string).and_return('?country=usa')
+    end
+
+    it 'does not contain the query string' do
+      expect(sageone.callback_url).to eq('https://example.com/sub_uri/auth/sageone/callback')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
-$LOAD_PATH.unshift File.expand_path('..', __FILE__)
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path(__dir__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'simplecov'
 SimpleCov.start
 require 'rspec'

metadata

@@ -1,99 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-sageone
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jared Moody
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2023-07-06 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.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !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: OmniAuth strategy for SageOne.
 email:
 - jared@jetbuilt.com
@@ -101,44 +45,51 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/_guard-core
+- bin/autospec
+- bin/guard
+- bin/rspec
+- bin/rubocop
 - lib/omniauth-sageone.rb
 - lib/omniauth-sageone/version.rb
 - lib/omniauth/strategies/sage_one.rb
 - omniauth-sageone.gemspec
-- spec/omniauth/strategies/sageone_spec.rb
+- spec/omniauth/strategies/sage_one_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jetbuilt/omniauth-sageone
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14.1
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: OmniAuth strategy for SageOne.
-test_files:
-- spec/omniauth/strategies/sageone_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/omniauth/strategies/sageone_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-describe OmniAuth::Strategies::SageOne do
-  it 'should do some testing' do
-    pending
-  end
-end