slack-block-kit 0.1.0

data/examples/slack_template_08.rb

@@ -0,0 +1,77 @@
+[ SectionBlock[text: Text[mrkdwn: ":mag: Search results for #{Bold['Cata']}"]],
+  DividerBlock[],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toYourApp.com', 'Use Case Catalogue']],
+      "Use Case Catalogue for the following departments/roles..."
+    ]],
+    accessory: StaticSelectElement[
+      placeholder: Text[plain_text: 'Manage', emoji: true],
+      options: [
+        Option[text: Text[plain_text: 'Edit it', emoji: true], value: 'value-0'],
+        Option[text: Text[plain_text: 'Read it', emoji: true], value: 'value-1'],
+        Option[text: Text[plain_text: 'Save it', emoji: true], value: 'value-2']
+      ]
+    ]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toYourApp.com', 'Customer Support - Workflow Diagram Catalogue']],
+      "This resource was put together by members of..."
+    ]],
+    accessory: StaticSelectElement[
+      placeholder: Text[plain_text: 'Manage', emoji: true],
+      options: [
+        Option[text: Text[plain_text: 'Manage it', emoji: true], value: 'value-0'],
+        Option[text: Text[plain_text: 'Read it', emoji: true], value: 'value-1'],
+        Option[text: Text[plain_text: 'Save it', emoji: true], value: 'value-2']
+      ]
+    ]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toYourApp.com', 'Self-Serve Learning Options Catalogue']],
+      "See the learning and development options we..."
+    ]],
+    accessory: StaticSelectElement[
+      placeholder: Text[plain_text: 'Manage', emoji: true],
+      options: [
+        Option[text: Text[plain_text: 'Manage it', emoji: true], value: 'value-0'],
+        Option[text: Text[plain_text: 'Read it', emoji: true], value: 'value-1'],
+        Option[text: Text[plain_text: 'Save it', emoji: true], value: 'value-2']
+      ]
+    ]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toYourApp.com', 'Use Case Catalogue - CF Presentation - [June 12, 2018]']],
+      "This is presentation will continue to be updated as..."
+    ]],
+    accessory: StaticSelectElement[
+      placeholder: Text[plain_text: 'Manage', emoji: true],
+      options: [
+        Option[text: Text[plain_text: 'Manage it', emoji: true], value: 'value-0'],
+        Option[text: Text[plain_text: 'Read it', emoji: true], value: 'value-1'],
+        Option[text: Text[plain_text: 'Save it', emoji: true], value: 'value-2']
+      ]
+    ]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toYourApp.com', 'Comprehensive Benefits Catalogue - 2019']],
+      "Information about all the benfits we offer is..."
+    ]],
+    accessory: StaticSelectElement[
+      placeholder: Text[plain_text: 'Manage', emoji: true],
+      options: [
+        Option[text: Text[plain_text: 'Manage it', emoji: true], value: 'value-0'],
+        Option[text: Text[plain_text: 'Read it', emoji: true], value: 'value-1'],
+        Option[text: Text[plain_text: 'Save it', emoji: true], value: 'value-2']
+      ]
+    ]
+  ],
+  DividerBlock[],
+  ActionsBlock[elements: [
+    ButtonElement[text: Text[plain_text: 'Next 5 Results', emoji: true], value: 'click_me_123']
+  ]]
+]

data/examples/slack_template_09.rb

@@ -0,0 +1,53 @@
+[ SectionBlock[text: Text[mrkdwn: ":newspaper:  #{Bold['Paper Company Newsletter']}  :newspaper:"]],
+  ContextBlock[elements: [Text[mrkdwn: "#{Bold['November 12, 2019']}  |  Sales Team Announcements"]]],
+  DividerBlock[],
+  SectionBlock[text: Text[mrkdwn: " :loud_sound: #{Bold['IN CASE YOU MISSED IT']} :loud_sound:"]],
+  SectionBlock[
+    text: Text[mrkdwn: "Replay our screening of #{Bold['Threat Level Midnight']} and pick up a copy of the DVD to give to your customers at the front desk."],
+    accessory: ButtonElement[text: Text[plain_text: 'Watch Now', emoji: true]]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      "The *2019 Dundies* happened. ",
+      "Awards were given, heroes were recognized. ",
+      "Check out *#dundies-2019* to see who won awards."
+    ]]
+  ],
+  DividerBlock[],
+  SectionBlock[text: Text[mrkdwn: ":calendar: |   #{Bold['UPCOMING EVENTS']}  | :calendar: "]],
+  SectionBlock[
+    text: Text[mrkdwn: "#{Code['11/20-11/22']} #{Bold['Beet the Competition']} #{Italic[' annual retreat at Schrute Farms']}"],
+    accessory: ButtonElement[text: Text[plain_text: 'RSVP', emoji: true]]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: "#{Code['12/01']} #{Bold["Toby's Going Away Party"]} at #{Italic['Benihana']}"],
+    accessory: ButtonElement[text: Text[plain_text: 'Learn More', emoji: true]]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: "#{Code['11/13']} :pretzel: #{Bold['Pretzel Day']} :pretzel: at #{Italic['Scranton Office']}"],
+    accessory: ButtonElement[text: Text[plain_text: 'RSVP', emoji: true]]
+  ],
+  DividerBlock[],
+  SectionBlock[text: Text[mrkdwn: ":calendar: |   #{Bold['PAST EVENTS']}  | :calendar: "]],
+  SectionBlock[
+    text: Text[mrkdwn: "#{Code['10/21']} #{Bold['Conference Room Meeting']}"],
+    accessory: ButtonElement[text: Text[plain_text: 'Watch Recording', emoji: true]]
+  ],
+  DividerBlock[],
+  SectionBlock[text: Text[mrkdwn: Bold['FOR YOUR INFORMATION']]],
+  SectionBlock[text: Text[mrkdwn: ":printer: #{Bold['Sabre Printers']} are no longer catching on fire! The newest version of our printers are safe to use. Make sure to tell your customers today.", verbatim: false]],
+  DividerBlock[],
+  SectionBlock[text: Text[mrkdwn: [
+    "Please join me in welcoming our 3 #{Bold['new hires']} to the Paper Company family! ",
+    nil,
+    " #{Bold['Robert California']}, CEO ",
+    nil,
+    " #{Bold['Ryan Howard']}, Temp ",
+    nil,
+    " #{Bold['Erin Hannon']}, Receptionist "
+  ]]],
+  DividerBlock[],
+  ContextBlock[elements: [
+    Text[mrkdwn: ":pushpin: Do you have something to include in the newsletter? Here's #{Bold['how to submit content']}."]
+  ]]
+]

data/lib/slack-block-kit.rb

@@ -0,0 +1 @@
+require_relative 'slack/block_kit'

data/lib/slack/block_kit.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'block_kit/type_restricted_array'
+require_relative 'block_kit/refinements/hash_compact'
+
+require_relative 'block_kit/block'
+require_relative 'block_kit/block/actions_block'
+require_relative 'block_kit/block/context_block'
+require_relative 'block_kit/block/divider_block'
+require_relative 'block_kit/block/image_block'
+require_relative 'block_kit/block/section_block'
+
+require_relative 'block_kit/composition_objects/confirmation_dialog'
+require_relative 'block_kit/composition_objects/filter'
+require_relative 'block_kit/composition_objects/option'
+require_relative 'block_kit/composition_objects/option_group'
+require_relative 'block_kit/composition_objects/text'
+
+require_relative 'block_kit/element'
+require_relative 'block_kit/element/button_element'
+require_relative 'block_kit/element/date_picker_element'
+require_relative 'block_kit/element/image_element'
+require_relative 'block_kit/element/overflow_element'
+
+require_relative 'block_kit/element/select_element'
+require_relative 'block_kit/element/channels_select_element'
+require_relative 'block_kit/element/conversations_select_element'
+require_relative 'block_kit/element/external_select_element'
+require_relative 'block_kit/element/static_select_element'
+require_relative 'block_kit/element/users_select_element'
+
+require_relative 'block_kit/element/multi_channels_select_element'
+require_relative 'block_kit/element/multi_conversations_select_element'
+require_relative 'block_kit/element/multi_external_select_element'
+require_relative 'block_kit/element/multi_static_select_element'
+require_relative 'block_kit/element/multi_users_select_element'
+
+require_relative 'block_kit/execution_context'

data/lib/slack/block_kit/block.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    class Block
+      attr_reader :block_id
+
+      def self.populate(hash, object)
+        object.block_id = hash[:block_id] if hash.key?(:block_id)
+        raise ArgumentError, "invalid #{name}" unless object.valid?
+      end
+
+      def self.[](hash)
+        new.tap { |obj| populate(hash, obj) }
+      end
+
+      def block_id=(obj)
+        raise TypeError, 'block_id must be a string' unless obj.respond_to?(:to_str)
+        raise RangeError, 'block_id must be max 255 characters' unless obj.size <= 255
+
+        @block_id = obj.to_s
+      end
+
+      def type
+        @type ||= self.class.name
+          .split('::')
+          .last.chomp('Block')
+          .gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+      end
+
+      def valid?
+        true
+      end
+
+      def to_h
+        { type: type,
+          block_id: block_id }
+      end
+    end
+  end
+end

data/lib/slack/block_kit/block/actions_block.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    class Block
+      class ActionsBlock < Block
+        using Refinements::HashCompact
+        attr_accessor :elements
+
+        def self.populate(hash, object)
+          hash[:elements].each(&object.elements.method(:<<))
+        end
+
+        def initialize
+          @elements = TypeRestrictedArray.new(
+            Element::ButtonElement,
+            Element::SelectElement,
+            Element::OverflowElement,
+            Element::DatePickerElement
+          )
+        end
+
+        def valid?
+          !@elements.empty? && @elements.size <= 5
+        end
+
+        def to_h
+          super.merge(
+            elements: elements.map(&:to_h)
+          ).compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/block/context_block.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    class Block
+      class ContextBlock < Block
+        using Refinements::HashCompact
+        attr_accessor :elements
+
+        def self.populate(hash, object)
+          hash[:elements].each(&object.elements.method(:<<))
+        end
+
+        def initialize
+          @elements = TypeRestrictedArray.new(Element, CompositionObjects::Text)
+        end
+
+        def valid?
+          !@elements.empty?
+        end
+
+        def to_h
+          super.merge(
+            elements: elements.map(&:to_h)
+          ).compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/block/divider_block.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    class Block
+      class DividerBlock < Block
+        def self.[](hash = {})
+          new.tap { |obj| populate(hash, obj) }
+        end
+
+        def to_h
+          super.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/block/image_block.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    class Block
+      class ImageBlock < Block
+        using Refinements::HashCompact
+        attr_accessor :image_url, :alt_text, :title
+
+        def self.populate(hash, object)
+          object.image_url = hash.fetch(:image_url)
+          object.alt_text = hash.fetch(:alt_text)
+          object.title = hash[:title] if hash.key?(:title)
+        end
+
+        def title=(obj)
+          raise TypeError, 'title must be a Text Object' unless obj.is_a?(CompositionObjects::Text)
+
+          @title = obj
+        end
+
+        def image_url=(url)
+          raise RangeError, 'image_url is max 3000 characters' unless url.size <= 3000
+
+          @image_url = url
+        end
+
+        def alt_text=(text)
+          raise RangeError, 'alt_text is max 2000 characters' unless text.size <= 2000
+
+          @alt_text = text
+        end
+
+        def to_h
+          super.merge(
+            image_url: image_url,
+            alt_text: alt_text,
+            title: title&.to_h
+          ).compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/block/section_block.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    class Block
+      class SectionBlock < Block
+        using Refinements::HashCompact
+        attr_reader :text, :fields, :accessory
+
+        def self.populate(hash, object)
+          object.accessory = hash[:accessory] if hash.key?(:accessory)
+          if hash.key?(:text) then object.text = hash[:text]
+          elsif hash.key?(:fields) then hash[:fields].each(&object.fields.method(:<<))
+          end
+        end
+
+        def initialize
+          @fields = TypeRestrictedArray.new(CompositionObjects::Text)
+        end
+
+        # Either text or fields must exist and be non-empty.
+        def valid?
+          if @text.nil? || @text.empty? then !@fields.empty?
+          else !@text&.empty?
+          end
+        end
+
+        def text=(obj)
+          raise TypeError, 'text must be a Text Object' unless obj.is_a?(CompositionObjects::Text)
+
+          @text = obj
+        end
+
+        def accessory=(elem)
+          raise TypeError, 'accessory must be a block element' unless elem.is_a?(Element)
+
+          @accessory = elem
+        end
+
+        def to_h
+          if text && text.text.size > 3000
+            raise RangeError, 'text in SectionBlock has max 3000 characters'
+          end
+
+          super.merge(
+            block_id: block_id,
+            text: text&.to_h,
+            fields: fields.map(&:to_h),
+            accessory: accessory&.to_h
+          ).compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/composition_objects/confirmation_dialog.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module CompositionObjects
+      class ConfirmationDialog
+        using Refinements::HashCompact
+        attr_reader :title, :text, :confirm, :deny
+
+        def self.[](hash)
+          new.tap do |object|
+            object.title = hash.fetch(:title)
+            object.text = hash.fetch(:text)
+            object.confirm = hash.fetch(:confirm)
+            object.deny = hash.fetch(:deny)
+          end
+        end
+
+        def title=(obj)
+          raise TypeError, 'title must be a Text Object' unless obj.is_a?(Text)
+          raise TypeError, 'title must be plain_text' unless obj.type == :plain_text
+          raise RangeError, 'title is max 100 characters' unless obj.text.size <= 100
+
+          @title = obj
+        end
+
+        def text=(obj)
+          raise TypeError, 'text must be a Text Object' unless obj.is_a?(Text)
+          raise RangeError, 'text is max 300 characters' unless obj.text.size <= 300
+
+          @text = obj
+        end
+
+        def confirm=(obj)
+          raise TypeError, 'confirm must be a Text Object' unless obj.is_a?(Text)
+          raise TypeError, 'confirm must be plain_text' unless obj.type == :plain_text
+          raise RangeError, 'confirm is max 30 characters' unless obj.text.size <= 30
+
+          @confirm = obj
+        end
+
+        def deny=(obj)
+          raise TypeError, 'deny must be a Text Object' unless obj.is_a?(Text)
+          raise TypeError, 'deny must be plain_text' unless obj.type == :plain_text
+          raise RangeError, 'deny is max 30 characters' unless obj.text.size <= 30
+
+          @deny = obj
+        end
+
+        def to_h
+          { title: title.to_h,
+            text: text.to_h,
+            confirm: confirm.to_h,
+            deny: deny.to_h }.compact
+        end
+      end
+    end
+  end
+end