ginjo-omniauth-slack 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 7429f940e8b8ab65aa6cf7b8afc127402c3f02256aa804ea426bdbeb46c1f2da
-  data.tar.gz: f15be0efa8af3bffafdb6c2c839c2a013a8488024a9c3d46441d6aea8320d05e
+SHA1:
+  metadata.gz: b3ff842e9cfab56ecf724517abbf5c5b11dcf342
+  data.tar.gz: eb8b4443126f1544eaf1b73580785a23dcd87512
 SHA512:
-  metadata.gz: c5513ec8a12e7efb9eca056b8923fb168efee4c2e9af3753d5c18c67d85171bf6eca03b918326f464aa887628430670c08f7253c5c4d1e5b6fe14609dedfd394
-  data.tar.gz: 860aee4675bd03ba0825b623e978e96c16330c17017e77f646f44afe79f6427cb074e1096bc329754be0e5919badb2609128a7459fa687a660cab5d23e938dcc
+  metadata.gz: d99aca16201b6367f87df3989e9c06b928ea7be002faaa9734ae52021a53d9473a238c85afe39a194c18775baefaa455bbdb1c6fe5d7c58c62643164707e9641
+  data.tar.gz: cebc21d494e97c0a44dacdf428762630e4d2a9f48eb14f09fa38fb7990106d2bb204921276be3f33102d167d0d582cf8f7d43ddb6661270f8d33cb80c89d4850

data/CHANGELOG.md

@@ -1,7 +1,24 @@
-## v2.4.0
+## v2.4.1(2018-09-18)
+
+* Set `client_options[:auth_scheme]` to `:basic_auth`, as OAuth2 gem does not yet make this the default. [wbr]
+
+* Stop using `:setup` option to manipulate site uri subdomain. [wbr]
+
+* Override `client` method to manipulate site uri subdomain. [wbr]
+
+* Allow `apps.permissions.users.list` call to be excluded by user. [wbr]
+
+* Fix gemspec dep for omniauth-oauth2. [wbr]
+
+* Add experimental class method `ad_hoc_client`. [wbr]
+
+
+## v2.4.0 (2018-08-28)
 
 Initial release of ginjo-omniauth-slack
 
+* Update gemspec dependencies.
+
 * Add/fix AuthHash `extra['scopes_requested']`. [wbr]
 
 * Refactor building of AuthHash to dynamically call additional API requests if necessary, scope permitting. [wbr]
@@ -35,7 +52,7 @@ Initial release of ginjo-omniauth-slack
 * Add test coverage for new functionality. [wbr]
 
 
-### Additional changes logged between 2.2.0 release and ginjo fork/refactor
+### Additional changes logged between 2.3.0 release and ginjo fork/refactor
 
 The specifics of these commits may or may not be relevant in the ginjo fork, but their functionality is covered in one way or another.
 

data/lib/omniauth-slack/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Slack
-    VERSION = "2.4.0"
+    VERSION = "2.4.1"
   end
 end

data/lib/omniauth/strategies/slack.rb

@@ -1,5 +1,6 @@
 require 'omniauth/strategies/oauth2'
 require 'thread'
+require 'uri'
 
 module OmniAuth
   module Strategies
@@ -11,17 +12,8 @@ module OmniAuth
 
       option :client_options, {
         site: 'https://slack.com',
-        token_url: '/api/oauth.access'
-      }
-
-      # Add team_domain to site subdomain if provided in auth url or provider options. 
-      option :setup, lambda{|env|
-        strategy = env['omniauth.strategy']
-        team_domain = strategy.request.params['team_domain'] || strategy.options[:team_domain]
-        site = strategy.options[:client_options]['site']
-        strategy.options[:client_options].site = (
-          !team_domain.to_s.empty? ? site.sub(/\:\\\\/, "://#{team_domain}.") : site
-        )
+        token_url: '/api/oauth.access',
+        auth_scheme: :basic_auth
       }
       
       option :auth_token_params, {
@@ -51,10 +43,14 @@ module OmniAuth
       end
 
       info do
-        define_additional_data
-        semaphore
+      
+        unless skip_info?
+          define_additional_data
+          semaphore
+        end
         
         num_threads = options.preload_data_with_threads.to_i
+        
         if num_threads > 0 && !skip_info?
           preload_data_with_threads(num_threads)
         end
@@ -147,6 +143,7 @@ module OmniAuth
           raw_info: @raw_info
         }
       end
+
       
       # Pass on certain authorize_params to the Slack authorization GET request.
       # See https://github.com/omniauth/omniauth/issues/390
@@ -157,29 +154,37 @@ module OmniAuth
               params[v.to_sym] = request.params[v]
             end
           end
+          log(:debug, "Authorize_params #{params.to_h}")
         end
       end
       
-      # Get a new OAuth2::Client and define custom capabilities.
-      # * verrides super :client method.
+      # Get a new OAuth2::Client and define custom behavior.
+      # * overrides previous omniauth-strategies-oauth2 :client definition.
       #
       # * Log API requests with OmniAuth.logger
       # * Add API responses to @raw_info hash
+      # * Set auth site uri with custom subdomain (if provided).
       #
       def client
-        st_raw_info = raw_info
         new_client = super
-        log(:debug, "New client #{new_client}.")
         
-        new_client.instance_eval do
-          define_singleton_method(:request) do |*args|
-            OmniAuth.logger.send(:debug, "(slack) API request #{args[0..1]}; in thread #{Thread.current.object_id}.")
-            request_output = super(*args)
-            uri = args[1].to_s.gsub(/^.*\/([^\/]+)/, '\1') # use single-quote or double-back-slash for replacement.
-            st_raw_info[uri.to_s]= request_output
-            request_output
-          end
+        team_domain = request.params['team_domain'] || options[:team_domain]
+        if !team_domain.to_s.empty?
+          site_uri = URI.parse(options[:client_options]['site'])
+          site_uri.host = "#{team_domain}.slack.com"
+          new_client.site = site_uri.to_s
+          log(:debug, "Oauth site uri with custom team_domain #{site_uri}")
+        end
+        
+        st_raw_info = raw_info
+        new_client.define_singleton_method(:request) do |*args|
+          OmniAuth.logger.send(:debug, "(slack) API request #{args[0..1]}; in thread #{Thread.current.object_id}.")
+          request_output = super(*args)
+          uri = args[1].to_s.gsub(/^.*\/([^\/]+)/, '\1') # use single-quote or double-back-slash for replacement.
+          st_raw_info[uri.to_s]= request_output
+          request_output
         end
+        
         new_client
       end
       
@@ -342,7 +347,7 @@ module OmniAuth
       #
       # Returns [<id>: <resource>]
       def apps_permissions_users_list
-        return {} unless !skip_info? && is_app_token?
+        return {} unless !skip_info? && is_app_token? && is_not_excluded?
         semaphore.synchronize {
           @apps_permissions_users_list_raw ||= access_token.get('/api/apps.permissions.users.list')
           @apps_permissions_users_list ||= @apps_permissions_users_list_raw.parsed['resources'].inject({}){|h,i| h[i['id']] = i; h}
@@ -388,6 +393,18 @@ module OmniAuth
         end
       end
       
+      def self.ad_hoc_client(client_id, client_key, token)
+        puts default_options['client_options'].to_yaml
+        ::OAuth2::AccessToken.new(
+          ::OAuth2::Client.new(
+            client_id,
+            client_key,
+            default_options['client_options'].map{|k,v| [k.to_sym, v]}.to_h
+          ),
+          token
+        )
+      end
+      
     end
   end
 end

data/omniauth-slack.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['kimura', 'ginjo']
   spec.email         = ['kimura@enigmo.co.jp', 'wbr@mac.com']
   spec.description   = %q{OmniAuth strategy for Slack}
-  spec.summary       = %q{OmniAuth strategy for Slack, based on the oauth2 and omniauth-oauth2 gems}
-  spec.homepage      = 'https://github.com/kmrshntr/omniauth-slack.git'
+  spec.summary       = %q{OmniAuth strategy for Slack, based on OAuth2 and OmniAuth}
+  spec.homepage      = 'https://github.com/ginjo/omniauth-slack.git'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'omniauth-oauth2', ['~> 1.4', '~> 1.5']
+  spec.add_runtime_dependency 'omniauth-oauth2', '>= 1.4.0'
 
   spec.add_development_dependency 'bundler', '>= 1.11.2'
   spec.add_development_dependency 'rake'

data/test/helper.rb

@@ -55,3 +55,4 @@ class StrategyTestCase < TestCase
 end
 
 Dir[File.expand_path("../support/**/*", __FILE__)].each(&method(:require))
+

data/test/support/shared_examples.rb

@@ -16,6 +16,16 @@ module OAuth2StrategyTests
       @options = { :client_options => { "authorize_url" => "https://example.com" } }
       assert_equal "https://example.com", strategy.client.options[:authorize_url]
     end
+    
+    test "should transfer team_domain from options to client.site uri" do
+      @options = { :team_domain => 'subdomain' }
+      assert_equal "https://subdomain.slack.com", strategy.client.site
+    end
+    
+    test "should transfer team_domain from request.params to client.site uri" do
+      @request.stubs(:params).returns({ 'team_domain' => 'subdomain2' })
+      assert_equal "https://subdomain2.slack.com", strategy.client.site
+    end
   end
 
   module AuthorizeParamsTests

data/test/test.rb

@@ -19,6 +19,10 @@ class ClientTest < StrategyTestCase
   test "has correct token url" do
     assert_equal "/api/oauth.access", strategy.client.options[:token_url]
   end
+
+  test "has correct auth_scheme" do
+    assert_equal :basic_auth, strategy.client.options[:auth_scheme]
+  end
   
   test 'request logs api call' do
     OAuth2::Client.class_eval do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ginjo-omniauth-slack
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - kimura
@@ -9,28 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2018-09-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.4'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +102,7 @@ files:
 - test/helper.rb
 - test/support/shared_examples.rb
 - test/test.rb
-homepage: https://github.com/kmrshntr/omniauth-slack.git
+homepage: https://github.com/ginjo/omniauth-slack.git
 licenses:
 - MIT
 metadata: {}
@@ -128,10 +122,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: OmniAuth strategy for Slack, based on the oauth2 and omniauth-oauth2 gems
+summary: OmniAuth strategy for Slack, based on OAuth2 and OmniAuth
 test_files:
 - test/helper.rb
 - test/support/shared_examples.rb