discorb 0.13.0 → 0.13.1

data/lib/discorb/channel.rb

@@ -166,8 +166,7 @@ module Discorb
 
     #
     # Deletes the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] reason The reason of deleting the channel.
     #
@@ -186,8 +185,7 @@ module Discorb
 
     #
     # Moves the channel to another position.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] position The position to move the channel.
     # @param [Boolean] lock_permissions Whether to lock the permissions of the channel.
@@ -196,13 +194,13 @@ module Discorb
     #
     # @return [Async::Task<self>] The moved channel.
     #
-    def move(position, lock_permissions: false, parent: :unset, reason: nil)
+    def move(position, lock_permissions: false, parent: Discorb::Unset, reason: nil)
       Async do
         payload = {
           position: position,
         }
         payload[:lock_permissions] = lock_permissions
-        payload[:parent_id] = parent&.id if parent != :unset
+        payload[:parent_id] = parent&.id if parent != Discorb::Unset
         @client.http.patch("/guilds/#{@guild_id}/channels", payload, audit_log_reason: reason).wait
       end
     end
@@ -256,8 +254,7 @@ module Discorb
 
     #
     # Edits the channel.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The name of the channel.
@@ -275,25 +272,25 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited channel.
     #
-    def edit(name: :unset, position: :unset, category: :unset, parent: :unset,
-             topic: :unset, nsfw: :unset, announce: :unset,
-             rate_limit_per_user: :unset, slowmode: :unset, default_auto_archive_duration: :unset,
-             archive_in: :unset, reason: nil)
+    def edit(name: Discorb::Unset, position: Discorb::Unset, category: Discorb::Unset, parent: Discorb::Unset,
+             topic: Discorb::Unset, nsfw: Discorb::Unset, announce: Discorb::Unset,
+             rate_limit_per_user: Discorb::Unset, slowmode: Discorb::Unset, default_auto_archive_duration: Discorb::Unset,
+             archive_in: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:announce] = announce ? 5 : 0 if announce != :unset
-        payload[:position] = position if position != :unset
-        payload[:topic] = topic || "" if topic != :unset
-        payload[:nsfw] = nsfw if nsfw != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:announce] = announce ? 5 : 0 if announce != Discorb::Unset
+        payload[:position] = position if position != Discorb::Unset
+        payload[:topic] = topic || "" if topic != Discorb::Unset
+        payload[:nsfw] = nsfw if nsfw != Discorb::Unset
 
-        slowmode = rate_limit_per_user if slowmode == :unset
-        payload[:rate_limit_per_user] = slowmode || 0 if slowmode != :unset
-        parent = category if parent == :unset
-        payload[:parent_id] = parent&.id if parent != :unset
+        slowmode = rate_limit_per_user if slowmode == Discorb::Unset
+        payload[:rate_limit_per_user] = slowmode || 0 if slowmode != Discorb::Unset
+        parent = category if parent == Discorb::Unset
+        payload[:parent_id] = parent&.id if parent != Discorb::Unset
 
         default_auto_archive_duration ||= archive_in
-        payload[:default_auto_archive_duration] = default_auto_archive_duration if default_auto_archive_duration != :unset
+        payload[:default_auto_archive_duration] = default_auto_archive_duration if default_auto_archive_duration != Discorb::Unset
 
         @client.http.patch("/channels/#{@id}", payload, audit_log_reason: reason).wait
         self
@@ -304,8 +301,7 @@ module Discorb
 
     #
     # Create webhook in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the webhook.
     # @param [Discorb::Image] avatar The avatar of the webhook.
@@ -324,8 +320,7 @@ module Discorb
 
     #
     # Fetch webhooks in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Webhook>>] The webhooks in the channel.
     #
@@ -338,12 +333,13 @@ module Discorb
 
     #
     # Bulk delete messages in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Message] messages The messages to delete.
     # @param [Boolean] force Whether to ignore the validation for message (14 days limit).
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete_messages!(*messages, force: false)
       Async do
         messages = messages.first if messages.length == 1 && messages.first.is_a?(Array)
@@ -367,12 +363,13 @@ module Discorb
 
     #
     # Set the channel's permission overwrite.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Role, Discorb::Member] target The target of the overwrite.
     # @param [String] reason The reason of setting the overwrite.
-    # @param [Symbol => Boolean] perms The permission overwrites to replace.
+    # @param [{Symbol => Boolean}] perms The permission overwrites to replace.
+    #
+    # @return [Async::Task<void>] The task.
     #
     def set_permissions(target, reason: nil, **perms)
       Async do
@@ -398,12 +395,13 @@ module Discorb
 
     #
     # Delete the channel's permission overwrite.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Role, Discorb::Member] target The target of the overwrite.
     # @param [String] reason The reason of deleting the overwrite.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete_permissions(target, reason: nil)
       Async do
         @client.http.delete("/channels/#{@id}/permissions/#{target.id}", audit_log_reason: reason).wait
@@ -416,8 +414,7 @@ module Discorb
 
     #
     # Fetch the channel's invites.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Invite>>] The invites in the channel.
     #
@@ -430,8 +427,7 @@ module Discorb
 
     #
     # Create an invite in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] max_age The max age of the invite.
     # @param [Integer] max_uses The max uses of the invite.
@@ -456,12 +452,13 @@ module Discorb
 
     #
     # Follow the existing announcement channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::NewsChannel] target The channel to follow.
     # @param [String] reason The reason of following the channel.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def follow_from(target, reason: nil)
       Async do
         @client.http.post("/channels/#{target.id}/followers", { webhook_channel_id: @id }, audit_log_reason: reason).wait
@@ -470,12 +467,13 @@ module Discorb
 
     #
     # Follow the existing announcement channel from self.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::TextChannel] target The channel to follow to.
     # @param [String] reason The reason of following the channel.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def follow_to(target, reason: nil)
       Async do
         @client.http.post("/channels/#{@id}/followers", { webhook_channel_id: target.id }, audit_log_reason: reason).wait
@@ -484,8 +482,7 @@ module Discorb
 
     #
     # Start thread in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the thread.
     # @param [Discorb::Message] message The message to start the thread.
@@ -522,8 +519,7 @@ module Discorb
 
     #
     # Fetch archived threads in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived threads in the channel.
     #
@@ -536,8 +532,7 @@ module Discorb
 
     #
     # Fetch archived private threads in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived private threads in the channel.
     #
@@ -550,8 +545,7 @@ module Discorb
 
     #
     # Fetch joined archived private threads in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] limit The limit of threads to fetch.
     # @param [Time] before <description>
@@ -614,8 +608,7 @@ module Discorb
     @channel_type = 2
     #
     # Edit the voice channel.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The name of the voice channel.
@@ -627,14 +620,14 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited voice channel.
     #
-    def edit(name: :unset, position: :unset, bitrate: :unset, user_limit: :unset, rtc_region: :unset, reason: nil)
+    def edit(name: Discorb::Unset, position: Discorb::Unset, bitrate: Discorb::Unset, user_limit: Discorb::Unset, rtc_region: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:position] = position if position != :unset
-        payload[:bitrate] = bitrate if bitrate != :unset
-        payload[:user_limit] = user_limit if user_limit != :unset
-        payload[:rtc_region] = rtc_region if rtc_region != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:position] = position if position != Discorb::Unset
+        payload[:bitrate] = bitrate if bitrate != Discorb::Unset
+        payload[:user_limit] = user_limit if user_limit != Discorb::Unset
+        payload[:rtc_region] = rtc_region if rtc_region != Discorb::Unset
 
         @client.http.patch("/channels/#{@id}", payload, audit_log_reason: reason).wait
         self
@@ -683,8 +676,7 @@ module Discorb
 
     #
     # Edit the stage channel.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The name of the stage channel.
@@ -695,13 +687,13 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited stage channel.
     #
-    def edit(name: :unset, position: :unset, bitrate: :unset, rtc_region: :unset, reason: nil)
+    def edit(name: Discorb::Unset, position: Discorb::Unset, bitrate: Discorb::Unset, rtc_region: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:position] = position if position != :unset
-        payload[:bitrate] = bitrate if bitrate != :unset
-        payload[:rtc_region] = rtc_region if rtc_region != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:position] = position if position != Discorb::Unset
+        payload[:bitrate] = bitrate if bitrate != Discorb::Unset
+        payload[:rtc_region] = rtc_region if rtc_region != Discorb::Unset
         @client.http.patch("/channels/#{@id}", payload, audit_log_reason: reason).wait
         self
       end
@@ -711,8 +703,7 @@ module Discorb
 
     #
     # Start a stage instance.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] topic The topic of the stage instance.
     # @param [Boolean] public Whether the stage instance is public or not.
@@ -729,8 +720,7 @@ module Discorb
 
     #
     # Fetch a current stage instance.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<StageInstance>] The current stage instance.
     # @return [Async::Task<nil>] If there is no current stage instance.
@@ -792,6 +782,19 @@ module Discorb
     # @!attribute [r] parent
     #   @macro client_cache
     #   @return [Discorb::GuildChannel] The parent channel of the thread.
+    # @!attribute [r] me
+    #   @return [Discorb::ThreadChannel::Member] The bot's member in the thread.
+    #   @return [nil] If the bot is not in the thread.
+    # @!attribute [r] joined?
+    #   @return [Boolean] Whether the bot is in the thread or not.
+    # @!attribute [r] guild
+    #   @macro client_cache
+    #   @return [Discorb::Guild] The guild of the thread.
+    # @!attribute [r] owner
+    #   @macro client_cache
+    #   @macro members_intent
+    #   @return [Discorb::Member] The owner of the thread.
+
 
     include Messageable
     @channel_type = nil
@@ -807,8 +810,7 @@ module Discorb
 
     #
     # Edit the thread.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The name of the thread.
@@ -825,14 +827,14 @@ module Discorb
     # @see #unarchive
     # @see #unlock
     #
-    def edit(name: :unset, archived: :unset, auto_archive_duration: :unset, archive_in: :unset, locked: :unset, reason: nil)
+    def edit(name: Discorb::Unset, archived: Discorb::Unset, auto_archive_duration: Discorb::Unset, archive_in: Discorb::Unset, locked: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:archived] = archived if archived != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:archived] = archived if archived != Discorb::Unset
         auto_archive_duration ||= archive_in
-        payload[:auto_archive_duration] = auto_archive_duration if auto_archive_duration != :unset
-        payload[:locked] = locked if locked != :unset
+        payload[:auto_archive_duration] = auto_archive_duration if auto_archive_duration != Discorb::Unset
+        payload[:locked] = locked if locked != Discorb::Unset
         @client.http.patch("/channels/#{@id}", payload, audit_log_reason: reason).wait
         self
       end
@@ -897,7 +899,7 @@ module Discorb
     end
 
     def joined?
-      @members[@client.user.id]
+      !!me
     end
 
     def guild
@@ -912,6 +914,13 @@ module Discorb
       "#<#{self.class} \"##{@name}\" id=#{@id}>"
     end
 
+    #
+    # Add a member to the thread.
+    #
+    # @param [Discorb::Member, :me] member The member to add. If `:me` is given, the bot will be added.
+    #
+    # @return [Async::Task<void>] The task.
+    #
     def add_member(member = :me)
       Async do
         if member == :me
@@ -924,6 +933,13 @@ module Discorb
 
     alias join add_member
 
+    #
+    # Remove a member from the thread.
+    #
+    # @param [Discorb::Member, :me] member The member to remove. If `:me` is given, the bot will be removed.
+    #
+    # @return [Async::Task<void>] The task.
+    #
     def remove_member(member = :me)
       Async do
         if member == :me
@@ -936,6 +952,11 @@ module Discorb
 
     alias leave remove_member
 
+    #
+    # Fetch members in the thread.
+    #
+    # @return [Array<Discorb::ThreadChannel::Member>] The members in the thread.
+    #
     def fetch_members
       Async do
         _resp, data = @client.http.get("/channels/#{@id}/thread-members").wait
@@ -959,6 +980,9 @@ module Discorb
       attr_reader :channel_type
     end
 
+    #
+    # Repre
+    #
     class Member < DiscordModel
       attr_reader :joined_at
 

data/lib/discorb/client.rb

@@ -105,7 +105,7 @@ module Discorb
 
     #
     # Registers an event handler.
-    # @see file:docs/Events.md
+    # @see file:docs/Events.md Events Documentation
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id Custom ID of the event.
@@ -146,10 +146,13 @@ module Discorb
 
     #
     # Dispatch an event.
+    # @async
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Object] args The arguments to pass to the event.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def dispatch(event_name, *args)
       Async do
         if (conditions = @conditions[event_name])
@@ -199,8 +202,7 @@ module Discorb
 
     #
     # Fetch user from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id <description>
     #
@@ -217,8 +219,7 @@ module Discorb
 
     #
     # Fetch channel from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id The ID of the channel.
     #
@@ -235,8 +236,7 @@ module Discorb
 
     #
     # Fetch guild from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id <description>
     #
@@ -253,8 +253,7 @@ module Discorb
 
     #
     # Fetch invite from code.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] code The code of the invite.
     # @param [Boolean] with_count Whether to include the count of the invite.
@@ -272,8 +271,7 @@ module Discorb
     #
     # Fetch webhook from ID.
     # If application was cached, it will be used.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Boolean] force Whether to force the fetch.
     #
@@ -291,8 +289,7 @@ module Discorb
 
     #
     # Fetch nitro sticker pack from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Sticker::Pack>>] The packs.
     #
@@ -334,12 +331,13 @@ module Discorb
 
     #
     # Method to wait for a event.
+    # @async
     #
     # @param [Symbol] event The name of the event.
     # @param [Integer] timeout The timeout in seconds.
     # @param [Proc] check The check to use.
     #
-    # @return [Object] The result of the event.
+    # @return [Async::Task<Object>] The result of the event.
     #
     # @raise [Discorb::TimeoutError] If the event didn't occur in time.
     #
@@ -416,7 +414,7 @@ module Discorb
     #
     # Starts the client.
     # @note This method behavior will change by CLI.
-    # @see file:docs/cli.md
+    # @see file:docs/cli.md CLI documentation
     #
     # @param [String, nil] token The token to use.
     #

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.13.0"
+  VERSION = "0.13.1"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 
@@ -117,6 +117,8 @@ module Discorb
     alias id to_s
   end
 
+  # @return [Object] Object that represents nil.
+  #   This is used as a default value for optional parameters.
   Unset = Object.new
   class << Unset
     def method_missing(*)

data/lib/discorb/emoji.rb

@@ -82,8 +82,7 @@ module Discorb
 
     #
     # Edit the emoji.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The new name of the emoji.
@@ -92,11 +91,11 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited emoji.
     #
-    def edit(name: :unset, roles: :unset, reason: nil)
+    def edit(name: Discorb::Unset, roles: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != Discorb::Unset
         @client.http.patch("/guilds/#{@guild.id}/emojis/#{@id}", payload, audit_log_reason: reason)
         self
       end
@@ -106,8 +105,7 @@ module Discorb
 
     #
     # Delete the emoji.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] reason The reason for deleting the emoji.
     #