slack_block_kit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d96c457901f958a818423822d263731b973700608553814c22121d5250bc64
-  data.tar.gz: 74f88c477c0611c4396234ccab674ba608d868db9cb2dfdfd9fdd15e96b4166a
+  metadata.gz: 067c0037a8fd2f3bff99855b8879b6dedb658ac2006b458022d3053b9bca46ca
+  data.tar.gz: 879d0649e57afa5815c1b16be7c87b41b28d934832eebfdc6d3b36352ad005f1
 SHA512:
-  metadata.gz: de53fe305167a4d8039b30faf18c4f8ea029631a79e8f7571fb913eb6453dc2040e79d0edcd62cfa65f7be7453d1d1f9f32243d9d7ee573c200f96803dc0e637
-  data.tar.gz: '018baa8a2ab4b6f046ec8582e22614fce06b88934690c5eaee85bd0d96c706dc582e4cc4079bcb761ee5ba649b9e5f6f15afdc732836c935c34ab9210ac12032'
+  metadata.gz: ae170ecd8b12fad81fdf955fc36840295bdef4e1ca4c4b454022571713e610c60c5e6880a0a260bc9b002adbe4423a74f6d871503fe213730f49c04ec04bd4c7
+  data.tar.gz: 4042f3ab1ac4efa2de8f108a065caea0d6f1334cd19bc24aab6dee4c55d5267e50517c99bbcafc8e8c281eed815697018c04e148ab88ab5729f5d623576cc888

data/.circleci/config.yml

@@ -0,0 +1,49 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.3
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            - v1-dependencies-
+
+      - run:
+          name: bundle
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: rspec
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+      - run:
+          name: rubocop
+          command: bundle exec rubocop -p

data/.gitignore

@@ -5,7 +5,9 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/examples.txt
 /tmp/
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,3 +1,4 @@
+require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
@@ -5,3 +6,6 @@ AllCops:
 
 Metrics/LineLength:
   Max: 120
+
+Style/AsciiComments:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,16 +1,33 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-03-02 15:46:18 +0000 using RuboCop version 0.63.1.
+# on 2019-03-05 20:45:28 +0000 using RuboCop version 0.63.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 63
+
 # Offense count: 1
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 6
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 116
+
+# Offense count: 5
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/lib/slack/block_kit/composition/confirmation_dialog_spec.rb'
+    - 'spec/lib/slack/block_kit/composition/option_group_spec.rb'
+    - 'spec/lib/slack/block_kit/composition/option_spec.rb'
 
-# Offense count: 19
+# Offense count: 4
 Style/Documentation:
-  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/slack/block_kit.rb'

data/Gemfile.lock

@@ -28,6 +28,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.63.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -36,6 +38,8 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
     unicode-display_width (1.4.1)
 
@@ -46,7 +50,9 @@ DEPENDENCIES
   bundler (< 2.0)
   rake
   rspec
+  rspec_junit_formatter
   rubocop
+  rubocop-rspec
   slack_block_kit!
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,17 @@
+[![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)
+
 # Slack::BlockKit
 
-TODO
+A collection of ruby objects that represent Slack's block kit.
+
+You can play around with the block kit using [Slack's block kit builder!](https://api.slack.com/tools/block-kit-builder)
+
+The 'blocks' availables are split in line with how Slack documents them, that is:
+
+- `Slack::BlockKit::Layout` contains the [Layout blocks](https://api.slack.com/reference/messaging/blocks)
+- `Slack::BlockKit::Element` contains the [Block elements](https://api.slack.com/reference/messaging/block-elements)
+- `Slack::BlockKit::Composition` contains the [Message composition objects](https://api.slack.com/reference/messaging/composition-objects)
 
 ## Installation
 
@@ -30,6 +41,8 @@ require 'slack/block_kit'
 
 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!
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/slack/block_kit.rb

@@ -4,12 +4,23 @@ module Slack
   module BlockKit
     module Composition; end
     module Element; end
-    module Layout;end
+    module Layout; end
 
-    VERSION = '0.1.0'
+    VERSION = '0.2.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 }
     Dir[File.join(__dir__, 'block_kit', 'layout', '*.rb')].each { |file| require file }
+    Dir[File.join(__dir__, 'block_kit', '*.rb')].each { |file| require file }
+
+    module_function
+
+    def blocks
+      blocks = Blocks.new
+
+      yield(blocks) if block_given?
+
+      blocks
+    end
   end
 end

data/lib/slack/block_kit/blocks.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    # Blocks are a series of components that can be combined to create visually
+    # rich and compellingly interactive messages.
+    #
+    # https://api.slack.com/reference/messaging/blocks
+    class Blocks
+      attr_accessor :blocks
+
+      def initialize
+        @blocks = []
+
+        yield(self) if block_given?
+      end
+
+      def actions(block_id: nil)
+        block = Layout::Actions.new(block_id: block_id)
+
+        yield(block) if block_given?
+
+        append(block)
+      end
+
+      def context(block_id: nil)
+        block = Layout::Context.new(block_id: block_id)
+
+        yield(block) if block_given?
+
+        append(block)
+      end
+
+      def divider(block_id: nil)
+        block = Layout::Divider.new(block_id: block_id)
+
+        append(block)
+      end
+
+      def image(url:, alt_text:, title: nil, block_id: nil, emoji: nil)
+        block = Layout::Image.new(
+          url: url,
+          alt_text: alt_text,
+          title: title,
+          block_id: block_id,
+          emoji: emoji
+        )
+
+        append(block)
+      end
+
+      def section(block_id: nil)
+        block = Layout::Section.new(block_id: block_id)
+
+        yield(block) if block_given?
+
+        append(block)
+      end
+
+      def append(block)
+        @blocks << block
+
+        self
+      end
+
+      def as_json(*)
+        @blocks.map(&:as_json)
+      end
+    end
+  end
+end

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

@@ -3,12 +3,40 @@
 module Slack
   module BlockKit
     module Composition
+      # An object that defines a dialog that provides a confirmation step to any
+      # interactive element. This dialog will ask the user to confirm their
+      # action by offering confirm and deny buttons.
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#confirm
       class ConfirmationDialog
-        def initialize(title:, text:, confirm:, deny:)
-          @title = title
-          @text = text
-          @confirm = confirm
-          @deny = deny
+        def title(text:, emoji: nil)
+          @title = PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def confirm(text:, emoji: nil)
+          @confirm = PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def deny(text:, emoji: nil)
+          @deny = PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def plain_text(text:, emoji: nil)
+          @text = PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def mrkdwn(text:, verbatim: nil)
+          @text = Mrkdwn.new(text: text, verbatim: verbatim)
+
+          self
         end
 
         def as_json(*)

data/lib/slack/block_kit/composition/mrkdwn.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Composition
+      # An object containing some text, formatted using Slack's "mrkdwn".
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#text
+      # https://api.slack.com/messaging/composing/formatting
+      class Mrkdwn
+        TYPE = 'mrkdwn'
+
+        def initialize(text:, verbatim: nil)
+          @text = text
+          @verbatim = verbatim
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            text: @text,
+            verbatim: @verbatim
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/slack/block_kit/composition/option.rb

@@ -3,9 +3,13 @@
 module Slack
   module BlockKit
     module Composition
+      # An object that represents a single selectable item in a select menu.
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#option
+      # https://api.slack.com/reference/messaging/block-elements#select
       class Option
-        def initialize(text:, value:)
-          @text = text
+        def initialize(value:, text:, emoji: nil)
+          @text = PlainText.new(text: text, emoji: emoji)
           @value = value
         end
 

data/lib/slack/block_kit/composition/option_group.rb

@@ -3,16 +3,30 @@
 module Slack
   module BlockKit
     module Composition
+      # Provides a way to group options in a select menu.
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#option-group
+      # https://api.slack.com/reference/messaging/block-elements#select
       class OptionGroup
-        def initialize(label:, options:)
-          @label = label
-          @options = options
+        attr_accessor :options
+
+        def initialize(label:, emoji: nil)
+          @label = PlainText.new(text: label, emoji: emoji)
+          @options = []
+
+          yield(self) if block_given?
+        end
+
+        def option(text:, value:, emoji: nil)
+          @options << Option.new(text: text, value: value, emoji: emoji)
+
+          self
         end
 
         def as_json(*)
           {
             label: @label.as_json,
-            options: options.map(&:as_json)
+            options: @options.map(&:as_json)
           }
         end
       end

data/lib/slack/block_kit/composition/plain_text.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Composition
+      # An object containing some text, formatted using plain text.
+      #
+      # https://api.slack.com/reference/messaging/composition-objects#text
+      class PlainText
+        TYPE = 'plain_text'
+
+        def initialize(text:, emoji: nil)
+          @text = text
+          @emoji = emoji
+        end
+
+        def as_json(*)
+          {
+            type: TYPE,
+            text: @text,
+            emoji: @emoji
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -3,15 +3,31 @@
 module Slack
   module BlockKit
     module Element
+      # An interactive element that inserts a button.
+      # The button can be a trigger for anything from opening a simple link
+      # to starting a complex workflow.
+      #
+      # https://api.slack.com/reference/messaging/block-elements#button
       class Button
         TYPE = 'button'
 
-        def initialize(text:, action_id:, url: nil, value: nil, confirm: nil)
-          @text = text
+        attr_accessor :confirm
+
+        def initialize(text:, action_id:, emoji: nil, url: nil, value: nil)
+          @text = Composition::PlainText.new(text: text, emoji: emoji)
           @action_id = action_id
           @url = url
           @value = value
-          @confirm = confirm
+
+          yield(self) if block_given?
+        end
+
+        def confirmation_dialog
+          @confirm = Composition::ConfirmationDialog.new
+
+          yield(@confirm) if block_given?
+
+          @confirm
         end
 
         def as_json(*)