discordrb 3.4.0 → 3.5.0

data/lib/discordrb/cache.rb

@@ -21,8 +21,7 @@ module Discordrb
 
       @channels = {}
       @pm_channels = {}
-
-      @restricted_channels = []
+      @thread_members = {}
     end
 
     # Returns or caches the available voice regions
@@ -42,28 +41,21 @@ module Discordrb
     # @param id [Integer] The channel ID for which to search for.
     # @param server [Server] The server for which to search the channel for. If this isn't specified, it will be
     #   inferred using the API
-    # @return [Channel] The channel identified by the ID.
+    # @return [Channel, nil] The channel identified by the ID.
+    # @raise Discordrb::Errors::NoPermission
     def channel(id, server = nil)
       id = id.resolve_id
 
-      raise Discordrb::Errors::NoPermission if @restricted_channels.include? id
-
       debug("Obtaining data for channel with id #{id}")
       return @channels[id] if @channels[id]
 
       begin
-        begin
-          response = API::Channel.resolve(token, id)
-        rescue RestClient::ResourceNotFound
-          return nil
-        end
-        channel = Channel.new(JSON.parse(response), self, server)
-        @channels[id] = channel
-      rescue Discordrb::Errors::NoPermission
-        debug "Tried to get access to restricted channel #{id}, blacklisting it"
-        @restricted_channels << id
-        raise
+        response = API::Channel.resolve(token, id)
+      rescue Discordrb::Errors::UnknownChannel
+        return nil
       end
+      channel = Channel.new(JSON.parse(response), self, server)
+      @channels[id] = channel
     end
 
     alias_method :group_channel, :channel
@@ -79,7 +71,7 @@ module Discordrb
       LOGGER.out("Resolving user #{id}")
       begin
         response = API::User.resolve(token, id)
-      rescue RestClient::ResourceNotFound
+      rescue Discordrb::Errors::UnknownUser
         return nil
       end
       user = User.new(JSON.parse(response), self)
@@ -111,7 +103,6 @@ module Discordrb
     def member(server_or_id, user_id)
       server_id = server_or_id.resolve_id
       user_id = user_id.resolve_id
-
       server = server_or_id.is_a?(Server) ? server_or_id : self.server(server_id)
 
       return server.member(user_id) if server.member_cached?(user_id)
@@ -119,7 +110,7 @@ module Discordrb
       LOGGER.out("Resolving member #{server_id} on server #{user_id}")
       begin
         response = API::Server.resolve_member(token, server_id, user_id)
-      rescue RestClient::ResourceNotFound
+      rescue Discordrb::Errors::UnknownUser, Discordrb::Errors::UnknownMember
         return nil
       end
       member = Member.new(JSON.parse(response), server, self)
@@ -156,10 +147,14 @@ module Discordrb
 
     # Ensures a given server object is cached and if not, cache it from the given data hash.
     # @param data [Hash] A data hash representing a server.
+    # @param force_cache [true, false] Whether the object in cache should be updated with the given
+    #   data if it already exists.
     # @return [Server] the server represented by the data hash.
-    def ensure_server(data)
+    def ensure_server(data, force_cache = false)
       if @servers.include?(data['id'].to_i)
-        @servers[data['id'].to_i]
+        server = @servers[data['id'].to_i]
+        server.update_data(data) if force_cache
+        server
       else
         @servers[data['id'].to_i] = Server.new(data, self)
       end
@@ -177,6 +172,16 @@ module Discordrb
       end
     end
 
+    # Ensures a given thread member object is cached.
+    # @param data [Hash] Thread member data.
+    def ensure_thread_member(data)
+      thread_id = data['id'].to_i
+      user_id = data['user_id'].to_i
+
+      @thread_members[thread_id] ||= {}
+      @thread_members[thread_id][user_id] = data.slice('join_timestamp', 'flags')
+    end
+
     # Requests member chunks for a given server ID.
     # @param id [Integer] The server ID to request chunks for.
     def request_chunks(id)
@@ -194,7 +199,7 @@ module Discordrb
     # @return [String] Only the code for the invite.
     def resolve_invite_code(invite)
       invite = invite.code if invite.is_a? Discordrb::Invite
-      invite = invite[invite.rindex('/') + 1..-1] if invite.start_with?('http', 'discord.gg')
+      invite = invite[invite.rindex('/') + 1..] if invite.start_with?('http', 'discord.gg')
       invite
     end
 

data/lib/discordrb/commands/command_bot.rb

@@ -44,9 +44,10 @@ module Discordrb::Commands
     # @option attributes [Symbol, Array<Symbol>, false] :help_command The name of the command that displays info for
     #   other commands. Use an array if you want to have aliases. Default is "help". If none should be created, use
     #   `false` as the value.
-    # @option attributes [String] :command_doesnt_exist_message The message that should be displayed if a user attempts
+    # @option attributes [String, #call] :command_doesnt_exist_message The message that should be displayed if a user attempts
     #   to use a command that does not exist. If none is specified, no message will be displayed. In the message, you
-    #   can use the string '%command%' that will be replaced with the name of the command.
+    #   can use the string '%command%' that will be replaced with the name of the command. Anything responding to call
+    #   such as a proc will be called with the event, and is expected to return a String or nil.
     # @option attributes [String] :no_permission_message The message to be displayed when `NoPermission` error is raised.
     # @option attributes [true, false] :spaces_allowed Whether spaces are allowed to occur between the prefix and the
     #   command. Default is false.
@@ -69,7 +70,9 @@ module Discordrb::Commands
     # @option attributes [String] :quote_end Character that should end a quoted string (see
     #   :advanced_functionality). Default is '"' or the same as :quote_start. Set to an empty string to disable.
     # @option attributes [true, false] :ignore_bots Whether the bot should ignore bot accounts or not. Default is false.
-    def initialize(attributes = {})
+    def initialize(**attributes)
+      # TODO: This needs to be revisited. undefined attributes are treated
+      # as explicitly passed nils.
       super(
         log_mode: attributes[:log_mode],
         token: attributes[:token],
@@ -84,7 +87,7 @@ module Discordrb::Commands
         redact_token: attributes.key?(:redact_token) ? attributes[:redact_token] : true,
         ignore_bots: attributes[:ignore_bots],
         compress_mode: attributes[:compress_mode],
-        intents: attributes[:intents]
+        intents: attributes[:intents] || :all
       )
 
       @prefix = attributes[:prefix]
@@ -217,7 +220,11 @@ module Discordrb::Commands
                     (command && !command.attributes[:channels].nil?)
 
       unless command
-        event.respond @attributes[:command_doesnt_exist_message].gsub('%command%', name.to_s) if @attributes[:command_doesnt_exist_message]
+        if @attributes[:command_doesnt_exist_message]
+          message = @attributes[:command_doesnt_exist_message]
+          message = message.call(event) if message.respond_to?(:call)
+          event.respond message.gsub('%command%', name.to_s) if message
+        end
         return
       end
       return unless !check_permissions || channels?(event.channel, command.attributes[:channels])
@@ -330,7 +337,7 @@ module Discordrb::Commands
       return nil if chain.empty?
 
       args = chain.split(' ')
-      execute_command(args[0].to_sym, event, args[1..-1])
+      execute_command(args[0].to_sym, event, args[1..])
     end
 
     # Sets the permission level of a user
@@ -438,7 +445,7 @@ module Discordrb::Commands
     def standard_prefix_trigger(message, prefix)
       return nil unless message.start_with? prefix
 
-      message[prefix.length..-1]
+      message[prefix.length..]
     end
 
     def required_permissions?(member, required, channel = nil)

data/lib/discordrb/commands/container.rb

@@ -86,7 +86,7 @@ module Discordrb::Commands
     # Adds all commands from another container into this one. Existing commands will be overwritten.
     # @param container [Module] A module that `extend`s {CommandContainer} from which the commands will be added.
     def include_commands(container)
-      handlers = container.instance_variable_get '@commands'
+      handlers = container.instance_variable_get :@commands
       return unless handlers
 
       @commands ||= {}

data/lib/discordrb/commands/parser.rb

@@ -246,7 +246,7 @@ module Discordrb::Commands
 
         first_space = command.index ' '
         command_name = first_space ? command[0..first_space - 1] : command
-        arguments = first_space ? command[first_space + 1..-1] : ''
+        arguments = first_space ? command[first_space + 1..] : ''
 
         # Append a previous sign if none is present
         arguments += @attributes[:previous] unless arguments.include? @attributes[:previous]
@@ -318,7 +318,7 @@ module Discordrb::Commands
           arg.split ' '
         end
 
-        chain = chain[chain_args_index + 1..-1]
+        chain = chain[chain_args_index + 1..]
       end
 
       [chain_args, chain]

data/lib/discordrb/commands/rate_limiter.rb

@@ -125,7 +125,7 @@ module Discordrb::Commands
     # Adds all the buckets from another RateLimiter onto this one.
     # @param limiter [Module] Another {RateLimiter} module
     def include_buckets(limiter)
-      buckets = limiter.instance_variable_get('@buckets') || {}
+      buckets = limiter.instance_variable_get(:@buckets) || {}
       @buckets ||= {}
       @buckets.merge! buckets
     end

data/lib/discordrb/container.rb

@@ -13,6 +13,7 @@ require 'discordrb/events/guilds'
 require 'discordrb/events/await'
 require 'discordrb/events/bans'
 require 'discordrb/events/reactions'
+require 'discordrb/events/interactions'
 
 require 'discordrb/await'
 
@@ -522,6 +523,118 @@ module Discordrb
       register_event(InviteDeleteEvent, attributes, block)
     end
 
+    # This **event** is raised whenever an interaction event is received.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [Integer, Symbol, String] :type The interaction type, can be the integer value or the name
+    #   of the key in {Discordrb::Interaction::TYPES}.
+    # @option attributes [String, Integer, Server, nil] :server The server where this event was created. `nil` for DM channels.
+    # @option attributes [String, Integer, Channel] :channel The channel where this event was created.
+    # @option attributes [String, Integer, User] :user The user that triggered this event.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [InteractionCreateEvent] The event that was raised.
+    # @return [InteractionCreateEventHandler] The event handler that was registered.
+    def interaction_create(attributes = {}, &block)
+      register_event(InteractionCreateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an application command (slash command) is executed.
+    # @param name [Symbol] The name of the application command this handler is for.
+    # @param attributes [Hash] The event's attributes.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ApplicationCommandEvent] The event that was raised.
+    # @return [ApplicationCommandEventHandler] The event handler that was registered.
+    def application_command(name, attributes = {}, &block)
+      @application_commands ||= {}
+
+      unless block
+        @application_commands[name] ||= ApplicationCommandEventHandler.new(attributes, nil)
+        return @application_commands[name]
+      end
+
+      @application_commands[name] = ApplicationCommandEventHandler.new(attributes, block)
+    end
+
+    # This **event** is raised whenever an button interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ButtonEvent] The event that was raised.
+    # @return [ButtonEventHandler] The event handler that was registered.
+    def button(attributes = {}, &block)
+      register_event(ButtonEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select string interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [StringSelectEvent] The event that was raised.
+    # @return [StringSelectEventHandler] The event handler that was registered.
+    def string_select(attributes = {}, &block)
+      register_event(StringSelectEvent, attributes, block)
+    end
+
+    alias_method :select_menu, :string_select
+
+    # This **event** is raised whenever a modal is submitted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @option attributes [String, Integer, Server, nil] :server The server where this event was created. `nil` for DM channels.
+    # @option attributes [String, Integer, Channel] :channel The channel where this event was created.
+    # @option attributes [String, Integer, User] :user The user that triggered this event.    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ModalSubmitEvent] The event that was raised.
+    # @return [ModalSubmitEventHandler] The event handler that was registered.
+    def modal_submit(attributes = {}, &block)
+      register_event(ModalSubmitEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select user interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [UserSelectEvent] The event that was raised.
+    # @return [UserSelectEventHandler] The event handler that was registered.
+    def user_select(attributes = {}, &block)
+      register_event(UserSelectEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select role interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [RoleSelectEvent] The event that was raised.
+    # @return [RoleSelectEventHandler] The event handler that was registered.
+    def role_select(attributes = {}, &block)
+      register_event(RoleSelectEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select mentionable interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [MentionableSelectEvent] The event that was raised.
+    # @return [MentionableSelectEventHandler] The event handler that was registered.
+    def mentionable_select(attributes = {}, &block)
+      register_event(MentionableSelectEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select channel interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelSelectEvent] The event that was raised.
+    # @return [ChannelSelectEventHandler] The event handler that was registered.
+    def channel_select(attributes = {}, &block)
+      register_event(ChannelSelectEvent, attributes, block)
+    end
+
     # This **event** is raised for every dispatch received over the gateway, whether supported by discordrb or not.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Symbol, Regexp] :type Matches the event type of the dispatch.
@@ -552,9 +665,16 @@ module Discordrb
       @event_handlers[clazz].delete(handler)
     end
 
+    # Remove an application command handler
+    # @param name [String, Symbol] The name of the command handler to remove.
+    def remove_application_command_handler(name)
+      @application_commands.delete(name)
+    end
+
     # Removes all events from this event handler.
     def clear!
       @event_handlers&.clear
+      @application_commands&.clear
     end
 
     # Adds an event handler to this container. Usually, it's more expressive to just use one of the shorthand adder
@@ -570,11 +690,19 @@ module Discordrb
     # Adds all event handlers from another container into this one. Existing event handlers will be overwritten.
     # @param container [Module] A module that `extend`s {EventContainer} from which the handlers will be added.
     def include_events(container)
-      handlers = container.instance_variable_get '@event_handlers'
-      return unless handlers
+      application_command_handlers = container.instance_variable_get(:@application_commands)
+      handlers = container.instance_variable_get :@event_handlers
+      return unless handlers || application_command_handlers
 
       @event_handlers ||= {}
-      @event_handlers.merge!(handlers) { |_, old, new| old + new }
+      @event_handlers.merge!(handlers || {}) { |_, old, new| old + new }
+
+      @application_commands ||= {}
+
+      @application_commands.merge!(application_command_handlers || {}) do |_, old, new|
+        old.subcommands.merge!(new.subcommands)
+        old
+      end
     end
 
     alias_method :include!, :include_events
@@ -612,6 +740,7 @@ module Discordrb
 
     include Discordrb::Events
 
+    # @return [EventHandler]
     def register_event(clazz, attributes, block)
       handler = EventContainer.handler_class(clazz).new(attributes, block)
 

data/lib/discordrb/data/activity.rb

@@ -17,7 +17,7 @@ module Discordrb
     # @return [String] the activity's name
     attr_reader :name
 
-    # @return [Integer, nil] activity type. Can be {GAME}, {STREAMING}, {LISTENING}, {CUSTOM}
+    # @return [Integer, nil] activity type. Can be {GAME}, {STREAMING}, {LISTENING}, {CUSTOM}, or {COMPETING}
     attr_reader :type
 
     # @return [String, nil] stream URL, when the activity type is {STREAMING}
@@ -67,6 +67,8 @@ module Discordrb
     WATCHING = 3
     # Type indicating the activity is a custom status
     CUSTOM = 4
+    # Type indicating the activity is for a competitive game
+    COMPETING = 5
 
     # @!visibility private
     def initialize(data, bot)
@@ -260,5 +262,10 @@ module Discordrb
     def custom_status
       @activities.select { |act| act.type == Activity::CUSTOM }
     end
+
+    # @return [Array<Activity>] all activities of type {Activity::COMPETING}
+    def competing
+      @activities.select { |act| act.type == Activity::COMPETING }
+    end
   end
 end

data/lib/discordrb/data/attachment.rb

@@ -27,6 +27,16 @@ module Discordrb
     # @return [Integer, nil] the height of an image file, in pixels, or `nil` if the file is not an image.
     attr_reader :height
 
+    # @return [String, nil] the attachment's description.
+    attr_reader :description
+
+    # @return [String, nil] the attachment's media type.
+    attr_reader :content_type
+
+    # @return [true, false] whether this attachment is ephemeral.
+    attr_reader :ephemeral
+    alias_method :ephemeral?, :ephemeral
+
     # @!visibility private
     def initialize(data, message, bot)
       @bot = bot
@@ -41,6 +51,11 @@ module Discordrb
 
       @width = data['width']
       @height = data['height']
+
+      @description = data['description']
+      @content_type = data['content_type']
+
+      @ephemeral = data['ephemeral']
     end
 
     # @return [true, false] whether this file is an image file.

data/lib/discordrb/data/audit_logs.rb

@@ -177,7 +177,7 @@ module Discordrb
 
       # The inspect method is overwritten to give more useful output
       def inspect
-        "<AuditLogs::Entry id=#{@id} action=#{@action} reason=#{@reason} action_type=#{@action_type} target_type=#{@target_type} count=#{@count} days=#{@days} members_removed=#{@members_removed}>"
+        "<AuditLogs::Entry id=#{@id} key=#{@key} action=#{@action} reason=#{@reason} action_type=#{@action_type} target_type=#{@target_type} count=#{@count} days=#{@days} members_removed=#{@members_removed}>"
       end
 
       # Process action changes
@@ -219,8 +219,8 @@ module Discordrb
         @old = Permissions.new(@old) if @old && @key == 'permissions'
         @new = Permissions.new(@new) if @new && @key == 'permissions'
 
-        @old = @old.map { |o| Overwrite.new(o['id'], type: o['type'].to_sym, allow: o['allow'], deny: o['deny']) } if @old && @key == 'permission_overwrites'
-        @new = @new.map { |o| Overwrite.new(o['id'], type: o['type'].to_sym, allow: o['allow'], deny: o['deny']) } if @new && @key == 'permission_overwrites'
+        @old = @old.map { |o| Overwrite.new(o['id'], type: o['type'], allow: o['allow'], deny: o['deny']) } if @old && @key == 'permission_overwrites'
+        @new = @new.map { |o| Overwrite.new(o['id'], type: o['type'], allow: o['allow'], deny: o['deny']) } if @new && @key == 'permission_overwrites'
       end
 
       # @return [Channel, nil] the channel that was previously used in the server widget. Only present if the key for this change is `widget_channel_id`.