discorb 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 497fc76081f6183ccd3ec7c14768e80d81a172c092afa67f26bcec625f7b204f
-  data.tar.gz: 5d0d4070c729b2b63d6a746fa559900b2205d51f737105d8c8653c59eec01e97
+  metadata.gz: 4bc9c7d6433e9e093a0d58d821ed97e3f001d63224c9f65eb1693a2ee3d16f7d
+  data.tar.gz: daff87553c1996cbc1a68765ee3df54947f46b7660fc1a16f0a17a0e0660e2c7
 SHA512:
-  metadata.gz: bf93daa59116cbd29d408e361b0cebf0e4b681c21eb2e07466f2ea2659f7bec959a58c4bf168c8b5058bb4221bb26352770c94e6bc61a9713a82d72bf98316e8
-  data.tar.gz: aa07fe600a6397f69584a33d4b79dfd2d64952c4c1fff83a08a84418e0547a78c9b2261fce7e96a46bf19d4dab9ff0972ebe09b2ddf59371d5d74a761282c45e
+  metadata.gz: dceaba51436368feeb9e99bc4afda5cea9ac45aa0525bb44cdd33c427fef6c6617d17bf1a56b27acac137df05b4d6f27395e22883ce574e4e48d3e7a8ca05a13
+  data.tar.gz: 81622ca789eee2f8c55b4fd98e7c0bdc602d164247602508c8b041757d61fcb77f659d01142db8a8c16b9dd6e6cc402ebf9f45cf881e787a77449ba4831b8376

data/.rubocop.yml

@@ -10,10 +10,14 @@ Metrics:
   Enabled: false
 
 Style/TrailingCommaInHashLiteral:  # Disabled for rufo
-  Enabled: false
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:  # Disabled for rufo
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/StringLiterals:  # Disabled for rufo
-  Enabled: false
+  Enabled: true
+  EnforcedStyle: double_quotes
 
 Style/TrailingCommaInArguments:  # Disabled for rufo
   Enabled: false

data/Changelog.md

@@ -6,6 +6,15 @@
 
 ## v0.15
 
+### v0.15.1
+
+- Add: Add `Member#can_manage?`
+- Add: Add `Discorb::VERSION_ARRAY`
+- Fix: `Snowflake#timestamp` includes milliseconds now
+- Fix: `TextChannel#create_invite` will no longer return `ArgumentError`
+- Fix: Connection will not closed with 4001 when `Client#update_presence`
+  is called
+
 ### v0.15.0
 
 - Add: Migrate to API v10

data/Rakefile

@@ -320,6 +320,12 @@ end
 
 task document: %i[document:yard document:replace]
 
+desc "Lint code with rubocop"
 task :lint do
   sh "rubocop lib"
 end
+
+desc "Autofix code with rubocop"
+task "lint:fix" do
+  sh "rubocop lib -A"
+end

data/docs/events.md

@@ -487,6 +487,46 @@ Fires when an invitation is deleted.
 
 ### Interaction events
 
+#### `interaction_create(interaction)`
+
+Fires when an interaction is created. This will fire for all interactions.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::Interaction}| The created interaction. |
+
+#### `application_command(interaction)`
+
+Fires when an application command is used.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::CommandInteraction}| The created interaction. |
+
+#### `slash_command(interaction)`
+
+Fires when a slash command is used.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::CommandInteraction::SlashCommand}| The created interaction. |
+
+#### `message_command(interaction)`
+
+Fires when a message command is used.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::CommandInteraction::MessageMenuCommand}| The created interaction. |
+
+#### `user_command(interaction)`
+
+Fires when a user command is used.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::CommandInteraction::UserMenuCommand}| The created interaction. |
+
 #### `button_click(interaction)`
 
 Fires when a button is clicked.
@@ -503,6 +543,16 @@ Fires when a select menu is selected.
 | ---------- | ----- | ----------- |
 |`interaction`| {Discorb::MessageComponentInteraction::SelectMenu}| The interaction object. |
 
+#### `form_submit(interaction)`
+
+Fires when a form is submitted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::ModalInteraction} | The interaction object. |
+
+#### `slash_command
+
 ### Voice events
 
 Because it's big, it's documented in {file:docs/voice_events.md}.

data/lib/discorb/allowed_mentions.rb

@@ -32,7 +32,14 @@ module Discorb
       "#<#{self.class} @everyone=#{@everyone} @roles=#{@roles} @users=#{@users} @replied_user=#{@replied_user}>"
     end
 
+    #
+    # Converts the object to a hash.
     # @private
+    #
+    # @param [Discorb::AllowedMentions, nil] other The object to merge.
+    #
+    # @return [Hash] The hash.
+    #
     def to_hash(other = nil)
       payload = {
         parse: %w[everyone roles users],

data/lib/discorb/app_command/command.rb

@@ -23,24 +23,39 @@ module Discorb
       # @return [Discorb::Dictionary{Discorb::Snowflake, :global => Discorb::Snowflake}] The ID mapping.
       attr_reader :id_map
 
-      @types = {
+      # @private
+      # @return [{Integer => Symbol}] The mapping of raw types to types.
+      TYPES = {
         1 => :chat_input,
         2 => :user,
         3 => :message,
       }.freeze
 
+      #
+      # Initialize a new command.
       # @private
+      #
+      # @param [String] name The name of the command.
+      # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+      # @param [Proc] block The block of the command.
+      # @param [:chat_input, :user, :message] type The type of the command.
+      #
       def initialize(name, guild_ids, block, type)
         @name = name
         @guild_ids = guild_ids&.map(&:to_s)
         @block = block
         @raw_type = type
-        @type = Discorb::ApplicationCommand::Command.types[type]
+        @type = Discorb::ApplicationCommand::Command::TYPES[type]
         @type_raw = type
         @id_map = Discorb::Dictionary.new
       end
 
+      #
+      # Changes the self pointer to the given object.
       # @private
+      #
+      # @param [Object] instance The object to change the self pointer to.
+      #
       def replace_block(instance)
         current_block = @block.dup
         @block = proc do |*args|
@@ -48,7 +63,12 @@ module Discorb
         end
       end
 
+      #
+      # Converts the object to a hash.
       # @private
+      #
+      # @return [Hash] The hash represents the object.
+      #
       def to_hash
         {
           name: @name,
@@ -66,7 +86,18 @@ module Discorb
         # @return [Hash{String => Hash}] The options of the command.
         attr_reader :options
 
+        #
+        # Initialize a new slash command.
         # @private
+        #
+        # @param [String] name The name of the command.
+        # @param [String] description The description of the command.
+        # @param [Hash{String => Hash}] options The options of the command.
+        # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+        # @param [Proc] block The block of the command.
+        # @param [:chat_input, :user, :message] type The type of the command.
+        # @param [Discorb::ApplicationCommand::Command, nil] parent The parent command.
+        #
         def initialize(name, description, options, guild_ids, block, type, parent)
           super(name, guild_ids, block, type)
           @description = description
@@ -85,7 +116,12 @@ module Discorb
           (@parent + " " + @name).strip
         end
 
+        #
+        # Converts the object to a hash.
         # @private
+        #
+        # @return [Hash] The hash represents the object.
+        #
         def to_hash
           options_payload = options.map do |name, value|
             ret = {
@@ -145,7 +181,16 @@ module Discorb
         # @return [String] The description of the command.
         attr_reader :description
 
+        #
+        # Initialize a new group command.
         # @private
+        #
+        # @param [String] name The name of the command.
+        # @param [String] description The description of the command.
+        # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+        # @param [:chat_input, :user, :message] type The type of the command.
+        # @param [Discorb::Client] client The client of the command.
+        #
         def initialize(name, description, guild_ids, type, client)
           super(name, guild_ids, block, type)
           @description = description
@@ -196,13 +241,23 @@ module Discorb
           @name
         end
 
+        #
+        # Changes the self pointer to the given object.
         # @private
+        #
+        # @param [Object] instance The object to change to.
+        #
         def block_replace(instance)
           super
           @commands.each { |c| c.replace_block(instance) }
         end
 
+        #
+        # Converts the object to a hash.
         # @private
+        #
+        # @return [Hash] The hash represents the object.
+        #
         def to_hash
           options_payload = @commands.map do |command|
             if command.is_a?(SlashCommand)
@@ -240,7 +295,14 @@ module Discorb
         # @return [Array<Discorb::ApplicationCommand::Command::SlashCommand>] The subcommands of the command.
         attr_reader :commands
 
+        #
+        # Initialize a new subcommand group.
         # @private
+        #
+        # @param [String] name The name of the command.
+        # @param [String] description The description of the command.
+        # @param [Discorb::ApplicationCommand::Command::GroupCommand] parent The parent command.
+        # @param [Discorb::Client] client The client.
         def initialize(name, description, parent, client)
           super(name, description, [], 1, client)
 

data/lib/discorb/application.rb

@@ -29,7 +29,13 @@ module Discorb
     alias bot_require_code_grant? bot_require_code_grant
     # @return [Discorb::Application::Flag] The application's flags.
     attr_reader :flags
+    #
+    # Initializes a new instance of the Application class.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    #
     def initialize(client, data)
       @client = client
       @data = data
@@ -97,7 +103,13 @@ module Discorb
       # @return [Discorb::Application::Team::Member] The team's member.
       attr_reader :members
 
+      #
+      # Initializes a new instance of the Team class.
       # @private
+      #
+      # @param [Discorb::Client] client The client that instantiated the object.
+      # @param [Hash] data The data of the object.
+      #
       def initialize(client, data)
         @client = client
         @id = Snowflake.new(data[:id])
@@ -142,7 +154,9 @@ module Discorb
         # @!attribute [r] owner?
         #   @return [Boolean] Whether the member is the team's owner.
 
-        @membership_state = {
+        # @private
+        # @return [{Integer => Symbol}] The permission map.
+        MEMBERSHIP_STATE = {
           1 => :invited,
           2 => :accepted,
         }.freeze
@@ -153,7 +167,7 @@ module Discorb
           @team = team
           @user = client.users[data[:user][:id]] || User.new(client, data[:user])
           @team_id = Snowflake.new(data[:team_id])
-          @membership_state = self.class.membership_state[data[:membership_state]]
+          @membership_state = MEMBERSHIP_STATE[data[:membership_state]]
           @permissions = data[:permissions].map(&:to_sym)
         end
 
@@ -176,11 +190,6 @@ module Discorb
         def ==(other)
           super || @user == other
         end
-
-        class << self
-          # @private
-          attr_reader :membership_state
-        end
       end
     end
   end

data/lib/discorb/asset.rb

@@ -11,7 +11,13 @@ module Discorb
     # @!attribute [r] animated?
     #   @return [Boolean] Whether the asset is animated.
 
+    #
+    # Initialize a new instance of the Asset class.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    #
     def initialize(target, hash, path: nil)
       @hash = hash
       @target = target
@@ -63,7 +69,10 @@ module Discorb
     # @!attribute [r] animated?
     #   @return [false] For compatibility with {Asset}, always `false`.
 
+    #
+    # Initialize a new instance of the DefaultAvatar class.
     # @private
+    #
     def initialize(discriminator)
       @discriminator = discriminator.to_s.rjust(4, "0")
     end

data/lib/discorb/attachment.rb

@@ -33,6 +33,7 @@ module Discorb
     # @return [:client, :discord] The attachment was created by.
     attr_reader :created_by
     # @private
+    # @return [Boolean] Whether the attachment will be closed after it is sent.
     attr_reader :will_close
 
     # @!attribute [r] image?
@@ -62,7 +63,10 @@ module Discorb
       @created_by = :client
     end
 
+    #
+    # Initializes the object from a hash.
     # @private
+    #
     def initialize_hash(data)
       @id = Snowflake.new(data[:id])
       @filename = data[:filename]
@@ -79,7 +83,18 @@ module Discorb
       @content_type.start_with? "image/"
     end
 
+    def inspect
+      if @created_by == :discord
+        "<#{self.class} #{@id}: #{@filename}>"
+      else
+        "<#{self.class} #{io.fileno}: #{@filename}>"
+      end
+    end
+
+    #
+    # Creates a new file from a hash.
     # @private
+    #
     def self.from_hash(data)
       inst = allocate
       inst.initialize_hash(data)
@@ -93,7 +108,7 @@ module Discorb
     # @param [String] filename The filename of the file. object_id of the string is used if not set.
     # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
     #
-    # @return [File] The new file.
+    # @return [Discorb::Attachment] The new file.
     #
     def self.from_string(string, filename = nil, content_type: nil, description: nil)
       io = StringIO.new(string)

data/lib/discorb/audit_logs.rb

@@ -14,7 +14,10 @@ module Discorb
     # @return [Array<Discorb::AuditLog::Entry>] The entries in this audit log.
     attr_reader :entries
 
+    #
+    # Initializes a new instance of the AuditLog class.
     # @private
+    #
     def initialize(client, data, guild)
       @client = client
       @guild = guild
@@ -24,6 +27,10 @@ module Discorb
       @entries = data[:audit_log_entries].map { |entry| AuditLog::Entry.new(@client, entry, guild.id) }
     end
 
+    def inspect
+      "<#{self.class} #{@entries.length} entries>"
+    end
+
     #
     # Gets an entry from entries.
     #
@@ -108,8 +115,11 @@ module Discorb
       # @!attribute [r] user
       #   @return [Discorb::User] The user who performed the action.
 
+      #
+      # @return [{Integer => Symbol}] The map of events to their respective changes.
       # @private
-      @events = {
+      #
+      EVENTS = {
         1 => :guild_update,
         10 => :channel_create,
         11 => :channel_update,
@@ -159,24 +169,30 @@ module Discorb
         112 => :thread_delete,
       }.freeze
 
+      #
+      # The converter for the change.
       # @private
-      @converts = {
+      #
+      CONVERTERS = {
         channel: ->(client, id, _guild_id) { client.channels[id] },
         thread: ->(client, id, _guild_id) { client.channels[id] },
         role: ->(client, id, guild_id) { client.guilds[guild_id]&.roles&.[](id) },
         member: ->(client, id, guild_id) { client.guilds[guild_id]&.members&.[](id) },
         guild: ->(client, id, _guild_id) { client.guilds[id] },
         message: ->(client, id, _guild_id) { client.messages[id] },
-      }
+      }.freeze
 
+      #
+      # Initializes a new AuditLog entry.
       # @private
+      #
       def initialize(client, data, guild_id)
         @client = client
         @guild_id = Snowflake.new(guild_id)
         @id = Snowflake.new(data[:id])
         @user_id = Snowflake.new(data[:user_id])
         @target_id = Snowflake.new(data[:target_id])
-        @type = self.class.events[data[:action_type]]
+        @type = EVENTS[data[:action_type]]
         @target = self.class.converts[@type.to_s.split("_")[0].to_sym]&.call(client, @target_id, @gui)
         @target ||= Snowflake.new(data[:target_id])
         @changes = data[:changes] && Changes.new(data[:changes])
@@ -223,8 +239,11 @@ module Discorb
         attr_reader :data
 
         #
+        # Initializes a new changes object.
         # @private
         #
+        # @param [Hash] data The data to initialize with.
+        #
         def initialize(data)
           @data = data.to_h { |d| [d[:key].to_sym, d] }
           @data.each do |k, v|
@@ -232,6 +251,9 @@ module Discorb
           end
         end
 
+        #
+        # Formats the changes into a string.
+        #
         def inspect
           "#<#{self.class} #{@data.length} changes>"
         end
@@ -270,7 +292,10 @@ module Discorb
         # @return [Object] The new value of the change.
         attr_reader :new_value
 
+        #
+        # Initializes a new change object.
         # @private
+        #
         def initialize(data)
           @key = data[:key].to_sym
           method = case @key.to_s
@@ -298,10 +323,20 @@ module Discorb
           @new_value.__send__(method, ...)
         end
 
+        #
+        # Format the change into a string.
+        #
+        # @return [String] The string representation of the change.
+        #
         def inspect
           "#<#{self.class} #{@key.inspect} #{@old_value.inspect} -> #{@new_value.inspect}>"
         end
 
+        #
+        # Whether the change responds to the given method.
+        #
+        # @return [Boolean] Whether the change responds to the given method.
+        #
         def respond_to_missing?(method, include_private = false)
           @new_value.respond_to?(method, include_private)
         end
@@ -321,7 +356,10 @@ module Discorb
       # @return [Discorb::Integration::Account] The account of the integration.
       attr_reader :account
 
+      #
+      # Initializes a new integration object.
       # @private
+      #
       def initialize(data)
         @id = Snowflake.new(data[:id])
         @type = data[:type].to_sym

data/lib/discorb/channel.rb

@@ -19,7 +19,10 @@ module Discorb
     @channel_type = nil
     @subclasses = []
 
+    #
+    # Initializes a new instance of the Channel class.
     # @private
+    #
     def initialize(client, data, no_cache: false)
       @client = client
       @data = {}
@@ -44,12 +47,22 @@ module Discorb
       "#<#{self.class} \"##{@name}\" id=#{@id}>"
     end
 
+    #
+    # Returns the descendants of the Channel class.
     # @private
+    #
     def self.descendants
       ObjectSpace.each_object(Class).select { |klass| klass < self }
     end
 
+    #
+    # Creates a new instance of the Channel class or instance of its descendants.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    # @param [Boolean] no_cache Whether to disable cache the object.
+    #
     def self.make_channel(client, data, no_cache: false)
       descendants.each do |klass|
         return klass.new(client, data, no_cache: no_cache) if !klass.channel_type.nil? && klass.channel_type == data[:type]
@@ -59,7 +72,10 @@ module Discorb
     end
 
     class << self
+      #
       # @private
+      # @return [Integer] The type of the channel.
+      #
       attr_reader :channel_type
     end
 
@@ -67,7 +83,12 @@ module Discorb
       self.class.channel_type
     end
 
+    #
+    # Returns the channel id to request.
     # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    #
     def channel_id
       Async do
         @id
@@ -114,7 +135,7 @@ module Discorb
     #
     # @param [Discorb::GuildChannel] other The channel to compare.
     #
-    # @return [-1, 1] -1 if the channel is at lower than the other, 1 if the channel is at highter than the other.
+    # @return [-1, 0, 1] -1 if the channel is at lower than the other, 1 if the channel is at highter than the other.
     #
     def <=>(other)
       return 0 unless other.respond_to?(:position)
@@ -419,7 +440,7 @@ module Discorb
     def fetch_invites
       Async do
         _resp, data = @client.http.request(Route.new("/channels/#{@id}/invites", "//channels/:channel_id/invites", :get)).wait
-        data.map { |invite| Invite.new(@client, invite) }
+        data.map { |invite| Invite.new(@client, invite, false) }
       end
     end
 
@@ -444,7 +465,7 @@ module Discorb
           temporary: temporary,
           unique: unique,
         }, audit_log_reason: reason).wait
-        Invite.new(@client, data)
+        Invite.new(@client, data, false)
       end
     end
 
@@ -664,7 +685,10 @@ module Discorb
     attr_reader :bitrate
     # @return [Integer] The user limit of the voice channel.
     attr_reader :user_limit
+    #
     # @private
+    # @return [Discorb::Dictionary{Discorb::Snowflake => StageInstance}] The stage instances associated with the stage channel.
+    #
     attr_reader :stage_instances
 
     include Connectable
@@ -673,7 +697,10 @@ module Discorb
     #   @return [Discorb::StageInstance] The stage instance of the channel.
 
     @channel_type = 13
+    #
+    # Initialize a new stage channel.
     # @private
+    #
     def initialize(...)
       @stage_instances = Dictionary.new
       super(...)
@@ -823,7 +850,14 @@ module Discorb
     include Messageable
     @channel_type = nil
 
+    #
+    # Initialize a new thread channel.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the thread channel.
+    # @param [Boolean] no_cache Whether to disable the cache.
+    #
     def initialize(client, data, no_cache: false)
       @members = Dictionary.new
       super
@@ -1113,7 +1147,12 @@ module Discorb
   class DMChannel < Channel
     include Messageable
 
+    #
+    # Returns the channel id to request.
     # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    #
     def channel_id
       Async do
         @id

data/lib/discorb/client.rb

@@ -54,7 +54,10 @@ module Discorb
     attr_reader :session_id
     # @return [Hash{String => Discorb::Extension}] The loaded extensions.
     attr_reader :extensions
+    #
     # @private
+    # @return [Hash{Discorb::Snowflake => Discorb::ApplicationCommand::Command}] The commands on the top level.
+    #
     attr_reader :bottom_commands
 
     #
@@ -309,6 +312,7 @@ module Discorb
         activities: [],
         status: status,
         since: nil,
+        afk: nil,
       }
       payload[:activities] = [activity.to_hash] unless activity.nil?
       payload[:status] = status unless status.nil?