slack-ruby-client 0.13.1 → 0.14.0

data/lib/slack/web/api/endpoints/chat.rb

@@ -82,18 +82,22 @@ module Slack
           # @option options [user] :user
           #   id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
           # @option options [Object] :as_user
-          #   Pass true to post the message as the authed bot. Defaults to false.
+          #   Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
           # @option options [Object] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
+          # @option options [Object] :blocks
+          #   A JSON-based array of structured blocks, presented as a URL-encoded string.
           # @option options [Object] :link_names
           #   Find and link channel names and usernames.
           # @option options [Object] :parse
           #   Change how messages are treated. Defaults to none. See below.
+          # @option options [Object] :thread_ts
+          #   Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
           # @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, :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
@@ -102,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
 
@@ -116,6 +126,8 @@ module Slack
           #   Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
           # @option options [Object] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
+          # @option options [Object] :blocks
+          #   A JSON-based array of structured blocks, presented as a URL-encoded string.
           # @option options [Object] :icon_emoji
           #   Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
           # @option options [Object] :icon_url
@@ -140,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
 
@@ -188,6 +206,8 @@ module Slack
           #   Pass true to update the message as the authed user. Bot users in this context are considered authed users.
           # @option options [Object] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.
+          # @option options [Object] :blocks
+          #   A JSON-based array of structured blocks, presented as a URL-encoded string.
           # @option options [Object] :link_names
           #   Find and link channel names and usernames. Defaults to none. See below.
           # @option options [Object] :parse
@@ -196,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
@@ -205,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/endpoints/conversations.rb

@@ -83,6 +83,8 @@ module Slack
           #   Conversation ID to learn more about.
           # @option options [Object] :include_locale
           #   Set this to true to receive the locale for this conversation. Defaults to false.
+          # @option options [Object] :include_num_members
+          #   Set to true to include the member count for the specified conversation. Defaults to false.
           # @see https://api.slack.com/methods/conversations.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.info.json
           def conversations_info(options = {})

data/lib/slack/web/api/endpoints/files.rb

@@ -67,17 +67,16 @@ module Slack
           #   Filter files created before this timestamp (inclusive).
           # @option options [Object] :types
           #   Filter files by type:
+          #   * `all` - All files
+          #   * `spaces` - Posts
+          #   * `snippets` - Snippets
+          #   * `images` - Image files
+          #   * `gdocs` - Google docs
+          #   * `zips` - Zip files
+          #   * `pdfs` - PDF files
           #
-          #   all - All files
-          #   spaces - Posts
-          #   snippets - Snippets
-          #   images - Image files
-          #   gdocs - Google docs
-          #   zips - Zip files
-          #   pdfs - PDF files
+          #   You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list.
           #
-          #
-          #   You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.
           #   .
           # @option options [user] :user
           #   Filter files created by a single user.

data/lib/slack/web/api/endpoints/reactions.rb

@@ -13,9 +13,9 @@ module Slack
           # @option options [channel] :channel
           #   Channel where the message to add reaction to was posted.
           # @option options [file] :file
-          #   File to add reaction to.
+          #   File to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead.
           # @option options [Object] :file_comment
-          #   File comment to add reaction to.
+          #   File comment to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead.
           # @option options [Object] :timestamp
           #   Timestamp of the message to add reaction to.
           # @see https://api.slack.com/methods/reactions.add

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/pagination/cursor.rb

@@ -28,6 +28,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 +36,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/tasks/real_time.rake

@@ -15,12 +15,14 @@ namespace :slack do
           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'))
         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)

data/lib/tasks/web.rake

@@ -53,6 +53,7 @@ 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

data/slack-ruby-client.gemspec

@@ -1,4 +1,4 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'slack/version'
 
 Gem::Specification.new do |s|
@@ -26,7 +26,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'json-schema'
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '0.58.2'
+  s.add_development_dependency 'rubocop', '0.61.1'
+  s.add_development_dependency 'timecop'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
 end

data/spec/integration/integration_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
   let(:logger) do
     logger = Logger.new(STDOUT)
-    logger.level = Logger::DEBUG
+    logger.level = Logger::INFO
     logger
   end
 
@@ -19,16 +19,18 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     Slack.configure do |slack|
       slack.logger = logger
     end
+
+    @queue = QueueWithTimeout.new
   end
 
   after do
     Slack.config.reset
   end
 
-  let(:queue) { QueueWithTimeout.new }
-
   let(:client) { Slack::RealTime::Client.new(token: ENV['SLACK_API_TOKEN']) }
 
+  let(:queue) { @queue }
+
   def start
     # starts the client and pushes an item on a queue when connected
     client.start_async do |driver|
@@ -45,13 +47,14 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     end
 
     client.on :close do
+      logger.info 'Disconnecting ...'
       # pushes another item to the queue when disconnected
-      queue.push nil
+      queue.push nil if @queue
     end
   end
 
   def start_server
-    dt = rand(5) + 2
+    dt = rand(2..6)
     logger.debug "#start_server, waiting #{dt} second(s)"
     sleep dt # prevent Slack 429 rate limit errors
     # start server and wait for on :open
@@ -61,9 +64,12 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
   end
 
   def wait_for_server
+    return unless @queue
+
     logger.debug '#wait_for_server'
     queue.pop_with_timeout(5)
     logger.debug '#wait_for_server, joined'
+    @queue = nil
   end
 
   def stop_server
@@ -82,7 +88,7 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
       start_server
     end
 
-    let(:channel) { "@#{client.self.name}" }
+    let(:channel) { "@#{client.self.id}" }
 
     it 'responds to message' do
       message = SecureRandom.hex
@@ -91,6 +97,7 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
         logger.debug data
         # concurrent execution of tests causes messages to arrive in any order
         next unless data.text == message
+
         expect(data.text).to eq message
         expect(data.subtype).to eq 'bot_message'
         logger.debug 'client.stop!'
@@ -118,6 +125,57 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     start_server
   end
 
+  context 'with websocket_ping set' do
+    before do
+      client.websocket_ping = 2
+    end
+    it 'sends pings' do
+      @reply_to = nil
+      client.on :pong do |data|
+        @reply_to = data.reply_to
+        queue.push nil
+        client.stop!
+      end
+      start_server
+      queue.pop_with_timeout(5)
+      expect(@reply_to).to be 1
+    end
+    it 'rebuilds the websocket connection when dropped' do
+      @reply_to = nil
+      client.on :pong do |data|
+        @reply_to = data.reply_to
+        if @reply_to == 1
+          client.instance_variable_get(:@socket).close
+        else
+          expect(@reply_to).to be 2
+          queue.push nil
+          client.stop!
+        end
+      end
+      start_server
+      queue.pop_with_timeout(10)
+      queue.pop_with_timeout(10)
+    end
+  end
+
+  context 'with websocket_ping not set' do
+    before do
+      client.websocket_ping = 0
+    end
+    it 'does not send pings' do
+      @reply_to = nil
+      client.on :pong do |data|
+        @reply_to = data.reply_to
+      end
+      client.on :hello do
+        client.stop!
+      end
+      start_server
+      wait_for_server
+      expect(@reply_to).to be nil
+    end
+  end
+
   it 'gets close, followed by closed' do
     client.on :hello do
       expect(client.started?).to be true

data/spec/slack/events/config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe Slack::Events::Config do
+  before do
+    ENV['SLACK_SIGNING_SECRET'] = 'secret'
+    Slack::Events::Config.reset
+  end
+  it 'defaults signing secret to ENV[SLACK_SIGNING_SECRET]' do
+    expect(Slack::Events.config.signing_secret).to eq 'secret'
+  end
+  it 'defaults signature expiration to 5 minutes' do
+    expect(Slack::Events.config.signature_expires_in).to eq 5 * 60
+  end
+  context 'configured' do
+    before do
+      Slack::Events.configure do |config|
+        config.signing_secret = 'custom'
+        config.signature_expires_in = 45
+      end
+    end
+    it 'uses the configured values' do
+      expect(Slack::Events.config.signing_secret).to eq 'custom'
+      expect(Slack::Events.config.signature_expires_in).to eq 45
+    end
+  end
+  after do
+    ENV.delete 'SLACK_SIGNING_SECRET'
+  end
+end

data/spec/slack/events/request_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+RSpec.describe Slack::Events::Request do
+  before do
+    Slack::Events.configure do |config|
+      config.signing_secret = 'ade6ca762ade4db0e7d31484cd616b9c'
+      config.signature_expires_in = 30
+    end
+  end
+  let(:signature) { 'v0=91177eea054d65de0fc0f9b4ec57714307bc0ce2c5f3bf0d28b1b720c8f92ba2' }
+  let(:timestamp) { '1547933148' }
+  let(:body) { '{"token":"X34FAqCu8tmGEkEEpoDncnja","challenge":"P7sFXA4o3HV2hTx4zb4zcQ9yrvuQs8pDh6EacOxmMRj0tJaXfQFF","type":"url_verification"}' }
+  let(:http_request) do
+    double(
+      headers: {
+        'X-Slack-Request-Timestamp' => timestamp,
+        'X-Slack-Signature' => signature
+      },
+      body: double(
+        read: body
+      )
+    )
+  end
+  subject do
+    Slack::Events::Request.new(http_request)
+  end
+  it 'reads http request' do
+    expect(subject.signature).to eq signature
+    expect(subject.body).to eq body
+    expect(subject.timestamp).to eq timestamp
+    expect(subject.version).to eq 'v0'
+  end
+  context 'time' do
+    after do
+      Timecop.return
+    end
+    context 'with an invalid signature' do
+      let(:signature) { 'v0=invalid' }
+      before do
+        Timecop.freeze(Time.at(timestamp.to_i))
+      end
+      it 'is invalid but not expired' do
+        expect(subject).to_not be_valid
+        expect(subject).to_not be_expired
+      end
+    end
+    context 'with an invalid body' do
+      let(:body) { 'invalid' }
+      before do
+        Timecop.freeze(Time.at(timestamp.to_i))
+      end
+      it 'is invalid but not expired' do
+        expect(subject).to_not be_valid
+        expect(subject).to_not be_expired
+      end
+    end
+    context 'with an invalid signing secret' do
+      before do
+        Slack::Events.configure do |config|
+          config.signing_secret = 'invalid'
+        end
+        Timecop.freeze(Time.at(timestamp.to_i))
+      end
+      it 'is invalid but not expired' do
+        expect(subject).to_not be_valid
+        expect(subject).to_not be_expired
+      end
+    end
+    context 'within time window' do
+      before do
+        Timecop.freeze(Time.at(timestamp.to_i) + Slack::Events.config.signature_expires_in - 1)
+      end
+      it 'is valid' do
+        expect(subject).to be_valid
+        expect(subject).to_not be_expired
+      end
+      it 'does not raise an error and returns true' do
+        expect(subject.verify!).to be true
+      end
+    end
+    context 'after time window' do
+      before do
+        Timecop.freeze(Time.at(timestamp.to_i) + Slack::Events.config.signature_expires_in + 1)
+      end
+      it 'is valid but expired' do
+        expect(subject).to be_valid
+        expect(subject).to be_expired
+      end
+      it 'raises an error on verify!' do
+        expect { subject.verify! }.to raise_error Slack::Events::Request::TimestampExpired
+      end
+    end
+    context 'before time but within window' do
+      before do
+        Timecop.freeze(Time.at(timestamp.to_i) - Slack::Events.config.signature_expires_in + 1)
+      end
+      it 'is valid and not expired' do
+        expect(subject).to be_valid
+        expect(subject).to_not be_expired
+      end
+      it 'does not raise an error on verify!' do
+        expect(subject.verify!).to be true
+      end
+    end
+    context 'before time window' do
+      before do
+        Timecop.freeze(Time.at(timestamp.to_i) - Slack::Events.config.signature_expires_in - 1)
+      end
+      it 'is valid but expired' do
+        expect(subject).to be_valid
+        expect(subject).to be_expired
+      end
+      it 'raises an error on verify!' do
+        expect { subject.verify! }.to raise_error Slack::Events::Request::TimestampExpired
+      end
+    end
+  end
+  after do
+    Slack::Events.config.reset
+  end
+end