discorb 0.15.0 → 0.17.0

data/lib/discorb/voice_state.rb

@@ -46,7 +46,13 @@ module Discorb
     #   @macro client_cache
     #   @return [Discorb::User] The user this voice state is for.
 
+    #
+    # Initialize a new voice state.
     # @private
+    #
+    # @param [Discorb::Client] client The client this voice state belongs to.
+    # @param [Hash] data The data of the voice state.
+    #
     def initialize(client, data)
       @client = client
       _set_data(data)
@@ -89,10 +95,10 @@ module Discorb
       @user_id = data[:user_id]
       unless guild.nil?
         @member = if data.key?(:member)
-            guild.members[data[:user_id]] || Member.new(@client, @guild_id, data[:member][:user], data[:member])
-          else
-            guild.members[data[:user_id]]
-          end
+                    guild.members[data[:user_id]] || Member.new(@client, @guild_id, data[:member][:user], data[:member])
+                  else
+                    guild.members[data[:user_id]]
+        end
       end
       @session_id = data[:session_id]
       @deaf = data[:deaf]
@@ -135,7 +141,14 @@ module Discorb
       2 => :guild_only,
     }
 
+    #
+    # Initialize a new instance of the StageInstance class.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the stage instance.
+    # @param [Boolean] no_cache Whether to disable caching.
+    #
     def initialize(client, data, no_cache: false)
       @client = client
       @data = data
@@ -182,9 +195,10 @@ module Discorb
       Async do
         payload = {}
         payload[:topic] = topic if topic != Discorb::Unset
-        payload[:privacy_level] = self.class.privacy_level.key(privacy_level) if privacy_level != Discorb::Unset
+        payload[:privacy_level] = PRIVACY_LEVEL.key(privacy_level) if privacy_level != Discorb::Unset
         @client.http.request(
-          Route.new("/stage-instances/#{@channel_id}", "//stage-instances/:channel_id", :patch), payload, audit_log_reason: reason,
+          Route.new("/stage-instances/#{@channel_id}", "//stage-instances/:channel_id",
+                    :patch), payload, audit_log_reason: reason,
         ).wait
         self
       end
@@ -201,7 +215,10 @@ module Discorb
     #
     def delete!(reason: nil)
       Async do
-        @client.http.request(Route.new("/stage-instances/#{@channel_id}", "//stage-instances/:stage_instance_id", :delete), audit_log_reason: reason).wait
+        @client.http.request(
+          Route.new("/stage-instances/#{@channel_id}", "//stage-instances/:stage_instance_id",
+                    :delete), {}, audit_log_reason: reason
+        ).wait
         self
       end
     end
@@ -216,7 +233,7 @@ module Discorb
       @guild_id = Snowflake.new(data[:guild_id])
       @channel_id = Snowflake.new(data[:channel_id])
       @topic = data[:topic]
-      @privacy_level = self.class.privacy_level[data[:privacy_level]]
+      @privacy_level = PRIVACY_LEVEL[data[:privacy_level]]
       @discoverable_disabled = data[:discoverable_disabled]
     end
 
@@ -246,7 +263,12 @@ module Discorb
     attr_reader :custom
     alias custom? custom
 
+    #
+    # Initialize a new instance of the VoiceRegion class.
     # @private
+    #
+    # @param [Hash] data The data of the voice region.
+    #
     def initialize(data)
       @id = data[:id]
       @name = data[:name]

data/lib/discorb/webhook.rb

@@ -22,7 +22,13 @@ module Discorb
     # @return [String] The URL of the webhook.
     attr_reader :token
 
+    #
+    # Initializes a webhook.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the webhook.
+    #
     def initialize(client, data)
       @name = data[:name]
       @guild_id = data[:guild_id] && Snowflake.new(data[:guild_id])
@@ -60,22 +66,23 @@ 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: Discorb::Unset, wait: true)
+             file: nil, files: nil, username: nil, avatar_url: Discorb::Unset, wait: true)
       Async do
         payload = {}
         payload[:content] = content if content
         payload[:tts] = tts
         tmp_embed = if embed
-            [embed]
-          elsif embeds
-            embeds
-          end
+                      [embed]
+                    elsif embeds
+                      embeds
+        end
         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 != Discorb::Unset
         files = [file]
-        _resp, data = @http.multipart_request(Route.new("#{url}?wait=#{wait}", "//webhooks/:webhook_id/:token", :post), files, payload, headers: headers).wait
+        _resp, data = @http.multipart_request(Route.new("#{url}?wait=#{wait}", "//webhooks/:webhook_id/:token", :post),
+                                              files, payload, headers: headers).wait
         data && Webhook::Message.new(self, data)
       end
     end
@@ -151,7 +158,10 @@ module Discorb
         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_request(Route.new("#{url}/messages/#{Utils.try(message, :id)}", "//webhooks/:webhook_id/:token/messages/:message_id", :patch), payload, files).wait
+        _resp, data = @http.multipart_request(
+          Route.new("#{url}/messages/#{Utils.try(message, :id)}", "//webhooks/:webhook_id/:token/messages/:message_id",
+                    :patch), payload, files
+        ).wait
         message.send(:_set_data, data)
         message
       end
@@ -167,9 +177,9 @@ module Discorb
     def delete_message!(message)
       Async do
         @http.request(Route.new(
-          "#{url}/messages/#{Utils.try(message, :id)}",
-          "//webhooks/:webhook_id/:token/messages/:message_id", :delete
-        )).wait
+                        "#{url}/messages/#{Utils.try(message, :id)}",
+                        "//webhooks/:webhook_id/:token/messages/:message_id", :delete
+                      )).wait
         message
       end
     end
@@ -200,7 +210,13 @@ module Discorb
       # @!attribute [r] url
       #   @return [String] The URL of the webhook.
 
+      #
+      # Initializes the incoming webhook.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [String] url The URL of the webhook.
+      #
       def initialize(client, data)
         super
         @token = data[:token]
@@ -222,7 +238,13 @@ module Discorb
       #   Represents a source channel of follower webhook.
       #   @return [Discorb::Channel, Discorb::Webhook::FollowerWebhook::Channel] The source channel of follower webhook.
 
+      #
+      # Initializes the follower webhook.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The data of the follower webhook.
+      #
       def initialize(client, data)
         super
         @source_guild = FollowerWebhook::Guild.new(data[:source_guild])
@@ -248,12 +270,21 @@ module Discorb
         # @return [Discorb::Asset] The icon of the guild.
         attr_reader :icon
 
+        #
+        # Initialize a new guild.
         # @private
+        #
+        # @param [Hash] data The data of the guild.
+        #
         def initialize(data)
           @id = Snowflake.new(data[:id])
           @name = data[:name]
           @icon = Asset.new(self, data[:icon])
         end
+
+        def inspect
+          "#<#{self.class.name} #{@id}: #{@name}>"
+        end
       end
 
       #
@@ -265,11 +296,20 @@ module Discorb
         # @return [String] The name of the channel.
         attr_reader :name
 
+        #
+        # Initialize a new channel.
         # @private
+        #
+        # @param [Hash] data The data of the channel.
+        #
         def initialize(data)
           @id = Snowflake.new(data[:id])
           @name = data[:name]
         end
+
+        def inspect
+          "#<#{self.class.name} #{@id}: #{@name}>"
+        end
       end
     end
 
@@ -290,7 +330,13 @@ module Discorb
       # @return [Discorb::Snowflake] The ID of the guild.
       attr_reader :guild_id
 
+      #
+      # Initializes the message.
       # @private
+      #
+      # @param [Discorb::Webhook] webhook The webhook.
+      # @param [Hash] data The data of the message.
+      # @param [Discorb::Client] client The client. This will be nil if it's created from {URLWebhook}.
       def initialize(webhook, data, client = nil)
         @client = client
         @webhook = webhook
@@ -329,7 +375,7 @@ module Discorb
 
       def _set_data(data)
         @id = Snowflake.new(data[:id])
-        @type = Discorb::Message.message_type[data[:type]]
+        @type = Discorb::Message::MESSAGE_TYPE[data[:type]]
         @content = data[:content]
         @channel_id = Snowflake.new(data[:channel_id])
         @author = Author.new(data[:author])
@@ -364,7 +410,12 @@ module Discorb
         # @return [String] The discriminator of the author.
         attr_reader :discriminator
 
+        #
+        # Initializes the author.
         # @private
+        #
+        # @param [Hash] data The data of the author.
+        #
         def initialize(data)
           @data = data
           @bot = data[:bot]
@@ -384,6 +435,10 @@ module Discorb
         end
 
         alias to_s_user to_s
+
+        def inspect
+          "#<#{self.class.name} #{self}>"
+        end
       end
     end
 
@@ -396,25 +451,33 @@ module Discorb
       # @return [Discorb::Webhook::URLWebhook] The URLWebhook.
       #
       def new(url)
-        if self != Webhook
-          return super(*url) if url.is_a?(Array)
-
-          return super
-        end
-        if url.is_a?(String)
+        if self == Webhook
           URLWebhook.new(url)
         else
-          case url[1][:type]
-          when 1
-            IncomingWebhook
-          when 2
-            FollowerWebhook
-          when 3
-            ApplicationWebhook
-          end.new(url)
+          super
         end
       end
 
+      #
+      # Creates Webhook with discord data.
+      # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The data of the webhook.
+      #
+      # @return [Discorb::Webhook] The Webhook.
+      #
+      def from_data(client, data)
+        case data[:type]
+        when 1
+          IncomingWebhook
+        when 2
+          FollowerWebhook
+        when 3
+          ApplicationWebhook
+        end.new(client, data)
+      end
+
       def from_url(url)
         URLWebhook.new(url)
       end

data/lib/discorb.rb

@@ -4,9 +4,13 @@
 #
 # @author sevenc-nanashi
 module Discorb
+  #
+  # Method to define a macro for YARD.
   # @private
+  #
   # @!macro [new] async
-  #   @note This is an asynchronous method, it will return a `Async::Task` object. Use `Async::Task#wait` to get the result.
+  #   @note This is an asynchronous method, it will return a `Async::Task` object.
+  #     Use `Async::Task#wait` to get the result.
   #
   # @!macro [new] client_cache
   #   @note This method returns an object from client cache. it will return `nil` if the object is not in cache.
@@ -16,14 +20,14 @@ 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 `Discorb::Unset`. Specify value to set the value, if not don't specify or specify `Discorb::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.
   #   @raise [Discorb::HTTPError] HTTP request failed.
   #
   def macro
-    # NOTE: this method is only for YARD.
     puts "Wow, You found the easter egg!\n"
     red = "\e[31m"
     reset = "\e[m"
@@ -40,13 +44,13 @@ module Discorb
 end
 
 require_order = %w[common flag dictionary error rate_limit http intents emoji_table modules] +
-                %w[message_meta allowed_mentions] +
+                %w[channel/container message_meta allowed_mentions] +
                 %w[user member guild emoji channel embed message] +
                 %w[application audit_logs color components event event_handler] +
-                %w[attachment guild_template image integration interaction invite log permission] +
+                %w[attachment guild_template image integration interaction invite permission] +
                 %w[presence reaction role sticker utils voice_state webhook] +
                 %w[gateway_requests gateway app_command] +
-                %w[asset extension client extend]
+                %w[asset extension shard client extend]
 require_order.each do |name|
   require_relative "discorb/#{name}.rb"
 end

data/po/yard.pot

@@ -4519,7 +4519,7 @@ msgid "Command block."
 msgstr ""
 
 # @return [Discorb::ApplicationCommand::Command::GroupCommand]
-# @return [Discorb::ApplicationCommand::Command::SlashCommand]
+# @return [Discorb::ApplicationCommand::Command::ChatInputCommand]
 # @return [Discorb::ApplicationCommand::Command::SubcommandGroup]
 # @return [Discorb::ApplicationCommand::Command]
 #: ../lib/discorb/app_command.rb:40
@@ -4722,7 +4722,7 @@ msgstr ""
 msgid "a new instance of Command"
 msgstr ""
 
-# Discorb::ApplicationCommand::Command::SlashCommand
+# Discorb::ApplicationCommand::Command::ChatInputCommand
 #: ../lib/discorb/app_command.rb:194
 msgid "Represents the slash command."
 msgstr ""
@@ -4738,12 +4738,12 @@ msgstr ""
 msgid "The options of the command."
 msgstr ""
 
-# @return [SlashCommand]
+# @return [ChatInputCommand]
 #: ../lib/discorb/app_command.rb:203
-msgid "a new instance of SlashCommand"
+msgid "a new instance of ChatInputCommand"
 msgstr ""
 
-# Discorb::ApplicationCommand::Command::SlashCommand#to_s
+# Discorb::ApplicationCommand::Command::ChatInputCommand#to_s
 #: ../lib/discorb/app_command.rb:213
 msgid "Returns the commands name."
 msgstr ""
@@ -4753,8 +4753,8 @@ msgstr ""
 msgid "Represents the command with subcommands."
 msgstr ""
 
-# @return [Array<Discorb::ApplicationCommand::Command::SlashCommand, Discorb::ApplicationCommand::Command::SubcommandGroup>]
-# @return [Array<Discorb::ApplicationCommand::Command::SlashCommand>]
+# @return [Array<Discorb::ApplicationCommand::Command::ChatInputCommand, Discorb::ApplicationCommand::Command::SubcommandGroup>]
+# @return [Array<Discorb::ApplicationCommand::Command::ChatInputCommand>]
 #: ../lib/discorb/app_command.rb:275
 #: ../lib/discorb/app_command.rb:372
 msgid "The subcommands of the command."
@@ -4772,7 +4772,7 @@ msgstr ""
 msgid "Add new subcommand."
 msgstr ""
 
-# @return [Discorb::ApplicationCommand::Command::SlashCommand]
+# @return [Discorb::ApplicationCommand::Command::ChatInputCommand]
 #: ../lib/discorb/app_command.rb:294
 #: ../lib/discorb/app_command.rb:391
 msgid "The added subcommand."
@@ -12122,7 +12122,7 @@ msgstr ""
 msgid "Represents a command interaction."
 msgstr ""
 
-# Discorb::CommandInteraction::SlashCommand
+# Discorb::CommandInteraction::ChatInputCommand
 #: ../lib/discorb/interaction/command.rb:11
 msgid "Represents a slash command interaction."
 msgstr ""