discorb 0.18.1 → 0.19.0

data/lib/discorb/interaction/root.rb

@@ -83,6 +83,142 @@ module Discorb
       "#<#{self.class} id=#{@id}>"
     end
 
+    #
+    # Send followup message.
+    #
+    # @async
+    #
+    # @param [String] content The content of the response.
+    # @param [Boolean] tts Whether to send the message as text-to-speech.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discorb::Embed>] embeds The embeds to send. (max: 10)
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
+    # @param [Discorb::Attachment] attachment The attachment to send.
+    # @param [Array<Discorb::Attachment>] attachments The attachments to send. (max: 10)
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    # @param [Boolean] ephemeral Whether to make the response ephemeral.
+    #
+    # @return [Discorb::Webhook::Message] The message.
+    #
+    def post(
+      content = nil,
+      tts: false,
+      embed: nil,
+      embeds: nil,
+      allowed_mentions: nil,
+      attachment: nil,
+      attachments: nil,
+      components: nil,
+      ephemeral: false
+    )
+      Async do
+        payload = {}
+        payload[:content] = content if content
+        payload[:tts] = tts
+        payload[:embeds] = (embeds || [embed]).map { |e| e&.to_hash }.filter { _1 }
+        payload[:allowed_mentions] =
+          allowed_mentions&.to_hash(@client.allowed_mentions) || @client.allowed_mentions.to_hash
+        payload[:components] = Component.to_payload(components) if components
+        payload[:flags] = (ephemeral ? 1 << 6 : 0)
+        attachments ||= attachment ? [attachment] : []
+
+        payload[:attachments] = attachments.map.with_index do |a, i|
+          {
+            id: i,
+            filename: a.filename,
+            description: a.description,
+          }
+        end
+
+        _resp, data = @client.http.multipart_request(
+          Route.new(
+            "/webhooks/#{@application_id}/#{@token}",
+            "//webhooks/:webhook_id/:token",
+            :post
+          ),
+          payload,
+          attachments
+        ).wait
+        webhook = Webhook::URLWebhook.new("/webhooks/#{@application_id}/#{@token}")
+        Webhook::Message.new(webhook, data, @client)
+        ret
+      end
+    end
+
+    #
+    # Edit the original response message.
+    # This method is low-level.
+    #
+    # @async
+    #
+    # @param [String] content The content of the response.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discorb::Embed>] embeds The embeds to send. (max: 10)
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
+    # @param [Discorb::Attachment] attachment The attachment to send.
+    # @param [Array<Discorb::Attachment>] attachments The attachments to send. (max: 10)
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    #
+    # @return [Async::Task<void>] The task.
+    #
+    # @see CallbackMessage#edit
+    #
+    def edit_original_message(
+      content = nil,
+      embed: nil,
+      embeds: nil,
+      attachment: nil,
+      attachments: nil,
+      components: nil
+    )
+      Async do
+        payload = {}
+        payload[:content] = content if content
+        payload[:embeds] = (embeds || [embed]).map { |e| e&.to_hash }.filter { _1 }.then { _1.empty? ? nil : _1 }
+        payload[:components] = Component.to_payload(components) if components
+        attachments ||= attachment && [attachment]
+
+        payload[:attachments] = attachments&.map&.with_index do |a, i|
+          {
+            id: i,
+            filename: a.filename,
+            description: a.description,
+          }
+        end
+        payload.compact!
+
+        @client.http.multipart_request(
+          Route.new(
+            "/webhooks/#{@application_id}/#{@token}/messages/@original",
+            "//webhooks/:webhook_id/:token/messages/@original",
+            :patch
+          ),
+          payload,
+          attachments
+        ).wait
+      end
+    end
+
+    #
+    # Delete the original response message.
+    # This method is low-level.
+    #
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
+    #
+    def delete_original_message
+      Async do
+        @client.http.request(
+          Route.new(
+            "/webhooks/#{@application_id}/#{@token}/messages/@original",
+            "//webhooks/:webhook_id/:token/messages/@original",
+            :delete
+          )
+        ).wait
+      end
+    end
+
     class << self
       # @private
       attr_reader :interaction_type, :interaction_name, :event_name

data/lib/discorb/invite.rb

@@ -112,7 +112,7 @@ module Discorb
     # @async
     # @return [Async::Task<void>] The task.
     #
-    def delete!(reason: nil)
+    def delete(reason: nil)
       Async do
         @client.http.request(Route.new("/invites/#{@code}", "//invites/:code", :delete), {}, audit_log_reason: reason)
       end

data/lib/discorb/message.rb

@@ -282,9 +282,9 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete!(reason: nil)
+    def delete(reason: nil)
       Async do
-        channel.delete_message!(@id, reason: reason).wait
+        channel.delete_message(@id, reason: reason).wait
       end
     end
 
@@ -408,10 +408,10 @@ module Discorb
     #
     # @return [Async::Task<Array<Discorb::User>>] The users.
     #
-    def fetch_reacted_users(emoji, limit: nil, after: 0)
+    def fetch_reacted_users(emoji, limit: nil, after: Discorb::Snowflake.new("0"))
       Async do
         if limit.nil? || !limit.positive?
-          after = 0
+          after = Discorb::Snowflake.new("0")
           users = []
           loop do
             _resp, data = @client.http.request(

data/lib/discorb/modules.rb

@@ -135,7 +135,7 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete_message!(message_id, reason: nil)
+    def delete_message(message_id, reason: nil)
       Async do
         @client.http.request(
           Route.new(
@@ -146,7 +146,7 @@ module Discorb
       end
     end
 
-    alias destroy_message! delete_message!
+    alias destroy_message delete_message
 
     #
     # Fetch a message from ID.

data/lib/discorb/permission.rb

@@ -202,7 +202,9 @@ module Discorb
     def +(other)
       result = to_hash
       self.class.bits.each_key do |field|
-        result[field] = other[field] unless other[field].nil?
+        unless other[field].nil?
+          result[field] = (other[field] || raise(KeyError, "field #{field} not found in #{other.inspect}"))
+        end
       end
       self.class.from_hash(result)
     end

data/lib/discorb/role.rb

@@ -165,7 +165,7 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete!(reason: nil)
+    def delete(reason: nil)
       Async do
         @client.http.request(
           Route.new("/guilds/#{@guild.id}/roles/#{@id}", "//guilds/:guild_id/roles/:role_id",
@@ -174,7 +174,7 @@ module Discorb
       end
     end
 
-    alias destroy! delete!
+    alias destroy delete
 
     def tag
       Tag.new(@tags)

data/lib/discorb/shard.rb

@@ -61,7 +61,7 @@ module Discorb
     #
     # @return [void]
     #
-    def close!
+    def close
       @status = :closed
       @main_task&.stop
       @thread.kill

data/lib/discorb/sticker.rb

@@ -100,7 +100,7 @@ module Discorb
       #
       # @param [String] reason The reason for the deletion.
       #
-      def delete!(reason: nil)
+      def delete(reason: nil)
         Async do
           @client.http.request(
             Route.new("/guilds/#{@guild_id}/stickers/#{@id}", "//guilds/:guild_id/stickers/:sticker_id",
@@ -109,7 +109,7 @@ module Discorb
         end
       end
 
-      alias destroy! delete!
+      alias destroy delete
     end
 
     #

data/lib/discorb/voice_state.rb

@@ -213,7 +213,7 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete!(reason: nil)
+    def delete(reason: nil)
       Async do
         @client.http.request(
           Route.new("/stage-instances/#{@channel_id}", "//stage-instances/:stage_instance_id",
@@ -223,8 +223,8 @@ module Discorb
       end
     end
 
-    alias destroy! delete!
-    alias end! delete!
+    alias destroy delete
+    alias end delete
 
     private
 

data/lib/discorb/webhook.rb

@@ -135,14 +135,14 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete!
+    def delete
       Async do
         @http.request(Route.new(url, "//webhooks/:webhook_id/:token", :delete)).wait
         self
       end
     end
 
-    alias destroy! delete!
+    alias destroy delete
 
     #
     # Edits the webhook's message.
@@ -191,7 +191,7 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete_message!(message)
+    def delete_message(message)
       Async do
         @http.request(
           Route.new(
@@ -385,9 +385,9 @@ module Discorb
       #
       # @return [Async::Task<void>] The task.
       #
-      def delete!
+      def delete
         Async do
-          @webhook.delete_message!(self).wait
+          @webhook.delete_message(self).wait
         end
       end
 

data/sig/discorb/activity.rbs

@@ -18,6 +18,7 @@ module Discorb
     # @return [Hash] A hash representation of the activity.
     def to_hash: -> Discorb::json
 
+    %a{pure}
     def inspect: -> String
   end
 end

data/sig/discorb/allowed_mentions.rbs

@@ -16,6 +16,7 @@ module Discorb
       ?replied_user: bool?
     ) -> void
 
+    %a{pure}
     def inspect: -> String
 
     #

data/sig/discorb/app_command/base.rbs

@@ -83,6 +83,7 @@ module Discorb
       # @private
       #
       # @return [Hash] The hash represents the object.
+      %a{pure}
       def to_hash: -> Discorb::json
 
       # @return [Hash{String => String}] The name of the command.
@@ -143,6 +144,7 @@ module Discorb
         # Returns the commands name.
         #
         # @return [String] The name of the command.
+        %a{pure}
         def to_s: -> String
 
         #
@@ -150,6 +152,7 @@ module Discorb
         # @private
         #
         # @return [Hash] The hash represents the object.
+        %a{pure}
         def to_hash: -> Discorb::json
 
         # @return [Hash{String => String}] The description of the command.
@@ -219,6 +222,7 @@ module Discorb
         # Returns the command name.
         #
         # @return [String] The command name.
+        %a{pure}
         def to_s: -> String
 
         #
@@ -233,6 +237,7 @@ module Discorb
         # @private
         #
         # @return [Hash] The hash represents the object.
+        %a{pure}
         def to_hash: -> Discorb::json
 
         # @return [Array<Discorb::ApplicationCommand::Command>] The subcommands of the command.
@@ -260,6 +265,7 @@ module Discorb
           Discorb::Client client
         ) -> void
 
+        %a{pure}
         def to_s: -> untyped
 
         #

data/sig/discorb/application.rbs

@@ -10,6 +10,7 @@ module Discorb
     # @param [Hash] data The data of the object.
     def initialize: (Discorb::Client client, Discorb::json data) -> void
 
+    %a{pure}
     def inspect: -> String
 
     # @return [Discorb::Snowflake] The application's ID.
@@ -85,8 +86,10 @@ module Discorb
       # The team's owner.
       #
       # @return [Discorb::Application::Team::Member] The team's owner.
+      %a{pure}
       def owner: -> Discorb::Application::Team::Member
 
+      %a{pure}
       def inspect: -> String
 
       # @return [Discorb::Snowflake] The team's ID.
@@ -111,6 +114,7 @@ module Discorb
 
         def initialize: (untyped client, untyped team, untyped data) -> void
 
+        %a{pure}
         def inspect: -> String
 
         def ==: (untyped other) -> untyped

data/sig/discorb/asset.rbs

@@ -19,8 +19,10 @@ module Discorb
     # @return [String] URL of the asset.
     def url: (?image_format: String?, ?size: Integer) -> String
 
+    %a{pure}
     def inspect: -> String
 
+    %a{pure}
     def endpoint: -> untyped
 
     # @return [String] The hash of asset.

data/sig/discorb/attachment.rbs

@@ -24,8 +24,16 @@ module Discorb
     # @private
     def initialize_hash: (untyped data) -> untyped
 
+    %a{pure}
     def inspect: -> String
 
+    #
+    # Convert the attachment to hash.
+    #
+    # @return [Hash] The action hash.
+    %a{pure}
+    def to_hash: -> Discorb::json
+
     #
     # Creates a new file from a hash.
     # @private

data/sig/discorb/audit_log.rbs

@@ -7,6 +7,7 @@ module Discorb
     # @private
     def initialize: (untyped client, untyped data, untyped guild) -> void
 
+    %a{pure}
     def inspect: -> String
 
     #
@@ -50,6 +51,7 @@ module Discorb
       # @return [nil] The change with the given key does not exist.
       def []: (Symbol key) -> Discorb::AuditLog::Entry::Change
 
+      %a{pure}
       def inspect: -> String
 
       # @return [Discorb::Snowflake] The ID of the entry.
@@ -145,12 +147,14 @@ module Discorb
 
         #
         # Formats the changes into a string.
+        %a{pure}
         def inspect: -> String
 
         #
         # Get keys of changes.
         #
         # @return [Array<Symbol>] The keys of the changes.
+        %a{pure}
         def keys: -> ::Array[Symbol]
 
         #
@@ -160,6 +164,7 @@ module Discorb
         #
         # @return [Discorb::AuditLog::Entry::Change] The change with the given key.
         # @return [nil] The change with the given key does not exist.
+        %a{pure}
         def []: (Symbol key) -> Discorb::AuditLog::Entry::Change
 
         # Returns the value of attribute data.
@@ -183,6 +188,7 @@ module Discorb
         # Format the change into a string.
         #
         # @return [String] The string representation of the change.
+        %a{pure}
         def inspect: -> String
 
         #
@@ -213,6 +219,7 @@ module Discorb
       # @private
       def initialize: (untyped data) -> void
 
+      %a{pure}
       def inspect: -> String
 
       # @return [Discorb::Snowflake] The ID of the integration.

data/sig/discorb/automod.rbs

@@ -34,20 +34,27 @@ module Discorb
 
     # @return [Symbol] Returns the type of the preset.
     # @note This is only available if the trigger type is `:keyword_preset`.
+    %a{pure}
     def preset_type: -> preset_type
 
     # @return [Symbol] Returns the type of the trigger.
+    %a{pure}
     def trigger_type: -> trigger_type
 
     # @return [Symbol] Returns the type of the event.
+    %a{pure}
     def event_type: -> :message_send
 
+    %a{pure}
     def creator: -> Discorb::Member
 
+    %a{pure}
     def guild: -> Discorb::Guild
 
+    %a{pure}
     def exempt_roles: -> Array[Discorb::Role]
 
+    %a{pure}
     def exempt_channels: -> Array[Discorb::Channel]
 
     #
@@ -76,7 +83,7 @@ module Discorb
     # @return [Async::Task<void>] The task.
     def edit: (
       ?name: String,
-      ?event_type: :send_message,
+      ?event_type: :message_send,
       ?actions: Array[Discorb::AutoModRule::Action],
       ?enabled: bool,
       ?exempt_roles: Array[Discorb::Role],
@@ -92,20 +99,29 @@ module Discorb
     # @param [String] reason The reason for deleting the rule.
     #
     # @return [Async::Task<void>] The task.
-    def delete!: (?reason: nil) -> Async::Task[void]
+    def delete: (?reason: nil) -> Async::Task[void]
 
     class Action < Discorb::DiscordModel
+      type action_type = :ban | :kick | :mute | :warn
+
       # @return [Hash{Integer => Symbol}] The mapping of action types.
       # @private
-      ACTION_TYPES: Hash[Integer, Symbol]
+      ACTION_TYPES: Hash[Integer, action_type]
 
       # @return [Symbol] Returns the type of the action.
-      attr_reader type: :ban | :kick | :mute | :warn
+      attr_reader type: action_type
 
       # @return [Integer] The duration of the timeout.
       # @note This is only available if the action type is `:timeout`.
       attr_reader duration_seconds: Integer?
 
+      #
+      # Convert the action to hash.
+      #
+      # @return [Hash] The action hash.
+      %a{pure}
+      def to_hash: -> Discorb::json
+
       #
       # Initialize a new action.
       #
@@ -115,13 +131,14 @@ module Discorb
       # @param [Discorb::Channel] channel The channel that the alert message is sent to.
       #   This is only available if the action type is `:send_alert_message`.
       def initialize: (
-        Symbol `type`,
+        action_type `type`,
         ?duration_seconds: Integer?,
         ?channel: Discorb::Channel?
       ) -> void
 
       # @return [Discorb::Channel] The channel that the alert message is sent to.
       # @note This is only available if the action type is `:send_alert_message`.
+      %a{pure}
       def channel: -> Discorb::Channel?
     end
   end

data/sig/discorb/avatar.rbs

@@ -18,6 +18,7 @@ module Discorb
     # rubocop: disable Lint/UnusedMethodArgument
     def url: (?image_format: String?, ?size: Integer) -> String
 
+    %a{pure}
     def inspect: -> String
 
     # @return [false] For compatibility with {Asset}, always `false`.

data/sig/discorb/channel/base.rbs

@@ -16,6 +16,7 @@ module Discorb
     # @return [Boolean] True if the channel is other channel.
     def ==: (Discorb::Channel other) -> bool
 
+    %a{pure}
     def inspect: -> String
 
     #
@@ -36,6 +37,7 @@ module Discorb
       ?no_cache: bool
     ) -> untyped
 
+    %a{pure}
     def `type`: -> String
 
     #
@@ -78,14 +80,19 @@ module Discorb
     # Stringifies the channel.
     #
     # @return [String] The name of the channel with `#`.
+    %a{pure}
     def to_s: -> String
 
+    %a{pure}
     def mention: -> String
 
+    %a{pure}
     def parent: -> Discorb::CategoryChannel?
 
+    %a{pure}
     def guild: -> Discorb::Guild
 
+    %a{pure}
     def inspect: -> String
 
     #
@@ -95,7 +102,7 @@ module Discorb
     # @param [String] reason The reason of deleting the channel.
     #
     # @return [Async::Task<self>] The deleted channel.
-    def delete!: (?reason: String?) -> Async::Task[self]
+    def delete: (?reason: String?) -> Async::Task[self]
 
     #
     # Moves the channel to another position.

data/sig/discorb/channel/category.rbs

@@ -4,6 +4,7 @@ module Discorb
   class CategoryChannel < Discorb::GuildChannel
     include Discorb::ChannelContainer
 
+    %a{pure}
     def channels: -> Array[Discorb::GuildChannel]
 
     def create_text_channel: (

data/sig/discorb/channel/container.rbs

@@ -6,24 +6,28 @@ module Discorb
     # Returns text channels.
     #
     # @return [Array<Discorb::TextChannel>] The text channels.
+    %a{pure}
     def text_channels: -> ::Array[Discorb::TextChannel]
 
     #
     # Returns voice channels.
     #
     # @return [Array<Discorb::VoiceChannel>] The voice channels.
+    %a{pure}
     def voice_channels: -> ::Array[Discorb::VoiceChannel]
 
     #
     # Returns news channels.
     #
     # @return [Array<Discorb::NewsChannel>] The news channels.
+    %a{pure}
     def news_channels: -> ::Array[Discorb::NewsChannel]
 
     #
     # Returns stage channels.
     #
     # @return [Array<Discorb::StageChannel>] The stage channels.
+    %a{pure}
     def stage_channels: -> ::Array[Discorb::StageChannel]
   end
 end

data/sig/discorb/channel/stage.rbs

@@ -54,12 +54,16 @@ module Discorb
     # @return [Async::Task<nil>] If there is no current stage instance.
     def fetch_stage_instance: -> Async::Task[StageInstance]
 
+    %a{pure}
     def voice_states: -> Array[Discorb::VoiceState]
 
+    %a{pure}
     def members: -> Array[Discorb::Member]
 
+    %a{pure}
     def speakers: -> Array[Discorb::Member]
 
+    %a{pure}
     def audiences: -> Array[Discorb::Member]
 
     # @return [Integer] The bitrate of the voice channel.