discorb 0.18.0 → 0.20.0

data/lib/discorb/common.rb

@@ -1,164 +1,168 @@
-# frozen_string_literal: true
-
-module Discorb
-  # @return [String] The API base URL.
-  API_BASE_URL = "https://discord.com/api/v10"
-  # @return [String] The version of discorb.
-  VERSION = "0.18.0"
-  # @return [Array<Integer>] The version array of discorb.
-  VERSION_ARRAY = VERSION.split(".").map(&:to_i).freeze
-  # @return [String] The user agent for the bot.
-  USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}".freeze
-
-  #
-  # @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
-
-    def inspect
-      "#<#{self.class}: #{@id}>"
-    end
-
-    # @private
-    def hash
-      @id.hash
-    end
-  end
-
-  #
-  # Represents Snowflake of Discord.
-  #
-  # @see https://discord.com/developers/docs/reference#snowflakes Official Discord API docs
-  class Snowflake < String
-    #
-    # Initialize new snowflake.
-    # @private
-    #
-    # @param [#to_s] value The value of the snowflake.
-    #
-    def initialize(value)
-      @value = value.to_i
-      super(@value.to_s)
-    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.
-    # @!attribute [r] id
-    #   Alias of to_s.
-    #
-    #   @return [String] The snowflake.
-
-    #
-    # 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(((@value >> 22) + 1_420_070_400_000) / 1000.0)
-    end
-
-    def worker_id
-      (@value & 0x3E0000) >> 17
-    end
-
-    def process_id
-      (@value & 0x1F000) >> 12
-    end
-
-    def increment
-      @value & 0xFFF
-    end
-
-    def inspect
-      "#<#{self.class} #{self}>"
-    end
-
-    alias id to_s
-  end
-
-  #
-  # Represents an endpoint.
-  # @private
-  #
-  class Route
-    attr_reader :url, :key, :method
-
-    def initialize(url, key, method)
-      @url = url
-      @key = key
-      @method = method
-    end
-
-    def inspect
-      "#<#{self.class} #{self.identifier}>"
-    end
-
-    def hash
-      @url.hash
-    end
-
-    def identifier
-      "#{@method} #{@key}"
-    end
-
-    def major_param
-      param_type = @key.split("/").find { |k| k.start_with?(":") }
-      return "" unless param_type
-
-      param = url.gsub(API_BASE_URL, "").split("/")[@key.split("/").index(param_type) - 1]
-      %w[:channel_id :guild_id :webhook_id].include?(param_type) ? param : ""
-    end
-  end
-
-  # @return [Object] Object that represents unspecified value.
-  #   This is used as a default value for optional parameters.
-  Unset = Object.new
-end
+# frozen_string_literal: true
+
+module Discorb
+  # @return [String] The API base URL.
+  API_BASE_URL = "https://discord.com/api/v10"
+  # @return [String] The version of discorb.
+  VERSION = "0.20.0"
+  # @return [Array<Integer>] The version array of discorb.
+  VERSION_ARRAY = VERSION.split(".").map(&:to_i).freeze
+  # @return [String] The user agent for the bot.
+  USER_AGENT =
+    "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}".freeze
+
+  #
+  # @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
+
+    def inspect
+      "#<#{self.class}: #{@id}>"
+    end
+
+    # @private
+    def hash
+      @id.hash
+    end
+  end
+
+  #
+  # Represents Snowflake of Discord.
+  #
+  # @see https://discord.com/developers/docs/reference#snowflakes Official Discord API docs
+  class Snowflake < String
+    #
+    # Initialize new snowflake.
+    # @private
+    #
+    # @param [#to_s] value The value of the snowflake.
+    #
+    def initialize(value)
+      @value = value.to_i
+      super(@value.to_s)
+    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.
+    # @!attribute [r] id
+    #   Alias of to_s.
+    #
+    #   @return [String] The snowflake.
+
+    #
+    # 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(((@value >> 22) + 1_420_070_400_000) / 1000.0)
+    end
+
+    def worker_id
+      (@value & 0x3E0000) >> 17
+    end
+
+    def process_id
+      (@value & 0x1F000) >> 12
+    end
+
+    def increment
+      @value & 0xFFF
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+
+    alias id to_s
+  end
+
+  #
+  # Represents an endpoint.
+  # @private
+  #
+  class Route
+    attr_reader :url, :key, :method
+
+    def initialize(url, key, method)
+      @url = url
+      @key = key
+      @method = method
+    end
+
+    def inspect
+      "#<#{self.class} #{identifier}>"
+    end
+
+    def hash
+      @url.hash
+    end
+
+    def identifier
+      "#{@method} #{@key}"
+    end
+
+    def major_param
+      param_type = @key.split("/").find { |k| k.start_with?(":") }
+      return "" unless param_type
+
+      param =
+        url.gsub(API_BASE_URL, "").split("/")[
+          @key.split("/").index(param_type) - 1
+        ]
+      %w[:channel_id :guild_id :webhook_id].include?(param_type) ? param : ""
+    end
+  end
+
+  # @return [Object] Object that represents unspecified value.
+  #   This is used as a default value for optional parameters.
+  Unset = Object.new
+end

data/lib/discorb/components/button.rb

@@ -1,106 +1,107 @@
-# frozen_string_literal: true
-
-module Discorb
-  #
-  # 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
-
-    # @private
-    # @return [{Symbol => Integer}] The mapping of button styles.
-    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: STYLES[@style],
-          url: @url,
-          emoji: @emoji&.to_hash,
-          disabled: @disabled,
-        }
-      else
-        {
-          type: 2,
-          label: @label,
-          style: STYLES[@style],
-          custom_id: @custom_id,
-          emoji: @emoji&.to_hash,
-          disabled: @disabled,
-        }
-      end
-    end
-
-    def inspect
-      "#<#{self.class}: #{@custom_id || @url}>"
-    end
-
-    class << self
-      #
-      # Creates a new button from a hash.
-      #
-      # @param [Hash] data The hash to create the button from.
-      #
-      # @return [Discorb::Button] The created button.
-      #
-      def from_hash(data)
-        new(
-          data[:label],
-          data[:style],
-          emoji: data[:emoji],
-          custom_id: data[:custom_id],
-          url: data[:url],
-          disabled: data[:disabled],
-        )
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # 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
+
+    # @private
+    # @return [{Symbol => Integer}] The mapping of button styles.
+    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: STYLES[@style],
+          url: @url,
+          emoji: @emoji&.to_hash,
+          disabled: @disabled
+        }
+      else
+        {
+          type: 2,
+          label: @label,
+          style: STYLES[@style],
+          custom_id: @custom_id,
+          emoji: @emoji&.to_hash,
+          disabled: @disabled
+        }
+      end
+    end
+
+    def inspect
+      "#<#{self.class}: #{@custom_id || @url}>"
+    end
+
+    class << self
+      #
+      # Creates a new button from a hash.
+      #
+      # @param [Hash] data The hash to create the button from.
+      #
+      # @return [Discorb::Button] The created button.
+      #
+      def from_hash(data)
+        new(
+          data[:label],
+          data[:style],
+          emoji: data[:emoji],
+          custom_id: data[:custom_id],
+          url: data[:url],
+          disabled: data[:disabled]
+        )
+      end
+    end
+  end
+end