slack-ruby-block-kit 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40f294a5c8ef52820a0db8fd474a4cba423dad298f14092217f6213b47ba45ad
-  data.tar.gz: e22e8b941d6d3c765c6f40735bd97ecd11f94ac4560e3ba038e0cef073a72241
+  metadata.gz: 378d3c0f61c46eb14a2b94d00b17ec9c244651410ca1808af7a153799fd5aae3
+  data.tar.gz: 5c6e19732f13dca80bcb6903d33d2b74ab2276d1e3440f39c959ba693d56a0b0
 SHA512:
-  metadata.gz: d7d952242309b0906da8e5ae6072f618a200e3604ad304ceeb323e2387ec5185cadee7e1554729f9beaf004431f0c97053d30c462d40c0c9bee6aaaa1cd91b88
-  data.tar.gz: 639e9d8b9b57c99022e0080233a0ecae95f958e04732a0f2bd0fc41cc1b704918fa0eb04a28d6e451a2d373f823c1fb8e40c1890d24ebe5d60af58150e6c27cb
+  metadata.gz: f461f8b3321c739727690bf72f02598698e5de10a2a99626f1bffa68a47771777f9af783df6063df841ab85e8db6fea6dcce8e5cb027ae029fcf88253f7f13f5
+  data.tar.gz: 7c80bdbf03ce41fef6a11f816a3ffaf9eda92ddd2011a9e20e3c6e9653ebf3306e529aa1b5c53811792d532a18ba732ec55163df3467e490652f6c4c7b2df562

data/.rubocop.yml

@@ -13,3 +13,6 @@ Style/AsciiComments:
 Naming/FileName:
   Exclude:
     - lib/slack-ruby-block-kit.rb
+
+Metrics/ParameterLists:
+  Max: 8

data/.rubocop_todo.yml

@@ -17,11 +17,6 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 117
 
-# Offense count: 3
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 6
-
 # Offense count: 5
 # Configuration parameters: Max.
 RSpec/ExampleLength:

data/Gemfile.lock

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

data/README.md

@@ -1,5 +1,5 @@
-[![CircleCI](https://circleci.com/gh/CGA1123/slack_block_kit-ruby/tree/master.svg?style=svg)](https://circleci.com/gh/CGA1123/slack_block_kit-ruby/tree/master)
-[![Gem Version](https://badge.fury.io/rb/slack_block_kit.svg)](https://badge.fury.io/rb/slack_block_kit)
+[![CircleCI](https://circleci.com/gh/CGA1123/slack-ruby-block-kit/tree/master.svg?style=svg)](https://circleci.com/gh/CGA1123/slack_block_kit-ruby/tree/master)
+[![Gem Version](https://badge.fury.io/rb/slack-ruby-block-kit.svg)](https://badge.fury.io/rb/slack-ruby-block-kit)
 
 # Slack::BlockKit
 
@@ -18,7 +18,7 @@ The 'blocks' availables are split in line with how Slack documents them, that is
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'slack_block_kit'
+gem 'slack-ruby-block-kit'
 ```
 
 
@@ -29,12 +29,12 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install slack_block_kit
+    $ gem install slack-ruby-block-kit
 
 Finally, require this:
 
 ```ruby
-require 'slack/block_kit'
+require 'slack-ruby-block-kit'
 ```
 
 ## Examples
@@ -43,7 +43,7 @@ Here are a few examples that might help you get started!
 
 ```ruby
 require 'faraday'
-require 'slack/block_kit'
+require 'slack-ruby-block-kit'
 require 'json'
 
 a_prebuilt_block = Slack::BlockKit::Layout::Section.new
@@ -88,7 +88,7 @@ You can also check out the [`slackerduty`](https://github.com/CGA1123/slackerdut
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/CGA1123/slack_block_kit-ruby
 
-See [issues](https://github.com/CGA1123/slack_block_kit-ruby/issues) if you want any inspiration as to what to help with!
+See [issues](https://github.com/CGA1123/slack-ruby-block-kit/issues) if you want any inspiration as to what to help with!
 
 ## License
 

data/lib/slack/block_kit.rb

@@ -6,7 +6,7 @@ module Slack
     module Element; end
     module Layout; end
 
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
 
     Dir[File.join(__dir__, 'block_kit', 'composition', '*.rb')].each { |file| require file }
     Dir[File.join(__dir__, 'block_kit', 'element', '*.rb')].each { |file| require file }

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Element
+      # A plain-text input, similar to the HTML <input> tag, creates a field
+      # where a user can enter freeform data. It can appear as a single-line
+      # field or a larger textarea using the multiline flag.
+      #
+      # Plain-text input elements are currently only available in modals
+      #
+      # https://api.slack.com/reference/block-kit/block-elements#input
+      class PlainTextInput
+        TYPE = 'plain_text_input'
+
+        def initialize(
+          action_id:,
+          placeholder: nil,
+          emoji: nil,
+          initial_value: nil,
+          multiline: nil,
+          min_length: nil,
+          max_length: nil
+        )
+          @placeholder = Composition::PlainText.new(text: placeholder, emoji: emoji) if placeholder
+          @initial_value = initial_value
+          @action_id = action_id
+          @multiline = multiline
+          @min_length = min_length
+          @max_length = max_length
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            action_id: @action_id,
+            placeholder: @placeholder&.as_json,
+            multiline: @multiline,
+            min_length: @min_length,
+            max_length: @max_length,
+            initial_value: @initial_value
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Layout
+      # A block that collects information from users - it can hold a plain-text
+      # input element, a select menu element, a multi-select menu element, or a
+      # datepicker.
+      #
+      # https://api.slack.com/reference/block-kit/blocks#input
+      class Input
+        TYPE = 'input'
+
+        attr_accessor :label, :element, :block_id, :hint, :optional, :emoji
+
+        def initialize(
+          label:,
+          element:,
+          block_id: nil,
+          hint: nil,
+          optional: nil,
+          emoji: nil
+        )
+          @label = Composition::PlainText.new(text: label, emoji: emoji) if label
+          @hint = Composition::PlainText.new(text: hint, emoji: emoji) if hint
+          @block_id = block_id
+          @optional = optional
+          @element = element
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            element: @element.as_json,
+            label: @label&.as_json,
+            hint: @hint&.as_json,
+            block_id: @block_id,
+            optional: optional
+          }.compact
+        end
+      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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Christian Gregg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,12 +126,14 @@ files:
 - lib/slack/block_kit/element/external_select.rb
 - lib/slack/block_kit/element/image.rb
 - lib/slack/block_kit/element/overflow_menu.rb
+- lib/slack/block_kit/element/plain_text_input.rb
 - lib/slack/block_kit/element/static_select.rb
 - lib/slack/block_kit/element/users_select.rb
 - lib/slack/block_kit/layout/actions.rb
 - lib/slack/block_kit/layout/context.rb
 - lib/slack/block_kit/layout/divider.rb
 - lib/slack/block_kit/layout/image.rb
+- lib/slack/block_kit/layout/input.rb
 - lib/slack/block_kit/layout/section.rb
 - slack-ruby-block-kit.gemspec
 homepage: https://github.com/CGA1123/slack-ruby-block-kit