slack_block_kit 0.1.0 → 0.2.0

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

@@ -3,12 +3,36 @@
 module Slack
   module BlockKit
     module Layout
+      # Displays message context, which can include both images and text.
+      #
+      # https://api.slack.com/reference/messaging/blocks#context
       class Context
         TYPE = 'context'
 
-        def initialize(elements:, block_id: nil)
-          @elements = elements
+        attr_accessor :elements
+        def initialize(block_id: nil)
           @block_id = block_id
+          @elements = []
+
+          yield(self) if block_given?
+        end
+
+        def image(url:, alt_text:)
+          append(Element::Image.new(image_url: url, alt_text: alt_text))
+        end
+
+        def plain_text(text:, emoji: nil)
+          append(Composition::PlainText.new(text: text, emoji: emoji))
+        end
+
+        def mrkdwn(text:, verbatim: nil)
+          append(Composition::Mrkdwn.new(text: text, verbatim: verbatim))
+        end
+
+        def append(element)
+          @elements << element
+
+          self
         end
 
         def as_json(*)

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

@@ -3,6 +3,10 @@
 module Slack
   module BlockKit
     module Layout
+      # A content divider, like an <hr>, to split up different blocks inside of
+      # a message.
+      #
+      # https://api.slack.com/reference/messaging/blocks#divider
       class Divider
         TYPE = 'divider'
 

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

@@ -3,14 +3,23 @@
 module Slack
   module BlockKit
     module Layout
+      # A simple image block, designed to make those cat photos really pop.
+      #
+      # https://api.slack.com/reference/messaging/blocks#context
       class Image
         TYPE = 'image'
 
-        def initialize(image_url:, alt_text:, title: nil, block_id: nil)
-          @image_url = image_url
+        def initialize(url:, alt_text:, title: nil, block_id: nil, emoji: nil)
+          @image_url = url
           @alt_text = alt_text
-          @title = title
           @block_id = block_id
+
+          return unless title
+
+          @title = Composition::PlainText.new(
+            text: title,
+            emoji: emoji
+          )
         end
 
         def as_json(*)

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

@@ -3,14 +3,158 @@
 module Slack
   module BlockKit
     module Layout
+      # A section is one of the most flexible blocks available - it can be used
+      # as a simple text block, in combination with text fields, or side-by-side
+      # with any of the available block elements.
+      #
+      # https://api.slack.com/reference/messaging/blocks#section
       class Section
         TYPE = 'section'
 
-        def initialize(text:, block_id: nil, fields: nil, accessory: nil)
-          @text = text
+        attr_accessor :fields, :text, :accessory
+
+        def initialize(block_id: nil)
           @block_id = block_id
-          @fields = fields
-          @accessory = accessory
+
+          yield(self) if block_given?
+        end
+
+        def plaintext_field(text:, emoji: nil)
+          @fields ||= []
+
+          @fields << Composition::PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def mrkdwn_field(text:, verbatim: nil)
+          @fields ||= []
+
+          @fields << Composition::Mrkdwn.new(text: text, verbatim: verbatim)
+
+          self
+        end
+
+        def plain_text(text:, emoji: nil)
+          @text = Composition::PlainText.new(text: text, emoji: emoji)
+
+          self
+        end
+
+        def mrkdwn(text:, verbatim: nil)
+          @text = Composition::Mrkdwn.new(text: text, verbatim: verbatim)
+
+          self
+        end
+
+        def button(text:, action_id:, emoji: nil, url: nil, value: nil)
+          element = Element::Button.new(
+            text: text,
+            action_id: action_id,
+            emoji: emoji,
+            url: url,
+            value: value
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def channel_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::ChannelsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def converstation_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::ConversationsSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def date_picker(action_id:, placeholder: nil, initial: nil, emoji: nil)
+          element = Element::DatePicker.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def external_select(placeholder:, action_id:, initial: nil, min_query_length: nil, emoji: nil)
+          element = Element::ExternalSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            initial: initial,
+            min_query_length: min_query_length,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def overflow_menu(action_id:)
+          element = Element::OverflowMenu.new(action_id: action_id)
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def static_select(placeholder:, action_id:, emoji: nil)
+          element = Element::StaticSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            emoji: emoji
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def users_select(placeholder:, action_id:, initial: nil, emoji: nil)
+          element = Element::UsersSelect.new(
+            placeholder: placeholder,
+            action_id: action_id,
+            emoji: emoji,
+            initial: initial
+          )
+
+          yield(element) if block_given?
+
+          accessorise(element)
+        end
+
+        def image(url:, alt_text:)
+          accessorize(Element::Image.new(image_url: url, alt_text: alt_text))
+        end
+
+        def accessorise(element)
+          @accessory = element
+
+          self
         end
 
         def as_json(*)

data/lib/slack_block_kit.rb

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

data/slack_block_kit.gemspec

@@ -2,7 +2,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'slack/block_kit'
+require 'slack_block_kit'
 
 Gem::Specification.new do |spec|
   spec.name          = 'slack_block_kit'
@@ -31,5 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '< 2.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_block_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Christian Gregg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-03 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - c_arlt@hotmail.com
@@ -73,7 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Gemfile
@@ -82,10 +112,12 @@ files:
 - README.md
 - Rakefile
 - lib/slack/block_kit.rb
+- lib/slack/block_kit/blocks.rb
 - lib/slack/block_kit/composition/confirmation_dialog.rb
+- lib/slack/block_kit/composition/mrkdwn.rb
 - lib/slack/block_kit/composition/option.rb
 - lib/slack/block_kit/composition/option_group.rb
-- lib/slack/block_kit/composition/text.rb
+- lib/slack/block_kit/composition/plain_text.rb
 - lib/slack/block_kit/element/button.rb
 - lib/slack/block_kit/element/channels_select.rb
 - lib/slack/block_kit/element/conversations_select.rb
@@ -100,6 +132,7 @@ files:
 - lib/slack/block_kit/layout/divider.rb
 - lib/slack/block_kit/layout/image.rb
 - lib/slack/block_kit/layout/section.rb
+- lib/slack_block_kit.rb
 - slack_block_kit.gemspec
 homepage: https://github.com/CGA1123/slack_block_kit-ruby
 licenses:

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Slack
-  module BlockKit
-    module Composition
-      class Text
-        def initialize(type:, text:, emoji: nil, verbatim: nil)
-          @type = type
-          @text = text
-          @emoji = emoji
-          @verbatim = verbatim
-        end
-
-        def self.plaintext(text:, emoji: nil)
-          new(
-            type: 'plain_text',
-            text: text,
-            emoji: emoji
-          )
-        end
-
-        def self.markdown(text:, verbatim: nil)
-          new(
-            type: 'mrkdwn',
-            text: text,
-            verbatim: verbatim
-          )
-        end
-
-        def as_json(*)
-          {
-            type: @type,
-            text: @text,
-            emoji: @emoji,
-            verbatim: @verbatim
-          }.compact
-        end
-      end
-    end
-  end
-end