slack-ruby-block-kit 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba4b59b1f8d591f6560563d913833ea5193d3c0ad1ff46e30b4484949d8cfeda
-  data.tar.gz: 90c8576e1fadb6b9a17d8e6c76f9c871e073fa0cab1e9178a26959b80e62b1fa
+  metadata.gz: 31d357b44cc9c6e928a1ddc3e469393befde7bcc565416167e76767835551115
+  data.tar.gz: 942fb2311a0e388e7fe4d2fe40a76b2c398583fe06facdac05547b2d3102b6b1
 SHA512:
-  metadata.gz: 37e969657c3cd6f54fd0f4d9a77292b4740917463823b84af9325a87455b6b686af353d98769a09d6e36e2ddd503e62fc1d460f981c359326deb87232349d89c
-  data.tar.gz: af06784a17f10737b24c85b3ee2b59dd34f0bd61da21e19234d1cca04e213a195ca5698ec8ddbb876dd3a8fdf5894814b2c39da65305747f78a907401fbf5ccb
+  metadata.gz: 93c87de2988ede207c6950fd00ed7c68a84cb30cefeeeb105ce8309595f7135ef5db5ed3a9fa2ebf02e06b0744c0633ac3cd551ac9d93c43462ca1c8a1cb9d9f
+  data.tar.gz: 591a9b52614a626dccbe11dd1ddbf3ec6114f54f509209643d7e6eeac5a213d2e1262842c345ffab18af86e58fecec90ea7f5372403a2f8a03f36e131b5933dc

data/.rubocop.yml

@@ -53,3 +53,15 @@ Style/HashTransformValues:
 
 Style/SlicingWithRange:
   Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack-ruby-block-kit (0.8.0)
+    slack-ruby-block-kit (0.9.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/slack/block_kit.rb

@@ -6,12 +6,13 @@ module Slack
     module Element; end
     module Layout; end
 
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
 
     Dir[File.join(__dir__, 'block_kit', 'composition', '*.rb')].sort.each { |file| require file }
     Dir[File.join(__dir__, 'block_kit', 'element', '*.rb')].sort.each { |file| require file }
     Dir[File.join(__dir__, 'block_kit', 'layout', '*.rb')].sort.each { |file| require file }
     Dir[File.join(__dir__, 'block_kit', '*.rb')].sort.each { |file| require file }
+    Dir[File.join(__dir__, 'surfaces', '*.rb')].sort.each { |file| require file }
 
     module_function
 
@@ -22,5 +23,48 @@ module Slack
 
       blocks
     end
+
+    def home(blocks: nil,
+             private_metadata: nil, callback_id: nil, external_id: nil)
+      home_surface = Slack::Surfaces::Home.new(blocks: blocks,
+                                               private_metadata: private_metadata,
+                                               callback_id: callback_id,
+                                               external_id: external_id)
+
+      yield(home_surface) if block_given?
+
+      home_surface
+    end
+
+    def modal(title: nil,
+              blocks: nil,
+              private_metadata: nil, callback_id: nil, external_id: nil,
+              clear_on_close: nil, notify_on_close: nil)
+      modal_surface = Slack::Surfaces::Modal.new(title: title,
+                                                 blocks: blocks,
+                                                 private_metadata: private_metadata,
+                                                 callback_id: callback_id,
+                                                 external_id: external_id,
+                                                 clear_on_close: clear_on_close,
+                                                 notify_on_close: notify_on_close)
+
+      yield(modal_surface) if block_given?
+
+      modal_surface
+    end
+
+    def message(blocks: nil, channel: nil, thread_ts: nil, as_user: nil, text: nil)
+      message_surface = Slack::Surfaces::Message.new(
+        blocks: blocks,
+        channel: channel,
+        thread_ts: thread_ts,
+        text: text,
+        as_user: as_user
+      )
+
+      yield(message_surface) if block_given?
+
+      message_surface
+    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

@@ -157,7 +157,7 @@ module Slack
         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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-block-kit
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Christian Gregg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -186,6 +186,9 @@ files:
 - lib/slack/block_kit/layout/input.rb
 - lib/slack/block_kit/layout/section.rb
 - lib/slack/block_kit/layout/section/multi_select_elements.rb
+- lib/slack/surfaces/home.rb
+- lib/slack/surfaces/message.rb
+- lib/slack/surfaces/modal.rb
 - slack-ruby-block-kit.gemspec
 homepage: https://github.com/CGA1123/slack-ruby-block-kit
 licenses:
@@ -207,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for Slack's Block Kit