discorb 0.13.0 → 0.13.1

data/lib/discorb/http.rb

@@ -18,14 +18,14 @@ module Discorb
 
     #
     # Execute a GET request.
-    # @macro async
+    # @async
     #
     # @param [String] path The path to the resource.
     # @param [Hash] headers The headers to send with the request.
     # @param [String] audit_log_reason The audit log reason to send with the request.
     # @param [Hash] kwargs The keyword arguments.
     #
-    # @return [Array(Net::HTTPResponse, Hash)] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
     # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
     #
     # @raise [Discorb::HTTPError] The request was failed.
@@ -42,7 +42,7 @@ module Discorb
 
     #
     # Execute a POST request.
-    # @macro async
+    # @async
     #
     # @param [String] path The path to the resource.
     # @param [String, Hash] body The body of the request.
@@ -50,7 +50,7 @@ module Discorb
     # @param [String] audit_log_reason The audit log reason to send with the request.
     # @param [Hash] kwargs The keyword arguments.
     #
-    # @return [Array(Net::HTTPResponse, Hash)] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
     # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
     #
     # @raise [Discorb::HTTPError] The request was failed.
@@ -65,9 +65,46 @@ module Discorb
       end
     end
 
+    #
+    # Execute a multipart POST request.
+    # @async
+    #
+    # @param [String] path The path to the resource.
+    # @param [String, Hash] body The body of the request.
+    # @param [Array<Discorb::File>] files The files to upload.
+    # @param [Hash] headers The headers to send with the request.
+    # @param [String] audit_log_reason The audit log reason to send with the request.
+    # @param [Hash] kwargs The keyword arguments.
+    #
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
+    #
+    # @raise [Discorb::HTTPError] The request was failed.
+    #
+    def multipart_post(path, body = "", files, headers: nil, audit_log_reason: nil, **kwargs)
+      Async do |task|
+        @ratelimit_handler.wait("POST", path)
+        req = Net::HTTP::Post.new(get_path(path), get_headers(headers, body, audit_log_reason), **kwargs)
+        data = [
+          ["payload_json", get_body(body)],
+        ]
+        files&.each_with_index do |file, i|
+          next if file.nil?
+          data << ["files[#{i}]", file.io, { filename: file.filename, content_type: file.content_type }]
+        end
+        req.set_form(data, "multipart/form-data")
+        session = Net::HTTP.new("discord.com", 443)
+        session.use_ssl = true
+        resp = session.request(req)
+        data = get_response_data(resp)
+        @ratelimit_handler.save("POST", path, resp)
+        handle_response(:post, resp, data, path, body, headers, audit_log_reason, kwargs)
+      end
+    end
+
     #
     # Execute a PATCH request.
-    # @macro async
+    # @async
     #
     # @param [String] path The path to the resource.
     # @param [String, Hash] body The body of the request.
@@ -75,7 +112,7 @@ module Discorb
     # @param [String] audit_log_reason The audit log reason to send with the request.
     # @param [Hash] kwargs The keyword arguments.
     #
-    # @return [Array(Net::HTTPResponse, Hash)] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
     # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
     #
     # @raise [Discorb::HTTPError] The request was failed.
@@ -90,9 +127,44 @@ module Discorb
       end
     end
 
+    #
+    # Execute a PATCH request.
+    # @async
+    #
+    # @param [String] path The path to the resource.
+    # @param [String, Hash] body The body of the request.
+    # @param [Hash] headers The headers to send with the request.
+    # @param [String] audit_log_reason The audit log reason to send with the request.
+    # @param [Hash] kwargs The keyword arguments.
+    #
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
+    #
+    # @raise [Discorb::HTTPError] The request was failed.
+    #
+    def multipart_patch(path, body = "", headers: nil, audit_log_reason: nil, **kwargs)
+      Async do |task|
+        @ratelimit_handler.wait("PATCH", path)
+        req = Net::HTTP::Patch.new(get_path(path), get_headers(headers, body, audit_log_reason), **kwargs)
+        data = [
+          ["payload_json", get_body(body)],
+        ]
+        files&.each_with_index do |file, i|
+          data << ["files[#{i}]", file.io, { filename: file.filename, content_type: file.content_type }]
+        end
+        req.set_form(data, "multipart/form-data")
+        session = Net::HTTP.new("discord.com", 443)
+        session.use_ssl = true
+        resp = session.request(req)
+        data = get_response_data(resp)
+        @ratelimit_handler.save("PATCH", path, resp)
+        handle_response(:patch, resp, data, path, body, headers, audit_log_reason, kwargs)
+      end
+    end
+
     #
     # Execute a PUT request.
-    # @macro async
+    # @async
     #
     # @param [String] path The path to the resource.
     # @param [String, Hash] body The body of the request.
@@ -100,7 +172,7 @@ module Discorb
     # @param [String] audit_log_reason The audit log reason to send with the request.
     # @param [Hash] kwargs The keyword arguments.
     #
-    # @return [Array(Net::HTTPResponse, Hash)] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
     # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
     #
     # @raise [Discorb::HTTPError] The request was failed.
@@ -117,14 +189,14 @@ module Discorb
 
     #
     # Execute a DELETE request.
-    # @macro async
+    # @async
     #
     # @param [String] path The path to the resource.
     # @param [Hash] headers The headers to send with the request.
     # @param [String] audit_log_reason The audit log reason to send with the request.
     # @param [Hash] kwargs The keyword arguments.
     #
-    # @return [Array(Net::HTTPResponse, Hash)] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
     # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
     #
     # @raise [Discorb::HTTPError] The request was failed.
@@ -143,40 +215,6 @@ module Discorb
       "#<#{self.class} client=#{@client}>"
     end
 
-    #
-    # A helper method to send multipart/form-data requests for creating messages.
-    #
-    # @param [Hash] payload The payload to send.
-    # @param [Array<Discorb::File>] files The files to send.
-    #
-    # @return [Array(String, String)] The boundary and body.
-    #
-    def self.multipart(payload, files)
-      boundary = "DiscorbBySevenC7CMultipartFormData#{Time.now.to_f}"
-      str_payloads = [<<~HTTP]
-        Content-Disposition: form-data; name="payload_json"
-        Content-Type: application/json
-
-        #{payload.to_json}
-      HTTP
-      files.each_with_index do |single_file, i|
-        str_payloads << <<~HTTP
-          Content-Disposition: form-data; name="files[#{i}]"; filename="#{single_file.filename}"
-          Content-Type: #{single_file.content_type}
-
-          #{single_file.io.read}
-        HTTP
-      end
-      payload = +"--#{boundary}".encode(Encoding::ASCII_8BIT)
-      str_payloads.each do |str_payload|
-        payload << "\r\n".encode(Encoding::ASCII_8BIT)
-        payload << str_payload.force_encoding(Encoding::ASCII_8BIT)
-        payload << "\r\n--#{boundary}".encode(Encoding::ASCII_8BIT)
-      end
-      payload += +"--".encode(Encoding::ASCII_8BIT)
-      [boundary, payload]
-    end
-
     private
 
     def handle_response(method, resp, data, path, body, headers, audit_log_reason, kwargs)

data/lib/discorb/integration.rb

@@ -58,9 +58,12 @@ module Discorb
 
     #
     # Delete the integration.
+    # @async
     #
     # @param [String] reason The reason for deleting the integration.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete!(reason: nil)
       Async do
         @client.http.delete("/guilds/#{@guild}/integrations/#{@id}", audit_log_reason: reason).wait

data/lib/discorb/interaction/response.rb

@@ -7,11 +7,12 @@ module Discorb
       #
       # Response with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`(`5`).
       #
-      # @macro async
-      # @macro http
+      # @async
       #
       # @param [Boolean] ephemeral Whether to make the response ephemeral.
       #
+      # @return [Async::Task<void>] The task.
+      #
       def defer_source(ephemeral: false)
         Async do
           @client.http.post("/interactions/#{@id}/#{@token}/callback", {
@@ -27,8 +28,7 @@ module Discorb
       #
       # Response with `CHANNEL_MESSAGE_WITH_SOURCE`(`4`).
       #
-      # @macro async
-      # @macro http
+      # @async
       #
       # @param [String] content The content of the response.
       # @param [Boolean] tts Whether to send the message as text-to-speech.
@@ -77,8 +77,7 @@ module Discorb
 
         #
         # Edits the callback message.
-        # @macro async
-        # @macro http
+        # @async
         # @macro edit
         #
         # @param [String] content The new content of the message.
@@ -88,27 +87,23 @@ module Discorb
         # @param [Discorb::File] file The file to send.
         # @param [Array<Discorb::File>] files The files to send.
         #
+        # @return [Async::Task<void>] The task.
+        #
         def edit(
-          content = :unset,
-          embed: :unset, embeds: :unset,
-          file: :unset, files: :unset,
-          attachments: :unset
+          content = Discorb::Unset,
+          embed: Discorb::Unset, embeds: Discorb::Unset,
+          file: Discorb::Unset, files: Discorb::Unset,
+          attachments: Discorb::Unset
         )
           Async do
             payload = {}
-            payload[:content] = content if content != :unset
-            payload[:embeds] = embed ? [embed.to_hash] : [] if embed != :unset
-            payload[:embeds] = embeds.map(&:to_hash) if embeds != :unset
-            payload[:attachments] = attachments.map(&:to_hash) if attachments != :unset
-            files = [file] if file != :unset
-            if files == :unset
-              headers = {
-                "Content-Type" => "application/json",
-              }
-            else
-              headers, payload = HTTP.multipart(payload, files)
-            end
-            @client.http.patch("/webhooks/#{@application_id}/#{@token}/messages/@original", payload, headers: headers).wait
+            payload[:content] = content if content != Discorb::Unset
+            payload[:embeds] = embed ? [embed.to_hash] : [] if embed != Discorb::Unset
+            payload[:embeds] = embeds.map(&:to_hash) if embeds != Discorb::Unset
+            payload[:attachments] = attachments.map(&:to_hash) if attachments != Discorb::Unset
+            files = [file] if file != Discorb::Unset
+            files = [] if files == Discorb::Unset
+            @client.http.multipart_patch("/webhooks/#{@application_id}/#{@token}/messages/@original", payload, files, headers: headers).wait
           end
         end
 
@@ -116,8 +111,11 @@ module Discorb
 
         #
         # Deletes the callback message.
+        # @async
         # @note This will fail if the message is ephemeral.
         #
+        # @return [Async::Task<void>] The task.
+        #
         def delete!
           Async do
             @client.http.delete("/webhooks/#{@application_id}/#{@token}/messages/@original").wait
@@ -132,9 +130,12 @@ module Discorb
     module UpdateResponse
       #
       # Response with `DEFERRED_UPDATE_MESSAGE`(`6`).
+      # @async
       #
       # @param [Boolean] ephemeral Whether to make the response ephemeral.
       #
+      # @return [Async::Task<void>] The task.
+      #
       def defer_update(ephemeral: false)
         Async do
           @client.http.post("/interactions/#{@id}/#{@token}/callback", {
@@ -149,8 +150,7 @@ module Discorb
       #
       # Response with `UPDATE_MESSAGE`(`7`).
       #
-      # @macro async
-      # @macro http
+      # @async
       #
       # @param [String] content The content of the response.
       # @param [Boolean] tts Whether to send the message as text-to-speech.
@@ -160,6 +160,8 @@ module Discorb
       # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
       # @param [Boolean] ephemeral Whether to make the response ephemeral.
       #
+      # @return [Async::Task<void>] The task.
+      #
       def edit(content, tts: false, embed: nil, embeds: nil, allowed_mentions: nil, components: nil, ephemeral: false)
         Async do
           payload = {}

data/lib/discorb/interaction/root.rb

@@ -18,6 +18,12 @@ module Discorb
     attr_reader :version
     # @return [String] The token for the interaction.
     attr_reader :token
+    # @return [Symbol] The locale of the user that created the interaction.
+    # @note This modifies the language code, `-` will be replaced with `_`.
+    attr_reader :locale
+    # @return [Symbol] The locale of the guild that created the interaction.
+    # @note This modifies the language code, `-` will be replaced with `_`.
+    attr_reader :guild_locale
 
     # @!attribute [r] guild
     #   @macro client_cache
@@ -43,6 +49,8 @@ module Discorb
       @member = guild.members[data[:member][:id]] || Member.new(@client, @guild_id, data[:member][:user], data[:member]) if data[:member]
       @user = @client.users[data[:user][:id]] || User.new(@client, data[:user]) if data[:user]
       @token = data[:token]
+      @locale = data[:locale].to_s.gsub("-", "_").to_sym
+      @guild_locale = data[:guild_locale].to_s.gsub("-", "_").to_sym
       @version = data[:version]
       @defered = false
       @responded = false

data/lib/discorb/invite.rb

@@ -100,8 +100,9 @@ module Discorb
     end
 
     # Delete the invite.
-    # @macro async
-    # @macro http
+    # @async
+    # @return [Async::Task<void>] The task.
+    #
     def delete!(reason: nil)
       Async do
         @client.http.delete("/invites/#{@code}", audit_log_reason: reason)

data/lib/discorb/member.rb

@@ -143,12 +143,13 @@ 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
@@ -157,12 +158,13 @@ module Discorb
 
     #
     # 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
@@ -171,8 +173,7 @@ module Discorb
 
     #
     # 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
+        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.patch("/guilds/#{@guild_id}/members/#{@id}", 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,11 +371,12 @@ 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
@@ -380,11 +387,12 @@ 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
@@ -395,12 +403,13 @@ 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
@@ -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.
@@ -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