slack-ruby-client 0.14.2 → 0.15.0

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,12 +6,13 @@ 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)
@@ -19,7 +21,8 @@ namespace :slack do
           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'
 
@@ -37,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
@@ -58,11 +62,27 @@ namespace :slack do
           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

data/slack-ruby-client.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'slack/version'
 
@@ -16,17 +17,19 @@ Gem::Specification.new do |s|
   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 'rspec'
-  s.add_development_dependency 'rubocop', '0.61.1'
+  s.add_development_dependency 'rubocop', '~> 0.82.0'
+  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/channels_info.yml

@@ -2,45 +2,138 @@
 http_interactions:
 - request:
     method: post
-    uri: https://slack.com/api/channels.list
+    uri: https://slack.com/api/conversations.list
     body:
       encoding: UTF-8
       string: token=token
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Client/0.15.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: 200
       message: OK
     headers:
+      Date:
+      - Mon, 06 Jul 2020 14:21:41 GMT
+      Server:
+      - Apache
+      X-Slack-Req-Id:
+      - d6a36df98a9b67696d158d792698542b
+      X-Oauth-Scopes:
+      - channels:read
+      X-Accepted-Oauth-Scopes:
+      - channels:read,groups:read,mpim:read,im:read,read
+      Access-Control-Expose-Headers:
+      - x-slack-req-id, retry-after
+      X-Slack-Backend:
+      - r
+      X-Content-Type-Options:
+      - nosniff
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      X-Xss-Protection:
+      - '0'
+      Vary:
+      - Accept-Encoding
+      Pragma:
+      - no-cache
+      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
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Referrer-Policy:
+      - no-referrer
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Length:
+      - '616'
       Content-Type:
       - application/json; charset=utf-8
+      X-Via:
+      - haproxy-www-xvqc,haproxy-edge-sin-605a
     body:
-      encoding: UTF-8
-      string: '{"ok":true,"channels":[{"id":"C04KB5X4D","name":"general","is_channel":true,"created":1430222230,"creator":"U04KB5WQR","is_archived":false,"is_general":true,"is_member":true,"last_read":"1435863302.000026","latest":{"type":"message","user":"U0HPMN0GY","text":"```\n{\"ok\":true,\"args\":{\"token\":\"xoxb-17803748576-H794PZkqOo4DkjYddb438F2J\"}}```","ts":"1452025068.000045"},"unread_count":321,"unread_count_display":283,"members":["U04JPQ0JS","U04JZBDQQ","U04KB5WQR"],"topic":{"value":"","creator":"","last_set":0},"purpose":{"value":"This
-        channel is for team-wide communication and announcements. All team members
-        are in this channel.","creator":"","last_set":0}}]}'
-    http_version:
-  recorded_at: Fri, 22 Jan 2016 19:01:46 GMT
+      encoding: ASCII-8BIT
+      string: '{"ok":true,"channels":[{"id":"C016K3T7XK7","name":"random","is_channel":true,"is_group":false,"is_im":false,"created":1594044322,"is_archived":false,"is_general":false,"unlinked":0,"name_normalized":"random","is_shared":false,"parent_conversation":null,"creator":"U016LEXAH5Y","is_ext_shared":false,"is_org_shared":false,"shared_team_ids":["T016DNSRF7G"],"pending_shared":[],"pending_connected_team_ids":[],"is_pending_ext_shared":false,"is_member":false,"is_private":false,"is_mpim":false,"topic":{"value":"Non-work
+        banter and water cooler conversation","creator":"U016LEXAH5Y","last_set":1594044322},"purpose":{"value":"A
+        place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber
+        you''d prefer to keep out of more focused work-related channels.","creator":"U016LEXAH5Y","last_set":1594044322},"previous_names":[],"num_members":1},{"id":"C016Z3VRSSV","name":"general","is_channel":true,"is_group":false,"is_im":false,"created":1594044322,"is_archived":false,"is_general":true,"unlinked":0,"name_normalized":"general","is_shared":false,"parent_conversation":null,"creator":"U016LEXAH5Y","is_ext_shared":false,"is_org_shared":false,"shared_team_ids":["T016DNSRF7G"],"pending_shared":[],"pending_connected_team_ids":[],"is_pending_ext_shared":false,"is_member":false,"is_private":false,"is_mpim":false,"topic":{"value":"Company-wide
+        announcements and work-based matters","creator":"U016LEXAH5Y","last_set":1594044322},"purpose":{"value":"This
+        channel is for workspace-wide communication and announcements. All members
+        are in this channel.","creator":"U016LEXAH5Y","last_set":1594044322},"previous_names":[],"num_members":1},{"id":"C017AA3CCDN","name":"slack-ruby-client","is_channel":true,"is_group":false,"is_im":false,"created":1594044322,"is_archived":false,"is_general":false,"unlinked":0,"name_normalized":"slack-ruby-client","is_shared":false,"parent_conversation":null,"creator":"U016LEXAH5Y","is_ext_shared":false,"is_org_shared":false,"shared_team_ids":["T016DNSRF7G"],"pending_shared":[],"pending_connected_team_ids":[],"is_pending_ext_shared":false,"is_member":false,"is_private":false,"is_mpim":false,"topic":{"value":"","creator":"","last_set":0},"purpose":{"value":"","creator":"","last_set":0},"previous_names":[],"num_members":1}],"response_metadata":{"next_cursor":""}}'
+  recorded_at: Mon, 06 Jul 2020 14:21:41 GMT
 - request:
     method: post
     uri: https://slack.com/api/channels.info
     body:
       encoding: UTF-8
-      string: channel=C04KB5X4D&token=token
+      string: channel=C016Z3VRSSV&token=token
     headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Client/0.15.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: 200
       message: OK
     headers:
+      Date:
+      - Mon, 06 Jul 2020 14:21:42 GMT
+      Server:
+      - Apache
+      X-Content-Type-Options:
+      - nosniff
+      X-Slack-Req-Id:
+      - b7ad44601d7e0a60c5c68601e15c89c8
+      X-Oauth-Scopes:
+      - channels:read
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      X-Xss-Protection:
+      - '0'
+      Vary:
+      - Accept-Encoding
+      Pragma:
+      - no-cache
+      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
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Referrer-Policy:
+      - no-referrer
+      X-Slack-Backend:
+      - r
+      Access-Control-Expose-Headers:
+      - x-slack-req-id, retry-after
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Length:
+      - '222'
       Content-Type:
       - application/json; charset=utf-8
+      X-Via:
+      - haproxy-www-nu22,haproxy-edge-sin-p1t0
     body:
-      encoding: UTF-8
-      string: '{"ok":true,"channel":{"id":"C04KB5X4D","name":"general","is_channel":true,"created":1430222230,"creator":"U04KB5WQR","is_archived":false,"is_general":true,"is_member":true,"last_read":"1435863302.000026","latest":{"type":"message","user":"U0HPMN0GY","text":"```\n{\"ok\":true,\"args\":{\"token\":\"xoxb-17803748576-H794PZkqOo4DkjYddb438F2J\"}}```","ts":"1452025068.000045"},"unread_count":321,"unread_count_display":283,"members":["U04JPQ0JS","U04JZBDQQ","U04KB5WQR","U06JGTU5V","U07518DTL","U07KECJ77","U092BDCLV","U092V4E9L","U0EA7TZJN","U0H701CJZ","U0HLFUZLJ","U0HPMN0GY"],"topic":{"value":"","creator":"","last_set":0},"purpose":{"value":"This
-        channel is for team-wide communication and announcements. All team members
-        are in this channel.","creator":"","last_set":0}}}'
-    http_version:
-  recorded_at: Fri, 22 Jan 2016 19:01:46 GMT
-recorded_with: VCR 3.0.1
+      encoding: ASCII-8BIT
+      string: '{"ok":false,"error":"method_deprecated","response_metadata":{"messages":["[ERROR]
+        This method is retired and can no longer be used. Please use conversations.info
+        instead. Learn more: https:\/\/api.slack.com\/changelog\/2020-01-deprecating-antecedents-to-the-conversations-api."]}}'
+  recorded_at: Mon, 06 Jul 2020 14:21:42 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/slack/web/views_open_error.yml

@@ -0,0 +1,76 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://slack.com/api/views.open
+    body:
+      encoding: UTF-8
+      string: token=token&trigger_id=trigger_id&view=%7B%7D
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Client/0.14.6
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '154'
+      Connection:
+      - keep-alive
+      Date:
+      - Wed, 19 Feb 2020 17:52:59 GMT
+      Server:
+      - Apache
+      X-Content-Type-Options:
+      - nosniff
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      X-Xss-Protection:
+      - '0'
+      Vary:
+      - Accept-Encoding
+      Pragma:
+      - no-cache
+      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
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Referrer-Policy:
+      - no-referrer
+      X-Slack-Backend:
+      - h
+      Access-Control-Expose-Headers:
+      - x-slack-req-id, retry-after
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Via:
+      - haproxy-www-ixj4
+      X-Cache:
+      - Miss from cloudfront
+      Via:
+      - 1.1 b6cc1359c0cd55a8339441d8abb6a450.cloudfront.net (CloudFront)
+      X-Amz-Cf-Pop:
+      - JFK51-C1
+      X-Amz-Cf-Id:
+      - fWF96IvY1omctxPC6XwjvZ2TIfpmVLlsT35MsfAWqK7zDChMCpE_oQ==
+    body:
+      encoding: ASCII-8BIT
+      string: '{"ok":false,"error":"invalid_arguments","response_metadata":{"messages":["[ERROR]
+        missing required field: title [json-pointer:\/view]","[ERROR] missing required
+        field: blocks [json-pointer:\/view]","[ERROR] missing required field: type
+        [json-pointer:\/view]"]}}'
+    http_version: null
+  recorded_at: Wed, 19 Feb 2020 17:52:59 GMT
+recorded_with: VCR 5.1.0

data/spec/integration/integration_spec.rb

@@ -1,17 +1,22 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCURRENCY']) && 'missing SLACK_API_TOKEN and/or CONCURRENCY' do
+RSpec.describe 'integration test', skip: ( # rubocop:disable RSpec/DescribeClass
+  (!ENV['SLACK_API_TOKEN'] || !ENV['CONCURRENCY']) && 'missing SLACK_API_TOKEN and/or CONCURRENCY'
+) do
   around do |ex|
     WebMock.allow_net_connect!
     VCR.turned_off { ex.run }
     WebMock.disable_net_connect!
   end
 
+  let(:client) { Slack::RealTime::Client.new(token: ENV['SLACK_API_TOKEN']) }
   let(:logger) do
     logger = Logger.new(STDOUT)
     logger.level = Logger::INFO
     logger
   end
+  let!(:queue) { @queue = QueueWithTimeout.new }
 
   before do
     Thread.abort_on_exception = true
@@ -19,19 +24,12 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     Slack.configure do |slack|
       slack.logger = logger
     end
-  end
-
-  after do
-    Slack.config.reset
-  end
 
-  let(:client) { Slack::RealTime::Client.new(token: ENV['SLACK_API_TOKEN']) }
-
-  let!(:queue) { @queue = QueueWithTimeout.new }
-
-  before do
     client.on :hello do
-      logger.info "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+      logger.info(
+        "Successfully connected, welcome '#{client.self.name}' to " \
+        "the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+      )
     end
 
     client.on :message do |event|
@@ -45,6 +43,12 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     end
   end
 
+  after do
+    Slack.config.reset
+    wait_for_server # wait for :closed to be pushed on queue
+    @server.join if @server.is_a?(::Thread)
+  end
+
   def start_server
     dt = rand(10..20)
     logger.debug "#start_server, waiting #{dt} second(s)"
@@ -73,11 +77,6 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     @queue = nil
   end
 
-  after do
-    wait_for_server # wait for :closed to be pushed on queue
-    @server.join if @server.is_a?(::Thread)
-  end
-
   context 'client connected' do
     let(:channel) { "@#{client.self.id}" }
     let(:message) { SecureRandom.hex }
@@ -123,7 +122,7 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
   context 'with websocket_ping set' do
     before do
-      client.websocket_ping = 1
+      client.websocket_ping = 5
     end
 
     it 'sends pings' do
@@ -136,18 +135,20 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
       start_server
 
-      queue.pop_with_timeout(5)
-      expect(@reply_to).to be 1
+      queue.pop_with_timeout(10)
+      expect(@reply_to).to eq 1
     end
 
     it 'rebuilds the websocket connection when dropped' do
       @reply_to = nil
       client.on :pong do |data|
+        logger.info data
         @reply_to = data.reply_to
         if @reply_to == 1
           client.instance_variable_get(:@socket).close
+          queue.push :close
         else
-          expect(@reply_to).to be 2
+          expect(@reply_to).to eq 2
           queue.push :pong
           client.stop!
         end
@@ -155,8 +156,10 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
       start_server
 
-      queue.pop_with_timeout(10)
-      queue.pop_with_timeout(10)
+      4.times do |i|
+        queue.pop_with_timeout(10)
+        client.logger.info "Pop #{i}"
+      end
     end
   end