omniauth-square-oauth2 0.0.1

data/lib/omniauth-square.rb

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

data/lib/omniauth-square/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Square
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/strategies/square.rb

@@ -0,0 +1,60 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Square < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        :site          => 'https://squareup.com/',
+        :connect_site  => 'https://connect.squareup.com',
+        :authorize_url => '/oauth2/authorize',
+        :token_url     => '/oauth2/token'
+      }
+
+      uid { raw_info["merchant"][0]["id"] }
+
+      info do
+        prune!(
+          :name     => raw_info["merchant"][0]["business_name"],
+          :country  => raw_info["merchant"][0]["country"]
+        )
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def build_access_token
+        connect_client = client.dup
+        connect_client.site = options.client_options.connect_site
+        auth_params = {
+          :redirect_uri => callback_url,
+          :client_id => options.client_id,
+          :client_secret => options.client_secret,
+          :grant_type => "authorization_code"
+        }.merge(token_params.to_hash(:symbolize_keys => true))
+        connect_client.auth_code.get_token(
+          request.params["code"],
+          auth_params.merge(
+            token_params.to_hash(:symbolize_keys => true)
+          ),
+          deep_symbolize(options.auth_token_params)
+        )
+      end
+
+      private
+
+      def raw_info
+        @raw_info ||= access_token.get('/v2/merchants').parsed
+      end
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'square', 'Square'

data/omniauth-square-oauth2.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-square/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-square-oauth2"
+  s.version     = Omniauth::Square::VERSION
+  s.authors     = ["Nick Robinson"]
+  s.email       = ["nrobinson13+github@gmail.com"]
+  s.homepage    = "https://github.com/nickrobinson/omniauth-square-oauth2"
+  s.summary     = %q{Square OAuth strategy for OmniAuth}
+  s.description = %q{Square OAuth strategy for OmniAuth}
+  s.license           = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'omniauth-oauth2', '>= 1.1.1', '< 1.3.0'
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/square_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Square do
+  before :each do
+    @request = double('Request', :scheme => '', :url => '')
+    @request.stub(:params) { {} }
+  end
+
+  subject do
+    OmniAuth::Strategies::Square.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  describe '#client' do
+    it 'has correct Square site' do
+      subject.client.site.should eq('https://squareup.com/')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/oauth2/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth2/token')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      @raw_info = {
+        "merchant" => [{
+          "id" => "JGHJ0343",
+          "business_name" => "Foobar Sports",
+          "country" => "US",
+          "language_code" => "en-US",
+          "currency" => "USD",
+          "status" => "ACTIVE",
+          "main_location_id" => "DDM555V5KQPNS"
+        }]
+      }
+
+      subject.stub(:raw_info) { @raw_info }
+    end
+
+    context 'when data is present in raw info' do
+      it 'returns the name' do
+        subject.info[:name].should eq('Foobar Sports')
+      end
+
+      it 'returns raw info' do
+        subject.extra[:raw_info]['merchant'][0]['business_name'].should eq("Foobar Sports")
+      end
+    end
+  end
+
+  describe '#credentials' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      @access_token.stub(:token)
+      @access_token.stub(:expires?)
+      @access_token.stub(:expires_at)
+      @access_token.stub(:refresh_token)
+      subject.stub(:access_token) { @access_token }
+    end
+
+    it 'returns a Hash' do
+      subject.credentials.should be_a(Hash)
+    end
+
+    it 'returns the token' do
+      @access_token.stub(:token) { '123' }
+      subject.credentials['token'].should eq('123')
+    end
+
+    it 'returns the expiry status' do
+      @access_token.stub(:expires?) { true }
+      subject.credentials['expires'].should eq(true)
+
+      @access_token.stub(:expires?) { false }
+      subject.credentials['expires'].should eq(false)
+    end
+
+    it 'returns the refresh token and expiry time when expiring' do
+      ten_mins_from_now = (Time.now + 360).to_i
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { '321' }
+      @access_token.stub(:expires_at) { ten_mins_from_now }
+      subject.credentials['refresh_token'].should eq('321')
+      subject.credentials['expires_at'].should eq(ten_mins_from_now)
+    end
+
+    it 'does not return the refresh token when it is nil and expiring' do
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { nil }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+
+    it 'does not return the refresh token when not expiring' do
+      @access_token.stub(:expires?) { false }
+      @access_token.stub(:refresh_token) { 'XXX' }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-square'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,23 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-square-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Robinson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-10 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.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.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: 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: 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: Square OAuth strategy for OmniAuth
+email:
+- nrobinson13+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- coverage/.last_run.json
+- coverage/.resultset.json
+- coverage/.resultset.json.lock
+- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc.png
+- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc_disabled.png
+- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_both.png
+- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc.png
+- coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc_disabled.png
+- coverage/assets/0.12.3/application.css
+- coverage/assets/0.12.3/application.js
+- coverage/assets/0.12.3/colorbox/border.png
+- coverage/assets/0.12.3/colorbox/controls.png
+- coverage/assets/0.12.3/colorbox/loading.gif
+- coverage/assets/0.12.3/colorbox/loading_background.png
+- coverage/assets/0.12.3/favicon_green.png
+- coverage/assets/0.12.3/favicon_red.png
+- coverage/assets/0.12.3/favicon_yellow.png
+- coverage/assets/0.12.3/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.12.3/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.12.3/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.12.3/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.12.3/images/ui-icons_222222_256x240.png
+- coverage/assets/0.12.3/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.12.3/images/ui-icons_454545_256x240.png
+- coverage/assets/0.12.3/images/ui-icons_888888_256x240.png
+- coverage/assets/0.12.3/images/ui-icons_cd0a0a_256x240.png
+- coverage/assets/0.12.3/loading.gif
+- coverage/assets/0.12.3/magnify.png
+- coverage/index.html
+- lib/omniauth-square.rb
+- lib/omniauth-square/version.rb
+- lib/omniauth/strategies/square.rb
+- omniauth-square-oauth2.gemspec
+- spec/omniauth/strategies/square_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/nickrobinson/omniauth-square-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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Square OAuth strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/square_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb