omniauth-square-oauth2 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f19ab92a8efc93e052e61f76c30ae3aa747e5154e0c22ed05c1dd235a76d2999
-  data.tar.gz: 734bc25d8e398cc8d33b297b837dbafb7c1cffaa91254523cfed7525f89a2c45
+  metadata.gz: d364a56610f62d52a8b1666defb4f2d54caff8a644c800c7b28625ff8bdbb8f6
+  data.tar.gz: 845420fc652a8948347613893f72d4d92efbe60068b34800860db2d6ced2540d
 SHA512:
-  metadata.gz: e5f1b4c48dd0764ff141ead54e59435c026131cd407d6f430e673cad26aa8edf3d2f314d95a8bf10cfa6e9bc4ea898a6de68775981292d414933dc6e818c93e8
-  data.tar.gz: 913af461084fd09051c011e10d62202eff7d74f6862e6d6e9a16525bb27c4a3568a109d9eef3714dd760e6c56cc94565e08f8c64ee4317b6e763093cf75c45e1
+  metadata.gz: e3231e72c96a8e99f5bb2942d6eaf86e5f06755e936c1a93f98d787633c91624614e844aa7f7d1df71287532a03bb13979ce29fe74c98a8f393c55ad08502e29
+  data.tar.gz: 53375e4a96d511a8a1dbf95d62c37546d07268d326eb2eda572036804fb348a91abeb70a517b42bbf44b1403460c68e98b7419c4f3412be82c3a89d45694d59e

data/.github/workflows/ruby.yml

@@ -24,7 +24,7 @@ jobs:
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.6
     - name: Install dependencies

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    omniauth-square-oauth2 (0.0.2)
+    omniauth-square-oauth2 (0.2.2)
       omniauth-oauth2 (>= 1.7.3)
 
 GEM
@@ -10,25 +10,36 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
+    base64 (0.3.0)
+    bigdecimal (3.2.2)
     crack (0.4.4)
     diff-lcs (1.4.4)
     docile (1.3.2)
-    faraday (2.5.2)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.0)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
     hashdiff (1.0.1)
     hashie (5.0.0)
-    jwt (2.5.0)
-    multi_xml (0.6.0)
-    oauth2 (2.0.7)
-      faraday (>= 0.17.3, < 3.0)
-      jwt (>= 1.0, < 3.0)
+    json (2.12.2)
+    jwt (3.1.1)
+      base64
+    logger (1.7.0)
+    multi_xml (0.7.2)
+      bigdecimal (~> 3.1)
+    net-http (0.6.0)
+      uri
+    oauth2 (2.0.12)
+      faraday (>= 0.17.3, < 4.0)
+      jwt (>= 1.0, < 4.0)
+      logger (~> 1.2)
       multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-      rash_alt (>= 0.4, < 1)
-      version_gem (~> 1.1)
-    omniauth (2.1.0)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0, >= 2.0.3)
+      version_gem (>= 1.1.8, < 3)
+    omniauth (2.1.3)
       hashie (>= 3.4.6)
       rack (>= 2.2.3)
       rack-protection
@@ -40,14 +51,12 @@ GEM
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rack (2.2.3)
-    rack-protection (2.2.2)
+    rack-protection (3.0.6)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (10.5.0)
-    rash_alt (0.4.12)
-      hashie (>= 3.4)
     regexp_parser (1.8.1)
     rexml (3.2.4)
     rspec (2.99.0)
@@ -70,13 +79,16 @@ GEM
     rubocop-ast (0.7.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.5)
     simplecov (0.19.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.3)
+    snaky_hash (2.0.3)
+      hashie (>= 0.1.0, < 6)
+      version_gem (>= 1.1.8, < 3)
     unicode-display_width (1.7.0)
-    version_gem (1.1.0)
+    uri (1.0.3)
+    version_gem (1.1.8)
     webmock (3.9.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)

data/README.md

@@ -8,7 +8,7 @@ Square uses the OAuth2 flow, you can read about it here: http://connect.squareup
 
 So let's say you're using Rails, you need to add the strategy to your `Gemfile`:
 
-    gem 'omniauth-square-oauth2', '~> 1.0.0'
+    gem 'omniauth-square-oauth2', '~> 0.2.2'
 
 You can pull it in directly from github (if you really want to) e.g.:
 
@@ -20,7 +20,15 @@ Once these are in, you need to add the following to your `config/initializers/de
 
 Sandbox Example:
 
-     config.omniauth :square, "your_app_id", "your_app_oauth_secret", {:scope => "ITEMS_READ,ITEMS_WRITE,MERCHANT_PROFILE_READ", :client_options => {:connect_site => 'https://connect.squareupsandbox.com', :site => 'https://squareupsandbox.com'}}
+     config.omniauth :square, "your_app_id", "your_app_oauth_secret", {:scope => "ITEMS_READ,ITEMS_WRITE,MERCHANT_PROFILE_READ", :client_options => {:site => 'https://connect.squareupsandbox.com'}}
+
+## Configuration Options
+
+### Session Parameter
+
+To prevent repeated authorization prompts for already-authorized applications, you can set `session: false`:
+
+    config.omniauth :square, "your_app_id", "your_app_oauth_secret", {:scope => "ITEMS_READ,ITEMS_WRITE,MERCHANT_PROFILE_READ", :session => false}
 
 You will obviously have to put in your key and secret, which you get when you register your app with Square (they call them Application Key and Secret Key).
 

data/lib/omniauth/strategies/square.rb

@@ -30,6 +30,12 @@ module OmniAuth
         full_host + script_name + callback_path
       end
 
+      def authorize_params
+        super.tap do |params|
+          params[:session] = options[:session] if options[:session] == false
+        end
+      end
+
       def build_access_token
         options.token_params.merge!({client_id: options.client_id, client_secret: options.client_secret})
         super
@@ -41,8 +47,10 @@ module OmniAuth
         @raw_info ||= access_token.get('/v2/merchants').parsed
 
         # Get merchant email
-        team_members = access_token.post("/v2/team-members/search", {query: {filter: {is_owner: true}}})
-        @raw_info.merge!({email: team_members[0].email})
+        log :info, "Getting merchant email"
+        resp = access_token.post("/v2/team-members/search", {query: {filter: {is_owner: true}}}).parsed
+        log :info, "Got merchant email: #{resp[:team_members][0]}"
+        @raw_info.merge!({email: resp[:team_members][0].email_address})
       end
 
       def prune!(hash)

data/lib/omniauth-square/version.rb

@@ -2,6 +2,6 @@
 
 module Omniauth
   module Square
-    VERSION = '0.2.0'
+    VERSION = '0.2.2'
   end
 end

data/spec/omniauth/strategies/square_spec.rb

@@ -16,15 +16,15 @@ describe OmniAuth::Strategies::Square do
 
   describe '#client' do
     it 'has correct Square site' do
-      subject.client.site.should eq('https://squareup.com/')
+      subject.client.site.should eq('https://connect.squareup.com')
     end
 
     it 'has correct authorize url' do
-      subject.client.options[:authorize_url].should eq('/oauth2/authorize')
+      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')
+      subject.client.options[:token_url].should eq('oauth2/token')
     end
   end
 
@@ -106,4 +106,32 @@ describe OmniAuth::Strategies::Square do
       subject.credentials.should_not have_key('refresh_token')
     end
   end
+
+  describe '#authorize_params' do
+    context 'when session is set to false' do
+      before do
+        @options = { session: false }
+      end
+
+      it 'includes session=false in authorize params' do
+        subject.authorize_params[:session].should eq(false)
+      end
+    end
+
+    context 'when session is not set' do
+      it 'does not include session in authorize params' do
+        subject.authorize_params.should_not have_key(:session)
+      end
+    end
+
+    context 'when session is set to true' do
+      before do
+        @options = { session: true }
+      end
+
+      it 'does not include session in authorize params' do
+        subject.authorize_params.should_not have_key(:session)
+      end
+    end
+  end
 end

data/test_session.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'omniauth/strategies/square'
+
+# Mock the necessary environment
+class MockApp
+  def call(env)
+    [200, {}, ['Hello World']]
+  end
+end
+
+class MockRequest
+  def initialize
+    @env = {
+      'rack.session' => {},
+      'REQUEST_METHOD' => 'GET',
+      'PATH_INFO' => '/auth/square',
+      'rack.url_scheme' => 'http',
+      'HTTP_HOST' => 'localhost:3000'
+    }
+  end
+
+  def env
+    @env
+  end
+
+  def params
+    {}
+  end
+
+  def scheme
+    'http'
+  end
+
+  def url
+    'http://localhost:3000/auth/square'
+  end
+end
+
+# Test without session parameter
+puts "Testing without session parameter:"
+strategy = OmniAuth::Strategies::Square.new(MockApp.new)
+request = MockRequest.new
+strategy.instance_variable_set(:@env, request.env)
+params = strategy.authorize_params
+puts "Has session param: #{params.key?(:session)}"
+puts "Session value: #{params[:session]}" if params.key?(:session)
+
+# Test with session: false
+puts "\nTesting with session: false:"
+strategy = OmniAuth::Strategies::Square.new(MockApp.new, {session: false})
+request = MockRequest.new
+strategy.instance_variable_set(:@env, request.env)
+params = strategy.authorize_params
+puts "Has session param: #{params.key?(:session)}"
+puts "Session value: #{params[:session]}" if params.key?(:session)
+
+# Test with session: true (should not include session param)
+puts "\nTesting with session: true:"
+strategy = OmniAuth::Strategies::Square.new(MockApp.new, {session: true})
+request = MockRequest.new
+strategy.instance_variable_set(:@env, request.env)
+params = strategy.authorize_params
+puts "Has session param: #{params.key?(:session)}"
+puts "Session value: #{params[:session]}" if params.key?(:session)
+
+puts "\nAll params for session: false case:"
+strategy = OmniAuth::Strategies::Square.new(MockApp.new, {session: false})
+request = MockRequest.new
+strategy.instance_variable_set(:@env, request.env)
+params = strategy.authorize_params
+puts params.inspect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-square-oauth2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Nick Robinson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2025-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -129,6 +129,7 @@ files:
 - spec/omniauth/strategies/square_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
+- test_session.rb
 homepage: https://github.com/nickrobinson/omniauth-square-oauth2
 licenses:
 - MIT
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Square OAuth strategy for OmniAuth