slack-ruby-client 0.12.0 → 0.14.6

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Api
@@ -6,8 +7,20 @@ module Slack
           attr_reader :response
 
           def initialize(message, response = nil)
-            @response = response
             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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Api

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'mixins/channels.id'
 require_relative 'mixins/users.id'
 require_relative 'mixins/users.search'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'ids.id'
 
 module Slack

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'ids.id'
 
 module Slack

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Api
@@ -10,7 +11,9 @@ module Slack
 
             yield.tap do |list|
               list.public_send(list_method).each do |li|
-                return Slack::Messages::Message.new('ok' => true, key.to_s => { 'id' => li.id }) if li.name == name[1..-1]
+                if li.name == name[1..-1]
+                  return Slack::Messages::Message.new('ok' => true, key.to_s => { 'id' => li.id })
+                end
               end
             end
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'ids.id'
 
 module Slack

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 if defined?(Picky)
   module Slack
     module Web

data/lib/slack/web/api/patches/chat.5.postEphemeral-text-or-attachments.patch

@@ -1,10 +1,12 @@
-diff --git a/slack-ruby-client/lib/slack/web/api/endpoints/chat.rb b/slack-ruby-client-original/lib/slack/web/api/endpoints/chat.rb
-index 194419e..2ef5c65 100644
+diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
+index e1c409d..3b24fea 100644
 --- a/lib/slack/web/api/endpoints/chat.rb
 +++ b/lib/slack/web/api/endpoints/chat.rb
-@@ -93,7 +93,7 @@ module Slack
+@@ -120,9 +120,8 @@ 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 missing') if options[:text].nil?
 +            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?

data/lib/slack/web/api/patches/chat.6.block-kit-support.patch

@@ -0,0 +1,69 @@
+diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
+index 54a7db1..c535bb5 100644
+--- a/lib/slack/web/api/endpoints/chat.rb
++++ b/lib/slack/web/api/endpoints/chat.rb
+@@ -97,7 +97,7 @@ module Slack
+           # @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 :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 :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
++            # blocks must be passed as an encoded JSON string
++            if options.key?(:blocks)
++              blocks = options[:blocks]
++              blocks = JSON.dump(blocks) unless blocks.is_a?(String)
++              options = options.merge(blocks: blocks)
++            end
+             post('chat.postEphemeral', options)
+           end
+ 
+@@ -146,13 +152,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
++            # blocks must be passed as an encoded JSON string
++            if options.key?(:blocks)
++              blocks = options[:blocks]
++              blocks = JSON.dump(blocks) unless blocks.is_a?(String)
++              options = options.merge(blocks: blocks)
++            end
+             post('chat.postMessage', options)
+           end
+ 
+@@ -204,7 +216,7 @@ 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
++            # blocks must be passed as an encoded JSON string
++            if options.key?(:blocks)
++              blocks = options[:blocks]
++              blocks = JSON.dump(blocks) unless blocks.is_a?(String)
++              options = options.merge(blocks: blocks)
++            end
+             post('chat.update', options)
+           end
+         end

data/lib/slack/web/api/patches/views.1.view-json.patch

@@ -0,0 +1,40 @@
+diff --git a/lib/slack/web/api/endpoints/views.rb b/lib/slack/web/api/endpoints/views.rb
+index 3d7ac8e..10de15c 100644
+--- a/lib/slack/web/api/endpoints/views.rb
++++ b/lib/slack/web/api/endpoints/views.rb
+@@ -18,6 +18,11 @@ module Slack
+           def views_open(options = {})
+             throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+             throw ArgumentError.new('Required arguments :view missing') if options[:view].nil?
++            if options.key?(:view)
++              view = options[:view]
++              view = JSON.dump(view) unless view.is_a?(String)
++              options = options.merge(view: view)
++            end
+             post('views.open', options)
+           end
+ 
+@@ -33,6 +38,11 @@ module Slack
+           def views_push(options = {})
+             throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+             throw ArgumentError.new('Required arguments :view missing') if options[:view].nil?
++            if options.key?(:view)
++              view = options[:view]
++              view = JSON.dump(view) unless view.is_a?(String)
++              options = options.merge(view: view)
++            end
+             post('views.push', options)
+           end
+ 
+@@ -51,6 +61,11 @@ module Slack
+           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.update.json
+           def views_update(options = {})
+             throw ArgumentError.new('Required arguments :view missing') if options[:view].nil?
++            if options.key?(:view)
++              view = options[:view]
++              view = JSON.dump(view) unless view.is_a?(String)
++              options = options.merge(view: view)
++            end
+             post('views.update', options)
+           end
+         end

data/lib/slack/web/api/patches/views.1.views-published.patch

@@ -0,0 +1,16 @@
+diff --git a/lib/slack/web/api/endpoints/views.rb b/lib/slack/web/api/endpoints/views.rb
+index 31626b9..8182a9c 100644
+--- a/lib/slack/web/api/endpoints/views.rb
++++ b/lib/slack/web/api/endpoints/views.rb
+@@ -40,6 +40,11 @@ module Slack
+           def views_publish(options = {})
+             throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
+             throw ArgumentError.new('Required arguments :view missing') if options[:view].nil?
++            if options.key?(:view)
++              view = options[:view]
++              view = JSON.dump(view) unless view.is_a?(String)
++              options = options.merge(view: view)
++            end
+             post('views.publish', options)
+           end
+ 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 <% desc = group['desc'] || "#{group['name'].gsub(".", "_").camelize} methods." %>

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 <% files.sort.each do |f| %>

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 <% files.sort.each do |f| %>

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 require 'spec_helper'

data/lib/slack/web/client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     class Client
@@ -9,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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Config

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Faraday

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Faraday

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

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Faraday
       module Response
         class RaiseError < ::Faraday::Response::Middleware
           def on_complete(env)
-            if env.status == 429
-              raise Slack::Web::Api::Errors::TooManyRequestsError, env.response
-            elsif (body = env.body) && !body['ok']
-              error_message = body['error'] || body['errors'].map { |message| message['error'] }.join(',')
-              raise Slack::Web::Api::Errors::SlackError.new(error_message, env.response)
-            end
+            raise Slack::Web::Api::Errors::TooManyRequestsError, env.response if env.status == 429
+            return unless (body = env.body) && !body['ok']
+
+            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
         end
       end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Api
@@ -28,6 +29,7 @@ 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)
@@ -35,8 +37,10 @@ module Slack
               end
               yield response
               break unless response.response_metadata
+
               next_cursor = response.response_metadata.next_cursor
               break if next_cursor.blank?
+
               retry_count = 0
               sleep(sleep_interval) if sleep_interval
             end

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,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)
+
           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,10 +8,11 @@ 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/
@@ -34,7 +36,8 @@ namespace :slack do
         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
@@ -42,7 +45,8 @@ 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
@@ -53,15 +57,32 @@ namespace :slack do
           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