slack-block-kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1213cb50f260ad0e5a04217689cd89616631253fb1f7eb5a6542a967431085f
+  data.tar.gz: cd396560c416619a1bb64f4dc73b068db0a3e7b9f2c8b8ce1a8fa22279214a9a
+SHA512:
+  metadata.gz: 3171e4609ee091076a8b038ac83f10d48c0fb1293de1a3e9bb9c3dd1bd1116ea2721db9218b71544ef8f5aaf650a903effc3c0cef51b3ceab1d5feab65a1bc8f
+  data.tar.gz: 3464ea2809cd0d64ae80c013e98bf0b4e7ab605c127cc2a8fb2bc0405a4455c63929668a25cd7aafd1953d133f8bcd5bf69e249f0cf159dbcb84e56dcd2ec95a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slack-block-kit.gemspec
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# Slack::BlockKit
+
+This is a helper for producing Blocks you'd expect in BlockKit.
+
+## 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
+
+## Usage
+
+Require the gem using:
+
+```ruby
+require 'slack-block-kit'
+```
+
+Include the execution context DSL:
+
+```ruby
+include Slack::BlockKit::ExecutionContext
+```
+
+Then you can construct your blocks as you want:
+
+```ruby
+require 'slack-ruby-client'
+
+client = Slack::Web::Client.new
+
+blocks = [
+  SectionBlock[text: Text[mrkdwn: "Hello, #{Bold['World!']}"]]
+]
+
+client.chat_postMessage(
+  channel: '#general'
+  blocks: blocks.map(&:to_h)
+)
+```
+
+The current examples that Slack's BlockKit Builder provides have been reproduced under [examples](examples/).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/saraid/slack-block-kit.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack-block-kit"
+
+include Slack::BlockKit::ExecutionContext
+
+def pbpaste
+  require 'json'
+  puts JSON.pretty_generate eval(`pbpaste`).map(&:to_h).yield_self { |h| { blocks: h } }
+end
+
+def to_json(array)
+  require 'json'
+  puts JSON.pretty_generate Array(array).map(&:to_h).yield_self { |h| { blocks: h } }
+end
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+require "irb/completion"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/slack_template_00.rb

@@ -0,0 +1,46 @@
+[ SectionBlock[text: Text[mrkdwn: [
+    "Hello, Assistant to the Regional Manager Dwight! #{Bold['Michael Scott']} wants to know where you'd like to take the Paper Company investors to dinner tonight.",
+    nil,
+    " #{Bold['Please select a restaurant:']}"
+  ]]],
+  DividerBlock[],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold['Farmhouse Thai Cuisine'],
+      ':star::star::star::star: 1528 reviews',
+      ' They do have some vegan options, like the roti and curry, plus they have a ton of salad stuff and noodles can be ordered without meat!! They have something for everyone here'
+    ]],
+    accessory: ImageElement[
+      image_url: "https://s3-media3.fl.yelpcdn.com/bphoto/c7ed05m9lC2EmA3Aruue7A/o.jpg",
+      alt_text: "alt text for image"
+    ]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold['Kin Khao'],
+      ':star::star::star::star: 1638 reviews',
+      ' The sticky rice also goes wonderfully with the caramelized pork belly, which is absolutely melt-in-your-mouth and so soft.'
+    ]],
+    accessory: ImageElement[
+      image_url: "https://s3-media2.fl.yelpcdn.com/bphoto/korel-1YjNtFtJlMTaC26A/o.jpg",
+      alt_text: "alt text for image"
+    ]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold['Ler Ros'],
+      ':star::star::star::star: 2082 reviews',
+      ' I would really recommend the  Yum Koh Moo Yang - Spicy lime dressing and roasted quick marinated pork shoulder, basil leaves, chili & rice powder.'
+    ]],
+    accessory: ImageElement[
+      image_url: "https://s3-media2.fl.yelpcdn.com/bphoto/DawwNigKJ2ckPeDeDM7jAg/o.jpg",
+      alt_text: "alt text for image"
+    ]
+  ],
+  DividerBlock[],
+  ActionsBlock[elements: [
+    ButtonElement[text: Text[plain_text: 'Farmhouse', emoji: true], value: 'click_me_123'],
+    ButtonElement[text: Text[plain_text: 'Kin Khao', emoji: true], value: 'click_me_123'],
+    ButtonElement[text: Text[plain_text: 'Ler Ros', emoji: true], value: 'click_me_123']
+  ]]
+]

data/examples/slack_template_01.rb

@@ -0,0 +1,22 @@
+[ SectionBlock[text: Text[mrkdwn: [
+    "You have a new request:",
+    Bold[Link['fakeLink.toEmployeeProfile.com', 'Fred Enriquez - New device request']]
+  ]]],
+  SectionBlock[fields: [
+    Text[mrkdwn: [Bold['Type:'], 'Computer (laptop)']],
+    Text[mrkdwn: [Bold['When:'], 'Submitted Aut 10']],
+    Text[mrkdwn: [Bold['Last Update:'], 'Mar 10, 2015 (3 years, 5 months)']],
+    Text[mrkdwn: [Bold['Reason:'], "All vowel keys aren't working."]],
+    Text[mrkdwn: [Bold['Specs:'], '"Cheetah Pro 15" - Fast, really fast"']]
+  ]],
+  ActionsBlock[elements: [
+    ButtonElement[
+      text: Text[plain_text: 'Approve', emoji: true],
+      style: 'primary', value: 'click_me_123'
+    ],
+    ButtonElement[
+      text: Text[plain_text: 'Deny', emoji: true],
+      style: 'danger', value: 'click_me_123'
+    ]
+  ]]
+]

data/examples/slack_template_02.rb

@@ -0,0 +1,28 @@
+[ SectionBlock[text: Text[mrkdwn: [
+    "You have a new request:",
+    Bold[Link['google.com', 'Fred Enriquez - Time Off request']]
+  ]]],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold['Type:'], 'Paid time off',
+      Bold['When:'], 'Aug 10-Aug 13',
+      "#{Bold['Hours:']} 16.0 (2 days)",
+      "#{Bold['Remaining balance:']} 32.0 hours (4 days)",
+      "#{Bold['Comments:']} \"Family in town, going camping!\""
+    ]],
+    accessory: ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/approvalsNewDevice.png",
+      alt_text: "computer thumbnail"
+    ]
+  ],
+  ActionsBlock[elements: [
+    ButtonElement[
+      text: Text[plain_text: 'Approve', emoji: true],
+      style: 'primary', value: 'click_me_123'
+    ],
+    ButtonElement[
+      text: Text[plain_text: 'Deny', emoji: true],
+      style: 'danger', value: 'click_me_123'
+    ]
+  ]]
+]

data/examples/slack_template_03.rb

@@ -0,0 +1,57 @@
+[ SectionBlock[
+    text: Text[plain_text: 'Looks like you have a scheduling conflict with this event:', emoji: true]
+  ],
+  DividerBlock[],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toUserProfiles.com', 'Iris / Zelda 1-1']],
+      "Tuesday, January 21 4:00-4:30pm",
+      "Building 2 - Havarti Cheese (3)",
+      "2 guests"
+    ]],
+    accessory: ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/notifications.png",
+      alt_text: "calendar thumbnail"
+    ]
+  ],
+  ContextBlock[elements: [
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/notificationsWarningIcon.png",
+      alt_text: "notifications warning icon"
+    ],
+    Text[mrkdwn: Bold["Conflicts with Team Huddle: 4:15-4:30pm"]]
+  ]],
+  DividerBlock[],
+  SectionBlock[text: Text[mrkdwn: Bold['Propose a new time:']]],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold['Today - 4:30-5pm'],
+      "Everyone is available: @iris, @zelda"
+    ]],
+    accessory: ButtonElement[
+      text: Text[plain_text: "Choose", emoji: true],
+      value: "click_me_123"
+    ]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold['Tomorrow - 4-4:30pm'],
+      "Everyone is available: @iris, @zelda"
+    ]],
+    accessory: ButtonElement[
+      text: Text[plain_text: "Choose", emoji: true],
+      value: "click_me_123"
+    ]
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold['Tomorrow - 6-6:30pm'],
+      "Some people aren't available: @iris, #{Strike['@zelda']}"
+    ]],
+    accessory: ButtonElement[
+      text: Text[plain_text: "Choose", emoji: true],
+      value: "click_me_123"
+    ]
+  ],
+  SectionBlock[text: Text[mrkdwn: Bold[Link['fakelink.ToMoreTimes.com', 'Show more times']]]]
+]

data/examples/slack_template_04.rb

@@ -0,0 +1,29 @@
+[ SectionBlock[text: Text[mrkdwn: [
+    "Hey there :wave: I'm TaskBot. I'm here to help you create and manage tasks in Slack.",
+    "There are two ways to quickly create tasks:"
+  ]]],
+  SectionBlock[text: Text[mrkdwn: [
+    "#{Bold[":one: Use the #{Code['/task']} command"]}. Type #{Code['/task']} followed by a short description of your tasks and I'll ask for a due date (if applicable). Try it out by using the #{Code['/task']} command in this channel."
+  ]]],
+  SectionBlock[text: Text[mrkdwn: [
+    "#{Bold[":two: Use the #{Italic['Create a Task']} action."]} If you want to create a task from a message, select #{Code['Create a Task']} in a message's context menu. Try it out by selecting the #{Italic['Create a Task']} action for this message (shown below)."
+  ]]],
+  ImageBlock[
+    title: Text[plain_text: "image1", emoji: true],
+    image_url: "https://api.slack.com/img/blocks/bkb_template_images/onboardingComplex.jpg",
+    alt_text: "image1"
+  ],
+  SectionBlock[
+    text: Text[mrkdwn: ":heavy_plus_sign: To start tracking your team's tasks, #{Bold['add me to a channel']} and I'll introduce myself. I'm usually added to a team or project channel. Type #{Code['/invite @TaskBot']} from the channel or pick a channel on the right."],
+    accessory: ConversationsSelectElement[
+      placeholder: Text[plain_text: 'Select a channel...', emoji: true]
+    ]
+  ],
+  DividerBlock[],
+  ContextBlock[elements: [
+    Text[mrkdwn: [
+      ":eyes: View all tasks with #{Code['/task list']}",
+      ":question: Get help at any time with #{Code['/task help']} or type #{Bold['help']} in a DM with me"
+    ]]
+  ]]
+]

data/examples/slack_template_05.rb

@@ -0,0 +1,12 @@
+[ SectionBlock[text: Text[mrkdwn: 'Hi David :wave:']],
+  SectionBlock[text: Text[mrkdwn: "Great to see you here! App helps you to stay up-to-date with your meetings and events right here within Slack. These are just a few things which you will be able to do:"]],
+  SectionBlock[text: Text[mrkdwn: [
+    "• Schedule meetings ",
+    " • Manage and update attendees ",
+    " • Get notified about changes of your meetings"
+  ]]],
+  SectionBlock[text: Text[mrkdwn: "But before you can do all these amazing things, we need you to connect your calendar to App. Simply click the button below:"]],
+  ActionsBlock[elements: [
+    ButtonElement[text: Text[plain_text: 'Connect account', emoji: true], value: 'click_me_123']
+  ]]
+]

data/examples/slack_template_06.rb

@@ -0,0 +1,53 @@
+[ SectionBlock[text: Text[mrkdwn: "#{Bold['Where should we order lunch from?']} Poll by #{Link['fakeLink.toUser.com', 'Mark']}"]],
+  DividerBlock[],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      ":sushi: #{Bold['Ace Wasabi Rock-n-Roll Sushi Bar']}",
+      "The best landlocked sushi restaurant."
+    ]],
+    accessory: ButtonElement[text: Text[plain_text: 'Vote', emoji: true], value: 'click_me_123']
+  ],
+  ContextBlock[elements: [
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/profile_1.png",
+      alt_text: "Michael Scott"
+    ],
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/profile_2.png",
+      alt_text: "Dwight Schrute"
+    ],
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/profile_3.png",
+      alt_text: "Pam Beasely"
+    ],
+    Text[plain_text: "3 votes", emoji: true]
+  ]],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      ":hamburger: #{Bold['Super Hungryman Hamburgers']}",
+      "Only for the hungriest of the hungry."
+    ]],
+    accessory: ButtonElement[text: Text[plain_text: 'Vote', emoji: true], value: 'click_me_123']
+  ],
+  ContextBlock[elements: [
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/profile_4.png",
+      alt_text: "Angela"
+    ],
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/profile_2.png",
+      alt_text: "Dwight Schrute"
+    ],
+    Text[plain_text: "2 votes", emoji: true]
+  ]],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      ":ramen: #{Bold['Kagawa-Ya Udon Noodle Shop']}",
+      "Do you like to shop for noodles? We have noodles."
+    ]],
+    accessory: ButtonElement[text: Text[plain_text: 'Vote', emoji: true], value: "click_me_123"]
+  ],
+  ContextBlock[elements: [Text[mrkdwn: 'No votes']]],
+  DividerBlock[],
+  ActionsBlock[elements: [ButtonElement[text: Text[plain_text: 'Add a suggestion', emoji: true], value: 'click_me_123']]]
+]

data/examples/slack_template_07.rb

@@ -0,0 +1,74 @@
+[ SectionBlock[
+    text: Text[mrkdwn: "We found #{Bold['205 Hotels']} in New Orleans, LA from #{Bold['12/14 to 12/17']}"],
+    accessory: OverflowElement[options: [
+      Option[text: Text[plain_text: 'Option One', emoji: true], value: 'value-0'],
+      Option[text: Text[plain_text: 'Option Two', emoji: true], value: 'value-1'],
+      Option[text: Text[plain_text: 'Option Three', emoji: true], value: 'value-2'],
+      Option[text: Text[plain_text: 'Option Four', emoji: true], value: 'value-3'],
+    ]]
+  ],
+  DividerBlock[],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toHotelPage.com', 'Windsor Court Hotel']],
+      '★★★★★',
+      '$340 per night',
+      'Rated: 9.4 - Excellent'
+    ]],
+    accessory: ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/tripAgent_1.png",
+      alt_text: "Windsor Court Hotel thumbnail"
+    ]
+  ],
+  ContextBlock[elements: [
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/tripAgentLocationMarker.png",
+      alt_text: "Location Pin Icon"
+    ],
+    Text[plain_text: "Location: Central Business District", emoji: true]
+  ]],
+  DividerBlock[],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toHotelPage.com', 'The Ritz-Carlton New Orleans']],
+      '★★★★★',
+      '$340 per night',
+      'Rated: 9.1 - Excellent'
+    ]],
+    accessory: ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/tripAgent_2.png",
+      alt_text: "Ritz-Carlton New Orleans thumbnail"
+    ]
+  ],
+  ContextBlock[elements: [
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/tripAgentLocationMarker.png",
+      alt_text: "Location Pin Icon"
+    ],
+    Text[plain_text: "Location: French Quarter", emoji: true]
+  ]],
+  DividerBlock[],
+  SectionBlock[
+    text: Text[mrkdwn: [
+      Bold[Link['fakeLink.toHotelPage.com', 'Omni Royal Orleans Hotel']],
+      '★★★★★',
+      '$419 per night',
+      'Rated: 8.8 - Excellent'
+    ]],
+    accessory: ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/tripAgent_3.png",
+      alt_text: "Omni Royal Orleans Hotel thumbnail"
+    ]
+  ],
+  ContextBlock[elements: [
+    ImageElement[
+      image_url: "https://api.slack.com/img/blocks/bkb_template_images/tripAgentLocationMarker.png",
+      alt_text: "Location Pin Icon"
+    ],
+    Text[plain_text: "Location: French Quarter", emoji: true]
+  ]],
+  DividerBlock[],
+  ActionsBlock[elements: [
+    ButtonElement[text: Text[plain_text: 'Next 2 Results', emoji: true], value: 'click_me_123']
+  ]]
+]