omniauth-sageone 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9643d1d139cadb1e4151aeaf552cf365d983b337
-  data.tar.gz: 7a1920ffca755c363c72623fb910e7b157fca786
+  metadata.gz: da92bc2f9d2afee3f98d52341b7cf51d044cd1da
+  data.tar.gz: 6485af5bd93e8e05f7a35681a6344b5fb6d7ca8b
 SHA512:
-  metadata.gz: 2911bd73748bf718dd5ae352ac8ccf9a530b53247b70d7b7c8abbf680b18d4b2574e3fc742116ab2d069c2151fd74cf3024fd67794d736cb63a6a279e935c35f
-  data.tar.gz: 27db4f043197e11aa833ec33a6bb08055a7293c569b68b370676ca5085f74aac74e57b3b9e0510a952b64af75e51b52fff9d363e0921f6ab39d6bf4936abccac
+  metadata.gz: 485bfa8fbe9a70f414edf9de5479373f0a94b2030062961e68cd44123049b2335448260439753df0a54cc55d8e94f31d075cdc6be37409b05c5076ba480c1265
+  data.tar.gz: 6fb854d669c7962f2a4a34b9a75aab7eca1c78761ff354befb267c14a4d68ddc1560dcc96fa990bfbc50391ae3daed6d271d36f2164f3f4ee479add423a30f1b

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - 'lib/omniauth-sageone.rb'
+
+Style/RegexpLiteral:
+  Exclude:
+    - 'Guardfile'

data/Gemfile

@@ -5,7 +5,8 @@ gemspec
 
 group :development, :test do
   gem 'guard'
-  gem 'guard-rspec'
   gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
   gem 'rb-fsevent'
 end

data/Guardfile

@@ -1,10 +1,9 @@
-guard 'rspec', version: 2 do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end
-
 guard 'bundler' do
   watch('Gemfile')
   watch('omniauth-sageone.gemspec')
 end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -8,4 +8,24 @@ This is an unofficial OmniAuth strategy for authenticating to SageOne. To use it
       provider :sageone, ENV['SAGE_CLIENT_ID'], ENV['SAGE_CLIENT_SECRET'], scope: 'full_access'
     end
 
-    Options for `scope` are either `readonly` or `full_access`.
+    # Options for `scope` are either `readonly` or `full_access`.
+    
+## Auth Hash
+
+The hash in `env['omniauth.auth']` will have the following information:
+
+- in `credentials`:
+  - `token`: The access token.
+  - `refresh_token`: The refresh token. Use this to get a new token when the one in `token` has been expired.
+  - `expires_at`: Timestamp that indicates when `token` will expire.
+  - `expires`: `true`
+  - `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).
+- in `uid`: The `requested_by_id` returned by Sage One when fetching the token.
+
+## See Also
+
+https://developer.sageone.com has the Sage One API documentation.

data/Rakefile

@@ -1,12 +1,9 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 desc 'Default: run specs.'
-task :default => :spec
-
-desc "Run specs"
-RSpec::Core::RakeTask.new
+task default: :spec
 
 desc 'Run specs'
-task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/omniauth-sageone/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module SageOne
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'.freeze
   end
 end

data/lib/omniauth/strategies/sage_one.rb

@@ -3,29 +3,71 @@ require 'omniauth-oauth2'
 module OmniAuth
   module Strategies
     class SageOne < OmniAuth::Strategies::OAuth2
-      option :client_options, {
-        authorize_url: 'https://www.sageone.com/oauth2/auth',
-        token_url: 'https://api.sageone.com/oauth2/token'
-      }
+      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 :authorize_params, {
-        response_type: 'code'
-      }
+      option :client_options,
+             authorize_url: 'https://www.sageone.com/oauth2/auth/central'
+
+      option :authorize_params,
+             response_type: 'code'
+
+      uid do
+        access_token['requested_by_id']
+      end
+
+      credentials do
+        {
+          resource_owner_id: access_token['resource_owner_id']
+        }
+      end
+
+      info do
+        {
+          country: country
+        }
+      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.
+      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
-        verifier = request.params['code']
         client.auth_code.get_token(
-          verifier,
+          request.params['code'],
           {
             redirect_uri: callback_url.split('?').first
           }.merge(token_params.to_hash(symbolize_keys: true)),
           deep_symbolize(options.auth_token_params)
         )
       end
+
+      def country
+        request[:country].try(:downcase)
+      end
+
+      def client_options
+        hash = if country
+                 { token_url: TOKEN_URLS[country] }.merge(options.client_options)
+               else
+                 options.client_options
+               end
+
+        deep_symbolize(hash)
+      end
     end
   end
 end

data/omniauth-sageone.gemspec

@@ -1,19 +1,20 @@
 # -*- encoding: utf-8 -*-
+
 require File.expand_path('../lib/omniauth-sageone/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Jared Moody"]
-  gem.email         = ["jared@jetbuilt.com"]
-  gem.description   = %q{OmniAuth strategy for SageOne.}
-  gem.summary       = %q{OmniAuth strategy for SageOne.}
-  gem.homepage      = "https://github.com/jetbuilt/omniauth-sageone"
-  gem.licenses      = "MIT"
+  gem.authors       = ['Jared Moody']
+  gem.email         = ['jared@jetbuilt.com']
+  gem.description   = 'OmniAuth strategy for SageOne.'
+  gem.summary       = 'OmniAuth strategy for SageOne.'
+  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.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.name          = 'omniauth-sageone'
+  gem.require_paths = ['lib']
   gem.version       = OmniAuth::SageOne::VERSION
 
   gem.add_dependency 'omniauth', '~> 1.0'

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-$:.unshift File.expand_path('..', __FILE__)
-$:.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'simplecov'
 SimpleCov.start
 require 'rspec'
@@ -11,5 +11,5 @@ require 'omniauth-sageone'
 RSpec.configure do |config|
   config.include WebMock::API
   config.include Rack::Test::Methods
-  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.extend  OmniAuth::Test::StrategyMacros, type: :strategy
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-sageone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jared Moody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-05-19 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.
@@ -101,8 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -124,17 +125,17 @@ 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.0.14.1
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: OmniAuth strategy for SageOne.