slack-ruby-block-kit 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40f294a5c8ef52820a0db8fd474a4cba423dad298f14092217f6213b47ba45ad
+  data.tar.gz: e22e8b941d6d3c765c6f40735bd97ecd11f94ac4560e3ba038e0cef073a72241
+SHA512:
+  metadata.gz: d7d952242309b0906da8e5ae6072f618a200e3604ad304ceeb323e2387ec5185cadee7e1554729f9beaf004431f0c97053d30c462d40c0c9bee6aaaa1cd91b88
+  data.tar.gz: 639e9d8b9b57c99022e0080233a0ecae95f958e04732a0f2bd0fc41cc1b704918fa0eb04a28d6e451a2d373f823c1fb8e40c1890d24ebe5d60af58150e6c27cb

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

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/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

@@ -0,0 +1,15 @@
+require: rubocop-rspec
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5.3
+
+Metrics/LineLength:
+  Max: 120
+
+Style/AsciiComments:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/slack-ruby-block-kit.rb

data/.rubocop_todo.yml

@@ -0,0 +1,38 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --no-auto-gen-timestamp`
+# 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: CountComments.
+Metrics/ClassLength:
+  Max: 117
+
+# Offense count: 3
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# 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: 4
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/slack/block_kit.rb'

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tenios-rb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    slack-ruby-block-kit (0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      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)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (< 2.0)
+  rake
+  rspec
+  rspec_junit_formatter
+  rubocop
+  rubocop-rspec
+  slack-ruby-block-kit!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Christian Gregg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+[![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
+
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_block_kit'
+```
+
+
+And then execute:
+
+    $ bundle
+
+
+Or install it yourself as:
+
+    $ gem install slack_block_kit
+
+Finally, require this:
+
+```ruby
+require 'slack/block_kit'
+```
+
+## Examples
+
+Here are a few examples that might help you get started!
+
+```ruby
+require 'faraday'
+require 'slack/block_kit'
+require 'json'
+
+a_prebuilt_block = Slack::BlockKit::Layout::Section.new
+text = Slack::BlockKit::Composition::Mrkdwn.new(text: ':wave: *hello*')
+an_image = Slack::BlockKit::Element::Image.new(image_url: 'https://git.io/fjDW8', alt_text: 'a picture')
+a_prebuilt_block.accessorise(an_image)
+a_prebuilt_block.text = text
+
+blocks = Slack::BlockKit.blocks do |b|
+  b.section do |s|
+    s.plain_text(text: 'Some plain text message!')
+    s.button(text: 'A button that is important', style: 'primary', action_id: 'id')
+  end
+
+  b.divider
+
+  b.context do |c|
+    c.mrkdwn(text: '_some italicised text for context_')
+  end
+
+  b.append(a_prebuilt_block)
+end
+
+webhook_url = 'https://hooks.slack.com/services/your/webhook/url'
+body = { blocks: blocks.as_json, text: 'New block message!' }
+
+response = Faraday.post(
+  webhook_url,
+  body.to_json,
+  'Content-Type' => 'application/json'
+)
+```
+
+This will create a message like this:
+
+![example block message](https://git.io/fjDWR)
+
+You can also check out the [`slackerduty`](https://github.com/CGA1123/slackerduty) project for some example,
+[`Slackerduty::Alert`](https://github.com/CGA1123/slackerduty/blob/b33d708124ddf36d1432080ba7e16e66fefa6993/lib/slackerduty/alert.rb#L28-L34) and [`Slackerduty::Blocks`](https://github.com/CGA1123/slackerduty/blob/master/lib/slackerduty/blocks) may be helpful places to start.
+
+## Contributing
+
+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/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/slack-ruby-block-kit.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative './slack/block_kit'

data/lib/slack/block_kit.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Slack
+  module BlockKit
+    module Composition; end
+    module Element; end
+    module Layout; end
+
+    VERSION = '0.4.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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+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 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(*)
+          {
+            title: @title.as_json,
+            text: @text.as_json,
+            confirm: @confirm.as_json,
+            deny: @deny.as_json
+          }
+        end
+      end
+    end
+  end
+end