slack-ruby-block-kit 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1dbf4c507a258057e4268545eb470d52283d73f24911adedf77f4cb3bd63dea
-  data.tar.gz: fbb29fb003bc969ca8d9dc7eb3db3f025afd7585dc671009f5aa482d79fd711f
+  metadata.gz: 44fcae6fb294fcbfa6ca384c2a0347e017a512071e0b80c0fa32a222aed25ce4
+  data.tar.gz: 8aeeab3e359a31780efa1bc4a112a2ea6ecee249fd5d8053a1934e33a8b583ad
 SHA512:
-  metadata.gz: 9838653c7f9641515da8433252f34123dff455b3619c3ba32fbdccaffdb8b16144f830d6ed53a246afd04acbce4ed8887a66ba45079eca99cce50b370afcbae4
-  data.tar.gz: 4d079f8202a4d9b3a8966adf4f01e37eb0c08a22e074a3dc149a09466ea63124eb7841f8585cfc295880754a68bf2352e33a6b9de8e68afa7b5092c0e9a812c0
+  metadata.gz: 9826b5aeafed46bbaed087d3dc6840c02da3c28c556b6d21954b24a5784a4c10cb1894b5f20bc06856f89678a1aec3063386a46e7cc3d268fdb344186ab91899
+  data.tar.gz: 32a1d531da9ba92c3b526b84d3c0ea6c9fe962d6386705dcbe7752848c37fc701de1412fa3fa405d0a3a320c984f44383b29c8a5bb19f685ff914be3d9e922db

data/.github/workflows/release.yml

@@ -16,9 +16,10 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
-      - run: |
-          otp=${{github.event.inputs.otp}}
-          echo "::add-mask::$otp"
+      - name: Mask OTP
+        run: |
+          OTP=$(jq -r '.inputs.otp' $GITHUB_EVENT_PATH)
+          echo "::add-mask::$OTP"
       - run: gem update --system
       - run: git config --global user.email github-action@users.noreply.github.com
       - run: git config --global user.name GitHub Actions

data/.gitignore

@@ -1,4 +1,5 @@
-/.bundle/
+/.bundle
+/vendor/bundle
 /.yardoc
 /_yardoc/
 /coverage/
@@ -7,6 +8,7 @@
 /spec/reports/
 /spec/examples.txt
 /tmp/
+.idea
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -83,5 +83,8 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 8
 
+Metrics/MethodLength:
+  Max: 25
+
 RSpec/ExampleLength:
-  Max: 6
+  Max: 25

data/CHANGELOG.md

@@ -25,6 +25,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - N/A
 
+## [0.20.0] - 2022-09-25
+
+### Added
+- Added `focus_on_load` parameter to following elements (#153 by @aka-nez):
+  - `Slack::BlockKit::Element::ChannelsSelect`
+  - `Slack::BlockKit::Element::Checkboxes`
+  - `Slack::BlockKit::Element::ConversationsSelect`
+  - `Slack::BlockKit::Element::Datepicker`
+  - `Slack::BlockKit::Element::ExternalSelect`
+  - `Slack::BlockKit::Element::MultiChannelsSelect`
+  - `Slack::BlockKit::Element::MultiConversationsSelect`
+  - `Slack::BlockKit::Element::MultiExternalSelect`
+  - `Slack::BlockKit::Element::MultiStaticSelect`
+  - `Slack::BlockKit::Element::MultiUsersSelect`
+  - `Slack::BlockKit::Element::PlainTextInput`
+  - `Slack::BlockKit::Element::RadioButtons`
+  - `Slack::BlockKit::Element::StaticSelect`
+  - `Slack::BlockKit::Element::Timepicker`
+  - `Slack::BlockKit::Element::UsersSelect`
+
+## [0.19.0] - 2022-09-05
+
+### Added
+- Added `Slack::BlockKit::Layout::Video` (#152 by @jcat4)
+
+This adds support for Slack's new Video Block.
+
+See: https://api.slack.com/reference/block-kit/blocks#video
+
+
 ## [0.18.0] - 2022-08-26
 
 ### Added
@@ -125,8 +155,10 @@ This release contains a breaking change on the `Layout::Actions` interface.
 - Fixed initial options in multi select blocks (#46 by @caalberts)
 
 
-[Unreleased]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.18.0...HEAD
-[0.17.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.17.0...v0.18.0
+[Unreleased]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.20.0...HEAD
+[0.20.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.19.0...v0.20.0
+[0.19.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.18.0...v0.19.0
+[0.18.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.17.0...v0.18.0
 [0.17.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.16.0...v0.17.0
 [0.16.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.15.0...v0.16.0
 [0.15.0]: https://github.com/CGA1123/slack-ruby-block-kit/compare/v0.14.1...v0.15.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack-ruby-block-kit (0.18.0)
+    slack-ruby-block-kit (0.20.0)
       zeitwerk (~> 2.6)
 
 GEM

data/lib/slack/block_kit/blocks.rb

@@ -55,6 +55,19 @@ module Slack
         append(block)
       end
 
+      def video(alt_text:, thumbnail_url:, video_url:, title:, description:, **optional_args)
+        block = Layout::Video.new(
+          alt_text: alt_text,
+          thumbnail_url: thumbnail_url,
+          video_url: video_url,
+          title: title,
+          description: description,
+          **optional_args
+        )
+
+        append(block)
+      end
+
       def section(block_id: nil)
         block = Layout::Section.new(block_id: block_id)
 

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

@@ -17,10 +17,11 @@ module Slack
 
         TYPE = 'channels_select'
 
-        def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, focus_on_load: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_channel = initial
+          @focus_on_load = focus_on_load
 
           yield(self) if block_given?
         end
@@ -30,6 +31,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
+            focus_on_load: @focus_on_load,
             initial_channel: @initial_channel,
             confirm: confirm&.as_json
           }.compact

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

@@ -12,8 +12,9 @@ module Slack
 
         TYPE = 'checkboxes'
 
-        def initialize(action_id:)
+        def initialize(action_id:, focus_on_load: nil)
           @action_id = action_id
+          @focus_on_load = focus_on_load
           @options = []
 
           yield(self) if block_given?
@@ -36,6 +37,7 @@ module Slack
             action_id: @action_id,
             options: @options.map(&:as_json),
             initial_options: initial_options&.map(&:as_json),
+            focus_on_load: @focus_on_load,
             confirm: confirm&.as_json
           }.compact
         end

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

@@ -18,10 +18,17 @@ module Slack
 
         TYPE = 'conversations_select'
 
-        def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
+        def initialize(
+          placeholder:,
+          action_id:,
+          initial: nil,
+          emoji: nil,
+          focus_on_load: nil
+        )
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_conversation = initial
+          @focus_on_load = focus_on_load
           @filter = nil
 
           yield(self) if block_given?
@@ -44,6 +51,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
+            focus_on_load: @focus_on_load,
             initial_conversation: @initial_conversation,
             confirm: confirm&.as_json,
             filter: @filter&.as_json

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

@@ -14,9 +14,10 @@ module Slack
 
         TYPE = 'datepicker'
 
-        def initialize(action_id:, placeholder: nil, initial: nil, emoji: nil)
+        def initialize(action_id:, placeholder: nil, initial: nil, emoji: nil, focus_on_load: nil)
           @action_id = action_id
           @initial_date = initial
+          @focus_on_load = focus_on_load
           @placeholder = placeholder_text(placeholder, emoji)
 
           yield(self) if block_given?
@@ -28,6 +29,7 @@ module Slack
             action_id: @action_id,
             placeholder: @placeholder&.as_json,
             initial_date: @initial_date,
+            focus_on_load: @focus_on_load,
             confirm: confirm&.as_json
           }.compact
         end

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

@@ -23,11 +23,19 @@ module Slack
 
         TYPE = 'external_select'
 
-        def initialize(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil)
+        def initialize(
+          placeholder:,
+          action_id:,
+          initial: nil,
+          min_query_length: nil,
+          emoji: nil,
+          focus_on_load: nil
+        )
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_option = initial
           @min_query_length = min_query_length
+          @focus_on_load = focus_on_load
 
           yield(self) if block_given?
         end
@@ -37,6 +45,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
+            focus_on_load: @focus_on_load,
             initial_option: @initial_option&.as_json,
             min_query_length: @min_query_length,
             confirm: confirm&.as_json

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

@@ -17,11 +17,19 @@ module Slack
 
         TYPE = 'multi_channels_select'
 
-        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+        def initialize(
+          placeholder:,
+          action_id:,
+          initial: nil,
+          emoji: nil,
+          max_selected_items: nil,
+          focus_on_load: nil
+        )
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_channels = initial
           @max_selected_items = max_selected_items
+          @focus_on_load = focus_on_load
 
           yield(self) if block_given?
         end
@@ -32,6 +40,7 @@ module Slack
             placeholder: @placeholder.as_json,
             action_id: @action_id,
             initial_channels: @initial_channels,
+            focus_on_load: @focus_on_load,
             confirm: confirm&.as_json,
             max_selected_items: @max_selected_items
           }.compact

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

@@ -18,11 +18,19 @@ module Slack
 
         TYPE = 'multi_conversations_select'
 
-        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+        def initialize(
+          placeholder:,
+          action_id:,
+          initial: nil,
+          emoji: nil,
+          max_selected_items: nil,
+          focus_on_load: nil
+        )
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_conversations = initial
           @max_selected_items = max_selected_items
+          @focus_on_load = focus_on_load
           @filter = nil
 
           yield(self) if block_given?
@@ -46,6 +54,7 @@ module Slack
             placeholder: @placeholder.as_json,
             action_id: @action_id,
             initial_conversations: @initial_conversations,
+            focus_on_load: @focus_on_load,
             confirm: confirm&.as_json,
             max_selected_items: @max_selected_items,
             filter: @filter&.as_json

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

@@ -23,14 +23,21 @@ module Slack
 
         TYPE = 'multi_external_select'
 
-        def initialize(placeholder:, action_id:,
-                       initial: nil, min_query_length: nil, emoji: nil, max_selected_items: nil)
-
+        def initialize(
+          placeholder:,
+          action_id:,
+          initial: nil,
+          min_query_length: nil,
+          emoji: nil,
+          max_selected_items: nil,
+          focus_on_load: nil
+        )
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_options = initial
           @min_query_length = min_query_length
           @max_selected_items = max_selected_items
+          @focus_on_load = focus_on_load
 
           yield(self) if block_given?
         end
@@ -40,6 +47,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
+            focus_on_load: @focus_on_load,
             initial_options: @initial_options&.map(&:as_json),
             min_query_length: @min_query_length,
             confirm: confirm&.as_json,

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

@@ -19,10 +19,17 @@ module Slack
 
         attr_accessor :options, :option_groups
 
-        def initialize(placeholder:, action_id:, emoji: nil, max_selected_items: nil)
+        def initialize(
+          placeholder:,
+          action_id:,
+          emoji: nil,
+          max_selected_items: nil,
+          focus_on_load: nil
+        )
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @max_selected_items = max_selected_items
+          @focus_on_load = focus_on_load
 
           @options = nil
           @option_groups = nil
@@ -58,6 +65,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
+            focus_on_load: @focus_on_load,
             options: @options&.map(&:as_json),
             option_groups: @option_groups&.map(&:as_json),
             initial_options: initial_options&.map(&:as_json),

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

@@ -17,11 +17,19 @@ module Slack
 
         TYPE = 'multi_users_select'
 
-        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, max_selected_items: nil)
+        def initialize(
+          placeholder:,
+          action_id:,
+          initial: nil,
+          emoji: nil,
+          max_selected_items: nil,
+          focus_on_load: nil
+        )
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_users = initial
           @max_selected_items = max_selected_items
+          @focus_on_load = focus_on_load
 
           yield(self) if block_given?
         end
@@ -32,6 +40,7 @@ module Slack
             placeholder: @placeholder.as_json,
             action_id: @action_id,
             initial_users: @initial_users,
+            focus_on_load: @focus_on_load,
             confirm: confirm&.as_json,
             max_selected_items: @max_selected_items
           }.compact

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

@@ -20,7 +20,8 @@ module Slack
           initial_value: nil,
           multiline: nil,
           min_length: nil,
-          max_length: nil
+          max_length: nil,
+          focus_on_load: nil
         )
           @placeholder = placeholder && Composition::PlainText.new(text: placeholder, emoji: emoji)
           @initial_value = initial_value
@@ -28,6 +29,7 @@ module Slack
           @multiline = multiline
           @min_length = min_length
           @max_length = max_length
+          @focus_on_load = focus_on_load
           @dispatch_action_config = nil
         end
 
@@ -48,6 +50,7 @@ module Slack
             min_length: @min_length,
             max_length: @max_length,
             initial_value: @initial_value,
+            focus_on_load: @focus_on_load,
             dispatch_action_config: @dispatch_action_config&.as_json
           }.compact
         end

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

@@ -13,8 +13,9 @@ module Slack
 
         attr_accessor :options
 
-        def initialize(action_id:)
+        def initialize(action_id:, focus_on_load: nil)
           @action_id = action_id
+          @focus_on_load = focus_on_load
           @options = []
 
           yield(self) if block_given?
@@ -36,6 +37,7 @@ module Slack
           {
             type: TYPE,
             action_id: @action_id,
+            focus_on_load: @focus_on_load,
             options: @options.map(&:as_json),
             initial_option: initial_option&.as_json,
             confirm: confirm&.as_json

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

@@ -19,9 +19,10 @@ module Slack
 
         attr_accessor :options, :option_groups
 
-        def initialize(placeholder:, action_id:, emoji: nil)
+        def initialize(placeholder:, action_id:, emoji: nil, focus_on_load: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
+          @focus_on_load = focus_on_load
 
           yield(self) if block_given?
         end
@@ -54,6 +55,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
+            focus_on_load: @focus_on_load,
             options: options&.map(&:as_json),
             option_groups: option_groups&.map(&:as_json),
             initial_option: initial_option&.as_json,

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

@@ -15,10 +15,11 @@ module Slack
 
         TYPE = 'timepicker'
 
-        def initialize(action_id:, placeholder: nil, initial: nil, emoji: nil)
+        def initialize(action_id:, placeholder: nil, initial: nil, emoji: nil, focus_on_load: nil)
           @placeholder = placeholder_text(placeholder, emoji) if placeholder
           @initial_time = initial
           @action_id = action_id
+          @focus_on_load = focus_on_load
 
           yield(self) if block_given?
         end
@@ -29,6 +30,7 @@ module Slack
             action_id: @action_id,
             placeholder: @placeholder&.as_json,
             initial_time: @initial_time,
+            focus_on_load: @focus_on_load,
             confirm: confirm&.as_json
           }.compact
         end

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

@@ -17,10 +17,11 @@ module Slack
 
         TYPE = 'users_select'
 
-        def initialize(placeholder:, action_id:, initial: nil, emoji: nil)
+        def initialize(placeholder:, action_id:, initial: nil, emoji: nil, focus_on_load: nil)
           @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji)
           @action_id = action_id
           @initial_user = initial
+          @focus_on_load = focus_on_load
 
           yield(self) if block_given?
         end
@@ -30,6 +31,7 @@ module Slack
             type: TYPE,
             placeholder: @placeholder.as_json,
             action_id: @action_id,
+            focus_on_load: @focus_on_load,
             initial_user: @initial_user,
             confirm: confirm&.as_json
           }.compact

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # A video block is designed to embed videos in all app surfaces
+      # (e.g. link unfurls, messages, modals, App Home)  — anywhere you can put blocks!
+      # To use the video block within your app, you must have the links.embed:write scope.
+      #
+      # https://api.slack.com/reference/messaging/blocks#context
+      class Video
+        TYPE = 'video'
+
+        def initialize(alt_text:, thumbnail_url:, video_url:, title:, description:, **optional_args)
+          @alt_text = alt_text
+          @thumbnail_url = thumbnail_url
+          @video_url = video_url
+          @author_name = optional_args[:author_name]
+          @block_id = optional_args[:block_id]
+          @provider_icon_url = optional_args[:provider_icon_url]
+          @provider_name = optional_args[:provider_name]
+          @title_url = optional_args[:title_url]
+          @description = Composition::PlainText.new(
+            text: description,
+            emoji: optional_args[:emoji]
+          )
+          @title = Composition::PlainText.new(
+            text: title,
+            emoji: optional_args[:emoji]
+          )
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            alt_text: @alt_text,
+            thumbnail_url: @thumbnail_url,
+            video_url: @video_url,
+            author_name: @author_name,
+            block_id: @block_id,
+            provider_icon_url: @provider_icon_url,
+            provider_name: @provider_name,
+            title_url: @title_url,
+            description: @description.as_json,
+            title: @title.as_json
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Slack
   module BlockKit
-    VERSION = '0.18.0'
+    VERSION = '0.20.0'
   end
 end

data/lib/slack/surfaces/modal.rb

@@ -57,7 +57,7 @@ module Slack
         self
       end
 
-      def as_json(*) # rubocop:disable Metrics/MethodLength
+      def as_json(*)
         {
           type: TYPE,
           blocks: @blocks.as_json,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-block-kit
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Christian Gregg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -83,6 +83,7 @@ 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/block_kit/layout/video.rb
 - lib/slack/block_kit/version.rb
 - lib/slack/surfaces/home.rb
 - lib/slack/surfaces/message.rb
@@ -111,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.3.22
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for Slack's Block Kit