slack-ruby-client 0.7.9 → 0.16.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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Api
+      module Errors
+        class SlackError < ::Faraday::Error
+          attr_reader :response
+
+          def initialize(message, response = nil)
+            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
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Api
+      module Errors
+        class TooManyRequestsError < ::Faraday::Error
+          attr_reader :response
+
+          def initialize(response)
+            @response = response
+          end
+
+          def message
+            "Retry after #{retry_after} seconds"
+          end
+
+          def retry_after
+            response.headers['retry-after'].to_i
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,6 @@
-require 'slack/web/api/mixins/channels.id'
-require 'slack/web/api/mixins/users.id'
-require 'slack/web/api/mixins/users.search'
-require 'slack/web/api/mixins/groups.id'
+# 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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+require_relative 'ids.id'
+
 module Slack
   module Web
     module Api
       module Mixins
         module Channels
+          include Ids
           #
           # This method returns a channel ID given a channel name.
           #
@@ -11,13 +15,8 @@ module Slack
           def channels_id(options = {})
             name = options[:channel]
             throw ArgumentError.new('Required arguments :channel missing') if name.nil?
-            return { 'ok' => true, 'channel' => { 'id' => name } } unless name[0] == '#'
-            channels_list.tap do |list|
-              list.channels.each do |channel|
-                return Slack::Messages::Message.new('ok' => true, 'channel' => { 'id' => channel.id }) if channel.name == name[1..-1]
-              end
-            end
-            fail Slack::Web::Api::Error, 'channel_not_found'
+
+            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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+require_relative 'ids.id'
+
 module Slack
   module Web
     module Api
       module Mixins
         module Groups
+          include Ids
           #
           # This method returns a group ID given a group name.
           #
@@ -11,13 +15,8 @@ module Slack
           def groups_id(options = {})
             name = options[:channel]
             throw ArgumentError.new('Required arguments :channel missing') if name.nil?
-            return { 'ok' => true, 'group' => { 'id' => name } } unless name[0] == '#'
-            groups_list.tap do |list|
-              list.groups.each do |group|
-                return Slack::Messages::Message.new('ok' => true, 'group' => { 'id' => group.id }) if group.name == name[1..-1]
-              end
-            end
-            fail Slack::Web::Api::Error, 'channel_not_found'
+
+            id_for :group, name, '#', :groups_list, :groups, 'channel_not_found'
           end
         end
       end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Api
+      module Mixins
+        module Ids
+          private
+
+          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
+
+            public_send enum_method 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]
+              end
+            end
+
+            raise Slack::Web::Api::Errors::SlackError, not_found_error
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+require_relative 'ids.id'
+
 module Slack
   module Web
     module Api
       module Mixins
         module Users
+          include Ids
           #
           # This method returns a user ID given a user name.
           #
@@ -11,13 +15,8 @@ module Slack
           def users_id(options = {})
             name = options[:user]
             throw ArgumentError.new('Required arguments :user missing') if name.nil?
-            return { 'ok' => true, 'user' => { 'id' => name } } unless name[0] == '@'
-            users_list.tap do |list|
-              list.members.each do |user|
-                return Slack::Messages::Message.new('ok' => true, 'user' => { 'id' => user.id }) if user.name == name[1..-1]
-              end
-            end
-            fail Slack::Web::Api::Error, 'user_not_found'
+
+            id_for :user, name, '@', :users_list, :members, 'user_not_found'
           end
         end
       end

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

@@ -1,43 +1,46 @@
-module Slack
-  module Web
-    module Api
-      module Mixins
-        module Users
-          Member = Struct.new :id, :name, :first_name, :last_name, :real_name, :email
+# frozen_string_literal: true
+if defined?(Picky)
+  module Slack
+    module Web
+      module Api
+        module Mixins
+          module Users
+            Member = Struct.new :id, :name, :first_name, :last_name, :real_name, :email
 
-          #
-          # This method searches for users.
-          #
-          # @option options [user] :user
-          #   Free-formed text to search for.
-          def users_search(options = {})
-            query = options[:user]
-            throw ArgumentError.new('Required arguments :user missing') if query.nil?
-            index = Picky::Index.new(:users) do
-              category :name
-              category :first_name
-              category :last_name
-              category :real_name
-              category :email
+            #
+            # This method searches for users.
+            #
+            # @option options [user] :user
+            #   Free-formed text to search for.
+            def users_search(options = {})
+              query = options[:user]
+              throw ArgumentError.new('Required arguments :user missing') if query.nil?
+              index = Picky::Index.new(:users) do
+                category :name
+                category :first_name
+                category :last_name
+                category :real_name
+                category :email
+              end
+              members = users_list.members
+              members.each_with_index do |member, id|
+                user = Member.new(
+                  id,
+                  member.name,
+                  member.profile.first_name,
+                  member.profile.last_name,
+                  member.profile.real_name,
+                  member.profile.email
+                )
+                index.add(user)
+              end
+              ids = Picky::Search.new(index).search(query, 5, 0, unique: true).ids
+              results = ids.map { |id| members[id] }
+              Slack::Messages::Message.new('ok' => true, 'members' => results)
             end
-            members = users_list.members
-            members.each_with_index do |member, id|
-              user = Member.new(
-                id,
-                member.name,
-                member.profile.first_name,
-                member.profile.last_name,
-                member.profile.real_name,
-                member.profile.email
-              )
-              index.add(user)
-            end
-            ids = Picky::Search.new(index).search(query, 5, 0, unique: true).ids
-            results = ids.map { |id| members[id] }
-            Slack::Messages::Message.new('ok' => true, 'members' => results)
           end
         end
       end
     end
   end
-end if defined?(Picky)
+end

data/lib/slack/web/api/patches/chat.1.patch

@@ -0,0 +1,72 @@
+diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
+index 9de4aa9..8ed5625 100644
+--- a/lib/slack/web/api/endpoints/chat.rb
++++ b/lib/slack/web/api/endpoints/chat.rb
+@@ -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 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
++            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.postEphemeral', options)
+           end
+
+@@ -166,7 +177,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 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?
++            # 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
+
+@@ -254,8 +277,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, :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: 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]
++              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/dialog.1.open-json-support.patch

@@ -0,0 +1,17 @@
+diff --git a/lib/slack/web/api/endpoints/dialog.rb b/lib/slack/web/api/endpoints/dialog.rb
+index 01f9dfd..d017adf 100644
+--- a/lib/slack/web/api/endpoints/dialog.rb
++++ b/lib/slack/web/api/endpoints/dialog.rb
+@@ -17,6 +17,12 @@ module Slack
+           def dialog_open(options = {})
+             throw ArgumentError.new('Required arguments :dialog missing') if options[:dialog].nil?
+             throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
++            # dialog must be passed as an encoded JSON string
++            if options.key?(:dialog)
++              dialog = options[:dialog]
++              dialog = JSON.dump(dialog) unless dialog.is_a?(String)
++              options = options.merge(dialog: dialog)
++            end
+             post('dialog.open', 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
+