slack-ruby-client 0.11.0 → 2.7.0

data/lib/slack/web/faraday/response/wrap_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Faraday
+      module Response
+        class WrapError < ::Faraday::Middleware
+          UNAVAILABLE_ERROR_STATUSES = (500..599).freeze
+
+          def on_complete(env)
+            return unless UNAVAILABLE_ERROR_STATUSES.cover?(env.status)
+
+            raise Slack::Web::Api::Errors::UnavailableError, env.response
+          end
+
+          def call(env)
+            super
+          rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed
+            raise Slack::Web::Api::Errors::TimeoutError, env.response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/pagination/cursor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Api
@@ -5,11 +6,7 @@ module Slack
         class Cursor
           include Enumerable
 
-          attr_reader :client
-          attr_reader :verb
-          attr_reader :sleep_interval
-          attr_reader :max_retries
-          attr_reader :params
+          attr_reader :client, :verb, :sleep_interval, :max_retries, :params
 
           def initialize(client, verb, params = {})
             @client = client
@@ -28,15 +25,18 @@ module Slack
                 response = client.send(verb, query)
               rescue Slack::Web::Api::Errors::TooManyRequestsError => e
                 raise e if retry_count >= max_retries
+
                 client.logger.debug("#{self.class}##{__method__}") { e.to_s }
                 retry_count += 1
-                sleep(e.retry_after.seconds)
+                sleep(e.retry_after)
                 next
               end
               yield response
               break unless response.response_metadata
+
               next_cursor = response.response_metadata.next_cursor
-              break if next_cursor.blank?
+              break if next_cursor.nil? || next_cursor == ''
+
               retry_count = 0
               sleep(sleep_interval) if sleep_interval
             end

data/lib/slack-ruby-client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'slack/version'
 require_relative 'slack/logger'
 require_relative 'slack/config'
@@ -9,34 +10,39 @@ require_relative 'slack/messages/formatting'
 
 # Web API
 require 'faraday'
-require 'faraday_middleware'
+require 'faraday/mashify'
+require 'faraday/multipart'
 require 'json'
 require 'logger'
 begin
   require 'picky'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # ignore, only used in users_search
 end
 begin
   require 'openssl'
-rescue LoadError
-  # Used in slack/web/config
+rescue LoadError # rubocop:disable Lint/SuppressedException
+  # Used in slack/web/config and slack/utils/security
 end
 require_relative 'slack/web/config'
 require_relative 'slack/web/api/errors/slack_error'
 require_relative 'slack/web/api/errors/too_many_requests_error'
 require_relative 'slack/web/api/error'
+require_relative 'slack/web/api/errors'
+require_relative 'slack/web/api/errors/server_error'
+require_relative 'slack/web/api/options'
 require_relative 'slack/web/faraday/response/raise_error'
+require_relative 'slack/web/faraday/response/wrap_error'
+require_relative 'slack/web/faraday/options'
 require_relative 'slack/web/faraday/connection'
 require_relative 'slack/web/faraday/request'
 require_relative 'slack/web/api/mixins'
 require_relative 'slack/web/api/endpoints'
+require_relative 'slack/web/api/helpers'
 require_relative 'slack/web/pagination/cursor'
 require_relative 'slack/web/client'
 
 # RealTime API
-require 'active_support'
-require 'active_support/core_ext'
 require_relative 'slack/real_time/concurrency'
 require_relative 'slack/real_time/socket'
 require_relative 'slack/real_time/api/message_id'
@@ -47,3 +53,9 @@ require_relative 'slack/real_time/models'
 require_relative 'slack/real_time/stores'
 require_relative 'slack/real_time/config'
 require_relative 'slack/real_time/client'
+
+# Events API
+require_relative 'slack/events/config'
+require_relative 'slack/events/request'
+
+require_relative 'slack/utils/security'

data/lib/slack.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'

data/lib/slack_ruby_client.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'

data/lib/tasks/git.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 namespace :slack do
   # update slack-api-ref from https://github.com/slack-ruby/slack-api-ref
   task :git_update do

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,61 @@ 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")
-          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')
+          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
+
+          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('.', '_') })
+        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,19 @@ 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.files = `git ls-files`.split("\n").grep_v(%r{^spec/})
   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.1'
+  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.51.0'
-  s.add_development_dependency 'vcr'
-  s.add_development_dependency 'webmock'
+  s.add_dependency 'logger'
+  s.metadata['rubygems_mfa_required'] = 'true'
+  s.metadata['changelog_uri'] = 'https://github.com/slack-ruby/slack-ruby-client/blob/master/CHANGELOG.md'
 end