discorb 0.0.1

data/lib/discorb/common.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Discorb
+  API_BASE_URL = "https://discord.com/api/v9"
+  VERSION = "0.0.1"
+  USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
+
+  #
+  # @abstract
+  # Represents Discord model.
+  #
+  class DiscordModel
+    def eql?(other)
+      self == other
+    end
+
+    def ==(other)
+      if respond_to?(:id) && other.respond_to?(:id)
+        id == other.id
+      else
+        super
+      end
+    end
+
+    # @!visibility private
+    def inspect
+      super
+    end
+
+    def hash
+      @id.hash
+    end
+  end
+
+  #
+  # Represents Snowflake of Discord.
+  #
+  # @see https://discord.com/developers/docs/reference#snowflakes Official Discord API docs
+  class Snowflake < DiscordModel
+    # @!visibility private
+    def initialize(value)
+      @value = value.to_i
+    end
+
+    # @!attribute [r] timestamp
+    #   Timestamp of snowflake.
+    #
+    #   @return [Time] Timestamp of snowflake.
+    #
+    # @!attribute [r] worker_id
+    #   Worker ID of snowflake.
+    #
+    #   @return [Integer] Worker ID of snowflake.
+    #
+    # @!attribute [r] process_id
+    #   Process ID of snowflake.
+    #
+    #   @return [Integer] Process ID of snowflake.
+    # @!attribute [r] increment
+    #   Increment of snowflake.
+    #
+    #   @return [Integer] Increment of snowflake.
+
+    #
+    # Stringify snowflake.
+    #
+    # @return [String] Stringified snowflake.
+    #
+    def to_s
+      @value.to_s
+    end
+
+    #
+    # Integerize snowflake.
+    #
+    # @return [Integer] Integerized snowflake.
+    #
+    def to_i
+      @value.to_i
+    end
+
+    #
+    # Compares snowflake with other object.
+    #
+    # @param [#to_s] other Object to compare with.
+    #
+    # @return [Boolean] True if snowflake is equal to other object.
+    #
+    def ==(other)
+      return false unless other.respond_to?(:to_s)
+
+      to_s == other.to_s
+    end
+
+    #
+    # Alias of {#==}.
+    #
+    def eql?(other)
+      self == other
+    end
+
+    # Return hash of snowflake.
+    def hash
+      to_s.hash
+    end
+
+    def timestamp
+      Time.at(((sf >> 22) + 1_420_070_400_000) / 1000)
+    end
+
+    def worker_id
+      (snowflake & 0x3E0000) >> 17
+    end
+
+    def process_id
+      (snowflake & 0x1F000) >> 12
+    end
+
+    def increment
+      snowflake & 0xFFF
+    end
+  end
+end

data/lib/discorb/components.rb

@@ -0,0 +1,290 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # @abstract
+  # Represents a Discord component.
+  #
+  class Component
+    class << self
+      #
+      # Create a new component from hash data.
+      #
+      # @see https://discord.com/developers/docs/interactions/message-components Official Discord API documentation
+      # @param [Hash] data Hash data.
+      #
+      # @return [Component] A new component.
+      #
+      def from_hash(data)
+        case data[:type]
+        when 2
+          Button.new(
+            data[:label],
+            data[:style],
+            emoji: data[:emoji],
+            custom_id: data[:custom_id],
+            url: data[:url],
+            disabled: data[:disabled],
+          )
+        when 3
+          SelectMenu.new(
+            data[:custom_id],
+            data[:options].map { |o| SelectMenu::Option.from_hash(o) },
+            placeholder: data[:placeholder],
+            min_values: data[:min_values],
+            max_values: data[:max_values],
+          )
+        end
+      end
+    end
+  end
+
+  #
+  # Represents a button component.
+  #
+  class Button < Component
+    # @return [String] The label of the button.
+    attr_accessor :label
+    # @return [:primary, :secondary, :success, :danger, :link] The style of the button.
+    attr_accessor :style
+    # @return [Discorb::Emoji] The emoji of the button.
+    attr_accessor :emoji
+    # @return [String] The custom ID of the button.
+    #   Won't be used if the style is `:link`.
+    attr_accessor :custom_id
+    # @return [String] The URL of the button.
+    #   Only used when the style is `:link`.
+    attr_accessor :url
+    # @return [Boolean] Whether the button is disabled.
+    attr_accessor :disabled
+    alias disabled? disabled
+
+    @styles = {
+      primary: 1,
+      secondary: 2,
+      success: 3,
+      danger: 4,
+      link: 5,
+    }.freeze
+
+    #
+    # Initialize a new button.
+    #
+    # @param [String] label The label of the button.
+    # @param [:primary, :secondary, :success, :danger, :link] style The style of the button.
+    # @param [Discorb::Emoji] emoji The emoji of the button.
+    # @param [String] custom_id The custom ID of the button.
+    # @param [String] url The URL of the button.
+    # @param [Boolean] disabled Whether the button is disabled.
+    #
+    def initialize(label, style = :primary, emoji: nil, custom_id: nil, url: nil, disabled: false)
+      @label = label
+      @style = style
+      @emoji = emoji
+      @custom_id = custom_id
+      @url = url
+      @disabled = disabled
+    end
+
+    #
+    # Converts the button to a hash.
+    #
+    # @see https://discord.com/developers/docs/interactions/message-components#button-object-button-structure Official Discord API docs
+    # @return [Hash] A hash representation of the button.
+    #
+    def to_hash
+      if @style == :link
+        {
+          type: 2,
+          label: @label,
+          style: self.class.styles[@style],
+          url: @url,
+          emoji: hash_emoji(@emoji),
+          disabled: @disabled,
+        }
+      else
+        {
+          type: 2,
+          label: @label,
+          style: self.class.styles[@style],
+          custom_id: @custom_id,
+          emoji: hash_emoji(@emoji),
+          disabled: @disabled,
+        }
+      end
+    end
+
+    class << self
+      # @!visibility private
+      attr_reader :styles
+    end
+
+    private
+
+    def hash_emoji(emoji)
+      case emoji
+      when UnicodeEmoji
+        {
+          id: nil,
+          name: emoji.to_s,
+          animated: false,
+        }
+      when CustomEmoji
+        {
+          id: emoji.id,
+          name: emoji.name,
+          animated: emoji.animated?,
+        }
+      end
+    end
+  end
+
+  #
+  # Represents a select menu component.
+  #
+  class SelectMenu < Component
+    # @return [String] The custom ID of the select menu.
+    attr_accessor :custom_id
+    # @return [Array<SelectMenu::Option>] The options of the select menu.
+    attr_accessor :options
+    # @return [Integer] The minimum number of values.
+    attr_accessor :min_values
+    # @return [Integer] The maximum number of values.
+    attr_accessor :max_values
+    # @return [Boolean] Whether the select menu is disabled.
+    attr_reader :disabled
+    alias disabled? disabled
+
+    #
+    # Initialize a new select menu.
+    #
+    # @param [String, Symbol] custom_id Custom ID of the select menu.
+    # @param [Array<Discorb::SelectMenu::Option>] options The options of the select menu.
+    # @param [String] placeholder The placeholder of the select menu.
+    # @param [Integer] min_values The minimum number of values.
+    # @param [Integer] max_values The maximum number of values.
+    #
+    def initialize(custom_id, options, placeholder: nil, min_values: 1, max_values: 1)
+      @custom_id = custom_id
+      @options = options
+      @placeholder = placeholder
+      @min_values = min_values
+      @max_values = max_values
+    end
+
+    #
+    # Converts the select menu to a hash.
+    #
+    # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-menu-structure Official Discord API docs
+    # @return [Hash] A hash representation of the select menu.
+    #
+    def to_hash
+      {
+        type: 3,
+        custom_id: @custom_id,
+        options: @options.map(&:to_hash),
+        placeholder: @placeholder,
+        min_values: @min_values,
+        max_values: @max_values,
+      }
+    end
+
+    #
+    # Represents an option of a select menu.
+    #
+    class Option
+      # @return [String] The label of the option.
+      attr_accessor :label
+      # @return [String] The value of the option.
+      attr_accessor :value
+      # @return [String] The description of the option.
+      attr_accessor :description
+      # @return [Discorb::Emoji] The emoji of the option.
+      attr_accessor :emoji
+      # @return [Boolean] Whether the option is default.
+      attr_accessor :default
+
+      #
+      # Initialize a new option.
+      #
+      # @param [String] label The label of the option.
+      # @param [String] value The value of the option.
+      # @param [String] description The description of the option.
+      # @param [Discorb::Emoji] emoji The emoji of the option.
+      # @param [Boolean] default Whether the option is default.
+      def initialize(label, value, description: nil, emoji: nil, default: false)
+        @label = label
+        @value = value
+        @description = description
+        @emoji = emoji
+        @default = default
+      end
+
+      #
+      # Converts the option to a hash.
+      #
+      # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure Official Discord API docs
+      # @return [Hash] Hash representation of the option.
+      #
+      def to_hash
+        {
+          label: @label,
+          value: @value,
+          description: @description,
+          emoji: hash_emoji(@emoji),
+          default: @default,
+        }
+      end
+
+      # @!visibility private
+      def hash_emoji(emoji)
+        case emoji
+        when UnicodeEmoji
+          {
+            id: nil,
+            name: emoji.to_s,
+            animated: false,
+          }
+        when CustomEmoji
+          {
+            id: emoji.id,
+            name: emoji.name,
+            animated: emoji.animated?,
+          }
+        end
+      end
+
+      class << self
+        #
+        # Creates a new option from a hash.
+        #
+        # @param [Hash] data A hash representing the option.
+        #
+        # @return [Discorb::SelectMenu::Option] A new option.
+        #
+        def from_hash(data)
+          new(data[:label], data[:value], description: data[:description], emoji: data[:emoji], default: data[:default])
+        end
+      end
+    end
+
+    private
+
+    def hash_emoji(emoji)
+      case emoji
+      when UnicodeEmoji
+        {
+          id: nil,
+          name: emoji.to_s,
+          animated: false,
+        }
+      when CustomEmoji
+        {
+          id: emoji.id,
+          name: emoji.name,
+          animated: emoji.animated?,
+        }
+      end
+    end
+  end
+end

data/lib/discorb/dictionary.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Discorb
+  class Dictionary
+    # @return [Integer] The maximum number of items in the dictionary.
+    attr_accessor :limit
+
+    #
+    # Initialize a new Dictionary.
+    #
+    # @param [Hash] hash A hash of items to add to the dictionary.
+    # @param [Integer] limit The maximum number of items in the dictionary.
+    # @param [false, Proc] sort Whether to sort the items in the dictionary.
+    #
+    def initialize(hash = {}, limit: nil, sort: false)
+      @cache = hash.transform_keys(&:to_s)
+      @limit = limit
+      @sort = sort
+    end
+
+    #
+    # Registers a new item in the dictionary.
+    #
+    # @param [#to_s] id The ID of the item.
+    # @param [Object] body The item to register.
+    #
+    # @return [self] The dictionary.
+    #
+    def register(id, body)
+      @cache[id.to_s] = body
+      @cache = @cache.sort_by(&@sort).to_h if @sort
+      @cache.remove(@cache.values[-1]) if !@limit.nil? && @cache.size > @limit
+      body
+    end
+
+    #
+    # Merges another dictionary into this one.
+    #
+    # @param [Discorb::Dictionary] other The dictionary to merge.
+    #
+    def merge(other)
+      @cache.merge!(other)
+    end
+
+    #
+    # Removes an item from the dictionary.
+    #
+    # @param [#to_s] id The ID of the item to remove.
+    #
+    def remove(id)
+      @cache.remove(id.to_s)
+    end
+
+    #
+    # Get an item from the dictionary.
+    #
+    # @param [#to_s] id The ID of the item.
+    # @return [Object] The item.
+    # @return [nil] if the item was not found.
+    #
+    # @overload get(index)
+    #   @param [Integer] index The index of the item.
+    #
+    #   @return [Object] The item.
+    #   @return [nil] if the item is not found.
+    #
+    def get(id)
+      res = @cache[id.to_s]
+      if res.nil? && id.is_a?(Integer) && id < @cache.length
+        @cache.values[id]
+      else
+        res
+      end
+    end
+
+    #
+    # Returns the values of the dictionary.
+    #
+    # @return [Array] The values of the dictionary.
+    #
+    def values
+      @cache.values
+    end
+
+    #
+    # Checks if the dictionary has an ID.
+    #
+    # @param [#to_s] id The ID to check.
+    #
+    # @return [Boolean] `true` if the dictionary has the ID, `false` otherwise.
+    #
+    def has?(id)
+      !self[id].nil?
+    end
+
+    def method_missing(name, ...)
+      if values.respond_to?(name)
+        values.send(name, ...)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, args, kwargs)
+      if values.respond_to?(name)
+        true
+      else
+        super
+      end
+    end
+
+    alias [] get
+    alias []= register
+
+    def inspect
+      "#<#{self.class} #{values.length} items>"
+    end
+  end
+end