slack-ruby-block-kit 0.4.0

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

@@ -0,0 +1,81 @@
+# 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 is the simplest form of select menu, with a static list of options
+      # passed in when defining the element.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#static-select
+      class StaticSelect
+        TYPE = 'static_select'
+
+        attr_accessor :confirm, :options, :option_groups, :initial_option
+
+        def initialize(placeholder:, action_id:, emoji: nil)
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
+          @action_id = action_id
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          self
+        end
+
+        def option(value:, text:, emoji: nil)
+          @options ||= []
+          @options << Composition::Option.new(
+            value: value,
+            text: text,
+            emoji: emoji
+          )
+
+          self
+        end
+
+        def option_group(label:, emoji: nil)
+          option_group = Composition::OptionGroup.new(label: label, emoji: emoji)
+
+          yield(option_group) if block_given?
+
+          @option_groups ||= []
+          @option_groups << option_group
+
+          self
+        end
+
+        def initial(value:, text:, emoji: nil)
+          @initial_option = Composition::Option.new(
+            value: value,
+            text: text,
+            emoji: emoji
+          )
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            placeholder: @placeholder.as_json,
+            action_id: @action_id,
+            options: @options&.map(&:as_json),
+            option_groups: @option_groups&.map(&:as_json),
+            initial_option: @initial_option&.as_json,
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/element/users_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 Slack users
+      # visible to the current user in the active workspace.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#users-select
+      class UsersSelect
+        TYPE = 'users_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_user = 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_user: @initial_user,
+            confirm: @confirm&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/actions.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # A block that is used to hold interactive elements.
+      #
+      # https://api.slack.com/reference/messaging/blocks#actions
+      class Actions
+        TYPE = 'actions'
+
+        attr_accessor :elements
+
+        def initialize(block_id: nil)
+          @block_id = block_id
+          @elements = []
+
+          yield(self) if block_given?
+        end
+
+        def button(text:, action_id:, style: nil, emoji: nil, url: nil, value: nil)
+          element = Element::Button.new(
+            text: text,
+            action_id: action_id,
+            style: style,
+            emoji: emoji,
+            url: url,
+            value: value
+          )
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def channel_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::ChannelsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def converstation_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::ConversationsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def date_picker(action_id:, placeholder: nil, initial: nil, emoji: nil)
+          element = Element::DatePicker.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def external_select(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil)
+          element = Element::ExternalSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            min_query_length: min_query_length,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def overflow_menu(action_id:)
+          element = Element::OverflowMenu.new(action_id: action_id)
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def static_select(placeholder:, action_id:, emoji: nil)
+          element = Element::StaticSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def users_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::UsersSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            emoji: emoji,
+            initial: initial
+          )
+
+          yield(element) if block_given?
+
+          append(element)
+        end
+
+        def append(element)
+          @elements << element
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            elements: @elements.map(&:as_json),
+            block_id: @block_id
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/context.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # Displays message context, which can include both images and text.
+      #
+      # https://api.slack.com/reference/messaging/blocks#context
+      class Context
+        TYPE = 'context'
+
+        attr_accessor :elements
+        def initialize(block_id: nil)
+          @block_id = block_id
+          @elements = []
+
+          yield(self) if block_given?
+        end
+
+        def image(url:, alt_text:)
+          append(Element::Image.new(image_url: url, alt_text: alt_text))
+        end
+
+        def plain_text(text:, emoji: nil)
+          append(Composition::PlainText.new(text: text, emoji: emoji))
+        end
+
+        def mrkdwn(text:, verbatim: nil)
+          append(Composition::Mrkdwn.new(text: text, verbatim: verbatim))
+        end
+
+        def append(element)
+          @elements << element
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            elements: @elements.map(&:as_json),
+            block_id: @block_id
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/divider.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # A content divider, like an <hr>, to split up different blocks inside of
+      # a message.
+      #
+      # https://api.slack.com/reference/messaging/blocks#divider
+      class Divider
+        TYPE = 'divider'
+
+        def initialize(block_id: nil)
+          @block_id = block_id
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            block_id: @block_id
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # A simple image block, designed to make those cat photos really pop.
+      #
+      # https://api.slack.com/reference/messaging/blocks#context
+      class Image
+        TYPE = 'image'
+
+        def initialize(url:, alt_text:, title: nil, block_id: nil, emoji: nil)
+          @image_url = url
+          @alt_text = alt_text
+          @block_id = block_id
+
+          return unless title
+
+          @title = Composition::PlainText.new(
+            text: title,
+            emoji: emoji
+          )
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            image_url: @image_url,
+            alt_text: @alt_text,
+            title: @title&.as_json,
+            block_id: @block_id
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/layout/section.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # A section is one of the most flexible blocks available - it can be used
+      # as a simple text block, in combination with text fields, or side-by-side
+      # with any of the available block elements.
+      #
+      # https://api.slack.com/reference/messaging/blocks#section
+      class Section
+        TYPE = 'section'
+
+        attr_accessor :fields, :text, :accessory
+
+        def initialize(block_id: nil)
+          @block_id = block_id
+
+          yield(self) if block_given?
+        end
+
+        def plaintext_field(text:, emoji: nil)
+          @fields ||= []
+
+          @fields << Composition::PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def mrkdwn_field(text:, verbatim: nil)
+          @fields ||= []
+
+          @fields << Composition::Mrkdwn.new(text: text, verbatim: verbatim)
+
+          self
+        end
+
+        def plain_text(text:, emoji: nil)
+          @text = Composition::PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def mrkdwn(text:, verbatim: nil)
+          @text = Composition::Mrkdwn.new(text: text, verbatim: verbatim)
+
+          self
+        end
+
+        def button(text:, action_id:, style: nil, emoji: nil, url: nil, value: nil)
+          element = Element::Button.new(
+            text: text,
+            action_id: action_id,
+            style: style,
+            emoji: emoji,
+            url: url,
+            value: value
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def channel_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::ChannelsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def conversation_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::ConversationsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def date_picker(action_id:, placeholder: nil, initial: nil, emoji: nil)
+          element = Element::DatePicker.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def external_select(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil)
+          element = Element::ExternalSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            min_query_length: min_query_length,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def overflow_menu(action_id:)
+          element = Element::OverflowMenu.new(action_id: action_id)
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def static_select(placeholder:, action_id:, emoji: nil)
+          element = Element::StaticSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def users_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::UsersSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            emoji: emoji,
+            initial: initial
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def image(url:, alt_text:)
+          accessorize(Element::Image.new(image_url: url, alt_text: alt_text))
+        end
+
+        def accessorise(element)
+          @accessory = element
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            text: @text.as_json,
+            block_id: @block_id,
+            fields: @fields&.map(&:as_json),
+            accessory: @accessory&.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end