slack_builder 0.1.0

data/lib/slack_builder/elements/rich_text_elements/broadcast.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../base/element'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class Broadcast < Base::Element
+        TYPE = 'broadcast'
+
+        def initialize(range, ...)
+          @range = range&.to_s
+          super(...)
+        end
+
+        def to_h
+          super.merge(range: @range)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/channel.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../base/element'
+require_relative 'concerns/has_highlight_style'
+require_relative 'concerns/has_style'
+require_relative 'concerns/has_text_style'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class Channel < Base::Element
+        include Concerns::HasStyle
+        include Concerns::HasTextStyle
+        include Concerns::HasHighlightStyle
+
+        TYPE = 'channel'
+
+        def initialize(channel_id, ...)
+          @channel_id = channel_id
+          super(...)
+        end
+
+        def to_h
+          super.merge(channel_id: @channel_id)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/color.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../base/element'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class Color < Base::Element
+        TYPE = 'color'
+
+        def initialize(value, ...)
+          @value = value&.to_s
+          super(...)
+        end
+
+        def to_h
+          super.merge(value: @value)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/concerns/has_highlight_style.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      module Concerns
+        module HasHighlightStyle
+          def initialize(*args, highlight: false, client_highlight: false, unlink: false, **kwargs)
+            super(*args, **kwargs)
+            style.merge!(highlight: highlight, client_highlight: client_highlight, unlink: unlink)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/concerns/has_style.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      module Concerns
+        module HasStyle
+          def initialize(...)
+            @style = {}
+            super
+          end
+
+          def to_h
+            filtered_style.then do |style|
+              style.empty? ? super : super.merge(style: style)
+            end
+          end
+
+          private
+
+          attr_reader :style
+
+          def filtered_style
+            style.select { |_, v| v }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/concerns/has_text_style.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      module Concerns
+        module HasTextStyle
+          def initialize(*args, bold: false, italic: false, strike: false, **kwargs)
+            super(*args, **kwargs)
+            style.merge!(bold: bold, italic: italic, strike: strike)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/date.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../base/element'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class Date < Base::Element
+        TYPE = 'date'
+
+        def initialize(timestamp, format:, url: nil, fallback: nil, **kwargs)
+          @timestamp = timestamp
+          @format = format
+          @url = url unless url.nil?
+          @fallback = fallback unless fallback.nil?
+          super(**kwargs)
+        end
+
+        def to_h
+          super.merge(timestamp: @timestamp, format: @format).tap do |h|
+            h[:url] = @url if defined?(@url)
+            h[:fallback] = @fallback if defined?(@fallback)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/emoji.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../base/element'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class Emoji < Base::Element
+        TYPE = 'emoji'
+
+        def initialize(name, ...)
+          @name = name&.to_s
+          super(...)
+        end
+
+        def to_h
+          super.merge(name: @name)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/link.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'text'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class Link < Text
+        TYPE = 'link'
+
+        def initialize(*args, url:, unsafe: false, **kwargs)
+          @url = url
+          @unsafe = unsafe
+          super(*args, **kwargs)
+        end
+
+        def to_h
+          super.merge(url: @url, unsafe: @unsafe)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/text.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../base/text'
+require_relative 'concerns/has_style'
+require_relative 'concerns/has_text_style'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class Text < Base::Text
+        include Concerns::HasStyle
+        include Concerns::HasTextStyle
+
+        TYPE = 'text'
+
+        def initialize(*args, code: false, **kwargs)
+          super(*args, **kwargs)
+          style.merge!(code: code)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/user.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../base/element'
+require_relative 'concerns/has_highlight_style'
+require_relative 'concerns/has_style'
+require_relative 'concerns/has_text_style'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class User < Base::Element
+        include Concerns::HasStyle
+        include Concerns::HasTextStyle
+        include Concerns::HasHighlightStyle
+
+        TYPE = 'user'
+
+        def initialize(user_id, ...)
+          @user_id = user_id
+          super(...)
+        end
+
+        def to_h
+          super.merge(user_id: @user_id)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/rich_text_elements/usergroup.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../base/element'
+require_relative 'concerns/has_highlight_style'
+require_relative 'concerns/has_style'
+require_relative 'concerns/has_text_style'
+
+module SlackBuilder
+  module Elements
+    module RichTextElements
+      class Usergroup < Base::Element
+        include Concerns::HasStyle
+        include Concerns::HasTextStyle
+        include Concerns::HasHighlightStyle
+
+        TYPE = 'usergroup'
+
+        def initialize(usergroup_id, ...)
+          @usergroup_id = usergroup_id
+          super(...)
+        end
+
+        def to_h
+          super.merge(usergroup_id: @usergroup_id)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/section.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'base/element'
+require_relative 'base/concerns/has_elements'
+require_relative 'interactive_elements/button'
+require_relative 'text_elements/markdown'
+require_relative 'text_elements/plain_text'
+require_relative 'image'
+
+module SlackBuilder
+  module Elements
+    class Section < Base::Element
+      include Base::Concerns::HasElements
+
+      TYPE = 'section'
+      ELEMENTS_KEY_NAME = :fields
+
+      class Accessory
+        private_class_method :new
+
+        def self.build(&blk)
+          new.instance_exec(&blk)
+        end
+
+        private
+
+        def button(...)
+          InteractiveElements::Button.new(...)
+        end
+
+        def image(...)
+          Image.new(...)
+        end
+      end
+
+      def initialize(text = nil, verbatim: false, **kwargs, &blk)
+        @text = TextElements::Markdown.new(text, verbatim: verbatim) unless text.nil?
+        super(**kwargs, &blk)
+      end
+
+      def to_h
+        super.tap do |h|
+          h.delete(ELEMENTS_KEY_NAME) if empty?
+          h[:text] = @text.to_h if defined?(@text)
+          h[:accessory] = @accessory.to_h if defined?(@accessory)
+        end
+      end
+
+      def accessory(...)
+        @accessory = Accessory.build(...) if block_given?
+      end
+
+      def mrkdwn(...)
+        add TextElements::Markdown.new(...)
+      end
+
+      def plain_text(...)
+        add TextElements::PlainText.new(...)
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/text_elements/markdown.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../base/text'
+
+module SlackBuilder
+  module Elements
+    module TextElements
+      class Markdown < Base::Text
+        TYPE = 'mrkdwn'
+
+        def initialize(*args, verbatim: false, **kwargs)
+          @verbatim = verbatim
+          super(*args, **kwargs)
+        end
+
+        def to_h
+          super.merge(verbatim: @verbatim)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/text_elements/plain_text.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../base/text'
+
+module SlackBuilder
+  module Elements
+    module TextElements
+      class PlainText < Base::Text
+        TYPE = 'plain_text'
+
+        def initialize(*args, emoji: true, **kwargs)
+          @emoji = emoji
+          super(*args, **kwargs)
+        end
+
+        def to_h
+          super.merge(emoji: @emoji)
+        end
+      end
+    end
+  end
+end

data/lib/slack_builder/elements/video.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'base/element'
+require_relative 'text_elements/plain_text'
+
+module SlackBuilder
+  module Elements
+    class Video < Base::Element
+      TYPE = 'video'
+
+      def initialize(video_url, thumbnail_url:, alt_text:, title:, emoji: true, **kwargs)
+        @video_url = video_url
+        @thumbnail_url = thumbnail_url
+        @alt_text = alt_text
+        @title = TextElements::PlainText.new(title, emoji: emoji)
+        super(**kwargs)
+      end
+
+      def to_h
+        super.merge(
+          video_url: @video_url,
+          thumbnail_url: @thumbnail_url,
+          alt_text: @alt_text,
+          title: @title.to_h
+        )
+      end
+    end
+  end
+end

data/lib/slack_builder/message.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'attachment'
+require_relative 'elements/actions'
+require_relative 'elements/divider'
+require_relative 'elements/header'
+require_relative 'elements/image'
+require_relative 'elements/context'
+require_relative 'elements/rich_text'
+require_relative 'elements/section'
+require_relative 'elements/video'
+require_relative 'elements/base/concerns/has_elements'
+
+module SlackBuilder
+  class Message
+    include Elements::Base::Concerns::HasElements
+
+    def initialize(text = nil, &blk)
+      @text = text unless text.nil?
+      @attachments = []
+      super(&blk)
+    end
+
+    def to_h
+      {}.tap do |h|
+        h[:text] = @text if @text
+        h[:blocks] = to_a if any?
+        h[:attachments] = @attachments.map(&:to_h) if @attachments.any?
+      end
+    end
+
+    def attachment(...)
+      return unless block_given?
+
+      Attachment.new(...).tap do |a|
+        @attachments << a
+      end
+    end
+
+    def actions(...)
+      add Elements::Actions.new(...) if block_given?
+    end
+
+    def context(...)
+      add Elements::Context.new(...) if block_given?
+    end
+
+    def divider(...)
+      add Elements::Divider.new(...)
+    end
+
+    def header(...)
+      add Elements::Header.new(...)
+    end
+
+    def image(...)
+      add Elements::Image.new(...)
+    end
+
+    def rich_text(...)
+      add Elements::RichText.new(...) if block_given?
+    end
+
+    def section(...)
+      add Elements::Section.new(...)
+    end
+
+    def video(...)
+      add Elements::Video.new(...)
+    end
+  end
+end

data/lib/slack_builder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SlackBuilder
+  VERSION = '0.1.0'
+end

data/lib/slack_builder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'slack_builder/attachment'
+require_relative 'slack_builder/message'
+require_relative 'slack_builder/version'
+
+module SlackBuilder
+  def self.attachment(...)
+    Attachment.new(...)
+  end
+
+  def self.message(...)
+    Message.new(...)
+  end
+end

data/slack_builder.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/slack_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'slack_builder'
+  spec.version = SlackBuilder::VERSION
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.authors = ['cyb-']
+  spec.email = ['gchateau@student.42.fr']
+
+  spec.summary = 'Slack API payload builder DSL'
+  spec.description = 'Slack API builder to easily build blocks message payloads with a comfortable DSL'
+  spec.homepage = 'https://github.com/cyb-/slack-builder'
+  spec.license = 'MIT'
+
+  spec.metadata = {
+    'bug_tracker_uri'       => 'https://github.com/cyb-/slack-builder/issues',
+    'changelog_uri'         => 'https://github.com/cyb-/slack-builder/blob/main/CHANGELOG.md',
+    'documentation_uri'     => 'https://github.com/cyb-/slack-builder/blob/main/README.md',
+    'github_repo'           => 'ssh://github.com/cyb-/slack-builder',
+    'homepage_uri'          => spec.homepage,
+    'source_code_uri'       => 'https://github.com/cyb-/slack-builder',
+    'rubygems_mfa_required' => 'true',
+  }
+
+  ignored = Regexp.union(
+    /\A\.circleci/,
+    /\A\.git/,
+    /\A\.rubocop/,
+    /\A\.rspec/,
+    /\Abin/,
+    /\Aspec/,
+    /\AGemfile/,
+    /\ARakefile/
+  )
+  spec.files = `git ls-files`.split("\n").grep_v(ignored)
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: slack_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cyb-
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-15 00:00:00.000000000 Z
+dependencies: []
+description: Slack API builder to easily build blocks message payloads with a comfortable
+  DSL
+email:
+- gchateau@student.42.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/slack_builder.rb
+- lib/slack_builder/attachment.rb
+- lib/slack_builder/elements/actions.rb
+- lib/slack_builder/elements/base/concerns/has_elements.rb
+- lib/slack_builder/elements/base/element.rb
+- lib/slack_builder/elements/base/text.rb
+- lib/slack_builder/elements/context.rb
+- lib/slack_builder/elements/divider.rb
+- lib/slack_builder/elements/header.rb
+- lib/slack_builder/elements/image.rb
+- lib/slack_builder/elements/interactive_elements/button.rb
+- lib/slack_builder/elements/rich_text.rb
+- lib/slack_builder/elements/rich_text_elements/broadcast.rb
+- lib/slack_builder/elements/rich_text_elements/channel.rb
+- lib/slack_builder/elements/rich_text_elements/color.rb
+- lib/slack_builder/elements/rich_text_elements/concerns/has_highlight_style.rb
+- lib/slack_builder/elements/rich_text_elements/concerns/has_style.rb
+- lib/slack_builder/elements/rich_text_elements/concerns/has_text_style.rb
+- lib/slack_builder/elements/rich_text_elements/date.rb
+- lib/slack_builder/elements/rich_text_elements/emoji.rb
+- lib/slack_builder/elements/rich_text_elements/link.rb
+- lib/slack_builder/elements/rich_text_elements/text.rb
+- lib/slack_builder/elements/rich_text_elements/user.rb
+- lib/slack_builder/elements/rich_text_elements/usergroup.rb
+- lib/slack_builder/elements/section.rb
+- lib/slack_builder/elements/text_elements/markdown.rb
+- lib/slack_builder/elements/text_elements/plain_text.rb
+- lib/slack_builder/elements/video.rb
+- lib/slack_builder/message.rb
+- lib/slack_builder/version.rb
+- slack_builder.gemspec
+homepage: https://github.com/cyb-/slack-builder
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/cyb-/slack-builder/issues
+  changelog_uri: https://github.com/cyb-/slack-builder/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/cyb-/slack-builder/blob/main/README.md
+  github_repo: ssh://github.com/cyb-/slack-builder
+  homepage_uri: https://github.com/cyb-/slack-builder
+  source_code_uri: https://github.com/cyb-/slack-builder
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Slack API payload builder DSL
+test_files: []