slack-ruby-client 0.13.1 → 2.0.0

data/lib/tasks/real_time.rake

@@ -1,48 +1,78 @@
-# largely from https://github.com/aki017/slack-ruby-gem
+# frozen_string_literal: true
+
 require 'json-schema'
 require 'erubis'
 
+# largely from https://github.com/aki017/slack-ruby-gem
 namespace :slack do
   namespace :real_time do
     namespace :api do
-      REAL_TIME_EVENTS_MARKER = '### RealTime Events'.freeze
+      REAL_TIME_EVENTS_MARKER = '### RealTime Events'
 
-      desc 'Update API.'
+      desc 'Update Real Time API.'
       task update: [:git_update] do
         event_schema = JSON.parse(File.read('lib/slack/real_time/api/schema/event.json'))
-        events = Dir.glob('lib/slack/web/api/slack-api-ref/events/**/*.json').each_with_object({}) do |path, result|
+        dirglob = 'lib/slack/web/api/slack-api-ref/events/**/*.json'
+        events = Dir.glob(dirglob).each_with_object({}) do |path, result|
           name = File.basename(path, '.json')
           parsed = JSON.parse(File.read(path))
           JSON::Validator.validate(event_schema, parsed, insert_defaults: true)
-          next if %w[message hello].include?(name)
+          next if name == 'message'
+
           result[name] = parsed
         end
 
-        event_handler_template = Erubis::Eruby.new(File.read('lib/slack/real_time/api/templates/event_handler.erb'))
+        hook_template = Erubis::Eruby.new(File.read('lib/slack/real_time/api/templates/event_handler.erb'))
         Dir.glob('lib/slack/real_time/stores/**/*.rb').each do |store_file|
           next if File.basename(store_file) == 'base.rb'
-          STDOUT.write "#{File.basename(store_file)}:"
+
+          STDOUT.write "#{File.basename(store_file)}: "
 
           store_file_contents = File.read(store_file)
 
-          events.each_pair do |event_name, event_data|
-            if store_file_contents.include?("on :#{event_name} do")
-              STDOUT.write('.')
-            else
-              STDOUT.write('x')
-              rendered_event_handler = event_handler_template.result(
-                name: event_data['name'],
-                desc: event_data['desc']
-              )
-
-              store_file_contents.gsub! REAL_TIME_EVENTS_MARKER, REAL_TIME_EVENTS_MARKER + "\n\n" + rendered_event_handler.rstrip
-            end
+          unless store_file_contents.include?(REAL_TIME_EVENTS_MARKER)
+            puts "missing '#{REAL_TIME_EVENTS_MARKER}' line; skipping."
+            next
           end
 
-          File.open store_file, 'w' do |f|
-            f.write store_file_contents
+          # Extract current hook implementations from the store class
+          hooks = {}
+          hook_matcher = /
+            (?:^[[:blank:]]*\R)+                                                     # At least one blank line
+            (?:^[[:blank:]]*\#.*\R)*                                                 # Optional preceding comments
+            (?<hook>                                                                 # on :event do |data|
+              ^(?<padding>[[:blank:]]+)\#\ *on\ :(?<event>\w+)\ do\ \|[\w, ]+\|\ *\R # Commented hook
+              (?>^\k<padding>\#.*\R)*                                                # Extra comments
+              |
+              ^(?<padding>[[:blank:]]+)on\ :(?<event>\w+)\ do\ \|[\w, ]+\|\ *\R      # Active hook
+              [\s\S]*?                                                               # Inside block
+              (?>^\k<padding>end[[:blank:]]*\R)                                      # End of block
+            )
+          /x
+          store_file_contents.gsub!(hook_matcher) do
+            hook, event = Regexp.last_match.values_at(:hook, :event)
+            hooks[event] = hook
+            nil
           end
 
+          # Render latest event documentation with current hook implementations
+          rendered_hooks = events.sort.map do |event_name, event_data|
+            STDOUT.write(hooks.key?(event_name) ? '.' : 'x')
+
+            hook_template.result(
+              name: event_data['name'],
+              desc: event_data['desc'],
+              hook: hooks[event_name]
+            ).rstrip
+          end
+
+          # Insert updated event hooks under RealTime Events marker
+          store_file_contents.gsub!(
+            REAL_TIME_EVENTS_MARKER,
+            [REAL_TIME_EVENTS_MARKER, *rendered_hooks].join("\n\n")
+          )
+          File.write(store_file, store_file_contents)
+
           puts ' done.'
         end
       end

data/lib/tasks/update.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 namespace :slack do
   namespace :api do
     desc 'Auto-generate automatic portions of the Slack API client.'

data/lib/tasks/web.rake

@@ -1,16 +1,19 @@
-# largely from https://github.com/aki017/slack-ruby-gem
+# frozen_string_literal: true
+
 require 'json-schema'
 require 'erubis'
 require 'active_support'
 require 'active_support/core_ext'
 
+# largely from https://github.com/aki017/slack-ruby-gem
 namespace :slack do
   namespace :web do
     namespace :api do
-      desc 'Update API.'
+      desc 'Update Web API.'
       task update: [:git_update] do
         group_schema = JSON.parse(File.read('lib/slack/web/api/schema/group.json'))
-        groups = Dir.glob('lib/slack/web/api/slack-api-ref/groups/**/*.json').each_with_object({}) do |path, result|
+        dirglob = 'lib/slack/web/api/slack-api-ref/groups/**/*.json'
+        groups = Dir.glob(dirglob).each_with_object({}) do |path, result|
           name = File.basename(path, '.json')
           parsed = JSON.parse(File.read(path))
           parsed['undocumented'] = true if path =~ /undocumented/
@@ -30,38 +33,71 @@ namespace :slack do
           parsed = JSON.parse(File.read(path))
           parsed['undocumented'] = true if path =~ /undocumented/
           JSON::Validator.validate(method_schema, parsed, insert_defaults: true)
+          if parsed['deprecated'] && parsed['deprecation']['deprecation_warning'] =~ /It will stop functioning in February 2021/
+            next
+          end
+
           result[prefix][name] = parsed
         end
 
+        # Start with a fresh slate
+        Dir.glob('lib/slack/web/api/endpoints/*.rb').each { |file| File.delete(file) }
+        Dir.glob('spec/slack/web/api/endpoints/*_spec.rb').each { |file| File.delete(file) }
+        Dir.glob('bin/commands/*.rb').each { |file| File.delete(file) }
+
         method_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/method.erb'))
-        method_spec_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/method_spec.erb'))
+        method_spec_template =
+          Erubis::Eruby.new(File.read('lib/slack/web/api/templates/method_spec.erb'))
         command_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/command.erb'))
-        data.each_with_index do |(group, names), index|
+
+        data.each.with_index(1) do |(group, names), index|
           printf "%2d/%2d %10s %s\n", index, data.size, group, names.keys
           # method
           snaked_group = group.tr('.', '_')
           rendered_method = method_template.result(group: group, names: names)
           File.write "lib/slack/web/api/endpoints/#{snaked_group}.rb", rendered_method
-          custom_spec_exists = File.exist?("spec/slack/web/api/endpoints/custom_specs/#{group}_spec.rb")
+          custom_spec_exists =
+            File.exist?("spec/slack/web/api/endpoints/custom_specs/#{group}_spec.rb")
           unless custom_spec_exists
             rendered_method_spec = method_spec_template.result(group: group, names: names)
             File.write "spec/slack/web/api/endpoints/#{snaked_group}_spec.rb", rendered_method_spec
           end
-          Dir.glob("lib/slack/web/api/patches/#{group}*.patch").sort.each do |patch|
-            puts "- patching #{patch}"
-            system("git apply #{patch}") || raise('failed to apply patch')
+
+          unless ENV.key?('SKIP_PATCH')
+            Dir.glob("lib/slack/web/api/patches/#{group}*.patch").sort.each do |patch|
+              puts "- patching #{patch}"
+              system("git apply #{patch}") || raise('failed to apply patch')
+            end
           end
+
           # command
           raise "Missing group #{group}" unless groups.key?(group)
+
           rendered_command = command_template.result(group: groups[group], names: names)
           File.write "bin/commands/#{snaked_group}.rb", rendered_command
         end
 
-        endpoints_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/endpoints.erb'))
-        File.write 'lib/slack/web/api/endpoints.rb', endpoints_template.result(files: data.keys.map { |key| key.tr('.', '_') })
+        endpoints_template =
+          Erubis::Eruby.new(File.read('lib/slack/web/api/templates/endpoints.erb'))
+        File.write(
+          'lib/slack/web/api/endpoints.rb',
+          endpoints_template.result(files: data.keys.map { |key| key.tr('.', '_') })
+        )
 
         commands_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/commands.erb'))
-        File.write 'bin/commands.rb', commands_template.result(files: data.keys.map { |key| key.tr('.', '_') })
+        File.write(
+          'bin/commands.rb',
+          commands_template.result(files: data.keys.map { |key| key.tr('.', '_') })
+        )
+
+        errors_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/errors.erb'))
+        errors = data.values.map do |names|
+          names.values.map do |d|
+            d['errors'].keys
+          end
+        end.flatten.compact.uniq.sort
+        rendered_errors = errors_template.result(errors: errors)
+        File.write('lib/slack/web/api/errors.rb', rendered_errors)
       end
     end
   end

data/slack-ruby-client.gemspec

@@ -1,4 +1,5 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'slack/version'
 
 Gem::Specification.new do |s|
@@ -9,24 +10,18 @@ Gem::Specification.new do |s|
   s.authors = ['Daniel Doubrovkine']
   s.email = 'dblock@dblock.org'
   s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 2.7'
   s.required_rubygems_version = '>= 1.3.6'
   s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
   s.homepage = 'http://github.com/slack-ruby/slack-ruby-client'
   s.licenses = ['MIT']
   s.summary = 'Slack Web and RealTime API client.'
-  s.add_dependency 'activesupport'
-  s.add_dependency 'faraday', '>= 0.9'
-  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'faraday', '>= 2.0'
+  s.add_dependency 'faraday-mashify'
+  s.add_dependency 'faraday-multipart'
   s.add_dependency 'gli'
   s.add_dependency 'hashie'
   s.add_dependency 'websocket-driver'
-  s.add_development_dependency 'erubis'
-  s.add_development_dependency 'json-schema'
-  s.add_development_dependency 'rake', '~> 10'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '0.58.2'
-  s.add_development_dependency 'vcr'
-  s.add_development_dependency 'webmock'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/spec/fixtures/slack/web/429_error.yml

@@ -5,47 +5,14 @@ http_interactions:
     uri: https://slack.com/api/auth.test
     body:
       encoding: UTF-8
-      string: token=
-    headers:
-      Accept:
-      - application/json; charset=utf-8
-      User-Agent:
-      - Slack Ruby Client 0.1.0
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 429
-      message: OK
-    headers:
-      Access-Control-Allow-Origin:
-      - '*'
-      Retry-After:
-      - 3600
-      Date:
-      - Sat, 25 Jul 2015 14:42:07 GMT
-      Server:
-      - Apache
-      Connection:
-      - keep-alive
-    body:
-      encoding: US-ASCII
       string: ''
-    http_version: 
-  recorded_at: Sat, 25 Jul 2015 14:42:08 GMT
-- request:
-    method: post
-    uri: https://slack.com/api/auth.test
-    body:
-      encoding: UTF-8
-      string: token
     headers:
       Accept:
       - application/json; charset=utf-8
       User-Agent:
-      - Slack Ruby Client/0.5.0
+      - Slack Ruby Client/0.18.0
+      Authorization:
+      - Bearer <SLACK_API_TOKEN>
       Content-Type:
       - application/x-www-form-urlencoded
       Accept-Encoding:
@@ -55,31 +22,60 @@ http_interactions:
       code: 200
       message: OK
     headers:
-      Access-Control-Allow-Origin:
-      - '*'
-      Content-Security-Policy:
-      - referrer no-referrer;
-      Content-Type:
-      - application/json; charset=utf-8
       Date:
-      - Tue, 24 Nov 2015 20:03:05 GMT
+      - Sat, 04 Dec 2021 20:13:19 GMT
       Server:
       - Apache
+      Access-Control-Allow-Origin:
+      - "*"
+      Referrer-Policy:
+      - no-referrer
+      X-Slack-Backend:
+      - r
       Strict-Transport-Security:
       - max-age=31536000; includeSubDomains; preload
-      X-Accepted-Oauth-Scopes:
-      - identify
-      X-Content-Type-Options:
-      - nosniff
+      Access-Control-Allow-Headers:
+      - slack-route, x-slack-version-ts, x-b3-traceid, x-b3-spanid, x-b3-parentspanid,
+        x-b3-sampled, x-b3-flags
+      Access-Control-Expose-Headers:
+      - x-slack-req-id, retry-after
+      X-Oauth-Scopes:
+      - identify,read,post,client,apps
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
       X-Xss-Protection:
       - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Slack-Req-Id:
+      - 19b143ea43a655dcdc6c3debd59c41c0
+      Vary:
+      - Accept-Encoding
       Content-Length:
-      - '33'
-      Connection:
-      - keep-alive
+      - '165'
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Envoy-Upstream-Service-Time:
+      - '18'
+      X-Backend:
+      - main_normal main_bedrock_normal_with_overflow main_canary_with_overflow main_bedrock_canary_with_overflow
+        main_control_with_overflow main_bedrock_control_with_overflow
+      X-Server:
+      - slack-www-hhvm-main-iad-d5j5
+      X-Slack-Shared-Secret-Outcome:
+      - no-match
+      Via:
+      - envoy-www-iad-tdcc, envoy-edge-iad-olsk
+      X-Edge-Backend:
+      - envoy-www
+      X-Slack-Edge-Shared-Secret-Outcome:
+      - no-match
     body:
       encoding: UTF-8
-      string: '{"ok":false,"error":"not_authed"}'
-    http_version: 
-  recorded_at: Tue, 24 Nov 2015 20:03:05 GMT
-recorded_with: VCR 2.9.3
+      string: '{"ok":true,"url":"https:\/\/dblockdotorg.slack.com\/","team":"dblock","user":"travis-ci","team_id":"T04KB5WQH","user_id":"U0J1GAHN1","bot_id":"B0J1L75DY","is_enterprise_install":false}'
+  recorded_at: Sat, 19 Jan 2019 21:25:48 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/slack/web/auth_test_error.yml

@@ -5,14 +5,16 @@ http_interactions:
     uri: https://slack.com/api/auth.test
     body:
       encoding: UTF-8
-      string: token=
+      string: ''
     headers:
       Accept:
       - application/json; charset=utf-8
       User-Agent:
-      - Slack Ruby Client 0.1.0
-      Content-Type:
-      - application/x-www-form-urlencoded
+      - Slack Ruby Client/0.18.0
+      Authorization:
+      - Bearer <SLACK_API_TOKEN>
+      Content-Length:
+      - '0'
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
   response:
@@ -20,29 +22,60 @@ http_interactions:
       code: 200
       message: OK
     headers:
-      Access-Control-Allow-Origin:
-      - "*"
-      Content-Type:
-      - application/json; charset=utf-8
       Date:
-      - Sat, 25 Jul 2015 14:42:07 GMT
+      - Sat, 04 Dec 2021 20:13:18 GMT
       Server:
       - Apache
+      Access-Control-Allow-Origin:
+      - "*"
+      Referrer-Policy:
+      - no-referrer
+      X-Slack-Backend:
+      - r
       Strict-Transport-Security:
       - max-age=31536000; includeSubDomains; preload
-      Vary:
-      - Accept-Encoding
-      X-Content-Type-Options:
-      - nosniff
+      Access-Control-Allow-Headers:
+      - slack-route, x-slack-version-ts, x-b3-traceid, x-b3-spanid, x-b3-parentspanid,
+        x-b3-sampled, x-b3-flags
+      Access-Control-Expose-Headers:
+      - x-slack-req-id, retry-after
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
+      X-Robots-Tag:
+      - noindex,nofollow
       X-Xss-Protection:
       - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Slack-Req-Id:
+      - ad5ac4ccd453f8d6e46e1cc41d6d8a7a
+      Vary:
+      - Accept-Encoding
       Content-Length:
       - '53'
-      Connection:
-      - keep-alive
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Envoy-Upstream-Service-Time:
+      - '5'
+      X-Backend:
+      - main_normal main_bedrock_normal_with_overflow main_canary_with_overflow main_bedrock_canary_with_overflow
+        main_control_with_overflow main_bedrock_control_with_overflow
+      X-Server:
+      - slack-www-hhvm-main-iad-6qbu
+      X-Slack-Shared-Secret-Outcome:
+      - no-match
+      Via:
+      - envoy-www-iad-fsrl, envoy-edge-iad-m7rj
+      X-Edge-Backend:
+      - envoy-www
+      X-Slack-Edge-Shared-Secret-Outcome:
+      - no-match
     body:
       encoding: UTF-8
       string: '{"ok":false,"error":"not_authed"}'
-    http_version: 
-  recorded_at: Sat, 25 Jul 2015 14:42:08 GMT
-recorded_with: VCR 2.9.3
+  recorded_at: Sat, 19 Jan 2019 21:25:48 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/slack/web/auth_test_success.yml

@@ -5,12 +5,14 @@ http_interactions:
     uri: https://slack.com/api/auth.test
     body:
       encoding: UTF-8
-      string: token=token
+      string: ''
     headers:
       Accept:
       - application/json; charset=utf-8
       User-Agent:
-      - Slack Ruby Gem 1.1.1
+      - Slack Ruby Client/0.18.0
+      Authorization:
+      - Bearer <SLACK_API_TOKEN>
       Content-Type:
       - application/x-www-form-urlencoded
       Accept-Encoding:
@@ -20,38 +22,60 @@ http_interactions:
       code: 200
       message: OK
     headers:
-      Access-Control-Allow-Origin:
-      - '*'
-      Cache-Control:
-      - private, no-cache, no-store, must-revalidate
-      Content-Type:
-      - application/json; charset=utf-8
       Date:
-      - Tue, 28 Apr 2015 12:55:23 GMT
-      Expires:
-      - Mon, 26 Jul 1997 05:00:00 GMT
-      Pragma:
-      - no-cache
+      - Sat, 04 Dec 2021 20:13:19 GMT
       Server:
       - Apache
+      Access-Control-Allow-Origin:
+      - "*"
+      Referrer-Policy:
+      - no-referrer
+      X-Slack-Backend:
+      - r
       Strict-Transport-Security:
       - max-age=31536000; includeSubDomains; preload
-      Vary:
-      - Accept-Encoding
-      X-Accepted-Oauth-Scopes:
-      - identify
-      X-Content-Type-Options:
-      - nosniff
+      Access-Control-Allow-Headers:
+      - slack-route, x-slack-version-ts, x-b3-traceid, x-b3-spanid, x-b3-parentspanid,
+        x-b3-sampled, x-b3-flags
+      Access-Control-Expose-Headers:
+      - x-slack-req-id, retry-after
       X-Oauth-Scopes:
-      - identify,read,post,client
+      - identify,read,post,client,apps
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
       X-Xss-Protection:
       - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Slack-Req-Id:
+      - cf2877c6fab8f3aa7747f2e07d0b5fd5
+      Vary:
+      - Accept-Encoding
       Content-Length:
-      - '128'
-      Connection:
-      - keep-alive
+      - '165'
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Envoy-Upstream-Service-Time:
+      - '18'
+      X-Backend:
+      - main_normal main_bedrock_normal_with_overflow main_canary_with_overflow main_bedrock_canary_with_overflow
+        main_control_with_overflow main_bedrock_control_with_overflow
+      X-Server:
+      - slack-www-hhvm-main-iad-i2dg
+      X-Slack-Shared-Secret-Outcome:
+      - no-match
+      Via:
+      - envoy-www-iad-pwei, envoy-edge-iad-p7fn
+      X-Edge-Backend:
+      - envoy-www
+      X-Slack-Edge-Shared-Secret-Outcome:
+      - no-match
     body:
       encoding: UTF-8
-      string: '{"ok":true,"url":"https:\/\/rubybot.slack.com\/","team":"team_name","user":"user_name","team_id":"TDEADBEEF","user_id":"UBAADFOOD"}'
-    http_version:
-  recorded_at: Tue, 28 Apr 2015 12:55:22 GMT
+      string: '{"ok":true,"url":"https:\/\/rubybot.slack.com\/","team":"team_name","user":"user_name","team_id":"TDEADBEEF","user_id":"UBAADFOOD","bot_id":"B0J1L75DY","is_enterprise_install":false}'
+  recorded_at: Sat, 19 Jan 2019 21:25:48 GMT
+recorded_with: VCR 6.0.0