slack_layout 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94f52b39278f2b8041c9eb59e825762eda643641079d0edf9fd6e4fbc85ab8a0
+  data.tar.gz: dc645ceda8745a0646b7991a85ce819d8ad4f4f7a17534c38fe752654ffd29d8
+SHA512:
+  metadata.gz: c0b6428a6a0933561f404cf0daae32f9b19261e7f5a0898aaeef7046a4275035c97428458087c177123b3c196054e4c960c0800abe41703dbd310cc6b5ef43cd
+  data.tar.gz: 4efb710581809828e9d2e832b419b20d285ad73bd19cb3dc6bd8e0c064a29617c234545f9c6723174e05164c11db69eb514b2ace091e0ad552754217d7fa2e18

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slack_layout.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "slack-ruby-client"
+gem "slack-ruby-block-kit"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    slack_layout (0.1.0)
+      slack-ruby-block-kit
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    faraday (2.7.10)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-mashify (0.1.1)
+      faraday (~> 2.0)
+      hashie
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
+    gli (2.21.1)
+    hashie (5.0.0)
+    multipart-post (2.3.0)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
+    slack-ruby-block-kit (0.21.0)
+      zeitwerk (~> 2.6)
+    slack-ruby-client (2.1.0)
+      faraday (>= 2.0)
+      faraday-mashify
+      faraday-multipart
+      gli
+      hashie
+    zeitwerk (2.6.9)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  slack-ruby-block-kit
+  slack-ruby-client
+  slack_layout!
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Borja Garcia de Vinuesa
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Borja GVO
+
+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,139 @@
+# SlackLayout
+
+A ruby gem that makes building Slack's BlockKit layouts easy while keeping everything organized.
+
+It leverages [Slack::BlockKit](https://github.com/CGA1123/slack-ruby-block-kit) by providing an inheritance pattern that makes building new layouts convenient and fast.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_layout'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install slack_layout
+
+## Usage
+To create a new layout create a new class that inherits from `SlackLayout`. For example:
+
+```ruby
+class MyCustomSlackLayout < SlackLayout
+  attr_reader :param1, :param2
+
+  def initialize(param1, param2)
+    @param1 = param1
+    @param2 = param2
+    super()
+  end
+
+  def blocks
+    section do |section|
+      section.mrkdwn_field text: param1
+    end
+
+    actions do |actions|
+      actions.button(
+        text: "Archive Now!",
+        style: "danger",
+        value: param2,
+        action_id: "archive_now",
+        emoji: true,
+      )
+
+      actions.button(
+        text: "Snooze 14 days",
+        style: "primary",
+        value: param2,
+        action_id: "archive_snooze",
+        emoji: true,
+      )
+    end
+  end
+end
+```
+Then you can use it anywhere in your code:
+
+```ruby
+param1 = "22"
+param2 = "Anything you want to use in your layout"
+layout = MyCustomSlackLayout.new(param1, param2)
+```
+
+Now, you can access the layout json that Slack needs to be sent by calling `as_json` on the layout:
+
+```ruby
+layout.as_json
+```
+
+Which will produce the following json:
+
+```json
+[
+  {
+    "type": "section",
+    "fields": [
+      {
+        "type": "mrkdwn",
+        "text": "The message for a custom layout"
+      }
+    ]
+  },
+  {
+    "type": "actions",
+    "elements": [
+      {
+        "type": "button",
+        "text": {
+          "type": "plain_text",
+          "text": "Archive Now!",
+          "emoji": true
+        },
+        "action_id": "archive_now",
+        "value": "22",
+        "style": "danger"
+      },
+      {
+        "type": "button",
+        "text": {
+          "type": "plain_text",
+          "text": "Snooze 14 days",
+          "emoji": true
+        },
+        "action_id": "archive_snooze",
+        "value": "22",
+        "style": "primary"
+      }
+    ]
+  }
+]
+```
+
+Then, use it anywhere in Slack. For example, you could use it to extend the functionality of a message in one of your Slack channels.
+
+```ruby
+# Assuming $slack is an already initialized Slack ruby client
+$slack.chat_postMessage(channel: channel_id, blocks: layout.as_json)
+```
+
+For a complete guide on building with Block Kit, please visit https://api.slack.com/block-kit.
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/bgvo/slack_layout.
+
+## 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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "slack_layout"
+
+# 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"
+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/lib/slack_layout/version.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+VERSION = "0.1.2"

data/lib/slack_layout.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "slack_layout/version"
+require "slack-ruby-block-kit"
+
+class SlackLayout
+  attr_accessor :layout
+
+  def initialize
+    Slack::BlockKit.blocks do |layout|
+      @layout = layout
+    end
+    build
+  end
+
+  def build
+    blocks
+  end
+
+  def blocks
+    raise NotImplementedError
+  end
+
+  def as_json
+    layout.as_json
+  end
+
+  def method_missing(method, *args, &block)
+    layout.send(method, *args, &block)
+  end
+end

data/slack_layout.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/slack_layout/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "slack_layout"
+  spec.version = VERSION
+  spec.authors = ["Borja Garcia de Vinuesa Ordovas"]
+  spec.email = ["hi@bgvo.io"]
+
+  spec.summary = "Build Slack layouts with ease using BlockKit"
+  spec.description = "Pretty easy to use gem to build Slack layouts using BlockKit."
+  spec.homepage = "https://bgvo.io"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_runtime_dependency "slack-ruby-block-kit"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: slack_layout
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Borja Garcia de Vinuesa Ordovas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-block-kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pretty easy to use gem to build Slack layouts using BlockKit.
+email:
+- hi@bgvo.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_layout.rb
+- lib/slack_layout/version.rb
+- slack_layout.gemspec
+homepage: https://bgvo.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bgvo.io
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Build Slack layouts with ease using BlockKit
+test_files: []