slack-ruby-block-kit 0.7.0 → 0.12.0

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

@@ -15,14 +15,15 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#overflow
       class OverflowMenu
+        include Composition::ConfirmationDialog::Confirmable
+
         TYPE = 'overflow'
 
-        attr_accessor :options, :confirm
+        attr_accessor :options
 
         def initialize(action_id:)
           @action_id = action_id
           @options = []
-          @confirm = nil
 
           yield(self) if block_given?
         end
@@ -38,20 +39,12 @@ module Slack
           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
+            confirm: confirm&.as_json
           }.compact
         end
       end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A radio button group that allows a user to choose one item from a list of possible options.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#radio
+      class RadioButtons
+        include Composition::ConfirmationDialog::Confirmable
+
+        TYPE = 'radio_buttons'
+
+        attr_accessor :options
+
+        def initialize(action_id:)
+          @action_id = action_id
+          @options = []
+
+          yield(self) if block_given?
+        end
+
+        def option(value:, text:, initial: false)
+          option = Composition::Option.new(
+            value: value,
+            text: text,
+            initial: initial
+          )
+
+          @options << option
+
+          self
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            action_id: @action_id,
+            options: @options.map(&:as_json),
+            initial_option: initial_option&.as_json,
+            confirm: confirm&.as_json
+          }.compact
+        end
+
+        private
+
+        def initial_option
+          @options&.find(&:initial?)
+        end
+      end
+    end
+  end
+end

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

@@ -13,9 +13,11 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#static-select
       class StaticSelect
+        include Composition::ConfirmationDialog::Confirmable
+
         TYPE = 'static_select'
 
-        attr_accessor :confirm, :options, :option_groups, :initial_option
+        attr_accessor :options, :option_groups
 
         def initialize(placeholder:, action_id:, emoji: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
@@ -24,20 +26,13 @@ module Slack
           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)
+        def option(value:, text:, initial: false, emoji: nil)
           @options ||= []
           @options << Composition::Option.new(
             value: value,
             text: text,
-            emoji: emoji
+            emoji: emoji,
+            initial: initial
           )
 
           self
@@ -54,27 +49,27 @@ module Slack
           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
+            options: options&.map(&:as_json),
+            option_groups: option_groups&.map(&:as_json),
+            initial_option: initial_option&.as_json,
+            confirm: confirm&.as_json
           }.compact
         end
+
+        private
+
+        def initial_option
+          opts = options || option_groups&.flat_map(&:options)
+
+          return unless opts
+
+          opts.find(&:initial?)
+        end
       end
     end
   end

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

@@ -13,9 +13,9 @@ module Slack
       #
       # https://api.slack.com/reference/messaging/block-elements#users-select
       class UsersSelect
-        TYPE = 'users_select'
+        include Composition::ConfirmationDialog::Confirmable
 
-        attr_accessor :confirm
+        TYPE = 'users_select'
 
         def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
@@ -25,21 +25,13 @@ module Slack
           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
+            confirm: confirm&.as_json
           }.compact
         end
       end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # A header is a plain-text block that displays in a larger, bold font.
+      # Use it to delineate between different groups of content in your app's
+      # surfaces.
+      #
+      # https://api.slack.com/reference/block-kit/blocks#header
+      class Header
+        TYPE = 'header'
+
+        def initialize(text:, block_id: nil, emoji: nil)
+          @text = Composition::PlainText.new(text: text, emoji: emoji)
+          @block_id = block_id
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            text: @text.as_json,
+            block_id: @block_id
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -13,10 +13,7 @@ module Slack
           @image_url = url
           @alt_text = alt_text
           @block_id = block_id
-
-          return unless title
-
-          @title = Composition::PlainText.new(
+          @title = title && Composition::PlainText.new(
             text: title,
             emoji: emoji
           )

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

@@ -156,8 +156,28 @@ module Slack
           accessorise(element)
         end
 
+        def checkboxes(action_id:)
+          element = Element::Checkboxes.new(
+            action_id: action_id
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def radio_buttons(action_id:)
+          element = Element::RadioButtons.new(
+            action_id: action_id
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
         def image(url:, alt_text:)
-          accessorize(Element::Image.new(image_url: url, alt_text: alt_text))
+          accessorise(Element::Image.new(image_url: url, alt_text: alt_text))
         end
 
         def accessorise(element)

data/lib/slack/block_kit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    VERSION = '0.12.0'
+  end
+end

data/lib/slack/surfaces/home.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Slack
+  module Surfaces
+    # The Home tab is a persistent, yet dynamic interface
+    # for apps that lives within the App Home.
+    #
+    # https://api.slack.com/surfaces#tabs
+    # https://api.slack.com/reference/surfaces/views
+    class Home
+      TYPE = 'home'
+
+      def initialize(blocks: nil,
+                     private_metadata: nil, callback_id: nil, external_id: nil)
+        @blocks = blocks || Slack::BlockKit::Blocks.new
+
+        @private_metadata = private_metadata
+        @callback_id = callback_id
+        @external_id = external_id
+      end
+
+      attr_reader :blocks
+
+      def as_json(*)
+        {
+          type: TYPE,
+          blocks: @blocks.as_json,
+          private_metadata: @private_metadata,
+          callback_id: @callback_id,
+          external_id: @external_id
+        }.compact
+      end
+    end
+  end
+end

data/lib/slack/surfaces/message.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Slack
+  module Surfaces
+    # App-published messages are dynamic yet transient spaces.
+    # They allow users to complete workflows among their Slack conversations.
+    #
+    # https://api.slack.com/surfaces#messages
+    # https://api.slack.com/messaging/composing#complex_layouts
+    class Message
+      TYPE = 'message'
+
+      def initialize(blocks: nil, text: nil, channel: nil, thread_ts: nil, as_user: nil)
+        @blocks = blocks || Slack::BlockKit::Blocks.new
+        @channel = channel
+        @thread_ts = thread_ts
+        @as_user = as_user
+        @text = text
+      end
+
+      attr_reader :blocks
+
+      def as_json(*)
+        {
+          channel: @channel,
+          thread_ts: @thread_ts,
+          as_user: @as_user,
+          text: @text,
+          blocks: @blocks.as_json
+        }.compact
+      end
+    end
+  end
+end

data/lib/slack/surfaces/modal.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Slack
+  module Surfaces
+    # Modals provide focused spaces ideal for requesting and collecting data from users,
+    # or temporarily displaying dynamic and interactive information.
+    #
+    # https://api.slack.com/surfaces#modals
+    # https://api.slack.com/reference/surfaces/views
+    #
+    # @param title [String] title is required. Must be set as an initial argument
+    #   or using #title for detail setup
+    #
+    class Modal
+      TYPE = 'modal'
+
+      def initialize(
+        title: nil,
+        blocks: nil,
+        private_metadata: nil,
+        callback_id: nil,
+        external_id: nil,
+        clear_on_close: nil,
+        notify_on_close: nil
+      )
+        @blocks = blocks || Slack::BlockKit::Blocks.new
+
+        @private_metadata = private_metadata
+        @callback_id = callback_id
+        @external_id = external_id
+
+        @clear_on_close = clear_on_close
+        @notify_on_close = notify_on_close
+
+        @title = Slack::BlockKit::Composition::PlainText.new(text: title) if title
+
+        @close, @submit = nil
+      end
+
+      attr_reader :blocks
+
+      def title(text:, emoji: nil)
+        @title = Slack::BlockKit::Composition::PlainText.new(text: text, emoji: emoji)
+
+        self
+      end
+
+      def close(text:, emoji: nil)
+        @close = Slack::BlockKit::Composition::PlainText.new(text: text, emoji: emoji)
+
+        self
+      end
+
+      def submit(text:, emoji: nil)
+        @submit = Slack::BlockKit::Composition::PlainText.new(text: text, emoji: emoji)
+
+        self
+      end
+
+      def as_json(*) # rubocop:disable Metrics/MethodLength
+        {
+          type: TYPE,
+          blocks: @blocks.as_json,
+          title: @title&.as_json,
+          close: @close&.as_json,
+          submit: @submit&.as_json,
+          clear_on_close: @clear_on_close,
+          notify_on_close: @notify_on_close,
+          private_metadata: @private_metadata,
+          callback_id: @callback_id,
+          external_id: @external_id
+        }.compact
+      end
+    end
+  end
+end

data/slack-ruby-block-kit.gemspec

@@ -2,7 +2,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'slack-ruby-block-kit'
+require 'slack/block_kit/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'slack-ruby-block-kit'
@@ -13,13 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/CGA1123/slack-ruby-block-kit'
   spec.license       = 'MIT'
 
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`
       .split("\x0")