slack-ruby-client 0.14.5 → 0.17.0

data/lib/slack/web/api/errors/internal_error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Api
+      module Errors
+        class ServerError < InternalError; end
+        class ParsingError < ServerError; end
+        class HttpRequestError < ServerError; end
+        class TimeoutError < HttpRequestError; end
+        class UnavailableError < HttpRequestError; end
+      end
+    end
+  end
+end

data/lib/slack/web/api/errors/slack_error.rb

@@ -10,6 +10,18 @@ module Slack
             super message
             @response = response
           end
+
+          def error
+            response.body.error
+          end
+
+          def errors
+            response.body.errors
+          end
+
+          def response_metadata
+            response.body.response_metadata
+          end
         end
       end
     end

data/lib/slack/web/api/mixins.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative 'mixins/channels.id'
+require_relative 'mixins/conversations.id'
 require_relative 'mixins/users.id'
 require_relative 'mixins/users.search'
 require_relative 'mixins/groups.id'

data/lib/slack/web/api/mixins/channels.id.rb

@@ -16,9 +16,7 @@ module Slack
             name = options[:channel]
             throw ArgumentError.new('Required arguments :channel missing') if name.nil?
 
-            id_for(:channel, name, '#', :channels, 'channel_not_found') do
-              channels_list
-            end
+            id_for :channel, name, '#', :channels_list, :channels, 'channel_not_found'
           end
         end
       end

data/lib/slack/web/api/mixins/conversations.id.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require_relative 'ids.id'
+
+module Slack
+  module Web
+    module Api
+      module Mixins
+        module Conversations
+          include Ids
+          #
+          # This method returns a channel ID given a channel name.
+          #
+          # @option options [channel] :channel
+          #   Channel to get ID for, prefixed with #.
+          def conversations_id(options = {})
+            name = options[:channel]
+            throw ArgumentError.new('Required arguments :channel missing') if name.nil?
+
+            id_for :channel, name, '#', :conversations_list, :channels, 'channel_not_found'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/mixins/groups.id.rb

@@ -16,9 +16,7 @@ module Slack
             name = options[:channel]
             throw ArgumentError.new('Required arguments :channel missing') if name.nil?
 
-            id_for(:group, name, '#', :groups, 'channel_not_found') do
-              groups_list
-            end
+            id_for :group, name, '#', :groups_list, :groups, 'channel_not_found'
           end
         end
       end

data/lib/slack/web/api/mixins/ids.id.rb

@@ -6,14 +6,12 @@ module Slack
         module Ids
           private
 
-          def id_for(key, name, prefix, list_method, not_found_error)
+          def id_for(key, name, prefix, enum_method, list_method, not_found_error)
             return { 'ok' => true, key.to_s => { 'id' => name } } unless name[0] == prefix
 
-            yield.tap do |list|
+            public_send enum_method do |list|
               list.public_send(list_method).each do |li|
-                if li.name == name[1..-1]
-                  return Slack::Messages::Message.new('ok' => true, key.to_s => { 'id' => li.id })
-                end
+                return Slack::Messages::Message.new('ok' => true, key.to_s => { 'id' => li.id }) if li.name == name[1..-1]
               end
             end
 

data/lib/slack/web/api/mixins/users.id.rb

@@ -16,9 +16,7 @@ module Slack
             name = options[:user]
             throw ArgumentError.new('Required arguments :user missing') if name.nil?
 
-            id_for(:user, name, '@', :members, 'user_not_found') do
-              users_list
-            end
+            id_for :user, name, '@', :users_list, :members, 'user_not_found'
           end
         end
       end

data/lib/slack/web/api/patches/{chat.6.block-kit-support.patch → chat.1.patch}

@@ -1,20 +1,23 @@
 diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
-index 54a7db1..c535bb5 100644
+index d090ae2..50186d5 100644
 --- a/lib/slack/web/api/endpoints/chat.rb
 +++ b/lib/slack/web/api/endpoints/chat.rb
-@@ -97,7 +97,7 @@ module Slack
+@@ -121,11 +121,22 @@ module Slack
+           # @see https://api.slack.com/methods/chat.postEphemeral
            # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postEphemeral.json
            def chat_postEphemeral(options = {})
+-            throw ArgumentError.new('Required arguments :attachments missing') if options[:attachments].nil?
              throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
--            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
+-            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
 +            throw ArgumentError.new('Required arguments :text, :attachments or :blocks missing') if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil?
              throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
              options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-             # attachments must be passed as an encoded JSON string
-@@ -106,6 +106,12 @@ module Slack
-               attachments = JSON.dump(attachments) unless attachments.is_a?(String)
-               options = options.merge(attachments: attachments)
-             end
++            # attachments must be passed as an encoded JSON string
++            if options.key?(:attachments)
++              attachments = options[:attachments]
++              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
++              options = options.merge(attachments: attachments)
++            end
 +            # blocks must be passed as an encoded JSON string
 +            if options.key?(:blocks)
 +              blocks = options[:blocks]
@@ -24,18 +27,17 @@ index 54a7db1..c535bb5 100644
              post('chat.postEphemeral', options)
            end
  
-@@ -146,13 +152,19 @@ module Slack
+@@ -168,6 +179,19 @@ module Slack
            # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
            def chat_postMessage(options = {})
              throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
--            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
 +            throw ArgumentError.new('Required arguments :text, :attachments or :blocks missing') if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil?
-             # attachments must be passed as an encoded JSON string
-             if options.key?(:attachments)
-               attachments = options[:attachments]
-               attachments = JSON.dump(attachments) unless attachments.is_a?(String)
-               options = options.merge(attachments: attachments)
-             end
++            # attachments must be passed as an encoded JSON string
++            if options.key?(:attachments)
++              attachments = options[:attachments]
++              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
++              options = options.merge(attachments: attachments)
++            end
 +            # blocks must be passed as an encoded JSON string
 +            if options.key?(:blocks)
 +              blocks = options[:blocks]
@@ -45,19 +47,19 @@ index 54a7db1..c535bb5 100644
              post('chat.postMessage', options)
            end
  
-@@ -204,7 +216,7 @@ module Slack
+@@ -257,8 +281,21 @@ module Slack
            # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.update.json
            def chat_update(options = {})
              throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
--            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
 +            throw ArgumentError.new('Required arguments :text, :attachments or :blocks missing') if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil?
              throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
-             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-             # attachments must be passed as an encoded JSON string
-@@ -213,6 +225,12 @@ module Slack
-               attachments = JSON.dump(attachments) unless attachments.is_a?(String)
-               options = options.merge(attachments: attachments)
-             end
+             options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
++            # attachments must be passed as an encoded JSON string
++            if options.key?(:attachments)
++              attachments = options[:attachments]
++              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
++              options = options.merge(attachments: attachments)
++            end
 +            # blocks must be passed as an encoded JSON string
 +            if options.key?(:blocks)
 +              blocks = options[:blocks]

data/lib/slack/web/api/templates/endpoints.erb

@@ -9,6 +9,7 @@ module Slack
   module Web
     module Api
       module Endpoints
+        include Slack::Web::Api::Mixins::Conversations
         include Slack::Web::Api::Mixins::Channels
         include Slack::Web::Api::Mixins::Users
         include Slack::Web::Api::Mixins::Groups

data/lib/slack/web/api/templates/errors.erb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Errors
+        <% errors.each do |e| %>
+        class <%= e.camelize %> < SlackError; end
+        <% end %>
+
+        ERROR_CLASSES = {
+          <% errors.each do |e| %>
+          '<%= e %>' => <%= e.camelize %>,
+          <% end %>
+        }.freeze
+      end
+    end
+  end
+end

data/lib/slack/web/api/templates/method.erb

@@ -40,7 +40,7 @@ module Slack
 <% if data['group'] == 'groups' && data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
 <% elsif data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
 <% end %>
 <% if data['args']['user'] %>
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
@@ -48,6 +48,9 @@ module Slack
 <% if data['undocumented'] %>
             logger.warn('The <%= group %>.<%= name %> method is undocumented.')
 <% end %>
+<% if data['deprecated'] %>
+            logger.warn('<%= group %>.<%= name %>: <%= data['deprecation']['deprecation_warning']%> Alternative methods: <%= data['deprecation']['alternative_methods'].join(', ')%>.')
+<% end %>
 <% if data['args'].keys.include?('cursor') %>
             if block_given?
               Pagination::Cursor.new(self, :<%= group.gsub(".", "_") %>_<%= name %>, options).each do |page|

data/lib/slack/web/api/templates/method_spec.erb

@@ -12,7 +12,7 @@ RSpec.describe Slack::Web::Api::Endpoints::<%= group.gsub(".", "_").camelize %>
   context '<%= group %>_<%= name %>' do
 <% required_params.each do |arg_name, arg_v| %>
     it 'requires <%= arg_name %>' do
-<% params_except_required = required_params.reject{ |name, _| name == arg_name  }.map{|var, opts| "#{var}: '#{opts['example']}'"}.join(', ') %>
+<% params_except_required = required_params.reject{ |name, _| name == arg_name  }.map{ |var, opts| "#{var}: %q[#{opts['example']}]"}.join(', ') %>
       expect { client.<%= group.gsub(".", "_") %>_<%= name %><%= params_except_required.empty? ? '' : "(#{params_except_required})" %> }.to raise_error ArgumentError, /Required arguments :<%= arg_name %> missing/
     end
 <% end %>

data/lib/slack/web/client.rb

@@ -10,7 +10,7 @@ module Slack
 
       def initialize(options = {})
         Slack::Web::Config::ATTRIBUTES.each do |key|
-          send("#{key}=", options[key] || Slack::Web.config.send(key))
+          send("#{key}=", options.fetch(key, Slack::Web.config.send(key)))
         end
         @logger ||= Slack::Config.logger || Slack::Logger.default
         @token ||= Slack.config.token

data/lib/slack/web/config.rb

@@ -16,6 +16,7 @@ module Slack
         open_timeout
         default_page_size
         default_max_retries
+        adapter
       ].freeze
 
       attr_accessor(*Config::ATTRIBUTES)
@@ -32,6 +33,7 @@ module Slack
         self.open_timeout = nil
         self.default_page_size = 100
         self.default_max_retries = 100
+        self.adapter = ::Faraday.default_adapter
       end
     end
 

data/lib/slack/web/faraday/connection.rb

@@ -6,29 +6,32 @@ module Slack
         private
 
         def connection
-          options = {
-            headers: { 'Accept' => 'application/json; charset=utf-8' }
-          }
+          @connection ||=
+            begin
+              options = {
+                headers: { 'Accept' => 'application/json; charset=utf-8' }
+              }
 
-          options[:headers]['User-Agent'] = user_agent if user_agent
-          options[:proxy] = proxy if proxy
-          options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
+              options[:headers]['User-Agent'] = user_agent if user_agent
+              options[:proxy] = proxy if proxy
+              options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
 
-          request_options = {}
-          request_options[:timeout] = timeout if timeout
-          request_options[:open_timeout] = open_timeout if open_timeout
-          options[:request] = request_options if request_options.any?
+              request_options = {}
+              request_options[:timeout] = timeout if timeout
+              request_options[:open_timeout] = open_timeout if open_timeout
+              options[:request] = request_options if request_options.any?
 
-          ::Faraday::Connection.new(endpoint, options) do |connection|
-            connection.use ::Faraday::Request::Multipart
-            connection.use ::Faraday::Request::UrlEncoded
-            connection.use ::Faraday::Response::RaiseError
-            connection.use ::Slack::Web::Faraday::Response::RaiseError
-            connection.use ::FaradayMiddleware::Mashify, mash_class: Slack::Messages::Message
-            connection.use ::FaradayMiddleware::ParseJson
-            connection.response :logger, logger if logger
-            connection.adapter ::Faraday.default_adapter
-          end
+              ::Faraday::Connection.new(endpoint, options) do |connection|
+                connection.use ::Faraday::Request::Multipart
+                connection.use ::Faraday::Request::UrlEncoded
+                connection.use ::Slack::Web::Faraday::Response::RaiseError
+                connection.use ::FaradayMiddleware::Mashify, mash_class: Slack::Messages::Message
+                connection.use ::FaradayMiddleware::ParseJson
+                connection.use ::Slack::Web::Faraday::Response::WrapError
+                connection.response :logger, logger if logger
+                connection.adapter adapter
+              end
+            end
         end
       end
     end

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

@@ -6,11 +6,25 @@ module Slack
         class RaiseError < ::Faraday::Response::Middleware
           def on_complete(env)
             raise Slack::Web::Api::Errors::TooManyRequestsError, env.response if env.status == 429
-            return unless (body = env.body) && !body['ok']
+
+            return unless env.success?
+
+            body = env.body
+            return unless body
+            return if body['ok']
 
             error_message =
               body['error'] || body['errors'].map { |message| message['error'] }.join(',')
-            raise Slack::Web::Api::Errors::SlackError.new(error_message, env.response)
+
+            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.new('parsing_error', 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.new('unavailable_error', env.response)
+          end
+
+          def call(env)
+            super
+          rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed
+            raise Slack::Web::Api::Errors::TimeoutError.new('timeout_error', env.response)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,14 +32,14 @@ module Slack
 
                 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

data/lib/tasks/real_time.rake

@@ -8,7 +8,7 @@ namespace :slack do
     namespace :api do
       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'))
         dirglob = 'lib/slack/web/api/slack-api-ref/events/**/*.json'

data/lib/tasks/web.rake

@@ -8,7 +8,7 @@ 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'))
         dirglob = 'lib/slack/web/api/slack-api-ref/groups/**/*.json'
@@ -32,6 +32,10 @@ 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
 
@@ -51,10 +55,14 @@ namespace :slack do
             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)
 
@@ -74,6 +82,15 @@ namespace :slack do
           '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