discordrb 3.3.0 → 3.5.0

data/lib/discordrb/events/invites.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Discordrb::Events
+  # Raised when an invite is created.
+  class InviteCreateEvent < Event
+    # @return [Invite] The invite that was created.
+    attr_reader :invite
+
+    # @return [Server, nil] The server the invite was created for.
+    attr_reader :server
+
+    # @return [Channel] The channel the invite was created for.
+    attr_reader :channel
+
+    # @!attribute [r] code
+    #   @return [String] The code for the created invite.
+    #   @see Invite#code
+    # @!attribute [r] created_at
+    #   @return [Time] The time the invite was created at.
+    #   @see Invite#created_at
+    # @!attribute [r] max_age
+    #   @return [Integer] The maximum age of the created invite.
+    #   @see Invite#max_age
+    # @!attribute [r] max_uses
+    #   @return [Integer] The maximum number of uses before the invite expires.
+    #   @see Invite#max_uses
+    # @!attribute [r] temporary
+    #   @return [true, false] Whether or not this invite grants temporary membership.
+    #   @see Invite#temporary
+    # @!attribute [r] inviter
+    #   @return [User] The user that created the invite.
+    #   @see Invite#inviter
+    delegate :code, :created_at, :max_age, :max_uses, :temporary, :inviter, to: :invite
+
+    alias temporary? temporary
+
+    def initialize(data, invite, bot)
+      @bot = bot
+      @invite = invite
+      @channel = bot.channel(data['channel_id'])
+      @server = bot.server(data['guild_id']) if data['guild_id']
+    end
+  end
+
+  # Raised when an invite is deleted.
+  class InviteDeleteEvent < Event
+    # @return [Channel] The channel the deleted invite was for.
+    attr_reader :channel
+
+    # @return [Server, nil] The server the deleted invite was for.
+    attr_reader :server
+
+    # @return [String] The code of the deleted invite.
+    attr_reader :code
+
+    def initialize(data, bot)
+      @bot = bot
+      @channel = bot.channel(data['channel_id'])
+      @server = bot.server(data['guild_id']) if data['guild_id']
+      @code = data['code']
+    end
+  end
+
+  # Event handler for InviteCreateEvent.
+  class InviteCreateEventHandler < EventHandler
+    def matches?(event)
+      return false unless event.is_a? InviteCreateEvent
+
+      [
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:channel], event.channel) do |a, e|
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:temporary], event.temporary?, &:==),
+        matches_all(@attributes[:inviter], event.inviter, &:==)
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Event handler for InviteDeleteEvent
+  class InviteDeleteEventHandler < EventHandler
+    def matches?(event)
+      return false unless event.is_a? InviteDeleteEvent
+
+      [
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:channel], event.channel) do |a, e|
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/discordrb/events/members.rb

@@ -34,8 +34,9 @@ module Discordrb::Events
     end
 
     def init_roles(data, _)
-      @roles = []
+      @roles = [@server.role(@server.id)]
       return unless data['roles']
+
       data['roles'].each do |element|
         role_id = element.to_i
         @roles << @server.roles.find { |r| r.id == role_id }
@@ -78,10 +79,13 @@ module Discordrb::Events
   # Member leaves
   # @see Discordrb::EventContainer#member_leave
   class ServerMemberDeleteEvent < ServerMemberEvent
-    # Overide init_user to account for the deleted user on the server
+    # 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
+
+    # @return [User] the user in question.
+    attr_reader :user
   end
 
   # Event handler for {ServerMemberDeleteEvent}

data/lib/discordrb/events/message.rb

@@ -14,27 +14,41 @@ module Discordrb::Events
     # @param content [String] The message to send to the channel
     # @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.
     # @param embed [Hash, Discordrb::Webhooks::Embed, nil] The rich embed to append to this message.
+    # @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 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.
     # @return [Discordrb::Message] the message that was sent
-    def send_message(content, tts = false, embed = nil)
-      channel.send_message(content, tts, embed)
+    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)
     end
 
     # The same as {#send_message}, but yields a {Webhooks::Embed} for easy building of embedded content inside a block.
     # @see Channel#send_embed
     # @param message [String] The message that should be sent along with the embed. If this is the empty string, only the embed will be shown.
     # @param embed [Discordrb::Webhooks::Embed, nil] The embed to start the building process with, or nil if one should be created anew.
+    # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`
+    # @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.
+    # @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.
     # @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, &block)
-      channel.send_embed(message, embed, &block)
+    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)
     end
 
     # Sends a temporary message to the channel this message was sent in, right now.
     # @param content [String] The content to send. Should not be longer than 2000 characters or it will result in an error.
     # @param timeout [Float] The amount of time in seconds after which the message sent will be deleted.
-    def send_temporary_message(content, timeout)
-      channel.send_temporary_message(content, timeout)
+    # @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.
+    # @param embed [Hash, Discordrb::Webhooks::Embed, nil] The rich embed to append to this message.
+    # @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)
     end
 
     # Adds a string to be sent after the event has finished execution. Avoids problems with rate limiting because only
@@ -82,9 +96,15 @@ module Discordrb::Events
     # @return [String] the message that has been saved by calls to {#<<} and will be sent to Discord upon completion.
     attr_reader :saved_message
 
-    # @return [File] the file that have been saved by calls to {#attach_file} and will be sent to Discord upon completion.
+    # @return [File] the file that has been saved by a call to {#attach_file} and will be sent to Discord upon completion.
     attr_reader :file
 
+    # @return [String] the filename set in {#attach_file} that will override the original filename when sent.
+    attr_reader :filename
+
+    # @return [true, false] Whether or not this file should appear as a spoiler. Set by {#attach_file}
+    attr_reader :file_spoiler
+
     # @!attribute [r] author
     #   @return [Member, User] who sent this message.
     #   @see Message#author
@@ -110,6 +130,8 @@ module Discordrb::Events
       @channel = message.channel
       @saved_message = ''
       @file = nil
+      @filename = nil
+      @file_spoiler = nil
     end
 
     # Sends file with a caption to the channel this message was sent in, right now.
@@ -117,25 +139,34 @@ module Discordrb::Events
     # because it avoids rate limiting problems
     # @param file [File] The file to send to the channel
     # @param caption [String] The caption attached to the file
+    # @param filename [String] Overrides the filename of the uploaded file
+    # @param spoiler [true, false] Whether or not this file should appear as a spoiler.
     # @return [Discordrb::Message] the message that was sent
     # @example Send a file from disk
     #   event.send_file(File.open('rubytaco.png', 'r'))
-    def send_file(file, caption: nil)
-      @message.channel.send_file(file, caption: caption)
+    def send_file(file, caption: nil, filename: nil, spoiler: nil)
+      @message.channel.send_file(file, caption: caption, filename: filename, spoiler: spoiler)
     end
 
     # Attaches a file to the message event and converts the message into
     # a caption.
     # @param file [File] The file to be attached
-    def attach_file(file)
+    # @param filename [String] Overrides the filename of the uploaded file
+    # @param spoiler [true, false] Whether or not this file should appear as a spoiler.
+    def attach_file(file, filename: nil, spoiler: nil)
       raise ArgumentError, 'Argument is not a file!' unless file.is_a?(File)
+
       @file = file
+      @filename = filename
+      @file_spoiler = spoiler
       nil
     end
 
     # Detaches a file from the message event.
     def detach_file
       @file = nil
+      @filename = nil
+      @file_spoiler = nil
     end
 
     # @return [true, false] whether or not this message was sent by the bot itself
@@ -161,51 +192,57 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:starting_with] || @attributes[:start_with], event.content) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             e.start_with? a
-          elsif a.is_a? Regexp
-            (e =~ a) && (e =~ a).zero?
+          when Regexp
+            (e =~ a)&.zero?
           end
         end,
         matches_all(@attributes[:ending_with] || @attributes[:end_with], event.content) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             e.end_with? a
-          elsif a.is_a? Regexp
+          when Regexp
             !(e =~ Regexp.new("#{a}$")).nil?
           end
         end,
         matches_all(@attributes[:containing] || @attributes[:contains], event.content) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             e.include? a
-          elsif a.is_a? Regexp
+          when Regexp
             (e =~ a)
           end
         end,
         matches_all(@attributes[:in], event.channel) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             # Make sure to remove the "#" from channel names in case it was specified
             a.delete('#') == e.name
-          elsif a.is_a? Integer
+          when Integer
             a == e.id
           else
             a == e
           end
         end,
         matches_all(@attributes[:from], event.author) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             a == e.name
-          elsif a.is_a? Integer
+          when Integer
             a == e.id
-          elsif a == :bot
+          when :bot
             e.current_bot?
           else
             a == e
           end
         end,
         matches_all(@attributes[:with_text] || @attributes[:content] || @attributes[:exact_text], event.content) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             e == a
-          elsif a.is_a? Regexp
+          when Regexp
             match = a.match(e)
             match ? (e == match[0]) : false
           end
@@ -221,7 +258,7 @@ module Discordrb::Events
       if event.file.nil?
         event.send_message(event.saved_message) unless event.saved_message.empty?
       else
-        event.send_file(event.file, caption: event.saved_message)
+        event.send_file(event.file, caption: event.saved_message, filename: event.filename, spoiler: event.file_spoiler)
       end
     end
   end
@@ -265,10 +302,11 @@ module Discordrb::Events
           a.resolve_id == e.resolve_id
         end,
         matches_all(@attributes[:in], event.channel) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             # Make sure to remove the "#" from channel names in case it was specified
             a.delete('#') == e.name
-          elsif a.is_a? Integer
+          when Integer
             a == e.id
           else
             a == e
@@ -291,4 +329,11 @@ module Discordrb::Events
 
   # Event handler for {MessageDeleteEvent}
   class MessageDeleteEventHandler < MessageIDEventHandler; end
+
+  # Raised whenever a MESSAGE_UPDATE is received
+  # @see Discordrb::EventContainer#message_update
+  class MessageUpdateEvent < MessageEvent; end
+
+  # Event handler for {MessageUpdateEvent}
+  class MessageUpdateEventHandler < MessageEventHandler; end
 end

data/lib/discordrb/events/presence.rb

@@ -15,11 +15,16 @@ module Discordrb::Events
     # @return [Symbol] the new status.
     attr_reader :status
 
+    # @return [Hash<Symbol, Symbol>] the current online status (`:online`, `:idle` or `:dnd`) of the user
+    #   on various device types (`:desktop`, `:mobile`, or `:web`). The value will be `nil` if the user is offline or invisible.
+    attr_reader :client_status
+
     def initialize(data, bot)
       @bot = bot
 
       @user = bot.user(data['user']['id'].to_i)
       @status = data['status'].to_sym
+      @client_status = user.client_status
       @server = bot.server(data['guild_id'].to_i)
     end
   end
@@ -32,9 +37,10 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:from], event.user) do |a, e|
-          a == if a.is_a? String
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Integer
+               when Integer
                  e.id
                else
                  e
@@ -59,28 +65,35 @@ module Discordrb::Events
     # @return [User] the user whose status got updated.
     attr_reader :user
 
-    # @return [String] the new game the user is playing.
-    attr_reader :game
+    # @return [Discordrb::Activity] The new activity
+    attr_reader :activity
 
-    # @return [String] the URL to the stream
-    attr_reader :url
+    # @!attribute [r] url
+    #   @return [String] the URL to the stream
 
-    # @return [String] what the player is currently doing (ex. game being streamed)
-    attr_reader :details
+    # @!attribute [r] details
+    #   @return [String] what the player is currently doing (ex. game being streamed)
 
-    # @return [Integer] the type of play. 0 = game, 1 = Twitch
-    attr_reader :type
+    # @!attribute [r] type
+    #   @return [Integer] the type of play. See {Discordrb::Activity}
+    delegate :url, :details, :type, to: :activity
 
-    def initialize(data, bot)
+    # @return [Hash<Symbol, Symbol>] the current online status (`:online`, `:idle` or `:dnd`) of the user
+    #   on various device types (`:desktop`, `:mobile`, or `:web`). The value will be `nil` if the user is offline or invisible.
+    attr_reader :client_status
+
+    def initialize(data, activity, bot)
       @bot = bot
+      @activity = activity
 
       @server = bot.server(data['guild_id'].to_i)
       @user = bot.user(data['user']['id'].to_i)
-      @game = data['game'] ? data['game']['name'] : nil
-      @type = data['game'] ? data['game']['type'].to_i : nil
-      # Handle optional 'game' fields safely
-      @url = data['game'] && data['game']['url'] ? data['game']['url'] : nil
-      @details = data['game'] && data['game']['details'] ? data['game']['details'] : nil
+      @client_status = @user.client_status
+    end
+
+    # @return [String] the name of the new game the user is playing.
+    def game
+      @activity.name
     end
   end
 
@@ -92,9 +105,10 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:from], event.user) do |a, e|
-          a == if a.is_a? String
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Integer
+               when Integer
                  e.id
                else
                  e
@@ -105,6 +119,9 @@ module Discordrb::Events
         end,
         matches_all(@attributes[:type], event.type) do |a, e|
           a == e
+        end,
+        matches_all(@attributes[:client_status], event.client_status) do |a, e|
+          e.slice(a.keys) == a
         end
       ].reduce(true, &:&)
     end

data/lib/discordrb/events/raw.rb

@@ -30,9 +30,7 @@ module Discordrb::Events
       [
         matches_all(@attributes[:type] || @attributes[:t], event.type) do |a, e|
           if a.is_a? Regexp
-            # 24: update to matches?
-            match = a.match(e)
-            match ? (e == match[0]) : false
+            a.match?(e)
           else
             e.to_s.casecmp(a.to_s).zero?
           end

data/lib/discordrb/events/reactions.rb

@@ -11,6 +11,9 @@ module Discordrb::Events
     # @return [Emoji] the emoji that was reacted with.
     attr_reader :emoji
 
+    # @!visibility private
+    attr_reader :message_id
+
     def initialize(data, bot)
       @bot = bot
 
@@ -54,13 +57,38 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:emoji], event.emoji) do |a, e|
-          if a.is_a? Integer
+          case a
+          when Integer
             e.id == a
-          elsif a.is_a? String
+          when String
             e.name == a || e.name == a.delete(':') || e.id == a.resolve_id
           else
             e == a
           end
+        end,
+        matches_all(@attributes[:message], event.message_id) do |a, e|
+          a == e
+        end,
+        matches_all(@attributes[:in], event.channel) do |a, e|
+          case a
+          when String
+            # Make sure to remove the "#" from channel names in case it was specified
+            a.delete('#') == e.name
+          when Integer
+            a == e.id
+          else
+            a == e
+          end
+        end,
+        matches_all(@attributes[:from], event.user) do |a, e|
+          case a
+          when String
+            a == e.name
+          when :bot
+            e.current_bot?
+          else
+            a == e
+          end
         end
       ].reduce(true, &:&)
     end
@@ -82,6 +110,9 @@ module Discordrb::Events
   class ReactionRemoveAllEvent < Event
     include Respondable
 
+    # @!visibility private
+    attr_reader :message_id
+
     def initialize(data, bot)
       @bot = bot
 
@@ -106,8 +137,22 @@ module Discordrb::Events
       # Check for the proper event type
       return false unless event.is_a? ReactionRemoveAllEvent
 
-      # No attributes yet as there is no property available on the event that doesn't involve doing a resolution request
-      [].reduce(true, &:&)
+      [
+        matches_all(@attributes[:message], event.message_id) do |a, e|
+          a == e
+        end,
+        matches_all(@attributes[:in], event.channel) do |a, e|
+          case a
+          when String
+            # Make sure to remove the "#" from channel names in case it was specified
+            a.delete('#') == e.name
+          when Integer
+            a == e.id
+          else
+            a == e
+          end
+        end
+      ].reduce(true, &:&)
     end
   end
 end

data/lib/discordrb/events/threads.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Discordrb::Events
+  # Raised when a thread is created
+  class ThreadCreateEvent < Event
+    # @return [Channel] the thread in question.
+    attr_reader :thread
+
+    delegate :name, :server, :owner, :parent_channel, :thread_metadata, to: :thread
+
+    def initialize(data, bot)
+      @bot = bot
+      @thread = data.is_a?(Discordrb::Channel) ? data : bot.channel(data['id'].to_i)
+    end
+  end
+
+  # Event handler for ChannelCreateEvent
+  class ThreadCreateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ThreadCreateEvent
+
+      [
+        matches_all(@attributes[:name], event.name) do |a, e|
+          a == if a.is_a? String
+                 e.to_s
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a.resolve_id == e.resolve_id
+        end,
+        matches_all(@attributes[:invitable], event.thread.invitable) do |a, e|
+          a == e
+        end,
+        matches_all(@attributes[:owner], event.thread.owner) do |a, e|
+          a.resolve_id == e.resolve_id
+        end,
+        matches_all(@attributes[:channel], event.thread.parent) do |a, e|
+          a.resolve_id == e.resolve_id
+        end
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Raised when a thread is updated (e.g. name changes)
+  class ThreadUpdateEvent < ThreadCreateEvent; end
+
+  # Event handler for ThreadUpdateEvent
+  class ThreadUpdateEventHandler < ThreadCreateEventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ThreadUpdateEvent
+
+      super
+    end
+  end
+
+  # Raised when members are added or removed from a thread.
+  class ThreadMembersUpdateEvent < Event
+    # @return [Channel]
+    attr_reader :thread
+
+    # @return [Array<Member, User>]
+    attr_reader :added_members
+
+    # @return [Array<Integer>]
+    attr_reader :removed_member_ids
+
+    # @return [Integer]
+    attr_reader :member_count
+
+    delegate :name, :server, :owner, :parent_channel, :thread_metadata, to: :thread
+
+    def initialize(data, bot)
+      @bot = bot
+      @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 || []
+      @removed_member_ids = data['removed_member_ids']&.map(&:resolve_id) || []
+      @member_count = data['member_count']
+    end
+  end
+
+  # Event handler for ThreadMembersUpdateEvent
+  class ThreadMembersUpdateEventHandler < ThreadCreateEventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ThreadMembersUpdateEvent
+
+      super
+    end
+  end
+end

data/lib/discordrb/events/typing.rb

@@ -45,18 +45,20 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:in], event.channel) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             a.delete('#') == e.name
-          elsif a.is_a? Integer
+          when Integer
             a == e.id
           else
             a == e
           end
         end,
         matches_all(@attributes[:from], event.user) do |a, e|
-          a == if a.is_a? String
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Integer
+               when Integer
                  e.id
                else
                  e