discorb 0.13.0 → 0.13.4

data/lib/discorb/member.rb

@@ -143,36 +143,37 @@ module Discorb
 
     #
     # Add a role to the member.
-    # @macro http
-    # @macro async
+    # @async
     #
     # @param [Discorb::Role] role The role to add.
     # @param [String] reason The reason for the action.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def add_role(role, reason: nil)
       Async do
-        @client.http.put("/guilds/#{@guild_id}/members/#{@id}/roles/#{role.is_a?(Role) ? role.id : role}", nil, audit_log_reason: reason).wait
+        @client.http.request(Route.new("/guilds/#{@guild_id}/members/#{@id}/roles/#{role.is_a?(Role) ? role.id : role}", "//guilds/:guild_id/members/:user_id/roles/:role_id", :put), nil, audit_log_reason: reason).wait
       end
     end
 
     #
     # Remove a role to the member.
-    # @macro http
-    # @macro async
+    # @async
     #
     # @param [Discorb::Role] role The role to add.
     # @param [String] reason The reason for the action.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def remove_role(role, reason: nil)
       Async do
-        @client.http.delete("/guilds/#{@guild_id}/members/#{@id}/roles/#{role.is_a?(Role) ? role.id : role}", audit_log_reason: reason).wait
+        @client.http.request(Route.new("/guilds/#{@guild_id}/members/#{@id}/roles/#{role.is_a?(Role) ? role.id : role}", "//guilds/:guild_id/members/:user_id/roles/:role_id", :delete), audit_log_reason: reason).wait
       end
     end
 
     #
     # Edit the member.
-    # @macro http
-    # @macro async
+    # @async
     # @macro edit
     #
     # @param [String] nick The nickname of the member.
@@ -180,27 +181,54 @@ module Discorb
     # @param [Boolean] mute Whether the member is muted.
     # @param [Boolean] deaf Whether the member is deafened.
     # @param [Discorb::StageChannel] channel The channel the member is moved to.
+    # @param [Time, nil] communication_disabled_until The time the member is timed out. Set to `nil` to end the timeout.
+    # @param [Time, nil] timeout_until Alias of `communication_disabled_until`.
     # @param [String] reason The reason for the action.
     #
-    def edit(nick: :unset, role: :unset, mute: :unset, deaf: :unset, channel: :unset, reason: nil)
+    # @return [Async::Task<void>] The task.
+    #
+    def edit(
+      nick: Discorb::Unset, role: Discorb::Unset, mute: Discorb::Unset, deaf: Discorb::Unset, channel: Discorb::Unset, communication_disabled_until: Discorb::Unset, timeout_until: Discorb::Unset,
+      reason: nil
+    )
       Async do
         payload = {}
-        payload[:nick] = nick if nick != :unset
-        payload[:roles] = role if role != :unset
-        payload[:mute] = mute if mute != :unset
-        payload[:deaf] = deaf if deaf != :unset
-        payload[:channel_id] = channel&.id if channel != :unset
-        @client.http.patch("/guilds/#{@guild_id}/members/#{@id}", payload, audit_log_reason: reason).wait
+        payload[:nick] = nick if nick != Discorb::Unset
+        payload[:roles] = role if role != Discorb::Unset
+        payload[:mute] = mute if mute != Discorb::Unset
+        payload[:deaf] = deaf if deaf != Discorb::Unset
+        communication_disabled_until = timeout_until if timeout_until != Discorb::Unset
+        payload[:communication_disabled_until] = communication_disabled_until&.iso8601 if communication_disabled_until != Discorb::Unset
+        payload[:channel_id] = channel&.id if channel != Discorb::Unset
+        @client.http.request(Route.new("/guilds/#{@guild_id}/members/#{@id}", "//guilds/:guild_id/members/:user_id", :patch), payload, audit_log_reason: reason).wait
       end
     end
 
     alias modify edit
 
+    #
+    # Timeout the member.
+    # @async
+    #
+    # @param [Time] time The time until the member is timeout.
+    # @param [String] reason The reason for the action.
+    #
+    # @return [Async::Task<void>] The task.
+    #
+    def timeout(time, reason: nil)
+      edit(communication_disabled_until: time, reason: reason)
+    end
+
+    alias disable_communication timeout
+
     #
     # Kick the member.
+    # @async
     #
     # @param [String] reason The reason for the action.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def kick(reason: nil)
       Async do
         guild.kick_member(self, reason: reason).wait
@@ -209,6 +237,7 @@ module Discorb
 
     #
     # Ban the member.
+    # @async
     #
     # @param [Integer] delete_message_days The number of days to delete messages.
     # @param [String] reason The reason for the action.

data/lib/discorb/message.rb

@@ -294,6 +294,7 @@ module Discorb
 
     #
     # Edit the message.
+    # @async
     #
     # @param [String] content The message content.
     # @param [Discorb::Embed] embed The embed to send.
@@ -302,6 +303,8 @@ module Discorb
     # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
     # @param [Boolean] supress Whether to supress embeds.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def edit(content = nil, embed: nil, embeds: nil, allowed_mentions: nil,
                             components: nil, supress: nil)
       Async do
@@ -312,9 +315,12 @@ module Discorb
 
     #
     # Delete the message.
+    # @async
     #
     # @param [String] reason The reason for deleting the message.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete!(reason: nil)
       Async do
         channel.delete_message!(@id, reason: reason).wait
@@ -342,8 +348,7 @@ module Discorb
     end
 
     # Reply to the message.
-    # @macro async
-    # @macro http
+    # @async
     # @param (see #post)
     # @return [Async::Task<Discorb::Message>] The message.
     def reply(*args, **kwargs)
@@ -354,8 +359,9 @@ module Discorb
 
     #
     # Publish the message.
-    # @macro async
-    # @macro http
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
     #
     def publish
       Async do
@@ -365,14 +371,15 @@ module Discorb
 
     #
     # Add a reaction to the message.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Emoji] emoji The emoji to react with.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def add_reaction(emoji)
       Async do
-        @client.http.put("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}/@me", nil).wait
+        @client.http.request(Route.new("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}/@me", "//channels/:channel_id/messages/:message_id/reactions/:emoji/@me", :put), nil).wait
       end
     end
 
@@ -380,14 +387,15 @@ module Discorb
 
     #
     # Remove a reaction from the message.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Emoji] emoji The emoji to remove.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def remove_reaction(emoji)
       Async do
-        @client.http.delete("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}/@me").wait
+        @client.http.request(Route.new("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}/@me", "//channels/:channel_id/messages/:message_id/reactions/:emoji/@me", :delete)).wait
       end
     end
 
@@ -395,15 +403,16 @@ module Discorb
 
     #
     # Remove other member's reaction from the message.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Emoji] emoji The emoji to remove.
     # @param [Discorb::Member] member The member to remove the reaction from.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def remove_reaction_of(emoji, member)
       Async do
-        @client.http.delete("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}/#{member.is_a?(Member) ? member.id : member}").wait
+        @client.http.request(Route.new("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}/#{member.is_a?(Member) ? member.id : member}", "//channels/:channel_id/messages/:message_id/reactions/:emoji/:user_id", :delete)).wait
       end
     end
 
@@ -411,8 +420,7 @@ module Discorb
 
     #
     # Fetch reacted users of reaction.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Emoji] emoji The emoji to fetch.
     # @param [Integer, nil] limit The maximum number of users to fetch. `nil` for no limit.
@@ -426,7 +434,7 @@ module Discorb
           after = 0
           users = []
           loop do
-            _resp, data = @client.http.get("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}?limit=100&after=#{after}").wait
+            _resp, data = @client.http.request(Route.new("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}?limit=100&after=#{after}", "//channels/:channel_id/messages/:message_id/reactions/:emoji", :get)).wait
             break if data.empty?
 
             users += data.map { |r| guild&.members&.[](r[:id]) || @client.users[r[:id]] || User.new(@client, r) }
@@ -437,7 +445,7 @@ module Discorb
           end
           next users
         else
-          _resp, data = @client.http.get("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}?limit=#{limit}&after=#{after}").wait
+          _resp, data = @client.http.request(Route.new("/channels/#{@channel_id}/messages/#{@id}/reactions/#{emoji.to_uri}?limit=#{limit}&after=#{after}", "//channels/:channel_id/messages/:message_id/reactions/:emoji", :get)).wait
           next data.map { |r| guild&.members&.[](r[:id]) || @client.users[r[:id]] || User.new(@client, r) }
         end
       end
@@ -445,11 +453,12 @@ module Discorb
 
     #
     # Pin the message.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] reason The reason for pinning the message.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def pin(reason: nil)
       Async do
         channel.pin_message(self, reason: reason).wait
@@ -458,11 +467,12 @@ module Discorb
 
     #
     # Unpin the message.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] reason The reason for unpinning the message.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def unpin(reason: nil)
       Async do
         channel.unpin_message(self, reason: reason).wait
@@ -471,10 +481,11 @@ module Discorb
 
     #
     # Start thread from the message.
+    # @async
     #
     # @param (see Discorb::Channel#start_thread)
     #
-    # @return [Async::Task<<Type>>] <description>
+    # @return [Async::Task<Discorb::ThreadChannel>] <description>
     #
     def start_thread(*args, **kwargs)
       Async do

data/lib/discorb/modules.rb

@@ -7,8 +7,7 @@ module Discorb
   module Messageable
     #
     # Post a message to the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] content The message content.
     # @param [Boolean] tts Whether the message is tts.
@@ -38,14 +37,8 @@ module Discorb
           allowed_mentions ? allowed_mentions.to_hash(@client.allowed_mentions) : @client.allowed_mentions.to_hash
         payload[:message_reference] = reference.to_reference if reference
         payload[:components] = Component.to_payload(components) if components
-        files = [file] if file
-        if files
-          seperator, payload = HTTP.multipart(payload, files)
-          headers = { "content-type" => "multipart/form-data; boundary=#{seperator}" }
-        else
-          headers = {}
-        end
-        _resp, data = @client.http.post("/channels/#{channel_id.wait}/messages", payload, headers: headers).wait
+        files = [file]
+        _resp, data = @client.http.multipart_request(Route.new("/channels/#{channel_id.wait}/messages", "//channels/:channel_id/messages", :post), payload, files).wait
         Message.new(@client, data.merge({ guild_id: @guild_id.to_s }))
       end
     end
@@ -54,8 +47,7 @@ module Discorb
 
     #
     # Edit a message.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] message_id The message id.
     # @param [String] content The message content.
@@ -65,6 +57,8 @@ module Discorb
     # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
     # @param [Boolean] supress Whether to supress embeds.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def edit_message(message_id, content = nil, embed: nil, embeds: nil, allowed_mentions: nil,
                                                 components: nil, supress: nil)
       Async do
@@ -80,21 +74,22 @@ module Discorb
           allowed_mentions ? allowed_mentions.to_hash(@client.allowed_mentions) : @client.allowed_mentions.to_hash
         payload[:components] = Component.to_payload(components) if components
         payload[:flags] = (supress ? 1 << 2 : 0) unless supress.nil?
-        @client.http.patch("/channels/#{channel_id.wait}/messages/#{message_id}", payload).wait
+        @client.http.request(Route.new("/channels/#{channel_id.wait}/messages/#{message_id}", "//channels/:channel_id/messages/:message_id", :patch), payload).wait
       end
     end
 
     #
     # Delete a message.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] message_id The message id.
     # @param [String] reason The reason for deleting the message.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete_message!(message_id, reason: nil)
       Async do
-        @client.http.delete("/channels/#{channel_id.wait}/messages/#{message_id}", audit_log_reason: reason).wait
+        @client.http.request(Route.new("/channels/#{channel_id.wait}/messages/#{message_id}", "//channels/:channel_id/messages/:message_id", :delete), audit_log_reason: reason).wait
       end
     end
 
@@ -102,8 +97,7 @@ module Discorb
 
     #
     # Fetch a message from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Snowflake] id The ID of the message.
     #
@@ -112,15 +106,14 @@ module Discorb
     #
     def fetch_message(id)
       Async do
-        _resp, data = @client.http.get("/channels/#{channel_id.wait}/messages/#{id}").wait
+        _resp, data = @client.http.request(Route.new("/channels/#{channel_id.wait}/messages/#{id}", "//channels/:channel_id/messages/:message_id", :get)).wait
         Message.new(@client, data.merge({ guild_id: @guild_id.to_s }))
       end
     end
 
     #
     # Fetch a message history.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] limit The number of messages to fetch.
     # @param [Discorb::Snowflake] before The ID of the message to fetch before.
@@ -137,57 +130,57 @@ module Discorb
           after: Discorb::Utils.try(around, :id),
           around: Discorb::Utils.try(before, :id),
         }.filter { |_k, v| !v.nil? }.to_h
-        _resp, messages = @client.http.get("/channels/#{channel_id.wait}/messages?#{URI.encode_www_form(params)}").wait
+        _resp, messages = @client.http.request(Route.new("/channels/#{channel_id.wait}/messages?#{URI.encode_www_form(params)}", "//channels/:channel_id/messages", :get)).wait
         messages.map { |m| Message.new(@client, m.merge({ guild_id: @guild_id.to_s })) }
       end
     end
 
     #
     # Fetch the pinned messages in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Message>>] The pinned messages in the channel.
     #
     def fetch_pins
       Async do
-        _resp, data = @client.http.get("/channels/#{channel_id.wait}/pins").wait
+        _resp, data = @client.http.request(Route.new("/channels/#{channel_id.wait}/pins", "//channels/:channel_id/pins", :get)).wait
         data.map { |pin| Message.new(@client, pin) }
       end
     end
 
     #
     # Pin a message in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Message] message The message to pin.
     # @param [String] reason The reason of pinning the message.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def pin_message(message, reason: nil)
       Async do
-        @client.http.put("/channels/#{channel_id.wait}/pins/#{message.id}", {}, audit_log_reason: reason).wait
+        @client.http.request(Route.new("/channels/#{channel_id.wait}/pins/#{message.id}", "//channels/:channel_id/pins/:message_id", :put), {}, audit_log_reason: reason).wait
       end
     end
 
     #
     # Unpin a message in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Message] message The message to unpin.
     # @param [String] reason The reason of unpinning the message.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def unpin_message(message, reason: nil)
       Async do
-        @client.http.delete("/channels/#{channel_id.wait}/pins/#{message.id}", audit_log_reason: reason).wait
+        @client.http.request(Route.new("/channels/#{channel_id.wait}/pins/#{message.id}", "//channels/:channel_id/pins/:message_id", :delete), audit_log_reason: reason).wait
       end
     end
 
     #
     # Trigger the typing indicator in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # If block is given, trigger typing indicator during executing block.
     # @example
@@ -202,7 +195,7 @@ module Discorb
         begin
           post_task = Async do
             loop do
-              @client.http.post("/channels/#{@id}/typing", {})
+              @client.http.request(Route.new("/channels/#{@id}/typing", "//channels/:channel_id/typing", :post), {})
               sleep(5)
             end
           end
@@ -212,7 +205,7 @@ module Discorb
         end
       else
         Async do |task|
-          @client.http.post("/channels/#{@id}/typing", {})
+          @client.http.request(Route.new("/channels/#{@id}/typing", "//channels/:channel_id/typing", :post), {})
         end
       end
     end

data/lib/discorb/presence.rb

@@ -175,12 +175,12 @@ module Discorb
       # Represents the assets of an activity.
       #
       class Asset < DiscordModel
-        # @return [String] The large image ID of the asset.
+        # @return [String] The large image ID or URL of the asset.
         attr_reader :large_image
         alias large_id large_image
         # @return [String] The large text of the activity.
         attr_reader :large_text
-        # @return [String] The small image ID of the activity.
+        # @return [String] The small image ID or URL of the activity.
         attr_reader :small_image
         alias small_id small_image
         # @return [String] The small text of the activity.

data/lib/discorb/rate_limit.rb

@@ -9,8 +9,8 @@ module Discorb
     # @private
     def initialize(client)
       @client = client
-      @current_ratelimits = {}
       @path_ratelimit_bucket = {}
+      @path_ratelimit_hash = {}
       @global = false
     end
 
@@ -21,12 +21,10 @@ module Discorb
     #
     # Wait for the rate limit to reset.
     #
-    # @param [String] method The HTTP method.
-    # @param [String] path The path.
+    # @param [Discorb::Route] path The path.
     #
-    def wait(method, path)
-      return if path.start_with?("https://")
-
+    def wait(path)
+      # return if path.url.start_with?("https://")
       if @global && @global > Time.now.to_f
         time = @global - Time.now.to_f
         @client.log.info("global rate limit reached, waiting #{time} seconds")
@@ -34,36 +32,34 @@ module Discorb
         @global = false
       end
 
-      return unless hash = @path_ratelimit_bucket[method + path]
+      return unless hash = @path_ratelimit_hash[path.identifier]
 
-      return unless b = @current_ratelimits[hash]
+      return unless bucket = @path_ratelimit_bucket[hash + path.major_param]
 
-      if b[:reset_at] < Time.now.to_f
-        @current_ratelimits.delete(hash)
+      if bucket[:reset_at] < Time.now.to_f
+        @path_ratelimit_bucket.delete(path.identifier + path.major_param)
         return
       end
-      return if b[:remaining] > 0
+      return if bucket[:remaining] > 0
 
-      time = b[:reset_at] - Time.now.to_f
-      @client.log.info("rate limit for #{method} #{path} reached, waiting #{time} seconds")
+      time = bucket[:reset_at] - Time.now.to_f
+      @client.log.info("rate limit for #{path.identifier} with #{path.major_param} reached, waiting #{time.round(4)} seconds")
       sleep(time)
     end
 
     #
     # Save the rate limit.
     #
-    # @param [String] method The HTTP method.
     # @param [String] path The path.
     # @param [Net::HTTPResponse] resp The response.
     #
-    def save(method, path, resp)
+    def save(path, resp)
       if resp["X-Ratelimit-Global"] == "true"
         @global = Time.now.to_f + JSON.parse(resp.body, symbolize_names: true)[:retry_after]
       end
       return unless resp["X-RateLimit-Remaining"]
-
-      @path_ratelimit_bucket[method + path] = resp["X-RateLimit-Bucket"]
-      @current_ratelimits[resp["X-RateLimit-Bucket"]] = {
+      @path_ratelimit_hash[path.identifier] = resp["X-Ratelimit-Bucket"]
+      @path_ratelimit_bucket[resp["X-Ratelimit-Bucket"] + path.major_param] = {
         remaining: resp["X-RateLimit-Remaining"].to_i,
         reset_at: Time.now.to_f + resp["X-RateLimit-Reset-After"].to_f,
       }

data/lib/discorb/role.rb

@@ -90,22 +90,22 @@ module Discorb
 
     #
     # Moves the role to a new position.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] position The new position.
     # @param [String] reason The reason for moving the role.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def move(position, reason: nil)
       Async do
-        @client.http.patch("/guilds/#{@guild.id}/roles", { id: @id, position: position }, audit_log_reason: reason).wait
+        @client.http.request(Route.new("/guilds/#{@guild.id}/roles", "//guilds/:guild_id/roles", :patch), { id: @id, position: position }, audit_log_reason: reason).wait
       end
     end
 
     #
     # Edits the role.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The new name of the role.
@@ -116,22 +116,24 @@ module Discorb
     # @param [Discorb::Image, Discorb::UnicodeEmoji] icon The new icon or emoji of the role.
     # @param [String] reason The reason for editing the role.
     #
-    def edit(name: :unset, position: :unset, color: :unset, hoist: :unset, mentionable: :unset, icon: :unset, reason: nil)
+    # @return [Async::Task<void>] The task.
+    #
+    def edit(name: Discorb::Unset, position: Discorb::Unset, color: Discorb::Unset, hoist: Discorb::Unset, mentionable: Discorb::Unset, icon: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:position] = position if position != :unset
-        payload[:color] = color.to_i if color != :unset
-        payload[:hoist] = hoist if hoist != :unset
-        payload[:mentionable] = mentionable if mentionable != :unset
-        if icon != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:position] = position if position != Discorb::Unset
+        payload[:color] = color.to_i if color != Discorb::Unset
+        payload[:hoist] = hoist if hoist != Discorb::Unset
+        payload[:mentionable] = mentionable if mentionable != Discorb::Unset
+        if icon != Discorb::Unset
           if icon.is_a?(Discorb::Image)
             payload[:icon] = icon.to_s
           else
             payload[:unicode_emoji] = icon.to_s
           end
         end
-        @client.http.patch("/guilds/#{@guild.id}/roles/#{@id}", payload, audit_log_reason: reason).wait
+        @client.http.request(Route.new("/guilds/#{@guild.id}/roles/#{@id}", "//guilds/:guild_id/roles/:role_id", :patch), payload, audit_log_reason: reason).wait
       end
     end
 
@@ -142,9 +144,11 @@ module Discorb
     #
     # @param [String] reason The reason for deleting the role.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete!(reason: nil)
       Async do
-        @client.http.delete("/guilds/#{@guild.id}/roles/#{@id}", audit_log_reason: reason).wait
+        @client.http.request(Route.new("/guilds/#{@guild.id}/roles/#{@id}", "//guilds/:guild_id/roles/:role_id", :delete), audit_log_reason: reason).wait
       end
     end