discorb 0.5.4 → 0.6.1

data/lib/discorb/channel.rb

@@ -171,7 +171,7 @@ module Discorb
     #
     # @param [String] reason The reason of deleting the channel.
     #
-    # @return [self] The deleted channel.
+    # @return [Async::Task<self>] The deleted channel.
     #
     def delete!(reason: nil)
       Async do
@@ -194,7 +194,7 @@ module Discorb
     # @param [Discorb::CategoryChannel] parent The parent of channel.
     # @param [String] reason The reason of moving the channel.
     #
-    # @return [self] The moved channel.
+    # @return [Async::Task<self>] The moved channel.
     #
     def move(position, lock_permissions: false, parent: :unset, reason: nil)
       Async do
@@ -273,7 +273,7 @@ module Discorb
     # @param [Integer] archive_in Alias of `default_auto_archive_duration`.
     # @param [String] reason The reason of editing the channel.
     #
-    # @return [self] The edited channel.
+    # @return [Async::Task<self>] The edited channel.
     #
     def edit(name: :unset, position: :unset, category: :unset, parent: :unset,
              topic: :unset, nsfw: :unset, announce: :unset,
@@ -310,7 +310,7 @@ module Discorb
     # @param [String] name The name of the webhook.
     # @param [Discorb::Image] avatar The avatar of the webhook.
     #
-    # @return [Discorb::Webhook::IncomingWebhook] The created webhook.
+    # @return [Async::Task<Discorb::Webhook::IncomingWebhook>] The created webhook.
     #
     def create_webhook(name, avatar: nil)
       Async do
@@ -327,7 +327,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Webhook>] The webhooks in the channel.
+    # @return [Async::Task<Array<Discorb::Webhook>>] The webhooks in the channel.
     #
     def fetch_webhooks
       Async do
@@ -419,7 +419,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Invite>] The invites in the channel.
+    # @return [Async::Task<Array<Discorb::Invite>>] The invites in the channel.
     #
     def fetch_invites
       Async do
@@ -440,7 +440,7 @@ module Discorb
     #   @note if it's `false` it may return existing invite.
     # @param [String] reason The reason of creating the invite.
     #
-    # @return [Invite] The created invite.
+    # @return [Async::Task<Invite>] The created invite.
     #
     def create_invite(max_age: nil, max_uses: nil, temporary: false, unique: false, reason: nil)
       Async do
@@ -487,7 +487,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Message>] The pinned messages in the channel.
+    # @return [Async::Task<Array<Discorb::Message>>] The pinned messages in the channel.
     #
     def fetch_pins
       Async do
@@ -535,7 +535,7 @@ module Discorb
     # @param [Boolean] public Whether the thread is public.
     # @param [String] reason The reason of starting the thread.
     #
-    # @return [Discorb::ThreadChannel] The started thread.
+    # @return [Async::Task<Discorb::ThreadChannel>] The started thread.
     #
     def start_thread(name, message: nil, auto_archive_duration: 1440, public: true, reason: nil)
       Async do
@@ -560,7 +560,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::ThreadChannel>] The archived threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived threads in the channel.
     #
     def fetch_archived_public_threads
       Async do
@@ -574,7 +574,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::ThreadChannel>] The archived private threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived private threads in the channel.
     #
     def fetch_archived_private_threads
       Async do
@@ -591,7 +591,7 @@ module Discorb
     # @param [Integer] limit The limit of threads to fetch.
     # @param [Time] before <description>
     #
-    # @return [Array<Discorb::ThreadChannel>] The joined archived private threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The joined archived private threads in the channel.
     #
     def fetch_joined_archived_private_threads(limit: nil, before: nil)
       Async do
@@ -660,7 +660,7 @@ module Discorb
     # @param [Symbol] rtc_region The region of the voice channel.
     # @param [String] reason The reason of editing the voice channel.
     #
-    # @return [self] The edited voice channel.
+    # @return [Async::Task<self>] The edited voice channel.
     #
     def edit(name: :unset, position: :unset, bitrate: :unset, user_limit: :unset, rtc_region: :unset, reason: nil)
       Async do
@@ -728,7 +728,7 @@ module Discorb
     # @param [Symbol] rtc_region The region of the stage channel.
     # @param [String] reason The reason of editing the stage channel.
     #
-    # @return [self] The edited stage channel.
+    # @return [Async::Task<self>] The edited stage channel.
     #
     def edit(name: :unset, position: :unset, bitrate: :unset, rtc_region: :unset, reason: nil)
       Async do
@@ -753,7 +753,7 @@ module Discorb
     # @param [Boolean] public Whether the stage instance is public or not.
     # @param [String] reason The reason of starting the stage instance.
     #
-    # @return [Discorb::StageInstance] The started stage instance.
+    # @return [Async::Task<Discorb::StageInstance>] The started stage instance.
     #
     def start(topic, public: false, reason: nil)
       Async do
@@ -767,8 +767,8 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [StageInstance] The current stage instance.
-    # @return [nil] If there is no current stage instance.
+    # @return [Async::Task<StageInstance>] The current stage instance.
+    # @return [Async::Task<nil>] If there is no current stage instance.
     #
     def fetch_stage_instance
       Async do
@@ -853,7 +853,7 @@ module Discorb
     # @param [Boolean] locked Whether the thread is locked or not.
     # @param [String] reason The reason of editing the thread.
     #
-    # @return [self] The edited thread.
+    # @return [Async::Task<self>] The edited thread.
     #
     # @see #archive
     # @see #lock

data/lib/discorb/client.rb

@@ -41,7 +41,7 @@ module Discorb
     attr_reader :messages
     # @return [Discorb::Logger] The logger.
     attr_reader :log
-    # @return [Array<Discorb::Command::Command>] The commands that the client is using.
+    # @return [Array<Discorb::ApplicationCommand::Command>] The commands that the client is using.
     attr_reader :commands
     # @return [Float] The ping of the client.
     #   @note This will be calculated from heartbeat and heartbeat_ack.
@@ -99,14 +99,15 @@ module Discorb
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id Custom ID of the event.
-    # @param [Hash] discriminator The discriminator of the event.
+    # @param [Hash] metadata The metadata of the event.
     # @param [Proc] block The block to execute when the event is triggered.
     #
     # @return [Discorb::Event] The event.
     #
-    def on(event_name, id: nil, **discriminator, &block)
-      ne = Event.new(block, id, discriminator)
+    def on(event_name, id: nil, **metadata, &block)
+      ne = Event.new(block, id, metadata)
       @events[event_name] ||= []
+      @events[event_name].delete_if { |e| e.metadata[:override] }
       @events[event_name] << ne
       ne
     end
@@ -118,12 +119,9 @@ module Discorb
     #
     # @return [Discorb::Event] The event.
     #
-    def once(event_name, id: nil, **discriminator, &block)
-      discriminator[:once] = true
-      ne = Event.new(block, id, discriminator)
-      @events[event_name] ||= []
-      @events[event_name] << ne
-      ne
+    def once(event_name, id: nil, **metadata, &block)
+      metadata[:once] = true
+      on(event_name, id: id, **metadata, &block)
     end
 
     #
@@ -177,7 +175,7 @@ module Discorb
           lambda { |event_args|
             Async(annotation: "Discorb event: #{event_name}") do |task|
               if block.is_a?(Discorb::Event)
-                @events[event_name].delete(block) if block.discriminator[:once]
+                @events[event_name].delete(block) if block.metadata[:once]
               end
               block.call(*event_args)
               @log.debug "Dispatched proc with ID #{block.id.inspect}"
@@ -202,7 +200,7 @@ module Discorb
     #
     # @param [#to_s] id <description>
     #
-    # @return [Discorb::User] The user.
+    # @return [Async::Task<Discorb::User>] The user.
     #
     # @raise [Discorb::NotFoundError] If the user doesn't exist.
     #
@@ -220,7 +218,7 @@ module Discorb
     #
     # @param [#to_s] id The ID of the channel.
     #
-    # @return [Discorb::Channel] The channel.
+    # @return [Async::Task<Discorb::Channel>] The channel.
     #
     # @raise [Discorb::NotFoundError] If the channel doesn't exist.
     #
@@ -238,7 +236,7 @@ module Discorb
     #
     # @param [#to_s] id <description>
     #
-    # @return [Discorb::Guild] The guild.
+    # @return [Async::Task<Discorb::Guild>] The guild.
     #
     # @raise [Discorb::NotFoundError] If the guild doesn't exist.
     #
@@ -258,7 +256,7 @@ module Discorb
     # @param [Boolean] with_count Whether to include the count of the invite.
     # @param [Boolean] with_expiration Whether to include the expiration of the invite.
     #
-    # @return [Discorb::Invite] The invite.
+    # @return [Async::Task<Discorb::Invite>] The invite.
     #
     def fetch_invite(code, with_count: false, with_expiration: false)
       Async do
@@ -275,7 +273,7 @@ module Discorb
     #
     # @param [Boolean] force Whether to force the fetch.
     #
-    # @return [Discorb::Application] The application.
+    # @return [Async::Task<Discorb::Application>] The application.
     #
     def fetch_application(force: false)
       Async do
@@ -292,7 +290,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Sticker::Pack>] The packs.
+    # @return [Async::Task<Array<Discorb::Sticker::Pack>>] The packs.
     #
     def fetch_nitro_sticker_packs
       Async do
@@ -369,10 +367,11 @@ module Discorb
     def extend(mod)
       if mod.respond_to?(:events)
         @events.each_value do |event|
-          event.delete_if { |c| c.discriminator[:extension] == mod.name }
+          event.delete_if { |c| c.metadata[:extension] == mod.name }
         end
         mod.events.each do |name, events|
-          @events[name] = [] if @events[name].nil?
+          @events[name] ||= []
+          @events[name].delete_if { |c| c.metadata[:override] }
           events.each do |event|
             @events[name] << event
           end
@@ -391,16 +390,20 @@ module Discorb
     end
 
     include Discorb::Gateway::Handler
-    include Discorb::Command::Handler
+    include Discorb::ApplicationCommand::Handler
 
     #
     # Starts the client.
     # @note This method behavior will change by CLI.
     # @see file:docs/cli.md
     #
-    # @param [String] token The token to use.
+    # @param [String, nil] token The token to use.
     #
-    def run(token)
+    # @note If the token is nil, you should use `discorb run` with the `-t` or `--token` option.
+    #
+    def run(token = nil)
+      token ||= ENV["DISCORB_CLI_TOKEN"]
+      raise ArgumentError, "Token is not specified, and -t/--token is not specified" if token.nil?
       case ENV["DISCORB_CLI_FLAG"]
       when nil
         start_client(token)
@@ -436,7 +439,14 @@ module Discorb
         end
         start_client(token)
       when "setup"
-        setup_commands(token)
+        guild_ids = "global"
+        if guilds = ENV["DISCORB_SETUP_GUILDS"]
+          guild_ids = guilds.split(",")
+        end
+        if guild_ids == ["global"]
+          guild_ids = false
+        end
+        setup_commands(token, guild_ids: guild_ids).wait
       end
     end
 
@@ -460,7 +470,7 @@ module Discorb
         }
         @token = token.to_s
         @close_condition = Async::Condition.new
-        main_task = Async do
+        @main_task = Async do
           @status = :running
           connect_gateway(true).wait
         rescue
@@ -469,7 +479,7 @@ module Discorb
           raise
         end
         @close_condition.wait
-        main_task.stop
+        @main_task.stop
       end
     end
   end

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.5.4"
+  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/embed.rb

@@ -65,9 +65,9 @@ module Discorb
         @timestamp = data[:timestamp] && Time.iso8601(data[:timestamp])
         @type = data[:type]
         @color = data[:color] && Color.new(data[:color])
-        @footer = data[:footer] && Footer.new(data[:footer][:text], icon: data[:footer][:icon])
+        @footer = data[:footer] && Footer.new(data[:footer][:text], icon: data[:footer][:icon_url])
         @author = if data[:author]
-            Author.new(data[:author][:name], icon: data[:author][:icon],
+            Author.new(data[:author][:name], icon: data[:author][:icon_url],
                                              url: data[:author][:url])
           end
         @thumbnail = data[:thumbnail] && Thumbnail.new(data[:thumbnail])

data/lib/discorb/emoji.rb

@@ -6,6 +6,13 @@ module Discorb
   # Represents a Discord emoji.
   # @abstract
   class Emoji
+    def eql?(other)
+      other.is_a?(self.class) && other.to_uri == to_uri
+    end
+
+    def ==(other)
+      eql?(other)
+    end
   end
 
   # Represents a custom emoji in discord.
@@ -79,7 +86,7 @@ module Discorb
     # @param [Array<Discorb::Role>] roles The new roles that can use this emoji.
     # @param [String] reason The reason for editing the emoji.
     #
-    # @return [self] The edited emoji.
+    # @return [Async::Task<self>] The edited emoji.
     #
     def edit(name: :unset, roles: :unset, reason: nil)
       Async do
@@ -100,7 +107,7 @@ module Discorb
     #
     # @param [String] reason The reason for deleting the emoji.
     #
-    # @return [self] The deleted emoji.
+    # @return [Async::Task<self>] The deleted emoji.
     #
     def delete!(reason: nil)
       Async do