Add support for Block Kit (#253)

Author: JrmKrb

CHANGELOG.md

@@ -6,6 +6,7 @@
 * [#242](https://github.com/slack-ruby/slack-ruby-client/pull/242): Added `apps_uninstall` to Web API - [@dblock](https://github.com/dblock).
 * [#244](https://github.com/slack-ruby/slack-ruby-client/pull/244): Implementing #restart for the celluloid socket class - [@RodneyU215](https://github.com/RodneyU215).
 * [#246](https://github.com/slack-ruby/slack-ruby-client/pull/246): Added TOC to README and danger-toc - [@dblock](https://github.com/dblock).
+* [#253](https://github.com/slack-ruby/slack-ruby-client/pull/253): Support for Block Kit - [@JrmKrb](https://github.com/JrmKrb).
 * Your contribution here.
 
 ### 0.13.1 (2018/9/30)

bin/commands/chat.rb

@@ -52,6 +52,7 @@
     c.flag 'user', desc: 'id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.'
     c.flag 'as_user', desc: '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.'
     c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
+    c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
     c.flag 'link_names', desc: 'Find and link channel names and usernames.'
     c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See below.'
     c.flag 'thread_ts', desc: "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead."
@@ -67,6 +68,7 @@
     c.flag 'text', desc: "Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation."
     c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.'
     c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
+    c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
     c.flag 'icon_emoji', desc: '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.'
     c.flag 'icon_url', desc: 'URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.'
     c.flag 'link_names', desc: 'Find and link channel names and usernames.'
@@ -104,6 +106,7 @@
     c.flag 'ts', desc: 'Timestamp of the message to be updated.'
     c.flag 'as_user', desc: 'Pass true to update the message as the authed user. Bot users in this context are considered authed users.'
     c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.'
+    c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
     c.flag 'link_names', desc: 'Find and link channel names and usernames. Defaults to none. See below.'
     c.flag 'parse', desc: 'Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.'
     c.action do |_global_options, options, _args|

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

@@ -85,6 +85,8 @@ def chat_meMessage(options = {})
           #   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
@@ -95,7 +97,7 @@ def chat_meMessage(options = {})
           # @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
@@ -104,6 +106,12 @@ def chat_postEphemeral(options = {})
               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
 
@@ -118,6 +126,8 @@ def chat_postEphemeral(options = {})
           #   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
@@ -142,13 +152,19 @@ def chat_postEphemeral(options = {})
           # @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
 
@@ -190,6 +206,8 @@ def chat_unfurl(options = {})
           #   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
@@ -198,7 +216,7 @@ def chat_unfurl(options = {})
           # @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
@@ -207,6 +225,12 @@ def chat_update(options = {})
               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

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