discordrb 3.1.1 → 3.4.0

data/lib/discordrb/events/bans.rb

@@ -27,20 +27,22 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:user], event.user) 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[:server], event.server) 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

data/lib/discordrb/events/channels.rb

@@ -126,10 +126,12 @@ module Discordrb::Events
   class ChannelRecipientEvent < Event
     # @return [Channel] the channel in question.
     attr_reader :channel
+
     delegate :name, :server, :type, :owner_id, :recipients, :topic, :user_limit, :position, :permission_overwrites, to: :channel
 
     # @return [Recipient] the recipient that was added/removed from the group
     attr_reader :recipient
+
     delegate :id, to: :recipient
 
     def initialize(data, bot)

data/lib/discordrb/events/generic.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/module'
-
 # Events used by discordrb
 module Discordrb::Events
   # A negated object, used to not match something in event parameters.
@@ -21,7 +19,7 @@ module Discordrb::Events
   #  2. A single attribute, negated
   #  3. An array of attributes, not negated
   #  4. An array of attributes, not negated
-  # Note that it doesn't allow an array of negated attributes. For info on negation stuff, see {not!}
+  # Note that it doesn't allow an array of negated attributes. For info on negation stuff, see {::#not!}
   # @param attributes [Object, Array<Object>, Negated<Object>, Negated<Array<Object>>, nil] One or more attributes to
   #   compare to the to_check value.
   # @param to_check [Object] What to compare the attributes to.
@@ -55,6 +53,24 @@ module Discordrb::Events
   class Event
     # @return [Bot] the bot used to initialize this event.
     attr_reader :bot
+
+    class << self
+      protected
+
+      # Delegates a list of methods to a particular object. This is essentially a reimplementation of ActiveSupport's
+      # `#delegate`, but without the overhead provided by the rest. Used in subclasses of `Event` to delegate properties
+      # on events to properties on data objects.
+      # @param methods [Array<Symbol>] The methods to delegate.
+      # @param hash [Hash<Symbol => Symbol>] A hash with one `:to` key and the value the method to be delegated to.
+      def delegate(*methods, hash)
+        methods.each do |e|
+          define_method(e) do
+            object = __send__(hash[:to])
+            object.__send__(e)
+          end
+        end
+      end
+    end
   end
 
   # Generic event handler that can be extended

data/lib/discordrb/events/guilds.rb

@@ -30,9 +30,10 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:server], event.server) do |a, e|
-          a == if a.is_a? String
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Fixnum
+               when Integer
                  e.id
                else
                  e
@@ -56,15 +57,137 @@ module Discordrb::Events
   # Event handler for {ServerUpdateEvent}
   class ServerUpdateEventHandler < ServerEventHandler; end
 
-  # Server is deleted
+  # Server is deleted, the server was left because the bot was kicked, or the
+  # bot made itself leave the server.
   # @see Discordrb::EventContainer#server_delete
   class ServerDeleteEvent < ServerEvent
-    # Overide init_server to account for the deleted server
-    def init_server(data, bot)
-      @server = Discordrb::Server.new(data, bot, false)
+    # @return [Integer] The ID of the server that was left.
+    attr_reader :server
+
+    # Override init_server to account for the deleted server
+    def init_server(data, _bot)
+      @server = data['id'].to_i
     end
   end
 
   # Event handler for {ServerDeleteEvent}
   class ServerDeleteEventHandler < ServerEventHandler; end
+
+  # Emoji is created/deleted/updated
+  class ServerEmojiChangeEvent < ServerEvent
+    # @return [Server] the server in question.
+    attr_reader :server
+
+    # @return [Array<Emoji>] array of emojis.
+    attr_reader :emoji
+
+    def initialize(server, data, bot)
+      @bot = bot
+      @server = server
+      process_emoji(data)
+    end
+
+    # @!visibility private
+    def process_emoji(data)
+      @emoji = data['emojis'].map do |e|
+        @server.emoji[e['id']]
+      end
+    end
+  end
+
+  # Generic event helper for when an emoji is either created or deleted
+  class ServerEmojiCDEvent < ServerEvent
+    # @return [Server] the server in question.
+    attr_reader :server
+
+    # @return [Emoji] the emoji data.
+    attr_reader :emoji
+
+    def initialize(server, emoji, bot)
+      @bot = bot
+      @emoji = emoji
+      @server = server
+    end
+  end
+
+  # Emoji is created
+  class ServerEmojiCreateEvent < ServerEmojiCDEvent; end
+
+  # Emoji is deleted
+  class ServerEmojiDeleteEvent < ServerEmojiCDEvent; end
+
+  # Emoji is updated
+  class ServerEmojiUpdateEvent < ServerEvent
+    # @return [Server] the server in question.
+    attr_reader :server
+
+    # @return [Emoji, nil] the emoji data before the event.
+    attr_reader :old_emoji
+
+    # @return [Emoji, nil] the updated emoji data.
+    attr_reader :emoji
+
+    def initialize(server, old_emoji, emoji, bot)
+      @bot = bot
+      @old_emoji = old_emoji
+      @emoji = emoji
+      @server = server
+    end
+  end
+
+  # Event handler for {ServerEmojiChangeEvent}
+  class ServerEmojiChangeEventHandler < ServerEventHandler; end
+
+  # Generic handler for emoji create and delete
+  class ServerEmojiCDEventHandler < ServerEventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ServerEmojiCDEvent
+
+      [
+        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[:id], event.emoji.id) { |a, e| a.resolve_id == e.resolve_id },
+        matches_all(@attributes[:name], event.emoji.name) { |a, e| a == e }
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Event handler for {ServerEmojiCreateEvent}
+  class ServerEmojiCreateEventHandler < ServerEmojiCDEventHandler; end
+
+  # Event handler for {ServerEmojiDeleteEvent}
+  class ServerEmojiDeleteEventHandler < ServerEmojiCDEventHandler; end
+
+  # Event handler for {ServerEmojiUpdateEvent}
+  class ServerEmojiUpdateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ServerEmojiUpdateEvent
+
+      [
+        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[:id], event.old_emoji.id) { |a, e| a.resolve_id == e.resolve_id },
+        matches_all(@attributes[:old_name], event.old_emoji.name) { |a, e| a == e },
+        matches_all(@attributes[:name], event.emoji.name) { |a, e| a == e }
+      ].reduce(true, &:&)
+    end
+  end
 end

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

@@ -12,16 +12,40 @@ module Discordrb::Events
     # Sends a message to the channel this message was sent in, right now. It is usually preferable to use {#<<} instead
     # because it avoids rate limiting problems
     # @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.
     # @return [Discordrb::Message] the message that was sent
-    def send_message(content)
-      @channel.send_message(content)
+    def send_message(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil)
+      channel.send_message(content, tts, embed, attachments, allowed_mentions, message_reference)
+    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.
+    # @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, &block)
+      channel.send_embed(message, embed, attachments, tts, allowed_mentions, message_reference, &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
+    def send_temporary_message(content, timeout, tts = false, embed = nil, attachments = nil, allowed_mentions = nil)
+      channel.send_temporary_message(content, timeout, tts, embed, attachments, allowed_mentions)
     end
 
     # Adds a string to be sent after the event has finished execution. Avoids problems with rate limiting because only
@@ -62,17 +86,24 @@ module Discordrb::Events
   # Event raised when a text message is sent to a channel
   class MessageEvent < Event
     include Respondable
+
     # @return [Message] the message which triggered this event.
     attr_reader :message
 
     # @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] who sent this message.
+    #   @return [Member, User] who sent this message.
     #   @see Message#author
     # @!attribute [r] channel
     #   @return [Channel] the channel in which this message was sent.
@@ -96,14 +127,8 @@ module Discordrb::Events
       @channel = message.channel
       @saved_message = ''
       @file = nil
-    end
-
-    # Sends a message to the channel this message was sent in, right now. It is usually preferable to use {#<<} instead
-    # because it avoids rate limiting problems
-    # @param content [String] The message to send to the channel
-    # @return [Discordrb::Message] the message that was sent
-    def send_message(content)
-      @message.channel.send_message(content)
+      @filename = nil
+      @file_spoiler = nil
     end
 
     # Sends file with a caption to the channel this message was sent in, right now.
@@ -111,24 +136,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
-    def send_file(file, caption: nil)
-      @message.channel.send_file(file, caption: caption)
+    # @example Send a file from disk
+    #   event.send_file(File.open('rubytaco.png', 'r'))
+    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
-      nil
+      @filename = nil
+      @file_spoiler = nil
     end
 
     # @return [true, false] whether or not this message was sent by the bot itself
@@ -154,51 +189,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
-            a.match(e) ? e.end_with?(a.match(e)[-1]) : false
+          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? Fixnum
+          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? Fixnum
+          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
@@ -214,7 +255,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
@@ -234,6 +275,7 @@ module Discordrb::Events
   # A subset of MessageEvent that only contains a message ID and a channel
   class MessageIDEvent < Event
     include Respondable
+
     # @return [Integer] the ID associated with this event
     attr_reader :id
 
@@ -257,10 +299,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
@@ -283,4 +326,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