discordrb 3.5.0 → 3.6.0

data/lib/discordrb/events/interactions.rb

@@ -29,70 +29,65 @@ module Discordrb::Events
     #   @see Interaction#user
     delegate :type, :server, :server_id, :channel, :channel_id, :user, to: :interaction
 
+    # @!visibility private
     def initialize(data, bot)
       @interaction = Discordrb::Interaction.new(data, bot)
       @bot = bot
     end
 
-    # (see Interaction#respond)
-    def respond(content: nil, tts: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: nil, wait: false, components: nil, &block)
-      @interaction.respond(
-        content: content, tts: tts, embeds: embeds, allowed_mentions: allowed_mentions,
-        flags: flags, ephemeral: ephemeral, wait: wait, components: components, &block
-      )
+    # @see Interaction#respond
+    def respond(...)
+      @interaction.respond(...)
     end
 
-    # (see Interaction#defer)
-    def defer(flags: 0, ephemeral: true)
-      @interaction.defer(flags: flags, ephemeral: ephemeral)
+    # @see Interaction#defer
+    def defer(...)
+      @interaction.defer(...)
     end
 
-    # (see Interaction#update_message)
-    def update_message(content: nil, tts: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: nil, wait: false, components: nil, &block)
-      @interaction.update_message(
-        content: content, tts: tts, embeds: embeds, allowed_mentions: allowed_mentions,
-        flags: flags, ephemeral: ephemeral, wait: wait, components: components, &block
-      )
+    # @see Interaction#update_message
+    def update_message(...)
+      @interaction.update_message(...)
     end
 
-    # (see Interaction#show_modal)
-    def show_modal(title:, custom_id:, components: nil, &block)
-      @interaction.show_modal(title: title, custom_id: custom_id, components: components, &block)
+    # @see Interaction#show_modal
+    def show_modal(...)
+      @interaction.show_modal(...)
     end
 
-    # (see Interaction#edit_response)
-    def edit_response(content: nil, embeds: nil, allowed_mentions: nil, components: nil, &block)
-      @interaction.edit_response(content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components, &block)
+    # @see Interaction#edit_response
+    def edit_response(...)
+      @interaction.edit_response(...)
     end
 
-    # (see Interaction#delete_response)
+    # @see Interaction#delete_response
     def delete_response
       @interaction.delete_response
     end
 
-    # (see Interaction#send_message)
-    def send_message(content: nil, embeds: nil, tts: false, allowed_mentions: nil, flags: 0, ephemeral: nil, components: nil, &block)
-      @interaction.send_message(content: content, embeds: embeds, tts: tts, allowed_mentions: allowed_mentions, flags: flags, ephemeral: ephemeral, components: components, &block)
+    # @see Interaction#send_message
+    def send_message(...)
+      @interaction.send_message(...)
     end
 
-    # (see Interaction#edit_message)
-    def edit_message(message, content: nil, embeds: nil, allowed_mentions: nil, &block)
-      @interaction.edit_message(message, content: content, embeds: embeds, allowed_mentions: allowed_mentions, &block)
+    # @see Interaction#edit_message
+    def edit_message(...)
+      @interaction.edit_message(...)
     end
 
-    # (see Interaction#delete_message)
-    def delete_message(message)
-      @interaction.delete_message(message)
+    # @see Interaction#delete_message
+    def delete_message(...)
+      @interaction.delete_message(...)
     end
 
-    # (see Interaction#defer_update)
+    # @see Interaction#defer_update
     def defer_update
       @interaction.defer_update
     end
 
-    # (see Interaction#get_component)
-    def get_component(custom_id)
-      @interaction.get_component(custom_id)
+    # @see Interaction#get_component
+    def get_component(...)
+      @interaction.get_component(...)
     end
   end
 
@@ -132,16 +127,16 @@ module Discordrb::Events
     # Struct to allow accessing data via [] or methods.
     Resolved = Struct.new('Resolved', :channels, :members, :messages, :roles, :users, :attachments) # rubocop:disable Lint/StructNewOverride
 
-    # @return [String] The name of the command.
+    # @return [Symbol] The name of the command.
     attr_reader :command_name
 
     # @return [Integer] The ID of the command.
     attr_reader :command_id
 
-    # @return [String, nil] The name of the subcommand group relevant to this event.
+    # @return [Symbol, nil] The name of the subcommand group relevant to this event.
     attr_reader :subcommand_group
 
-    # @return [String, nil] The name of the subcommand relevant to this event.
+    # @return [Symbol, nil] The name of the subcommand relevant to this event.
     attr_reader :subcommand
 
     # @return [Resolved]
@@ -153,6 +148,7 @@ module Discordrb::Events
     # @return [Integer, nil] The target of this command when it is a context command.
     attr_reader :target_id
 
+    # @!visibility private
     def initialize(data, bot)
       super
 
@@ -246,7 +242,7 @@ module Discordrb::Events
     # @yieldparam [SubcommandBuilder]
     # @return [ApplicationCommandEventHandler]
     def group(name)
-      raise ArgumentError, 'Unable to mix subcommands and groups' if @subcommands.any? { |_, v| v.is_a? Proc }
+      raise ArgumentError, 'Unable to mix subcommands and groups' if @subcommands.any? { |n, v| n == name && v.is_a?(Proc) }
 
       builder = SubcommandBuilder.new(name)
       yield builder
@@ -259,7 +255,7 @@ module Discordrb::Events
     # @yieldparam [SubcommandBuilder]
     # @return [ApplicationCommandEventHandler]
     def subcommand(name, &block)
-      raise ArgumentError, 'Unable to mix subcommands and groups' if @subcommands.any? { |_, v| v.is_a? Hash }
+      raise ArgumentError, 'Unable to mix subcommands and groups' if @subcommands.any? { |n, v| n == name && v.is_a?(Hash) }
 
       @subcommands[name.to_sym] = block
 
@@ -453,8 +449,8 @@ module Discordrb::Events
     def initialize(data, bot)
       super
 
-      users   = data['data']['resolved']['users'].keys.map { |e| bot.user(e) }
-      roles   = data['data']['resolved']['roles'] ? data['data']['resolved']['roles'].keys.map { |e| bot.server(data['guild_id']).role(e) } : []
+      users = data['data']['resolved']['users'].keys.map { |e| bot.user(e) }
+      roles = data['data']['resolved']['roles'] ? data['data']['resolved']['roles'].keys.map { |e| bot.server(data['guild_id']).role(e) } : []
       @values = { users: users, roles: roles }
     end
   end
@@ -479,4 +475,101 @@ module Discordrb::Events
   # Event handler for a select channel component.
   class ChannelSelectEventHandler < ComponentEventHandler
   end
+
+  # Event handler for an autocomplete option choices.
+  class AutocompleteEventHandler < InteractionCreateEventHandler
+    def matches?(event)
+      return false unless super
+      return false unless event.is_a?(AutocompleteEvent)
+
+      [
+        matches_all(@attributes[:name], event.focused) { |a, e| a&.to_s == e },
+        matches_all(@attributes[:command_id], event.command_id) { |a, e| a&.to_i == e },
+        matches_all(@attributes[:subcommand], event.subcommand) { |a, e| a&.to_sym == e },
+        matches_all(@attributes[:command_name], event.command_name) { |a, e| a&.to_sym == e },
+        matches_all(@attributes[:subcommand_group], event.subcommand_group) { |a, e| a&.to_sym == e },
+        matches_all(@attributes[:server], event.server_id) { |a, e| a&.resolve_id == e }
+      ].reduce(&:&)
+    end
+  end
+
+  # An event for an autocomplete option choice.
+  class AutocompleteEvent < ApplicationCommandEvent
+    # @return [String] Name of the currently focused option.
+    attr_reader :focused
+
+    # @return [Hash] An empty hash that can be used to return choices by adding K/V pairs.
+    attr_reader :choices
+
+    # @!visibility private
+    def initialize(data, bot)
+      super
+
+      @choices = {}
+
+      options = data['data']['options']
+
+      options = case options[0]['type']
+                when 1
+                  options[0]['options']
+                when 2
+                  options[0]['options'][0]['options']
+                else
+                  options
+                end
+
+      @focused = options.find { |opt| opt.key?('focused') }['name']
+    end
+
+    # Respond to this interaction with autocomplete choices.
+    # @param choices [Array<Hash>, Hash, nil] Autocomplete choices to return.
+    def respond(choices:)
+      @interaction.show_autocomplete_choices(choices || [])
+    end
+  end
+
+  # An event for whenever an application command's permissions are updated.
+  class ApplicationCommandPermissionsUpdateEvent < Event
+    # @return [Integer] the ID of the server where the command permissions were updated.
+    attr_reader :server_id
+
+    # @return [Integer, nil] the ID of the application command that was updated.
+    attr_reader :command_id
+
+    # @return [Array<ApplicationCommand::Permission>] the permissions that were updated.
+    attr_reader :permissions
+
+    # @return [Integer] the ID of the application whose commands were updated.
+    attr_reader :application_id
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @server_id = data['guild_id'].to_i
+      @application_id = data['application_id'].to_i
+      @command_id = data['id'].to_i if data['id'].to_i != @application_id
+      @permissions = data['permissions'].map do |permission|
+        Discordrb::ApplicationCommand::Permission.new(permission, data, bot)
+      end
+    end
+
+    # @return [Server] the server where the command's permissions were updated.
+    def server
+      @bot.server(@server_id)
+    end
+  end
+
+  # Event handler for the APPLICATION_COMMAND_PERMISSIONS_UPDATE event.
+  class ApplicationCommandPermissionsUpdateEventHandler < EventHandler
+    # @!visibility private
+    def matches?(event)
+      return false unless event.is_a?(ApplicationCommandPermissionsUpdateEvent)
+
+      [
+        matches_all(@attributes[:server], event.server_id) { |a, e| a.resolve_id == e },
+        matches_all(@attributes[:command_id], event.command_id) { |a, e| a.resolve_id == e },
+        matches_all(@attributes[:application_id], event.application_id) { |a, e| a.resolve_id == e }
+      ].reduce(&:&)
+    end
+  end
 end

data/lib/discordrb/events/invites.rb

@@ -34,6 +34,7 @@ module Discordrb::Events
 
     alias temporary? temporary
 
+    # @!visibility private
     def initialize(data, invite, bot)
       @bot = bot
       @invite = invite
@@ -53,6 +54,7 @@ module Discordrb::Events
     # @return [String] The code of the deleted invite.
     attr_reader :code
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
       @channel = bot.channel(data['channel_id'])

data/lib/discordrb/events/members.rb

@@ -16,6 +16,7 @@ module Discordrb::Events
     # @return [Server] the server on which the event happened.
     attr_reader :server
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 
@@ -28,11 +29,13 @@ module Discordrb::Events
 
     private
 
+    # @!visibility private
     def init_user(data, _)
       user_id = data['user']['id'].to_i
       @user = @server.member(user_id)
     end
 
+    # @!visibility private
     def init_roles(data, _)
       @roles = [@server.role(@server.id)]
       return unless data['roles']
@@ -71,7 +74,20 @@ module Discordrb::Events
 
   # Member is updated (roles added or deleted)
   # @see Discordrb::EventContainer#member_update
-  class ServerMemberUpdateEvent < ServerMemberEvent; end
+  class ServerMemberUpdateEvent < ServerMemberEvent
+    # @!visibility private
+    # @note Override init_user so we don't make requests all the time on large servers
+    def init_user(data, _)
+      @user_id = data['user']['id']
+    end
+
+    # @return [Member] the member in question.
+    def user
+      @server&.member(@user_id)
+    end
+
+    alias_method :member, :user
+  end
 
   # Event handler for {ServerMemberUpdateEvent}
   class ServerMemberUpdateEventHandler < ServerMemberEventHandler; end
@@ -79,7 +95,8 @@ module Discordrb::Events
   # Member leaves
   # @see Discordrb::EventContainer#member_leave
   class ServerMemberDeleteEvent < ServerMemberEvent
-    # Override init_user to account for the deleted user on the server
+    # @!visibility private
+    # @note Override init_user to account for the deleted user on the server
     def init_user(data, bot)
       @user = Discordrb::User.new(data['user'], bot)
     end

data/lib/discordrb/events/message.rb

@@ -18,9 +18,10 @@ module Discordrb::Events
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
     # @param components [View, Array<Hash>, nil] A collection of components to attach to the message.
+    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2) and SUPPRESS_NOTIFICATIONS (1 << 12) can be set.
     # @return [Discordrb::Message] the message that was sent
-    def send_message(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil)
-      channel.send_message(content, tts, embed, attachments, allowed_mentions, message_reference, components)
+    def send_message(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0)
+      channel.send_message(content, tts, embed, attachments, allowed_mentions, message_reference, components, flags)
     end
 
     # The same as {#send_message}, but yields a {Webhooks::Embed} for easy building of embedded content inside a block.
@@ -32,11 +33,12 @@ module Discordrb::Events
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
     # @param components [View, Array<Hash>, nil] A collection of components to attach to the message.
+    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2) and SUPPRESS_NOTIFICATIONS (1 << 12) can be set.
     # @yield [embed] Yields the embed to allow for easy building inside a block.
     # @yieldparam embed [Discordrb::Webhooks::Embed] The embed from the parameters, or a new one.
     # @return [Message] The resulting message.
-    def send_embed(message = '', embed = nil, attachments = nil, tts = false, allowed_mentions = nil, message_reference = nil, components = nil, &block)
-      channel.send_embed(message, embed, attachments, tts, allowed_mentions, message_reference, components, &block)
+    def send_embed(message = '', embed = nil, attachments = nil, tts = false, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0, &block)
+      channel.send_embed(message, embed, attachments, tts, allowed_mentions, message_reference, components, flags, &block)
     end
 
     # Sends a temporary message to the channel this message was sent in, right now.
@@ -47,8 +49,15 @@ module Discordrb::Events
     # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param components [View, Array<Hash>, nil] A collection of components to attach to the message.
-    def send_temporary_message(content, timeout, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, components = nil)
-      channel.send_temporary_message(content, timeout, tts, embed, attachments, allowed_mentions, components)
+    # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2) and SUPPRESS_NOTIFICATIONS (1 << 12) can be set.
+    def send_temporary_message(content, timeout, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, components = nil, flags = 0)
+      channel.send_temporary_message(content, timeout, tts, embed, attachments, allowed_mentions, components, flags)
+    end
+
+    # Sends a message to the channel this message was sent in, right now.
+    # @see Channel#send_message!
+    def send_message!(...)
+      channel.send_message!(...)
     end
 
     # Adds a string to be sent after the event has finished execution. Avoids problems with rate limiting because only
@@ -84,6 +93,9 @@ module Discordrb::Events
     alias_method :send, :send_message
     alias_method :respond, :send_message
     alias_method :send_temp, :send_temporary_message
+
+    alias_method :send!, :send_message!
+    alias_method :respond!, :send_message!
   end
 
   # Event raised when a text message is sent to a channel
@@ -124,6 +136,7 @@ module Discordrb::Events
     #   @see Channel#server
     delegate :server, to: :channel
 
+    # @!visibility private
     def initialize(message, bot)
       @bot = bot
       @message = message
@@ -226,7 +239,9 @@ module Discordrb::Events
             a == e
           end
         end,
-        matches_all(@attributes[:from], event.author) do |a, e|
+        matches_all(@attributes[:from], event.message) do |a, e|
+          # Resolve the author in the block in order to prevent resolving the author even when the attribute is `nil`
+          e = e.author
           case a
           when String
             a == e.name
@@ -247,9 +262,18 @@ module Discordrb::Events
             match ? (e == match[0]) : false
           end
         end,
+        matches_all(@attributes[:type] || @attributes[:message_type], event.message.type) do |a, e|
+          case a
+          when String, Symbol
+            Discordrb::Message::TYPES[a.to_sym] == e
+          when Integer
+            a == e
+          end
+        end,
         matches_all(@attributes[:after], event.timestamp) { |a, e| a > e },
         matches_all(@attributes[:before], event.timestamp) { |a, e| a < e },
-        matches_all(@attributes[:private], event.channel.private?) { |a, e| !e == !a }
+        matches_all(@attributes[:private], event.channel.private?) { |a, e| !e == !a },
+        matches_all(@attributes[:server], event.server) { |a, e| a&.resolve_id == e&.resolve_id }
       ].reduce(true, &:&)
     end
 
@@ -282,10 +306,14 @@ module Discordrb::Events
     # @return [Integer] the ID associated with this event
     attr_reader :id
 
+    # @return [Server, nil] the server associated with this event
+    attr_reader :server
+
     # @!visibility private
     def initialize(data, bot)
       @id = data['id'].to_i
       @channel = bot.channel(data['channel_id'].to_i)
+      @server = @channel.server
       @saved_message = ''
       @bot = bot
     end
@@ -311,6 +339,9 @@ module Discordrb::Events
           else
             a == e
           end
+        end,
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a&.resolve_id == e&.resolve_id
         end
       ].reduce(true, &:&)
     end

data/lib/discordrb/events/presence.rb

@@ -19,6 +19,7 @@ module Discordrb::Events
     #   on various device types (`:desktop`, `:mobile`, or `:web`). The value will be `nil` if the user is offline or invisible.
     attr_reader :client_status
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 
@@ -82,6 +83,7 @@ module Discordrb::Events
     #   on various device types (`:desktop`, `:mobile`, or `:web`). The value will be `nil` if the user is offline or invisible.
     attr_reader :client_status
 
+    # @!visibility private
     def initialize(data, activity, bot)
       @bot = bot
       @activity = activity

data/lib/discordrb/events/raw.rb

@@ -14,6 +14,7 @@ module Discordrb::Events
     attr_reader :data
     alias_method :d, :data
 
+    # @!visibility private
     def initialize(type, data, bot)
       @type = type
       @data = data

data/lib/discordrb/events/reactions.rb

@@ -14,6 +14,7 @@ module Discordrb::Events
     # @!visibility private
     attr_reader :message_id
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 
@@ -113,6 +114,7 @@ module Discordrb::Events
     # @!visibility private
     attr_reader :message_id
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 

data/lib/discordrb/events/roles.rb

@@ -17,6 +17,7 @@ module Discordrb::Events
     #   @see Role#name
     delegate :name, to: :role
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 
@@ -54,6 +55,7 @@ module Discordrb::Events
     # @return [Server] the server on which a role got deleted.
     attr_reader :server
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 

data/lib/discordrb/events/threads.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Generic subclass for threads
 module Discordrb::Events
   # Raised when a thread is created
   class ThreadCreateEvent < Event
@@ -8,6 +9,7 @@ module Discordrb::Events
 
     delegate :name, :server, :owner, :parent_channel, :thread_metadata, to: :thread
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
       @thread = data.is_a?(Discordrb::Channel) ? data : bot.channel(data['id'].to_i)
@@ -62,9 +64,6 @@ module Discordrb::Events
     # @return [Channel]
     attr_reader :thread
 
-    # @return [Array<Member, User>]
-    attr_reader :added_members
-
     # @return [Array<Integer>]
     attr_reader :removed_member_ids
 
@@ -73,17 +72,22 @@ module Discordrb::Events
 
     delegate :name, :server, :owner, :parent_channel, :thread_metadata, to: :thread
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
+      @server = bot.server(data['guild_id'].to_i) if data['guild_id']
       @thread = data.is_a?(Discordrb::Channel) ? data : bot.channel(data['id'].to_i)
-      @added_members = data['added_members']&.map do |member|
-        data['guild_id'] ? bot.member(data['guild_id'], member['user_id']) : bot.user(member['user_id'])
-      end || []
+      @added_member_ids = data['added_members']&.map { |m| m['user_id']&.to_i } || []
       @removed_member_ids = data['removed_member_ids']&.map(&:resolve_id) || []
       @member_count = data['member_count']
     end
   end
 
+  # @return [Array<Member, User>] the members that were added to the thread
+  def added_members
+    @added_members ||= @added_member_ids&.map { |id| @server&.member(id) || @bot.user(id) }
+  end
+
   # Event handler for ThreadMembersUpdateEvent
   class ThreadMembersUpdateEventHandler < ThreadCreateEventHandler
     def matches?(event)

data/lib/discordrb/events/typing.rb

@@ -17,6 +17,7 @@ module Discordrb::Events
     # @return [Time] when the typing happened.
     attr_reader :timestamp
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 

data/lib/discordrb/events/voice_server_update.rb

@@ -19,6 +19,7 @@ module Discordrb::Events
     # @return [String] The voice server host.
     attr_reader :endpoint
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 

data/lib/discordrb/events/voice_state_update.rb

@@ -11,6 +11,7 @@ module Discordrb::Events
     # @return [Channel, nil] the old channel this user was on, or nil if the user is newly joining voice.
     attr_reader :old_channel
 
+    # @!visibility private
     def initialize(data, old_channel_id, bot)
       @bot = bot
 

data/lib/discordrb/events/webhooks.rb

@@ -12,6 +12,7 @@ module Discordrb::Events
     # @return [Channel] the channel the webhook is associated to
     attr_reader :channel
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot