line-message-builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37235cb021f9418afaad94d10737c24c596203d412f9bccf8024caaec829bc2e
+  data.tar.gz: 0fb0fd5faf9b3c56a8c2a08d4dc72f39fa36b540a8e5f72f57358a392b7efe11
+SHA512:
+  metadata.gz: aac9d97a2edb4d90059f76d8716d768af138dbb411d65f3d16057da227be00ab6b8dd26af09ac96c4ee476f8b30343922b6294e9e4956155ad38f237b5fa4020
+  data.tar.gz: fedb66cb7216b45ba2afebe70b9acb5fd1a7fa428f9b2508601229239ac5bd4004e842324432b787dd752474805a68d9e40354b02170352cbbf3d2c4aa80d5e0

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CONVENTIONS.md

@@ -0,0 +1,45 @@
+# Coding Guideline
+
+These are coding guidelines that should be followed when writing code for this gem.
+
+## Introduction
+
+This gem is designed to provide DSL (Domain Specific Language) for building LINE messaging API reply messages.
+
+## Naming Conventions
+
+- Use `snake_case` for method names and variable names.
+- Use `CamelCase` for class names.
+- Use `UPPER_SNAKE_CASE` for constants.
+
+## Comments
+
+Only use comments for RDoc documentation. Do not use comments to explain anything in the code. The code should be self-explanatory. If you find yourself needing to write a comment to explain something, consider refactoring the code instead.
+
+## RSpec
+
+- Write feature tests instead of unit tests, use `Line::Message::Builder` as test subject to verify the behavior of the DSL.
+- Don't require any files in your spec files. RSpec will automatically require the necessary files for you.
+- Each example should only have one assertion.
+- Prefer `it { is_expected.to ... }` over `expect(...)` syntax.
+- Use `subject` to define the object under test.
+```ruby
+describe "#build" do
+  subject { builder.build }
+end
+```
+- Use `let` to override the subject if needed.
+```ruby
+let(:builder) { described_class.new }
+```
+
+- Name subject if needed.
+```ruby
+subject(:builder) { described_class.new }
+
+describe "#build" do
+  subject { builder.build }
+
+  it { is_expected.to be_a Array }
+end
+```

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Aotokitsuruya
+
+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,136 @@
+# LINE Message Builder
+
+Build LINE messages using DSL (Domain Specific Language) in Ruby.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add line-message-builder
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install line-message-builder
+```
+
+## Usage
+
+> [!NOTE]
+> Working in progress.
+
+### Builder
+
+```ruby
+builder = Line::MessageBuilder::Builder.new do
+    text "Hello, world!"
+end
+
+pp builder.build
+# => [{ type: "text", text: "Hello, world!" }]
+
+puts builder.to_json
+# => {"type":"text","text":"Hello, world!"}
+```
+
+### Context
+
+The context can make `Builder` to access additional methods and variables.
+
+```ruby
+context = OpenStruct.new(
+    name: "John Doe",
+)
+
+builder = Line::MessageBuilder::Builder.new(context) do
+    text "Hello, #{name}!"
+end
+
+pp builder.build
+# => [{ type: "text", text: "Hello, John Doe!" }]
+
+puts builder.to_json
+# => {"type":"text","text":"Hello, John Doe!"}
+```
+
+For Rails, you can use `view_context` to make `Builder` to access Rails helpers.
+
+```ruby
+# app/controllers/line_controller.rb
+builder = Line::MessageBuilder::Builder.new(view_context) do
+    text "Anything you want?" do
+        quick_reply do
+            action "Yes", label: "Yes", image_url: image_url("yes.png")
+            action "No", label: "No", image_url: image_url("no.png")
+        end
+    end
+end
+```
+
+If not in controller, you can create a `ActionView::Base` instance and pass it to `Builder`.
+
+```ruby
+# app/presenters/line_presenter.rb
+context = ActionView::Base.new(
+    ActionController::Base.view_paths,
+    {},
+    ActionController::Base.new,
+)
+
+builder = Line::MessageBuilder::Builder.new(context) do
+    text "Anything you want?" do
+        quick_reply do
+            action "Yes", label: "Yes", image_url: context.image_url("yes.png")
+            action "No", label: "No", image_url: context.image_url("no.png")
+        end
+    end
+end
+```
+
+## Capabilities
+
+### Message Types
+
+| Type     | Supported |
+| ----     | --------- |
+| Text     | ✅        |
+| Text v2  | ❌        |
+| Sticker  | ❌        |
+| Sticker  | ❌        |
+| Image    | ❌        |
+| Video    | ❌        |
+| Audio    | ❌        |
+| Location | ❌        |
+| Imagemap | ❌        |
+| Template | ❌        |
+| Flex     | ❌        |
+
+### Actions
+
+| Action Type     | Supported |
+| -----------     | --------- |
+| Postback        | ✅        |
+| Message         | ✅        |
+| Uri             | ❌        |
+| Datetime        | ❌        |
+| Camera          | ❌        |
+| CameraRoll      | ❌        |
+| Location        | ❌        |
+| Richmenu Switch | ❌        |
+| Clipboard       | ❌        |
+
+## 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 on GitHub at https://github.com/elct9620/line-message-builder.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/line/message/builder/actions/message.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    class Builder
+      module Actions
+        # The Message class is used to build message actions for quick replies.
+        class Message < Line::Message::Builder::Base
+          def initialize(text: nil, label: nil, context: nil, &)
+            @text = text
+            @label = label
+
+            super(context: context, &)
+          end
+
+          def label(label)
+            @label = label
+          end
+
+          def text(text)
+            @text = text
+          end
+
+          def to_h
+            {
+              type: "message",
+              label: @label,
+              text: @text
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/actions/postback.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    class Builder
+      module Actions
+        # The Postback class is used to build postback actions for quick replies.
+        class Postback < Line::Message::Builder::Base
+          def initialize(data: nil, label: nil, display_text: nil, context: nil, &)
+            @data = data
+            @label = label
+            @display_text = display_text
+
+            super(context: context, &)
+          end
+
+          def label(label)
+            @label = label
+          end
+
+          def data(data)
+            @data = data
+          end
+
+          def display_text(display_text)
+            @display_text = display_text
+          end
+
+          def to_h
+            {
+              type: "postback",
+              label: @label,
+              data: @data,
+              displayText: @display_text
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/actions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    class Builder
+      # The actions module contains classes for building different types of actions
+      module Actions
+        require_relative "actions/message"
+        require_relative "actions/postback"
+      end
+    end
+  end
+end

data/lib/line/message/builder/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    class Builder
+      # The base class to provide DSL functionality.
+      class Base
+        attr_reader :context
+
+        def initialize(context: nil, &block)
+          @context = context
+
+          instance_eval(&block) if ::Kernel.block_given?
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          context.respond_to?(method_name, include_private) || super
+        end
+
+        def method_missing(method_name, ...)
+          if context.respond_to?(method_name)
+            context.public_send(method_name, ...)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/quick_reply/builder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    class Builder
+      module QuickReply
+        # The Builder class is used to build quick reply buttons.
+        class Builder < Line::Message::Builder::Base
+          def initialize(context: nil, &)
+            @items = []
+
+            super
+          end
+
+          def message(text, label:, image_url: nil, &)
+            action(
+              Actions::Message.new(text: text, label: label, &).to_h,
+              image_url
+            )
+          end
+
+          def postback(data, label: nil, display_text: nil, image_url: nil, &)
+            action(
+              Actions::Postback.new(data: data, label: label, display_text: display_text, &).to_h,
+              image_url
+            )
+          end
+
+          def to_h
+            { items: @items.map(&:to_h) }
+          end
+
+          private
+
+          def action(action, image_url)
+            @items << {
+              type: "action",
+              imageUrl: image_url,
+              action: action
+            }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/quick_reply.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    class Builder
+      # The QuickReply allows to attach quick reply buttons to a message.
+      module QuickReply
+        require_relative "quick_reply/builder"
+
+        def quick_reply(&)
+          @quick_reply ||= Builder.new(context: context, &)
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/text.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    class Builder
+      # Text message builder.
+      class Text < Base
+        include QuickReply
+
+        def initialize(text, context: nil, &block)
+          @text = text
+
+          super(context: context, &block)
+        end
+
+        def to_h
+          {
+            type: "text",
+            text: @text,
+            quickReply: @quick_reply&.to_h
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/line/message/builder/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Line
+  module Message
+    class Builder
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/line/message/builder.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "builder/version"
+
+module Line
+  module Message
+    # The Builder module provides a DSL for building LINE messages.
+    class Builder
+      class Error < StandardError; end
+
+      require_relative "builder/base"
+      require_relative "builder/actions"
+      require_relative "builder/quick_reply"
+      require_relative "builder/text"
+
+      attr_reader :context
+
+      def initialize(context = nil, &)
+        @messages = []
+        @context = context
+
+        instance_eval(&) if ::Kernel.block_given?
+      end
+
+      def text(text)
+        @messages << Text.new(text, context: context)
+      end
+
+      def build
+        @messages.map(&:to_h)
+      end
+
+      def to_json(*args)
+        build.to_json(*args)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        context.respond_to?(method_name, include_private) || super
+      end
+
+      def method_missing(method_name, ...)
+        if context.respond_to?(method_name)
+          context.public_send(method_name, ...)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/line/message/rspec/matchers/have_text_message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_line_text_message do |expected|
+  match do |actual|
+    actual.each do |message|
+      next unless message[:type] == "text"
+
+      return true if message[:text].match?(expected)
+    end
+
+    false
+  end
+
+  failure_message do |_actual|
+    "expected to find a text message matching #{expected}"
+  end
+end

data/lib/line/message/rspec/matchers.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "matchers/have_text_message"

data/lib/line/message/rspec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "line/message/rspec/matchers"

data/release-please-config.json

@@ -0,0 +1,10 @@
+{
+  "release-type": "ruby",
+  "packages": {
+    ".":{
+        "component": "line-message-builder",
+        "include-component-in-tag": false,
+        "release-type": "ruby"
+      }
+  }
+}

data/sig/line/message/builder.rbs

@@ -0,0 +1,8 @@
+module Line
+  module Message
+    module Builder
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: line-message-builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aotokitsuruya
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-04 00:00:00.000000000 Z
+dependencies: []
+description: The LINE Messaging API message builder.
+email:
+- contact@aotoki.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CONVENTIONS.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/line/message/builder.rb
+- lib/line/message/builder/actions.rb
+- lib/line/message/builder/actions/message.rb
+- lib/line/message/builder/actions/postback.rb
+- lib/line/message/builder/base.rb
+- lib/line/message/builder/quick_reply.rb
+- lib/line/message/builder/quick_reply/builder.rb
+- lib/line/message/builder/text.rb
+- lib/line/message/builder/version.rb
+- lib/line/message/rspec.rb
+- lib/line/message/rspec/matchers.rb
+- lib/line/message/rspec/matchers/have_text_message.rb
+- release-please-config.json
+- sig/line/message/builder.rbs
+homepage: https://github.com/elct9620/line-message-builder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/elct9620/line-message-builder
+  source_code_uri: https://github.com/elct9620/line-message-builder/tree/main
+  changelog_uri: https://github.com/elct9620/line-message-builder/blob/main/CHANGELOG.md
+  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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: The LINE Messaging API message builder.
+test_files: []