discorb 0.6.0 → 0.6.1

data/lib/discorb/color.rb

@@ -130,35 +130,65 @@ module Discorb
     #
     # Create a color from a Discord's color.
     # Currently these colors are supported:
-    #   - teal (0x1abc9c)
-    #   - dark_teal (0x11806a)
-    #   - green (0x2ecc71)
-    #   - dark_green (0x1f8b4c)
-    #   - blue (0x3498db)
-    #   - dark_blue (0x206694)
-    #   - purple (0x9b59b6)
-    #   - dark_purple (0x71368a)
-    #   - magenta (0xe91e63)
-    #   - dark_magenta (0xad1457)
-    #   - gold (0xf1c40f)
-    #   - dark_gold (0xc27c0e)
-    #   - orange (0xe67e22)
-    #   - dark_orange (0xa84300)
-    #   - red (0xe74c3c)
-    #   - dark_red (0x992d22)
-    #   - lighter_grey (0x95a5a6)
-    #   - lighter_gray (0x95a5a6)
-    #   - dark_grey (0x607d8b)
-    #   - dark_gray (0x607d8b)
-    #   - light_grey (0x979c9f)
-    #   - light_gray (0x979c9f)
-    #   - darker_grey (0x546e7a)
-    #   - darker_gray (0x546e7a)
-    #   - og_blurple (0x7289da)
-    #   - blurple (0x5865f2)
-    #   - greyple (0x99aab5)
-    #   - dark_theme (0x36393f)
-    #   - fuchsia (0xeb459e)
+    # | Color Name | Hexadecimal |
+    # |------------|------------|
+    # | `:teal` | `#1abc9c` |
+    # | `:dark_teal` | `#11806a` |
+    # | `:green` | `#2ecc71` |
+    # | `:dark_green` | `#1f8b4c` |
+    # | `:blue` | `#3498db` |
+    # | `:dark_blue` | `#206694` |
+    # | `:purple` | `#9b59b6` |
+    # | `:dark_purple` | `#71368a` |
+    # | `:magenta` | `#e91e63` |
+    # | `:dark_magenta` | `#ad1457` |
+    # | `:gold` | `#f1c40f` |
+    # | `:dark_gold` | `#c27c0e` |
+    # | `:orange` | `#e67e22` |
+    # | `:dark_orange` | `#a84300` |
+    # | `:red` | `#e74c3c` |
+    # | `:dark_red` | `#992d22` |
+    # | `:lighter_grey` | `#95a5a6` |
+    # | `:lighter_gray` | `#95a5a6` |
+    # | `:dark_grey` | `#607d8b` |
+    # | `:dark_gray` | `#607d8b` |
+    # | `:light_grey` | `#979c9f` |
+    # | `:light_gray` | `#979c9f` |
+    # | `:darker_grey` | `#546e7a` |
+    # | `:darker_gray` | `#546e7a` |
+    # | `:og_blurple` | `#7289da` |
+    # | `:blurple` | `#5865f2` |
+    # | `:greyple` | `#99aab5` |
+    # | `:dark_theme` | `#36393f` |
+    # | `:fuchsia` | `#eb459e` |
+    # | `:dark_teal` | `#11806a` |
+    # | `:green` | `#2ecc71` |
+    # | `:dark_green` | `#1f8b4c` |
+    # | `:blue` | `#3498db` |
+    # | `:dark_blue` | `#206694` |
+    # | `:purple` | `#9b59b6` |
+    # | `:dark_purple` | `#71368a` |
+    # | `:magenta` | `#e91e63` |
+    # | `:dark_magenta` | `#ad1457` |
+    # | `:gold` | `#f1c40f` |
+    # | `:dark_gold` | `#c27c0e` |
+    # | `:orange` | `#e67e22` |
+    # | `:dark_orange` | `#a84300` |
+    # | `:red` | `#e74c3c` |
+    # | `:dark_red` | `#992d22` |
+    # | `:lighter_grey` | `#95a5a6` |
+    # | `:lighter_gray` | `#95a5a6` |
+    # | `:dark_grey` | `#607d8b` |
+    # | `:dark_gray` | `#607d8b` |
+    # | `:light_grey` | `#979c9f` |
+    # | `:light_gray` | `#979c9f` |
+    # | `:darker_grey` | `#546e7a` |
+    # | `:darker_gray` | `#546e7a` |
+    # | `:og_blurple` | `#7289da` |
+    # | `:blurple` | `#5865f2` |
+    # | `:greyple` | `#99aab5` |
+    # | `:dark_theme` | `#36393f` |
+    # | `:fuchsia` | `#eb459e` |
     #
     # @param [Symbol] color A Discord color name.
     #

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/error.rb

@@ -94,7 +94,7 @@ module Discorb
       @client.close!
       DiscorbError.instance_method(:initialize).bind(self).call(<<~MESSAGE)
         The client is banned from CloudFlare.
-        Hint: Try to increase the number of requests per second, e.g. Use sleep in between requests.
+        Hint: Try to decrease the number of requests per second, e.g. Use sleep in between requests.
       MESSAGE
     end
   end

data/lib/discorb/event.rb

@@ -11,17 +11,17 @@ module Discorb
     attr_reader :block
     # @return [Symbol] the event id.
     attr_reader :id
-    # @return [Hash] the event discriminator.
-    attr_reader :discriminator
+    # @return [Hash] the event metadata.
+    attr_reader :metadata
     # @return [Boolean] whether the event is once or not.
     attr_reader :once
     alias once? once
 
-    def initialize(block, id, discriminator)
+    def initialize(block, id, metadata)
       @block = block
       @id = id
-      @once = discriminator.fetch(:once, false)
-      @discriminator = discriminator
+      @once = metadata.fetch(:once, false)
+      @metadata = metadata
       @rescue = nil
     end
 

data/lib/discorb/extension.rb

@@ -8,7 +8,7 @@ module Discorb
   # @abstract
   #
   module Extension
-    include Discorb::Command::Handler
+    include Discorb::ApplicationCommand::Handler
     undef setup_commands
 
     @events = {}
@@ -19,18 +19,18 @@ module Discorb
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id The id of the event. Used to delete the event.
-    # @param [Hash] discriminator Other discriminators.
+    # @param [Hash] metadata Other metadata.
     # @param [Proc] block The block to execute when the event is triggered.
     #
     # @return [Discorb::Event] The event.
     #
-    def event(event_name, id: nil, **discriminator, &block)
+    def event(event_name, id: nil, **metadata, &block)
       raise ArgumentError, "Event name must be a symbol" unless event_name.is_a?(Symbol)
       raise ArgumentError, "block must be a Proc" unless block.is_a?(Proc)
 
       @events[event_name] ||= []
-      discriminator[:extension] = self.name
-      @events[event_name] << Discorb::Event.new(block, id, discriminator)
+      metadata[:extension] = self.name
+      @events[event_name] << Discorb::Event.new(block, id, metadata)
     end
 
     #
@@ -38,18 +38,18 @@ module Discorb
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id The id of the event. Used to delete the event.
-    # @param [Hash] discriminator Other discriminators.
+    # @param [Hash] metadata Other metadata.
     # @param [Proc] block The block to execute when the event is triggered.
     #
     # @return [Discorb::Event] The event.
     #
-    def once_event(event_name, id: nil, **discriminator, &block)
-      event(event_name, id: id, once: true, **discriminator, &block)
+    def once_event(event_name, id: nil, **metadata, &block)
+      event(event_name, id: id, once: true, **metadata, &block)
     end
 
     # @return [Hash{Symbol => Array<Discorb::Event>}] The events of the extension.
     attr_reader :events
-    # @return [Array<Discorb::Command::Command>] The commands of the extension.
+    # @return [Array<Discorb::ApplicationCommand::Command>] The commands of the extension.
     attr_reader :commands
     # @private
     attr_reader :bottom_commands

data/lib/discorb/intents.rb

@@ -26,7 +26,6 @@ module Discorb
     #
     # @param guilds [Boolean] Whether guild related events are enabled.
     # @param members [Boolean] Whether guild members related events are enabled.
-    #   @note You must enable members intent on developers portal.
     # @param bans [Boolean] Whether guild ban related events are enabled.
     # @param emojis [Boolean] Whether guild emojis related events are enabled.
     # @param integrations [Boolean] Whether guild integration related events are enabled.
@@ -34,13 +33,14 @@ module Discorb
     # @param invites [Boolean] Whether guild invite related events are enabled.
     # @param voice_states [Boolean] Whether guild voice state related events are enabled.
     # @param presences [Boolean] Whether guild presences related events are enabled.
-    #   @note You must enable members intent on developers portal.
     # @param messages [Boolean] Whether guild messages related events are enabled.
     # @param reactions [Boolean] Whether guild reaction related events are enabled.
     # @param dm_messages [Boolean] Whether dm messages related events are enabled.
     # @param dm_reactions [Boolean] Whether dm reactions related events are enabled.
     # @param dm_typing [Boolean] Whether dm typing related events are enabled.
     #
+    # @note You must enable privileged intents to use `members` and/or `presences` intents.
+    #
     def initialize(guilds: true,
                    members: false,
                    bans: true,

data/lib/discorb.rb

@@ -44,7 +44,7 @@ require_order = %w[common flag dictionary error rate_limit http intents emoji_ta
                 %w[application audit_logs color components event] +
                 %w[file guild_template image integration interaction invite log permission] +
                 %w[presence reaction role sticker utils voice_state webhook] +
-                %w[gateway_requests gateway command] +
+                %w[gateway_requests gateway app_command] +
                 %w[asset extension client extend]
 require_order.each do |name|
   require_relative "discorb/#{name}.rb"

data/po/yard.pot

@@ -322,7 +322,7 @@ msgid "## How do I register an application command?"
 msgstr ""
 
 #: ../docs/application_command.md:13
-msgid "Use {Discorb::Command::Handler#slash}, {Discorb::Command::Handler#group} for slash commands, {Discorb::Command::Handler#user_command} for user menu commands, and {Discorb::Command::Handler#message_command} for message menu commands."
+msgid "Use {Discorb::ApplicationCommand::Handler#slash}, {Discorb::ApplicationCommand::Handler#group} for slash commands, {Discorb::ApplicationCommand::Handler#user_command} for user menu commands, and {Discorb::ApplicationCommand::Handler#message_command} for message menu commands."
 msgstr ""
 
 #: ../docs/application_command.md:15
@@ -349,7 +349,7 @@ msgid "client.slash(\"hello\", \"Greet for you\") do |interaction|\n"
 msgstr ""
 
 #: ../docs/application_command.md:36
-msgid "{Discorb::Command::Handler#slash} takes 5 arguments:"
+msgid "{Discorb::ApplicationCommand::Handler#slash} takes 5 arguments:"
 msgstr ""
 
 #: ../docs/application_command.md:38
@@ -441,7 +441,7 @@ msgid "### Group Slash Commands"
 msgstr ""
 
 #: ../docs/application_command.md:104
-msgid "To register a group of slash commands, use {Discorb::Command::Handler#slash_group}."
+msgid "To register a group of slash commands, use {Discorb::ApplicationCommand::Handler#slash_group}."
 msgstr ""
 
 #: ../docs/application_command.md:106
@@ -473,7 +473,7 @@ msgid "group.slash(\"bump_alert\", \"Whether bot should notify DISBOARD bump.\",
 msgstr ""
 
 #: ../docs/application_command.md:128
-msgid "You can make subcommand group by using {Discorb::Command::GroupCommand#group}."
+msgid "You can make subcommand group by using {Discorb::ApplicationCommand::GroupCommand#group}."
 msgstr ""
 
 #: ../docs/application_command.md:130
@@ -558,7 +558,7 @@ msgid "```ruby\n"
 "  interaction.post(\"Hello, #{user.name}!\")\n"
 "end\n"
 "```\n"
-"{Discorb::Command::Handler#user_command} takes 3 arguments:"
+"{Discorb::ApplicationCommand::Handler#user_command} takes 3 arguments:"
 msgstr ""
 
 #: ../docs/application_command.md:216
@@ -595,7 +595,7 @@ msgid "```ruby\n"
 msgstr ""
 
 #: ../docs/application_command.md:238
-msgid "{Discorb::Command::Handler#message_command} takes 3 arguments:"
+msgid "{Discorb::ApplicationCommand::Handler#message_command} takes 3 arguments:"
 msgstr ""
 
 #: ../docs/application_command.md:248
@@ -4592,7 +4592,7 @@ msgstr ""
 msgid "The logger."
 msgstr ""
 
-# @return [Array<Discorb::Command::Command>]
+# @return [Array<Discorb::ApplicationCommand::Command>]
 #: ../lib/discorb/client.rb:45
 msgid "The commands that the client is using."
 msgstr ""
@@ -5262,17 +5262,17 @@ msgstr ""
 msgid "A Discord color name."
 msgstr ""
 
-# Discorb::Command
+# Discorb::ApplicationCommand
 #: ../lib/discorb/command.rb:5
 msgid "Handles application commands."
 msgstr ""
 
-# Discorb::Command::Handler
+# Discorb::ApplicationCommand::Handler
 #: ../lib/discorb/command.rb:9
 msgid "Module to handle commands."
 msgstr ""
 
-# Discorb::Command::Handler#slash
+# Discorb::ApplicationCommand::Handler#slash
 #: ../lib/discorb/command.rb:13
 msgid "Add new top-level command."
 msgstr ""
@@ -5364,14 +5364,14 @@ msgstr ""
 msgid "tag|param|options"
 msgstr ""
 
-# Discorb::Command::Handler#slash_group
+# Discorb::ApplicationCommand::Handler#slash_group
 #: ../lib/discorb/command.rb:41
 msgid "Add new command with group."
 msgstr ""
 
-# @return [Discorb::Command::Command::GroupCommand]
-# @return [Discorb::Command::Command::SubcommandGroup]
-# @return [Discorb::Command::Command]
+# @return [Discorb::ApplicationCommand::Command::GroupCommand]
+# @return [Discorb::ApplicationCommand::Command::SubcommandGroup]
+# @return [Discorb::ApplicationCommand::Command]
 #: ../lib/discorb/command.rb:51
 #: ../lib/discorb/command.rb:69
 #: ../lib/discorb/command.rb:87
@@ -5385,7 +5385,7 @@ msgstr ""
 msgid "tag|see|file:docs/slash_command.md"
 msgstr ""
 
-# Discorb::Command::Handler#message_command
+# Discorb::ApplicationCommand::Handler#message_command
 #: ../lib/discorb/command.rb:58
 msgid "Add message context menu command."
 msgstr ""
@@ -5397,13 +5397,13 @@ msgstr ""
 msgid "Block to execute."
 msgstr ""
 
-# @yieldparam [Discorb::CommandInteraction::UserMenuCommand]
+# @yieldparam [Discorb::ApplicationCommandInteraction::UserMenuCommand]
 #: ../lib/discorb/command.rb:69
 #: ../lib/discorb/command.rb:87
 msgid "tag|yieldparam|Interaction"
 msgstr ""
 
-# @yieldparam [Discorb::CommandInteraction::UserMenuCommand] Interaction
+# @yieldparam [Discorb::ApplicationCommandInteraction::UserMenuCommand] Interaction
 #: ../lib/discorb/command.rb:69
 #: ../lib/discorb/command.rb:87
 msgid "object."
@@ -5421,7 +5421,7 @@ msgstr ""
 msgid "Message object."
 msgstr ""
 
-# Discorb::Command::Handler#user_command
+# Discorb::ApplicationCommand::Handler#user_command
 #: ../lib/discorb/command.rb:76
 msgid "Add user context menu command."
 msgstr ""
@@ -5431,7 +5431,7 @@ msgstr ""
 msgid "User object."
 msgstr ""
 
-# Discorb::Command::Handler#setup_commands
+# Discorb::ApplicationCommand::Handler#setup_commands
 #: ../lib/discorb/command.rb:94
 msgid "Setup commands."
 msgstr ""
@@ -5456,7 +5456,7 @@ msgstr ""
 msgid "tag|see|Client#initialize"
 msgstr ""
 
-# Discorb::Command::Command
+# Discorb::ApplicationCommand::Command
 #: ../lib/discorb/command.rb:119
 msgid "Represents a application command."
 msgstr ""
@@ -5497,7 +5497,7 @@ msgstr ""
 msgid "a new instance of Command"
 msgstr ""
 
-# Discorb::Command::Command::SlashCommand
+# Discorb::ApplicationCommand::Command::SlashCommand
 #: ../lib/discorb/command.rb:163
 msgid "Represents the slash command."
 msgstr ""
@@ -5518,18 +5518,18 @@ msgstr ""
 msgid "a new instance of SlashCommand"
 msgstr ""
 
-# Discorb::Command::Command::SlashCommand#to_s
+# Discorb::ApplicationCommand::Command::SlashCommand#to_s
 #: ../lib/discorb/command.rb:185
 msgid "Returns the commands name."
 msgstr ""
 
-# Discorb::Command::Command::GroupCommand
+# Discorb::ApplicationCommand::Command::GroupCommand
 #: ../lib/discorb/command.rb:236
 msgid "Represents the command with subcommands."
 msgstr ""
 
-# @return [Array<Discorb::Command::Command::SlashCommand, Discorb::Command::Command::SubcommandGroup>]
-# @return [Array<Discorb::Command::Command::SlashCommand>]
+# @return [Array<Discorb::ApplicationCommand::Command::SlashCommand, Discorb::ApplicationCommand::Command::SubcommandGroup>]
+# @return [Array<Discorb::ApplicationCommand::Command::SlashCommand>]
 #: ../lib/discorb/command.rb:240
 #: ../lib/discorb/command.rb:361
 msgid "The subcommands of the command."
@@ -5540,20 +5540,20 @@ msgstr ""
 msgid "a new instance of GroupCommand"
 msgstr ""
 
-# Discorb::Command::Command::GroupCommand#slash
-# Discorb::Command::Command::SubcommandGroup#slash
+# Discorb::ApplicationCommand::Command::GroupCommand#slash
+# Discorb::ApplicationCommand::Command::SubcommandGroup#slash
 #: ../lib/discorb/command.rb:253
 #: ../lib/discorb/command.rb:376
 msgid "Add new subcommand."
 msgstr ""
 
-# @return [Discorb::Command::Command::SlashCommand]
+# @return [Discorb::ApplicationCommand::Command::SlashCommand]
 #: ../lib/discorb/command.rb:258
 #: ../lib/discorb/command.rb:380
 msgid "The added subcommand."
 msgstr ""
 
-# Discorb::Command::Command::GroupCommand#group
+# Discorb::ApplicationCommand::Command::GroupCommand#group
 #: ../lib/discorb/command.rb:301
 msgid "Add new subcommand group."
 msgstr ""
@@ -5568,7 +5568,7 @@ msgstr ""
 msgid "Group description."
 msgstr ""
 
-# Discorb::Command::Command::GroupCommand#to_s
+# Discorb::ApplicationCommand::Command::GroupCommand#to_s
 #: ../lib/discorb/command.rb:317
 msgid "Returns the command name."
 msgstr ""
@@ -5578,7 +5578,7 @@ msgstr ""
 msgid "The command name."
 msgstr ""
 
-# Discorb::Command::Command::SubcommandGroup
+# Discorb::ApplicationCommand::Command::SubcommandGroup
 #: ../lib/discorb/command.rb:357
 msgid "Represents the subcommand group."
 msgstr ""
@@ -5589,7 +5589,7 @@ msgid "a new instance of SubcommandGroup"
 msgstr ""
 
 # Discorb::Activity.types
-# Discorb::Command::Command.types
+# Discorb::ApplicationCommand::Command.types
 #: ../lib/discorb/command.rb:390
 #: ../lib/discorb/gateway_requests.rb:45
 msgid "Returns the value of attribute types."
@@ -9873,7 +9873,7 @@ msgstr ""
 msgid "Response with `UPDATE_MESSAGE`(`7`)."
 msgstr ""
 
-# Discorb::CommandInteraction
+# Discorb::ApplicationCommandInteraction
 #: ../lib/discorb/interaction.rb:245
 msgid "Represents a command interaction."
 msgstr ""
@@ -9883,12 +9883,12 @@ msgstr ""
 msgid "Implement this."
 msgstr ""
 
-# Discorb::CommandInteraction::SlashCommand
+# Discorb::ApplicationCommandInteraction::SlashCommand
 #: ../lib/discorb/interaction.rb:254
 msgid "Represents a slash command interaction."
 msgstr ""
 
-# Discorb::CommandInteraction::UserMenuCommand
+# Discorb::ApplicationCommandInteraction::UserMenuCommand
 #: ../lib/discorb/interaction.rb:310
 msgid "Represents a user context menu interaction."
 msgstr ""
@@ -9898,7 +9898,7 @@ msgstr ""
 msgid "The target user."
 msgstr ""
 
-# Discorb::CommandInteraction::MessageMenuCommand
+# Discorb::ApplicationCommandInteraction::MessageMenuCommand
 #: ../lib/discorb/interaction.rb:325
 msgid "Represents a message context menu interaction."
 msgstr ""
@@ -9908,7 +9908,7 @@ msgstr ""
 msgid "The target message."
 msgstr ""
 
-# Discorb::CommandInteraction.command_type
+# Discorb::ApplicationCommandInteraction.command_type
 #: ../lib/discorb/interaction.rb:348
 msgid "Returns the value of attribute command_type."
 msgstr ""