slack-ruby-client 0.7.2 → 1.0.0

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

@@ -1,12 +1,30 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Faraday
       module Response
         class RaiseError < ::Faraday::Response::Middleware
           def on_complete(env)
+            raise Slack::Web::Api::Errors::TooManyRequestsError, env.response if env.status == 429
+
+            return unless env.success?
+
             body = env.body
+            return unless body
             return if body['ok']
-            fail Slack::Web::Api::Error.new(body['error'], env.response)
+
+            error_message =
+              body['error'] || body['errors'].map { |message| message['error'] }.join(',')
+
+            error_class = Slack::Web::Api::Errors::ERROR_CLASSES[error_message]
+            error_class ||= Slack::Web::Api::Errors::SlackError
+            raise error_class.new(error_message, env.response)
+          end
+
+          def call(env)
+            super
+          rescue ::Faraday::ParsingError
+            raise Slack::Web::Api::Errors::ParsingError, env.response
           end
         end
       end

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::Response::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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Api
+      module Pagination
+        class Cursor
+          include Enumerable
+
+          attr_reader :client, :verb, :sleep_interval, :max_retries, :params
+
+          def initialize(client, verb, params = {})
+            @client = client
+            @verb = verb
+            @params = params.dup
+            @sleep_interval = @params.delete(:sleep_interval)
+            @max_retries = @params.delete(:max_retries) || client.default_max_retries
+          end
+
+          def each
+            next_cursor = nil
+            retry_count = 0
+            loop do
+              query = { limit: client.default_page_size }.merge(params).merge(cursor: next_cursor)
+              begin
+                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)
+                next
+              end
+              yield response
+              break unless response.response_metadata
+
+              next_cursor = response.response_metadata.next_cursor
+              break if next_cursor.nil? || next_cursor == ''
+
+              retry_count = 0
+              sleep(sleep_interval) if sleep_interval
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack-ruby-client.rb

@@ -1,11 +1,12 @@
-require 'slack/version'
-require 'slack/logger'
-require 'slack/config'
+# frozen_string_literal: true
+require_relative 'slack/version'
+require_relative 'slack/logger'
+require_relative 'slack/config'
 
 # Messages
 require 'hashie'
-require 'slack/messages/message'
-require 'slack/messages/formatting'
+require_relative 'slack/messages/message'
+require_relative 'slack/messages/formatting'
 
 # Web API
 require 'faraday'
@@ -14,28 +15,41 @@ require 'json'
 require 'logger'
 begin
   require 'picky'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # ignore, only used in users_search
 end
-require 'slack/web/config'
-require 'slack/web/api/error'
-require 'slack/web/faraday/response/raise_error'
-require 'slack/web/faraday/connection'
-require 'slack/web/faraday/request'
-require 'slack/web/api/mixins'
-require 'slack/web/api/endpoints'
-require 'slack/web/client'
+begin
+  require 'openssl'
+rescue LoadError # rubocop:disable Lint/SuppressedException
+  # Used in slack/web/config
+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/faraday/response/raise_error'
+require_relative 'slack/web/faraday/response/wrap_error'
+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/pagination/cursor'
+require_relative 'slack/web/client'
 
 # RealTime API
-require 'active_support'
-require 'active_support/core_ext'
-require 'slack/real_time/concurrency'
-require 'slack/real_time/socket'
-require 'slack/real_time/api/message_id'
-require 'slack/real_time/api/ping'
-require 'slack/real_time/api/message'
-require 'slack/real_time/api/typing'
-require 'slack/real_time/models'
-require 'slack/real_time/stores'
-require 'slack/real_time/config'
-require 'slack/real_time/client'
+require_relative 'slack/real_time/concurrency'
+require_relative 'slack/real_time/socket'
+require_relative 'slack/real_time/api/message_id'
+require_relative 'slack/real_time/api/ping'
+require_relative 'slack/real_time/api/message'
+require_relative 'slack/real_time/api/typing'
+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'

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,5 +1,6 @@
+# frozen_string_literal: true
 namespace :slack do
-  # update slack-api-ref from https://github.com/dblock/slack-api-ref
+  # update slack-api-ref from https://github.com/slack-ruby/slack-api-ref
   task :git_update do
     sh 'git submodule update --init --recursive'
     sh 'git submodule foreach git pull origin master'

data/lib/tasks/real_time.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # largely from https://github.com/aki017/slack-ruby-gem
 require 'json-schema'
 require 'erubis'
@@ -5,22 +6,26 @@ require 'erubis'
 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 %w[message hello].include?(name)
+
           result[name] = parsed
         end
 
-        event_handler_template = Erubis::Eruby.new(File.read('lib/slack/real_time/api/templates/event_handler.erb'))
+        event_handler_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)}:"
 
           store_file_contents = File.read(store_file)
@@ -35,7 +40,12 @@ namespace :slack do
                 desc: event_data['desc']
               )
 
-              store_file_contents.gsub! REAL_TIME_EVENTS_MARKER, REAL_TIME_EVENTS_MARKER + "\n\n" + rendered_event_handler.rstrip
+              store_file_contents.gsub!(
+                REAL_TIME_EVENTS_MARKER,
+                REAL_TIME_EVENTS_MARKER +
+                  "\n\n" +
+                  rendered_event_handler.rstrip
+              )
             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,3 +1,4 @@
+# frozen_string_literal: true
 # largely from https://github.com/aki017/slack-ruby-gem
 require 'json-schema'
 require 'erubis'
@@ -7,12 +8,14 @@ require 'active_support/core_ext'
 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/
           JSON::Validator.validate(group_schema, parsed, insert_defaults: true)
           result[name] = parsed
         end
@@ -27,12 +30,18 @@ namespace :slack do
           name = file_name.split('.')[-1]
           result[prefix] ||= {}
           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
 
         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|
           printf "%2d/%2d %10s %s\n", index, data.size, group, names.keys
@@ -40,25 +49,48 @@ namespace :slack do
           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}") || fail('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|
@@ -11,23 +12,24 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   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/dblock/slack-ruby-client'
+  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'
+  s.add_dependency 'faraday', '>= 1.0'
   s.add_dependency 'faraday_middleware'
-  s.add_dependency 'json'
-  s.add_dependency 'websocket-driver'
   s.add_dependency 'gli'
   s.add_dependency 'hashie'
+  s.add_dependency 'websocket-driver'
+  s.add_development_dependency 'activesupport'
   s.add_development_dependency 'erubis'
   s.add_development_dependency 'json-schema'
-  s.add_development_dependency 'rake', '~> 10'
+  s.add_development_dependency 'rake', '~> 13'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop', '~> 0.93.1'
+  s.add_development_dependency 'rubocop-performance', '~> 1.5.2'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.39.0'
+  s.add_development_dependency 'timecop'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
-  s.add_development_dependency 'rubocop', '0.35.0'
 end

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

@@ -5,45 +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:
-      - '*'
-      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:
@@ -53,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