slack-ruby-client 0.14.6 → 1.0.0

data/lib/slack/web/api/mixins/{channels.id.rb → conversations.id.rb}

@@ -5,20 +5,18 @@ module Slack
   module Web
     module Api
       module Mixins
-        module Channels
+        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 channels_id(options = {})
+          def conversations_id(options = {})
             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, '#', :conversations_list, :channels, '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/mixins.rb

@@ -1,5 +1,4 @@
 # 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/patches/{chat.6.block-kit-support.patch → chat.1.patch}

@@ -1,20 +1,22 @@
 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,10 +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 :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 +26,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 +46,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,9 +9,8 @@ module Slack
   module Web
     module Api
       module Endpoints
-        include Slack::Web::Api::Mixins::Channels
+        include Slack::Web::Api::Mixins::Conversations
         include Slack::Web::Api::Mixins::Users
-        include Slack::Web::Api::Mixins::Groups
 
 <% files.sort.each do |f| %>
         include <%= f.camelize %>

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/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/request.rb

@@ -22,15 +22,16 @@ module Slack
         private
 
         def request(method, path, options)
-          options = options.merge(token: token)
           response = connection.send(method) do |request|
             case method
             when :get, :delete
               request.url(path, options)
             when :post, :put
               request.path = path
+              options.compact!
               request.body = options unless options.empty?
             end
+            request.headers['Authorization'] = "Bearer #{token}" if token
             request.options.merge!(options.delete(:request)) if options.key?(:request)
           end
           response.body

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

@@ -6,7 +6,12 @@ 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(',')
@@ -15,6 +20,12 @@ module Slack
             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
     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

@@ -6,11 +6,7 @@ module Slack
         class Cursor
           include Enumerable
 
-          attr_reader :client
-          attr_reader :verb
-          attr_reader :sleep_interval
-          attr_reader :max_retries
-          attr_reader :params
+          attr_reader :client, :verb, :sleep_interval, :max_retries, :params
 
           def initialize(client, verb, params = {})
             @client = client
@@ -32,14 +28,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/slack-ruby-client.rb

@@ -15,12 +15,12 @@ require 'json'
 require 'logger'
 begin
   require 'picky'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # ignore, only used in users_search
 end
 begin
   require 'openssl'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # Used in slack/web/config
 end
 require_relative 'slack/web/config'
@@ -28,7 +28,9 @@ 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'
@@ -37,8 +39,6 @@ require_relative 'slack/web/pagination/cursor'
 require_relative 'slack/web/client'
 
 # RealTime API
-require 'active_support'
-require 'active_support/core_ext'
 require_relative 'slack/real_time/concurrency'
 require_relative 'slack/real_time/socket'
 require_relative 'slack/real_time/api/message_id'

data/lib/tasks/web.rake

@@ -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)
 

data/slack-ruby-client.gemspec

@@ -12,24 +12,23 @@ 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/slack-ruby/slack-ruby-client'
   s.licenses = ['MIT']
   s.summary = 'Slack Web and RealTime API client.'
-  s.add_dependency 'activesupport'
-  s.add_dependency 'faraday', '>= 0.9'
+  s.add_dependency 'faraday', '>= 1.0'
   s.add_dependency 'faraday_middleware'
   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.73.0'
-  s.add_development_dependency 'rubocop-performance', '~> 1.4.1'
-  s.add_development_dependency 'rubocop-rspec', '~> 1.34.0'
+  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'

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

@@ -5,47 +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:
-      - '*'
-      Retry-After:
-      - 3600
-      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:
@@ -55,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