rubord 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73d40380336ec0be54afd05fa19a6177fcfc25d16d335c7748da02de95da4538
+  data.tar.gz: ad7c6cb4f6ab3aae3019e213bda0d4dc0d5dc6307aaa89626f4e2e594daad7e3
+SHA512:
+  metadata.gz: 893c48fbcba9541e21c95d47076c6e427d6191638b11064ae59d99f4b8ec82bb606bbcb8a396c5da62c517c60d2a4ac85dfd91540270d1621fc2150337675ce1
+  data.tar.gz: c6b3a468ebf4fa9e9631fb1459e618908102d4c1820c70142d73cc7d0bbda27c23f874db774fc3be973ae88d72b4743d936e19b9a6442913e6d5f4492970a455

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kauã Eduardo
+
+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,39 @@
+# Rubord
+
+Rubord is a modern Ruby library for building Discord bots.
+
+It provides:
+- Gateway (WebSocket)
+- REST API
+- Interactions (Buttons, Modals, Select Menus)
+- Components v2 support
+
+## Installation
+
+```bash
+gem install rubord
+```
+
+Or in your Gemfile:
+
+```rb
+gem "rubord"
+```
+
+## Basic Example
+
+```rb
+client = Rubord::Client.new(intents: 3276799)
+
+client.on(:ready) do |client|
+  puts "Logged in: " + client.username
+end
+
+client.on(:message_create) do |message|
+  if message.content == "!hello"
+    message.reply("Hello!")
+  end
+end
+
+client.login("Your discord bot token")
+```

data/lib/rubord/components/actionRow.rb

@@ -0,0 +1,93 @@
+# components/actionRow.rb
+
+module Rubord
+  # Represents a Discord action row container.
+  #
+  # Action rows are containers for message components (buttons, select menus).
+  # They can hold up to 5 buttons or 1 select menu per row.
+  #
+  # @example Creating an action row with buttons
+  #   row = Rubord::ActionRow.new(
+  #     Rubord::Button.new(label: "Yes", custom_id: "yes"),
+  #     Rubord::Button.new(label: "No", custom_id: "no")
+  #   )
+  #
+  # @example Creating an empty row and adding components
+  #   row = Rubord::ActionRow.new
+  #   row.add(Rubord::Button.new(label: "Click", custom_id: "click"))
+  #
+  # @since 1.0.0
+  # @see https://discord.com/developers/docs/interactions/message-components#action-rows
+  class ActionRow
+    # @return [Integer] Component type (always 1 for action rows).
+    attr_accessor :type
+    
+    # @return [Array<Button, SelectMenu>] Components in this action row.
+    attr_accessor :components
+
+    # Creates a new action row.
+    #
+    # @param components [Array<Button, SelectMenu>] Components to include in the row.
+    #   Can be empty.
+    #
+    # @example Empty action row
+    #   ActionRow.new
+    #
+    # @example With initial buttons
+    #   ActionRow.new(
+    #     Button.new(label: "Save", custom_id: "save"),
+    #     Button.new(label: "Cancel", custom_id: "cancel")
+    #   )
+    #
+    # @note Action rows can contain either:
+    #   - Up to 5 buttons
+    #   - OR 1 select menu
+    #   Not a mixture of both.
+    def initialize(*components)
+      @type = 1
+      @components = components
+    end
+
+    # Adds a component to the action row.
+    #
+    # @param component [Button, SelectMenu] Component to add.
+    #
+    # @return [Rubord::ActionRow] Self for method chaining.
+    #
+    # @raise [ArgumentError] If adding component would violate Discord limits.
+    #
+    # @example
+    #   row = ActionRow.new
+    #   row.add(Button.new(label: "Test", custom_id: "test"))
+    def add(component)
+      @components << component
+      self
+    end
+
+    # Converts the action row to a Discord API-compatible hash.
+    #
+    # @return [Hash] Action row data in Discord API format.
+    #
+    # @example
+    #   row = ActionRow.new(Button.new(label: "Btn", custom_id: "btn"))
+    #   row.to_h
+    #   # => {type: 1, components: [{type: 2, style: 1, label: "Btn", custom_id: "btn", disabled: false}]}
+    def to_h
+      {
+        type: @type,
+        components: @components.map(&:to_h)
+      }
+    end
+  end
+
+  # Factory method for creating ActionRow instances.
+  #
+  # @param args [Array<Button, SelectMenu>] Components to include.
+  # @return [Rubord::ActionRow] New action row instance.
+  #
+  # @example
+  #   row = Rubord.ActionRow(button1, button2)
+  def self.ActionRow(*args)
+    ActionRow.new(*args)
+  end
+end

data/lib/rubord/components/button.rb

@@ -0,0 +1,125 @@
+# components/button.rb
+
+module Rubord
+  # Represents a Discord interactive button component.
+  #
+  # Buttons are interactive elements that users can click to trigger actions.
+  # They can be used in messages, modals, and action rows.
+  #
+  # @example Creating a primary button
+  #   button = Rubord::Button.new(
+  #     label: "Click Me",
+  #     style: 1,
+  #     custom_id: "my_button"
+  #   )
+  #
+  # @example Creating a link button
+  #   link_button = Rubord::Button.new(
+  #     label: "Visit Website",
+  #     style: 5,
+  #     url: "https://example.com"
+  #   )
+  #
+  # @since 1.0.0
+  # @see https://discord.com/developers/docs/interactions/message-components#buttons
+  class Button
+    # @return [Integer] Component type (always 2 for buttons).
+    attr_accessor :type
+    
+    # @return [Integer] Button style (1-5).
+    #   - 1: Primary (blurple)
+    #   - 2: Secondary (grey)
+    #   - 3: Success (green)
+    #   - 4: Danger (red)
+    #   - 5: Link (grey, navigates to URL)
+    attr_accessor :style
+    
+    # @return [String] Text displayed on the button (max 80 characters).
+    attr_accessor :label
+    
+    # @return [String, nil] Developer-defined identifier for the button.
+    #   Required for non-link buttons, must be unique per message.
+    attr_accessor :custom_id
+    
+    # @return [String, nil] URL for link buttons (style 5).
+    attr_accessor :url
+    
+    # @return [Boolean] Whether the button is disabled.
+    attr_accessor :disabled
+    
+    # @return [Hash, nil] Emoji to display on the button.
+    #   Format: `{name: "emoji_name", id: "emoji_id", animated: false}`
+    attr_accessor :emoji
+
+    # Creates a new button component.
+    #
+    # @param label [String] Text label displayed on the button.
+    # @param style [Integer] Button style (1-5).
+    #   Defaults to 1 (primary).
+    # @param custom_id [String, nil] Developer-defined identifier.
+    #   Required for non-link buttons.
+    # @param url [String, nil] URL for link buttons (style 5).
+    # @param disabled [Boolean] Whether the button is disabled.
+    #   Defaults to false.
+    # @param emoji [Hash, nil] Emoji to display on the button.
+    #
+    # @raise [ArgumentError] If required parameters are missing.
+    #
+    # @example Primary button with emoji
+    #   Button.new(
+    #     label: "Submit",
+    #     style: 1,
+    #     custom_id: "submit_btn",
+    #     emoji: { name: "✅" }
+    #   )
+    #
+    # @example Disabled danger button
+    #   Button.new(
+    #     label: "Delete",
+    #     style: 4,
+    #     custom_id: "delete_btn",
+    #     disabled: true
+    #   )
+    def initialize(label:, style: 1, custom_id: nil, url: nil, disabled: false, emoji: nil)
+      @type = 2
+      @style = style
+      @label = label
+      @custom_id = custom_id
+      @url = url
+      @disabled = disabled
+      @emoji = emoji
+    end
+
+    # Converts the button to a Discord API-compatible hash.
+    #
+    # @return [Hash] Button data in Discord API format.
+    #
+    # @example
+    #   button = Button.new(label: "Test", custom_id: "test")
+    #   button.to_h
+    #   # => {type: 2, style: 1, label: "Test", custom_id: "test", disabled: false}
+    def to_h
+      h = {
+        type: @type,
+        style: @style,
+        label: @label,
+        disabled: @disabled
+      }
+      h[:custom_id] = @custom_id if @custom_id
+      h[:url] = @url if @url
+      h[:emoji] = @emoji if @emoji
+      h
+    end
+  end
+
+  # Factory method for creating Button instances.
+  #
+  # @param args [Hash] Button initialization parameters.
+  # @return [Rubord::Button] New button instance.
+  #
+  # @example
+  #   button = Rubord.Button(label: "Click", custom_id: "click")
+  def self.Button(**args)
+    Button.new(**args)
+  end
+end

data/lib/rubord/components/componentsV2.rb

@@ -0,0 +1,4 @@
+require_relative "containers/container.rb"
+require_relative "containers/section.rb"
+require_relative "containers/separator.rb"
+require_relative "containers/text.rb"

data/lib/rubord/components/containers/base.rb

@@ -0,0 +1,15 @@
+module Rubord
+  module Components
+    class BaseComponent
+      attr_reader :type
+
+      def initialize(type)
+        @type = type
+      end
+
+      def to_h
+        raise NotImplementedError, "Implement to_h in subclass"
+      end
+    end
+  end
+end

data/lib/rubord/components/containers/container.rb

@@ -0,0 +1,39 @@
+require_relative "base"
+
+module Rubord
+  module Components
+    class Container < BaseComponent
+      attr_reader :components, :color
+
+      def initialize(*components, color: nil)
+        super(17)
+        @color = Rubord.Parser.color(color)
+        @components = []
+        components.each { |c| add(c) }
+      end
+
+      def add(component)
+        unless component.respond_to?(:to_h)
+          raise ArgumentError, "Invalid component inside Container: #{component.inspect}"
+        end
+
+        @components << component
+        self
+      end
+
+      def to_h
+        payload = {
+          type: @type,
+          components: @components.map(&:to_h)
+        }
+
+        payload[:accent_color] = @color if @color
+        payload
+      end
+    end
+  end
+
+  def self.Container(*components, **opts)
+    Components::Container.new(*components, **opts)
+  end
+end

data/lib/rubord/components/containers/section.rb

@@ -0,0 +1,26 @@
+require_relative "base"
+
+module Rubord
+  module Components
+    class Section < BaseComponent
+      def initialize(text:, accessory: nil)
+        super(9)
+        @text = text
+        @accessory = accessory
+      end
+
+      def to_h
+        h = {
+          type: @type,
+          text: @text.is_a?(String) ? { type: 10, content: @text } : @text.to_h
+        }
+        h[:accessory] = @accessory.to_h if @accessory
+        h
+      end
+    end
+  end
+
+  def self.Section(**args)
+    Components::Section.new(**args)
+  end
+end

data/lib/rubord/components/containers/separator.rb

@@ -0,0 +1,51 @@
+require_relative "base"
+
+module Rubord
+  module Components
+    class Separator < BaseComponent
+      SPACING = {
+        small: 1,
+        large: 2
+      }.freeze
+
+      attr_reader :divider, :spacing
+
+      def initialize(divider: true, spacing: :small)
+        super(14)
+
+        @divider = !!divider
+        @spacing = parse_spacing(spacing)
+      end
+
+      def to_h
+        {
+          type: @type,
+          divider: @divider,
+          spacing: @spacing
+        }
+      end
+
+      private
+
+      def parse_spacing(value)
+        case value
+        when Integer
+          unless SPACING.value?(value)
+            raise ArgumentError, "Invalid spacing value: #{value}"
+          end
+          value
+        when Symbol, String
+          spacing = SPACING[value.to_sym]
+          raise ArgumentError, "Invalid spacing: #{value.inspect}" unless spacing
+          spacing
+        else
+          raise ArgumentError, "Invalid spacing type: #{value.class}"
+        end
+      end
+    end
+  end
+
+  def self.Separator(**opts)
+    Components::Separator.new(**opts)
+  end
+end

data/lib/rubord/components/containers/text.rb

@@ -0,0 +1,23 @@
+require_relative "base"
+
+module Rubord
+  module Components
+    class Text < BaseComponent
+      def initialize(content)
+        super(10)
+        @content = content
+      end
+
+      def to_h
+        {
+          type: @type,
+          content: @content
+        }
+      end
+    end
+  end
+
+  def self.Text(content)
+    Components::Text.new(content)
+  end
+end

data/lib/rubord/components/modal.rb

@@ -0,0 +1,134 @@
+# components/modal.rb
+
+module Rubord
+  # Represents a Discord modal dialog component.
+  #
+  # Modals are pop-up dialog windows that can contain text inputs.
+  # They're triggered by interactions and allow for more complex user input.
+  #
+  # @example Creating a simple modal
+  #   modal = Rubord::Modal.new(
+  #     custom_id: "feedback_form",
+  #     title: "Submit Feedback"
+  #   )
+  #   modal.add_text_input(
+  #     custom_id: "feedback",
+  #     label: "Your feedback",
+  #     style: 2,
+  #     placeholder: "Type your feedback here..."
+  #   )
+  #
+  # @since 1.0.0
+  # @see https://discord.com/developers/docs/interactions/modals
+  class Modal
+    # @return [Integer] Component type (always 1 for modals).
+    attr_accessor :type
+    
+    # @return [String] Developer-defined identifier.
+    attr_accessor :custom_id
+    
+    # @return [String] Modal title (max 45 characters).
+    attr_accessor :title
+    
+    # @return [Array<Hash>] List of text input components.
+    attr_accessor :components
+
+    # Creates a new modal dialog.
+    #
+    # @param custom_id [String] Developer-defined identifier.
+    # @param title [String] Modal title (max 45 characters).
+    #
+    # @example
+    #   Modal.new(
+    #     custom_id: "user_registration",
+    #     title: "Register Account"
+    #   )
+    def initialize(custom_id:, title:)
+      @type = 1
+      @custom_id = custom_id
+      @title = title
+      @components = []
+    end
+
+    # Adds a text input field to the modal.
+    #
+    # @param custom_id [String] Developer-defined identifier for the input.
+    # @param label [String] Label displayed above the input (max 45 characters).
+    # @param style [Integer] Input style (1=single-line, 2=multi-line).
+    #   Defaults to 1.
+    # @param min_length [Integer, nil] Minimum input length.
+    # @param max_length [Integer, nil] Maximum input length.
+    # @param required [Boolean] Whether the input is required.
+    #   Defaults to true.
+    # @param value [String, nil] Pre-filled value.
+    # @param placeholder [String, nil] Placeholder text.
+    #
+    # @return [Rubord::Modal] Self for method chaining.
+    #
+    # @example Single-line required input
+    #   modal.add_text_input(
+    #     custom_id: "username",
+    #     label: "Username",
+    #     required: true,
+    #     min_length: 3,
+    #     max_length: 20
+    #   )
+    #
+    # @example Multi-line optional input
+    #   modal.add_text_input(
+    #     custom_id: "bio",
+    #     label: "Biography",
+    #     style: 2,
+    #     required: false,
+    #     placeholder: "Tell us about yourself...",
+    #     max_length: 500
+    #   )
+    def add_text_input(custom_id:, label:, style: 1, min_length: nil, max_length: nil, required: true, value: nil, placeholder: nil)
+      @components << {
+        type: 4,
+        custom_id: custom_id,
+        style: style,
+        label: label,
+        min_length: min_length,
+        max_length: max_length,
+        required: required,
+        value: value,
+        placeholder: placeholder
+      }.compact
+      self
+    end
+
+    # Converts the modal to a Discord API-compatible hash.
+    #
+    # @return [Hash] Modal data in Discord API format.
+    #
+    # @example
+    #   modal = Modal.new(custom_id: "test", title: "Test Modal")
+    #   modal.to_h
+    #   # => {type: 1, custom_id: "test", title: "Test Modal", components: [{type: 1, components: []}]}
+    def to_h
+      {
+        type: @type,
+        custom_id: @custom_id,
+        title: @title,
+        components: [
+          {
+            type: 1,
+            components: @components
+          }
+        ]
+      }
+    end
+  end
+
+  # Factory method for creating Modal instances.
+  #
+  # @param args [Hash] Modal initialization parameters.
+  # @return [Rubord::Modal] New modal instance.
+  #
+  # @example
+  #   modal = Rubord.Modal(custom_id: "form", title: "Feedback Form")
+  def self.Modal(**args)
+    Modal.new(**args)
+  end
+end