slack-ruby-block-kit 0.4.0

data/lib/slack/block_kit/composition/mrkdwn.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Composition
+      # An object containing some text, formatted using Slack's "mrkdwn".
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#text
+      # https://api.slack.com/messaging/composing/formatting
+      class Mrkdwn
+        TYPE = 'mrkdwn'
+
+        def initialize(text:, verbatim: nil)
+          @text = text
+          @verbatim = verbatim
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            text: @text,
+            verbatim: @verbatim
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/composition/option.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Composition
+      # An object that represents a single selectable item in a select menu.
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#option
+      # https://api.slack.com/reference/messaging/block-elements#select
+      class Option
+        def initialize(value:, text:, emoji: nil)
+          @text = PlainText.new(text: text, emoji: emoji)
+          @value = value
+        end
+
+        def as_json(*)
+          {
+            text: @text.as_json,
+            value: @value
+          }
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/composition/option_group.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Composition
+      # Provides a way to group options in a select menu.
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#option-group
+      # https://api.slack.com/reference/messaging/block-elements#select
+      class OptionGroup
+        attr_accessor :options
+
+        def initialize(label:, emoji: nil)
+          @label = PlainText.new(text: label, emoji: emoji)
+          @options = []
+
+          yield(self) if block_given?
+        end
+
+        def option(text:, value:, emoji: nil)
+          @options << Option.new(text: text, value: value, emoji: emoji)
+
+          self
+        end
+
+        def as_json(*)
+          {
+            label: @label.as_json,
+            options: @options.map(&:as_json)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/composition/plain_text.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Composition
+      # An object containing some text, formatted using plain text.
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#text
+      class PlainText
+        TYPE = 'plain_text'
+
+        def initialize(text:, emoji: nil)
+          @text = text
+          @emoji = emoji
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            text: @text,
+            emoji: @emoji
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/button.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # An interactive element that inserts a button.
+      # The button can be a trigger for anything from opening a simple link
+      # to starting a complex workflow.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#button
+      class Button
+        TYPE = 'button'
+
+        attr_accessor :confirm
+
+        def initialize(text:, action_id:, style: nil, emoji: nil, url: nil, value: nil)
+          @text = Composition::PlainText.new(text: text, emoji: emoji)
+          @action_id = action_id
+          @url = url
+          @style = style
+          @value = value
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          @confirm
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            text: @text.as_json,
+            action_id: @action_id,
+            url: @url,
+            value: @value,
+            style: @style,
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/channels_select.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This select menu will populate its options with a list of public
+      # channels visible to the current user in the active workspace.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#channel-select
+      class ChannelsSelect
+        TYPE = 'channels_select'
+
+        attr_accessor :confirm
+
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_channel = initial
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_channel: @initial_channel,
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/conversations_select.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This select menu will populate its options with a list of public and
+      # private channels, DMs, and MPIMs visible to the current user in the
+      # active workspace.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#conversation-select
+      class ConversationsSelect
+        TYPE = 'conversations_select'
+
+        attr_accessor :confirm
+
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_conversation = initial
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_conversation: @initial_conversation,
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/date_picker.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # An element which lets users easily select a date from a calendar style
+      # UI.
+      #
+      # Date picker elements can be used inside of section and actions blocks.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#datepicker
+      class DatePicker
+        TYPE = 'datepicker'
+
+        def initialize(action_id:, placeholder: nil, initial: nil, emoji: nil)
+          @action_id = action_id
+          @initial_date = initial
+          if placeholder
+            @placeholder = Composition::PlainText.new(
+              text: placeholder,
+              emoji: emoji
+            )
+          end
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            action_id: @action_id,
+            placeholder: @placeholder&.as_json,
+            initial_date: @initial_date,
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/external_select.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A select menu, just as with a standard HTML <select> tag, creates a drop
+      # down menu with a list of options for a user to choose. The select menu
+      # also includes type-ahead functionality, where a user can type a part or
+      # all of an option string to filter the list.
+      #
+      # This select menu will load its options from an external data source,
+      # allowing for a dynamic list of options.
+      #
+      # Each time a select menu of this type is opened or the user starts typing
+      # in the typeahead field, we'll send a request to your specified URL. Your
+      # app should return an HTTP 200 OK response, along with an
+      # application/json post body with an object containing either an options
+      # array, or an option_groups array.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#external-select
+      class ExternalSelect
+        TYPE = 'external_select'
+
+        attr_accessor :confirm
+
+        def initialize(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+          @initial_option = initial
+          @min_query_length = min_query_length
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            initial_option: @initial_option&.as_json,
+            min_query_length: min_query_length,
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/image.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # An element to insert an image - this element can be used in section and
+      # context blocks only. If you want a block with only an image in it,
+      # you're looking for the image block. (Slack::BlockKit::Layout::Image)
+      #
+      # https://api.slack.com/reference/messaging/block-elements#image
+      class Image
+        TYPE = 'image'
+
+        def initialize(image_url:, alt_text:)
+          @image_url = image_url
+          @alt_text = alt_text
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            image_url: @image_url,
+            alt_text: @alt_text
+          }
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/overflow_menu.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # This is like a cross between a button and a select menu - when a user
+      # clicks on this overflow button, they will be presented with a list of
+      # options to choose from. Unlike the select menu, there is no typeahead
+      # field, and the button always appears with an ellipsis ("…") rather than
+      # customisable text.
+      #
+      # As such, it is usually used if you want a more compact layout than a
+      # select menu, or to supply a list of less visually important actions
+      # after a row of buttons.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#overflow
+      class OverflowMenu
+        TYPE = 'overflow'
+
+        attr_accessor :options, :confirm
+
+        def initialize(action_id:)
+          @action_id = action_id
+          @options = []
+
+          yield(self) if block_given?
+        end
+
+        def option(value:, text:, emoji: nil)
+          @options << Composition::Option.new(
+            value: value,
+            text: text,
+            emoji: emoji
+          )
+
+          self
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            action_id: @action_id,
+            options: @options.map(&:as_json),
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end