slack-ruby-client 0.13.0 → 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

@@ -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,4 +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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'ids.id'
 
 module Slack
@@ -15,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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'ids.id'
 
 module Slack
@@ -15,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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Api
@@ -5,10 +6,10 @@ 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|
                 return Slack::Messages::Message.new('ok' => true, key.to_s => { 'id' => li.id }) if li.name == name[1..-1]
               end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'ids.id'
 
 module Slack
@@ -15,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/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.1.patch

@@ -0,0 +1,71 @@
+diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
+index d090ae2..50186d5 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
+ 
+@@ -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, :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
+ 
+@@ -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, :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/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| %>
@@ -8,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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -39,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]
@@ -47,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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 require 'spec_helper'
@@ -11,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

@@ -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
@@ -15,6 +16,7 @@ module Slack
         open_timeout
         default_page_size
         default_max_retries
+        adapter
       ].freeze
 
       attr_accessor(*Config::ATTRIBUTES)
@@ -31,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

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