discorb 0.13.0 → 0.13.1

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_post("/channels/#{channel_id.wait}/messages", 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
@@ -86,12 +80,13 @@ module Discorb
 
     #
     # 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
@@ -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.
     #
@@ -119,8 +113,7 @@ module Discorb
 
     #
     # 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.
@@ -144,8 +137,7 @@ module Discorb
 
     #
     # Fetch the pinned messages in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Message>>] The pinned messages in the channel.
     #
@@ -158,12 +150,13 @@ module Discorb
 
     #
     # 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
@@ -172,12 +165,13 @@ module Discorb
 
     #
     # 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
@@ -186,8 +180,7 @@ module Discorb
 
     #
     # Trigger the typing indicator in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # If block is given, trigger typing indicator during executing block.
     # @example

data/lib/discorb/role.rb

@@ -90,12 +90,13 @@ 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
@@ -104,8 +105,7 @@ module Discorb
 
     #
     # Edits the role.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The new name of the role.
@@ -116,15 +116,17 @@ 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
@@ -142,6 +144,8 @@ 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

data/lib/discorb/sticker.rb

@@ -67,8 +67,7 @@ module Discorb
 
       #
       # Edits the sticker.
-      # @macro async
-      # @macro http
+      # @async
       # @macro edit
       #
       # @param [String] name The new name of the sticker.
@@ -76,12 +75,14 @@ module Discorb
       # @param [Discorb::Emoji] tag The new tags of the sticker.
       # @param [String] reason The reason for the edit.
       #
-      def edit(name: :unset, description: :unset, tag: :unset, reason: :unset)
+      # @return [Async::Task<void>] The task.
+      #
+      def edit(name: Discorb::Unset, description: Discorb::Unset, tag: Discorb::Unset, reason: Discorb::Unset)
         Async do
           payload = {}
-          payload[:name] = name unless name == :unset
-          payload[:description] = description unless description == :unset
-          payload[:tags] = tag.name unless tag == :unset
+          payload[:name] = name unless name == Discorb::Unset
+          payload[:description] = description unless description == Discorb::Unset
+          payload[:tags] = tag.name unless tag == Discorb::Unset
           @client.http.patch("/guilds/#{@guild_id}/stickers/#{@id}", payload, audit_log_reason: reason).wait
         end
       end
@@ -90,8 +91,7 @@ module Discorb
 
       #
       # Deletes the sticker.
-      # @macro async
-      # @macro http
+      # @async
       #
       # @param [String] reason The reason for the deletion.
       #
@@ -112,14 +112,10 @@ module Discorb
       attr_reader :id
       # @return [String] The name of the sticker pack.
       attr_reader :name
-      # @return [Discorb::Snowflake] The ID of the SKU.
-      attr_reader :sku_id
       # @return [Discorb::Snowflake] The cover sticker of the pack.
       attr_reader :cover_sticker_id
       # @return [String] The description of the pack.
       attr_reader :description
-      # @return [Discorb::Store::SKU] The banner asset ID of the pack.
-      attr_reader :banner_asset_id
       # @return [Array<Discorb::Sticker>] The stickers in the pack.
       attr_reader :stickers
       # @return [Discorb::Asset] The banner of the pack.

data/lib/discorb/user.rb

@@ -58,8 +58,7 @@ module Discorb
 
     #
     # Whether the user is a owner of the client.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Boolean] strict Whether don't allow if the user is a member of the team.
     #
@@ -150,18 +149,19 @@ module Discorb
   class ClientUser < User
     #
     # Edit the client user.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The new username.
     # @param [Discorb::Image] avatar The new avatar.
     #
-    def edit(name: :unset, avatar: :unset)
+    # @return [Async::Task<void>] The task.
+    #
+    def edit(name: Discorb::Unset, avatar: Discorb::Unset)
       Async do
         payload = {}
-        payload[:username] = name unless name == :unset
-        if avatar == :unset
+        payload[:username] = name unless name == Discorb::Unset
+        if avatar == Discorb::Unset
           # Nothing
         elsif avatar.nil?
           payload[:avatar] = nil

data/lib/discorb/voice_state.rb

@@ -166,19 +166,20 @@ module Discorb
 
     #
     # Edits the stage instance.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] topic The new topic of the stage instance.
     # @param [:public, :guild_only] privacy_level The new privacy level of the stage instance.
     # @param [String] reason The reason for editing the stage instance.
     #
-    def edit(topic: :unset, privacy_level: :unset, reason: nil)
+    # @return [Async::Task<void>] The task.
+    #
+    def edit(topic: Discorb::Unset, privacy_level: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:topic] = topic if topic != :unset
-        payload[:privacy_level] = self.class.privacy_level.key(privacy_level) if privacy_level != :unset
+        payload[:topic] = topic if topic != Discorb::Unset
+        payload[:privacy_level] = self.class.privacy_level.key(privacy_level) if privacy_level != Discorb::Unset
         @client.http.edit("/stage-instances/#{@channel_id}", payload, audit_log_reason: reason).wait
         self
       end
@@ -191,6 +192,8 @@ module Discorb
     #
     # @param [String] reason The reason for deleting the stage instance.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete!(reason: nil)
       Async do
         @client.http.delete("/stage-instances/#{@channel_id}", audit_log_reason: reason).wait

data/lib/discorb/webhook.rb

@@ -43,8 +43,7 @@ module Discorb
 
     #
     # Posts a message to the webhook.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] content The content of the message.
     # @param [Boolean] tts Whether the message should be sent as text-to-speech.
@@ -61,7 +60,7 @@ module Discorb
     # @return [Async::Task<nil>] If `wait` is false.
     #
     def post(content = nil, tts: false, embed: nil, embeds: nil, allowed_mentions: nil,
-                            file: nil, files: nil, username: nil, avatar_url: :unset, wait: true)
+                            file: nil, files: nil, username: nil, avatar_url: Discorb::Unset, wait: true)
       Async do
         payload = {}
         payload[:content] = content if content
@@ -74,17 +73,9 @@ module Discorb
         payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
         payload[:allowed_mentions] = allowed_mentions&.to_hash
         payload[:username] = username if username
-        payload[:avatar_url] = avatar_url if avatar_url != :unset
-        files = [file] if file
-        if files
-          headers, payload = HTTP.multipart(payload, files)
-        else
-          headers = {
-            "Content-Type" => "application/json",
-          }
-        end
-        _resp, data = @http.post("#{url}?wait=#{wait}", payload, headers: headers).wait
-
+        payload[:avatar_url] = avatar_url if avatar_url != Discorb::Unset
+        files = [file]
+        _resp, data = @http.multipart_post("#{url}?wait=#{wait}", files, payload, headers: headers).wait
         data && Webhook::Message.new(self, data)
       end
     end
@@ -93,20 +84,21 @@ module Discorb
 
     #
     # Edits the webhook.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The new name of the webhook.
     # @param [Discorb::Image] avatar The new avatar of the webhook.
     # @param [Discorb::GuildChannel] channel The new channel of the webhook.
     #
-    def edit(name: :unset, avatar: :unset, channel: :unset)
+    # @return [Async::Task<void>] The task.
+    #
+    def edit(name: Discorb::Unset, avatar: Discorb::Unset, channel: Discorb::Unset)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:avatar] = avatar if avatar != :unset
-        payload[:channel_id] = Utils.try(channel, :id) if channel != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:avatar] = avatar if avatar != Discorb::Unset
+        payload[:channel_id] = Utils.try(channel, :id) if channel != Discorb::Unset
         @http.patch(url.to_s, payload).wait
       end
     end
@@ -115,8 +107,9 @@ module Discorb
 
     #
     # Deletes the webhook.
-    # @macro async
-    # @macro http
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
     #
     def delete!
       Async do
@@ -129,8 +122,7 @@ module Discorb
 
     #
     # Edits the webhook's message.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [Discorb::Webhook::Message] message The message to edit.
@@ -142,29 +134,24 @@ module Discorb
     # @param [Array<Discorb::File>] files The files to send.
     # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def edit_message(
-      message, content = :unset,
-      embed: :unset, embeds: :unset,
-      file: :unset, files: :unset,
-      attachments: :unset,
-      allowed_mentions: :unset
+      message, content = Discorb::Unset,
+      embed: Discorb::Unset, embeds: Discorb::Unset,
+      file: Discorb::Unset, files: Discorb::Unset,
+      attachments: Discorb::Unset,
+      allowed_mentions: 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
-        payload[:allowed_mentions] = allowed_mentions if allowed_mentions != :unset
-        files = [file] if file != :unset
-        if files == :unset
-          headers = {
-            "Content-Type" => "application/json",
-          }
-        else
-          headers, payload = HTTP.multipart(payload, files)
-        end
-        _resp, data = @http.patch("#{url}/messages/#{Utils.try(message, :id)}", 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
+        payload[:allowed_mentions] = allowed_mentions if allowed_mentions != Discorb::Unset
+        files = [file] if file != Discorb::Unset
+        _resp, data = @http.multipart_patch("#{url}/messages/#{Utils.try(message, :id)}", payload, headers: headers).wait
         message.send(:_set_data, data)
         message
       end
@@ -175,6 +162,8 @@ module Discorb
     #
     # @param [Discorb::Webhook::Message] message The message to delete.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete_message!(message)
       Async do
         @http.delete("#{url}/messages/#{Utils.try(message, :id)}").wait
@@ -308,12 +297,13 @@ module Discorb
 
       #
       # Edits the message.
-      # @macro async
-      # @macro http
+      # @async
       # @macro edit
       #
       # @param (see Webhook#edit_message)
       #
+      # @return [Async::Task<void>] The task.
+      #
       def edit(...)
         Async do
           @webhook.edit_message(self, ...).wait
@@ -322,8 +312,9 @@ module Discorb
 
       #
       # Deletes the message.
-      # @macro async
-      # @macro http
+      # @async
+      #
+      # @return [Async::Task<void>] The task.
       #
       def delete!
         Async do

data/lib/discorb.rb

@@ -16,7 +16,7 @@ module Discorb
   #   @note You must enable `GUILD_MEMBERS` intent to use this method.
   #
   # @!macro edit
-  #   @note The arguments of this method are defaultly set to `:unset`. Specify value to set the value, if not don't specify or specify `:unset`.
+  #   @note The arguments of this method are defaultly set to `Discorb::Unset`. Specify value to set the value, if not don't specify or specify `Discorb::Unset`.
   #
   # @!macro http
   #   @note This method calls HTTP request.