discorb 0.17.1 → 0.18.0

data/lib/discorb/gateway.rb

@@ -12,582 +12,12 @@ module Discorb
   # This module is internal use only.
   #
   module Gateway
-    #
-    # Represents an event.
-    # @abstract
-    #
-    class GatewayEvent
-      #
-      # Initializes a new instance of the GatewayEvent class.
-      # @private
-      #
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(data)
-        @data = data
-      end
-
-      def inspect
-        "#<#{self.class}>"
-      end
-    end
-
-    #
-    # Represents a reaction event.
-    #
-    class ReactionEvent < GatewayEvent
-      # @return [Hash] The raw data of the event.
-      attr_reader :data
-      # @return [Discorb::Snowflake] The ID of the user who reacted.
-      attr_reader :user_id
-      alias member_id user_id
-      # @return [Discorb::Snowflake] The ID of the channel the message was sent in.
-      attr_reader :channel_id
-      # @return [Discorb::Snowflake] The ID of the message.
-      attr_reader :message_id
-      # @return [Discorb::Snowflake] The ID of the guild the message was sent in.
-      attr_reader :guild_id
-      # @macro client_cache
-      # @return [Discorb::User] The user who reacted.
-      attr_reader :user
-      # @macro client_cache
-      # @return [Discorb::Channel] The channel the message was sent in.
-      attr_reader :channel
-      # @macro client_cache
-      # @return [Discorb::Guild] The guild the message was sent in.
-      attr_reader :guild
-      # @macro client_cache
-      # @return [Discorb::Message] The message the reaction was sent in.
-      attr_reader :message
-      # @macro client_cache
-      # @return [Discorb::Member] The member who reacted.
-      attr_reader :member
-      # @return [Discorb::UnicodeEmoji, Discorb::PartialEmoji] The emoji that was reacted with.
-      attr_reader :emoji
-      # @macro client_cache
-      # @return [Discorb::Member, Discorb::User] The user or member who reacted.
-      attr_reader :fired_by
-
-      alias reactor fired_by
-      alias from fired_by
-
-      #
-      # Initializes a new instance of the ReactionEvent class.
-      # @private
-      #
-      # @param [Discorb::Client] client The client that instantiated the object.
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(client, data)
-        @client = client
-        @data = data
-        if data.key?(:user_id)
-          @user_id = Snowflake.new(data[:user_id])
-        else
-          @member_data = data[:member]
-        end
-        @channel_id = Snowflake.new(data[:channel_id])
-        @message_id = Snowflake.new(data[:message_id])
-        @guild_id = Snowflake.new(data[:guild_id])
-        @guild = client.guilds[data[:guild_id]]
-        @channel = client.channels[data[:channel_id]] unless @guild.nil?
-
-        @user = client.users[data[:user_id]] if data.key?(:user_id)
-
-        unless @guild.nil?
-          @member = if data.key?(:member)
-              @guild.members[data[:member][:user][:id]] || Member.new(@client, @guild_id, data[:member][:user],
-                                                                      data[:member])
-            else
-              @guild.members[data[:user_id]]
-            end
-        end
-
-        @fired_by = @member || @user || @client.users[data[:user_id]]
-
-        @message = client.messages[data[:message_id]]
-        @emoji = data[:emoji][:id].nil? ? UnicodeEmoji.new(data[:emoji][:name]) : PartialEmoji.new(data[:emoji])
-      end
-
-      # Fetch the message.
-      # If message is cached, it will be returned.
-      # @async
-      #
-      # @param [Boolean] force Whether to force fetching the message.
-      #
-      # @return [Async::Task<Discorb::Message>] The message.
-      def fetch_message(force: false)
-        Async do
-          next @message if !force && @message
-
-          @message = @channel.fetch_message(@message_id).wait
-        end
-      end
-    end
-
-    #
-    # Represents a `INTEGRATION_DELETE` event.
-    #
-    class IntegrationDeleteEvent < GatewayEvent
-      # @return [Discorb::Snowflake] The ID of the integration.
-      attr_reader :id
-
-      # @!attribute [r] guild
-      #   @macro client_cache
-      #   @return [Discorb::Guild] The guild of the integration.
-      # @!attribute [r] user
-      #   @macro client_cache
-      #   @return [Discorb::User] The user associated with the integration.
-
-      #
-      # Initialize a new instance of the IntegrationDeleteEvent class.
-      # @private
-      #
-      #
-      # @param [Hash] data The data of the event.
-      #
-      #
-      def initialize(_client, data)
-        @id = Snowflake.new(data[:id])
-        @guild_id = data[:guild_id]
-        @user_id = data[:application_id]
-      end
-
-      def guild
-        @client.guilds[@guild_id]
-      end
-
-      def user
-        @client.users[@user_id]
-      end
-    end
-
-    #
-    # Represents a `MESSAGE_REACTION_REMOVE_ALL` event.
-    #
-    class ReactionRemoveAllEvent < GatewayEvent
-      # @return [Discorb::Snowflake] The ID of the channel the message was sent in.
-      attr_reader :channel_id
-      # @return [Discorb::Snowflake] The ID of the message.
-      attr_reader :message_id
-      # @return [Discorb::Snowflake] The ID of the guild the message was sent in.
-      attr_reader :guild_id
-      # @macro client_cache
-      # @return [Discorb::Channel] The channel the message was sent in.
-      attr_reader :channel
-      # @macro client_cache
-      # @return [Discorb::Guild] The guild the message was sent in.
-      attr_reader :guild
-      # @macro client_cache
-      # @return [Discorb::Message] The message the reaction was sent in.
-      attr_reader :message
-
-      #
-      # Initialize a new instance of the ReactionRemoveAllEvent class.
-      # @private
-      #
-      # @param [Discorb::Client] client The client that instantiated the object.
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(client, data)
-        @client = client
-        @data = data
-        @guild_id = Snowflake.new(data[:guild_id])
-        @channel_id = Snowflake.new(data[:channel_id])
-        @message_id = Snowflake.new(data[:message_id])
-        @guild = client.guilds[data[:guild_id]]
-        @channel = client.channels[data[:channel_id]]
-        @message = client.messages[data[:message_id]]
-      end
-
-      # Fetch the message.
-      # If message is cached, it will be returned.
-      # @async
-      #
-      # @param [Boolean] force Whether to force fetching the message.
-      #
-      # @return [Async::Task<Discorb::Message>] The message.
-      def fetch_message(force: false)
-        Async do
-          next @message if !force && @message
-
-          @message = @channel.fetch_message(@message_id).wait
-        end
-      end
-    end
-
-    #
-    # Represents a `MESSAGE_REACTION_REMOVE_EMOJI` event.
-    #
-    class ReactionRemoveEmojiEvent < GatewayEvent
-      # @return [Discorb::Snowflake] The ID of the channel the message was sent in.
-      attr_reader :channel_id
-      # @return [Discorb::Snowflake] The ID of the message.
-      attr_reader :message_id
-      # @return [Discorb::Snowflake] The ID of the guild the message was sent in.
-      attr_reader :guild_id
-      # @macro client_cache
-      # @return [Discorb::Channel] The channel the message was sent in.
-      attr_reader :channel
-      # @macro client_cache
-      # @return [Discorb::Guild] The guild the message was sent in.
-      attr_reader :guild
-      # @macro client_cache
-      # @return [Discorb::Message] The message the reaction was sent in.
-      attr_reader :message
-      # @return [Discorb::UnicodeEmoji, Discorb::PartialEmoji] The emoji that was reacted with.
-      attr_reader :emoji
-
-      #
-      # Initialize a new instance of the ReactionRemoveEmojiEvent class.
-      # @private
-      #
-      # @param [Discorb::Client] client The client that instantiated the object.
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(client, data)
-        @client = client
-        @data = data
-        @guild_id = Snowflake.new(data[:guild_id])
-        @channel_id = Snowflake.new(data[:channel_id])
-        @message_id = Snowflake.new(data[:message_id])
-        @guild = client.guilds[data[:guild_id]]
-        @channel = client.channels[data[:channel_id]]
-        @message = client.messages[data[:message_id]]
-        @emoji = data[:emoji][:id].nil? ? DiscordEmoji.new(data[:emoji][:name]) : PartialEmoji.new(data[:emoji])
-      end
-
-      # Fetch the message.
-      # If message is cached, it will be returned.
-      # @async
-      #
-      # @param [Boolean] force Whether to force fetching the message.
-      #
-      # @return [Async::Task<Discorb::Message>] The message.
-      def fetch_message(force: false)
-        Async do
-          next @message if !force && @message
-
-          @message = @channel.fetch_message(@message_id).wait
-        end
-      end
-    end
-
-    #
-    # Represents a `GUILD_SCHEDULED_EVENT_USER_ADD` and `GUILD_SCHEDULED_EVENT_USER_REMOVE` event.
-    #
-    class ScheduledEventUserEvent < GatewayEvent
-      # @return [Discorb::User] The user that triggered the event.
-      attr_reader :user
-      # @return [Discorb::Guild] The guild the event was triggered in.
-      attr_reader :guild
-      # @return [Discorb::ScheduledEvent] The scheduled event.
-      attr_reader :scheduled_event
-
-      #
-      # Initialize a new instance of the ScheduledEventUserEvent class.
-      # @private
-      #
-      # @param [Discorb::Client] client The client that instantiated the object.
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(client, data)
-        @client = client
-        @scheduled_event_id = Snowflake.new(data[:scheduled_event_id])
-        @user_id = Snowflake.new(data[:user_id])
-        @guild_id = Snowflake.new(data[:guild_id])
-        @guild = client.guilds[data[:guild_id]]
-        @scheduled_event = @guild.scheduled_events[@scheduled_event_id]
-        @user = client.users[data[:user_id]]
-      end
-    end
-
-    #
-    # Represents a `MESSAGE_UPDATE` event.
-    #
-    class MessageUpdateEvent < GatewayEvent
-      # @return [Discorb::Message] The message before update.
-      attr_reader :before
-      # @return [Discorb::Message] The message after update.
-      attr_reader :after
-      # @return [Discorb::Snowflake] The ID of the message.
-      attr_reader :id
-      # @return [Discorb::Snowflake] The ID of the channel the message was sent in.
-      attr_reader :channel_id
-      # @return [Discorb::Snowflake] The ID of the guild the message was sent in.
-      attr_reader :guild_id
-      # @return [String] The new content of the message.
-      attr_reader :content
-      # @return [Time] The time the message was edited.
-      attr_reader :timestamp
-      # @return [Boolean] Whether the message pings @everyone.
-      attr_reader :mention_everyone
-      # @macro client_cache
-      # @return [Array<Discorb::Role>] The roles mentioned in the message.
-      attr_reader :mention_roles
-      # @return [Array<Discorb::Attachment>] The attachments in the message.
-      attr_reader :attachments
-      # @return [Array<Discorb::Embed>] The embeds in the message.
-      attr_reader :embeds
-
-      # @!attribute [r] channel
-      #   @macro client_cache
-      #   @return [Discorb::Channel] The channel the message was sent in.
-      # @!attribute [r] guild
-      #   @macro client_cache
-      #   @return [Discorb::Guild] The guild the message was sent in.
-
-      def initialize(client, data, before, after)
-        @client = client
-        @data = data
-        @before = before
-        @after = after
-        @id = Snowflake.new(data[:id])
-        @channel_id = Snowflake.new(data[:channel_id])
-        @guild_id = Snowflake.new(data[:guild_id]) if data.key?(:guild_id)
-        @content = data[:content]
-        @timestamp = Time.iso8601(data[:edited_timestamp])
-        @mention_everyone = data[:mention_everyone]
-        @mention_roles = data[:mention_roles].map { |r| guild.roles[r] } if data.key?(:mention_roles)
-        @attachments = data[:attachments].map { |a| Attachment.from_hash(a) } if data.key?(:attachments)
-        @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.from_hash(e) } : [] if data.key?(:embeds)
-      end
-
-      def channel
-        @client.channels[@channel_id]
-      end
-
-      def guild
-        @client.guilds[@guild_id]
-      end
-
-      # Fetch the message.
-      # @async
-      #
-      # @return [Async::Task<Discorb::Message>] The message.
-      def fetch_message
-        Async do
-          channel.fetch_message(@id).wait
-        end
-      end
-    end
-
-    #
-    # Represents a message but it has only ID.
-    #
-    class UnknownDeleteBulkMessage < GatewayEvent
-      # @return [Discorb::Snowflake] The ID of the message.
-      attr_reader :id
-
-      # @!attribute [r] channel
-      #   @macro client_cache
-      #   @return [Discorb::Channel] The channel the message was sent in.
-      # @!attribute [r] guild
-      #   @macro client_cache
-      #   @return [Discorb::Guild] The guild the message was sent in.
-
-      #
-      # Initialize a new instance of the UnknownDeleteBulkMessage class.
-      # @private
-      #
-      # @param [Discorb::Client] client The client that instantiated the object.
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(client, id, data)
-        @client = client
-        @id = id
-        @data = data
-        @channel_id = Snowflake.new(data[:channel_id])
-        @guild_id = Snowflake.new(data[:guild_id]) if data.key?(:guild_id)
-      end
-
-      def channel
-        @client.channels[@channel_id]
-      end
-
-      def guild
-        @client.guilds[@guild_id]
-      end
-    end
-
-    #
-    # Represents a `INVITE_DELETE` event.
-    #
-    class InviteDeleteEvent < GatewayEvent
-      # @return [String] The invite code.
-      attr_reader :code
-
-      # @!attribute [r] channel
-      #   @macro client_cache
-      #   @return [Discorb::Channel] The channel the message was sent in.
-      # @!attribute [r] guild
-      #   @macro client_cache
-      #   @return [Discorb::Guild] The guild the message was sent in.
-
-      #
-      # Initialize a new instance of the InviteDeleteEvent class.
-      # @private
-      #
-      # @param [Discorb::Client] client The client that instantiated the object.
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(client, data)
-        @client = client
-        @data = data
-        @channel_id = Snowflake.new(data[:channel])
-        @guild_id = Snowflake.new(data[:guild_id])
-        @code = data[:code]
-      end
-
-      def channel
-        @client.channels[@channel_id]
-      end
-
-      def guild
-        @client.guilds[@guild_id]
-      end
-    end
-
-    #
-    # Represents a `TYPING_START` event.
-    #
-    class TypingStartEvent < GatewayEvent
-      # @return [Discorb::Snowflake] The ID of the channel the user is typing in.
-      attr_reader :user_id
-      # @macro client_cache
-      # @return [Discorb::Member] The member that is typing.
-      attr_reader :member
-
-      # @!attribute [r] channel
-      #   @macro client_cache
-      #   @return [Discorb::Channel] The channel the user is typing in.
-      # @!attribute [r] guild
-      #   @macro client_cache
-      #   @return [Discorb::Guild] The guild the user is typing in.
-      # @!attribute [r] user
-      #   @macro client_cache
-      #   @return [Discorb::User] The user that is typing.
-      # @!attribute [r] fired_by
-      #   @macro client_cache
-      #   @return [Discorb::Member, Discorb::User] The member or user that started typing.
-
-      #
-      # Initialize a new instance of the TypingStartEvent class.
-      # @private
-      #
-      # @param [Discorb::Client] client The client that instantiated the object.
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(client, data)
-        @client = client
-        @data = data
-        @channel_id = Snowflake.new(data[:channel_id])
-        @guild_id = Snowflake.new(data[:guild_id]) if data.key?(:guild_id)
-        @user_id = Snowflake.new(data[:user_id])
-        @timestamp = Time.at(data[:timestamp])
-        if guild
-          @member = guild.members[@user_id] || Member.new(
-            @client,
-            @guild_id,
-            @client.users[@user_id].instance_variable_get(:@data),
-            data[:member]
-          )
-        end
-      end
-
-      def user
-        @client.users[@user_id]
-      end
-
-      def channel
-        @client.channels[@channel_id]
-      end
-
-      def guild
-        @client.guilds[@guild_id]
-      end
-
-      def fired_by
-        @member || user
-      end
-
-      alias from fired_by
-    end
-
-    #
-    # Represents a message pin event.
-    #
-    class MessagePinEvent < GatewayEvent
-      # @return [Discorb::Message] The message that was pinned.
-      attr_reader :message
-      # @return [:pinned, :unpinned] The type of event.
-      attr_reader :type
-
-      # @!attribute [r] pinned?
-      #   @return [Boolean] Whether the message was pinned.
-      # @!attribute [r] unpinned?
-      #   @return [Boolean] Whether the message was unpinned.
-
-      def initialize(client, data, message)
-        @client = client
-        @data = data
-        @message = message
-        @type = if message.nil?
-            :unknown
-          elsif @message.pinned?
-            :pinned
-          else
-            :unpinned
-          end
-      end
-
-      def pinned?
-        @type == :pinned
-      end
-
-      def unpinned?
-        @type = :unpinned
-      end
-    end
-
-    #
-    # Represents a `WEBHOOKS_UPDATE` event.
-    #
-    class WebhooksUpdateEvent < GatewayEvent
-      # @!attribute [r] channel
-      #   @macro client_cache
-      #   @return [Discorb::Channel] The channel where the webhook was updated.
-      # @!attribute [r] guild
-      #   @macro client_cache
-      #   @return [Discorb::Guild] The guild where the webhook was updated.
-
-      #
-      # Initialize a new instance of the WebhooksUpdateEvent class.
-      # @private
-      #
-      # @param [Discorb::Client] client The client that instantiated the object.
-      # @param [Hash] data The data of the event.
-      #
-      def initialize(client, data)
-        @client = client
-        @data = data
-        @guild_id = Snowflake.new(data[:guild_id])
-        @channel_id = Snowflake.new(data[:channel_id])
-      end
-
-      def guild
-        @client.guilds[@guild_id]
-      end
-
-      def channel
-        @client.channels[@channel_id]
-      end
-    end
-
     #
     # A module to handle gateway events.
     #
     module Handler
+      # @type instance: Discorb::Client
+
       private
 
       def connect_gateway(reconnect)
@@ -623,10 +53,11 @@ module Discorb
                 headers: [["User-Agent", Discorb::USER_AGENT]],
                 handler: RawConnection,
               )
+              con = self.connection
               zlib_stream = Zlib::Inflate.new(Zlib::MAX_WBITS)
               buffer = +""
               begin
-                while (message = connection.read)
+                while (message = con.read)
                   buffer << message
                   if message.end_with?((+"\x00\x00\xff\xff").force_encoding("ASCII-8BIT"))
                     begin
@@ -652,7 +83,7 @@ module Discorb
                 next if @status == :closed
 
                 logger.error "Gateway connection closed accidentally: #{e.class}: #{e.message}"
-                connection.force_close
+                con.force_close
                 connect_gateway(true)
                 next
               end
@@ -663,7 +94,7 @@ module Discorb
                 raise ClientError.new("Authentication failed"), cause: nil
               when 4009
                 logger.info "Session timed out, reconnecting."
-                connection.force_close
+                con.force_close
                 connect_gateway(true)
                 next
               when 4014
@@ -678,19 +109,19 @@ module Discorb
                                                  ERROR
               when 1001
                 logger.info "Gateway closed with code 1001, reconnecting."
-                connection.force_close
+                con.force_close
                 connect_gateway(true)
                 next
               else
                 logger.error "Discord WebSocket closed with code #{e.code}."
                 logger.debug "#{e.message}"
-                connection.force_close
+                con.force_close
                 connect_gateway(false)
                 next
               end
             rescue StandardError => e
               logger.error "Discord WebSocket error: #{e.full_message}"
-              connection.force_close
+              con.force_close
               connect_gateway(false)
               next
             end
@@ -909,11 +340,11 @@ module Discorb
           return logger.warn "Unknown thread id #{data[:id]}, ignoring" unless (thread = @channels[data[:id]])
 
           if (member = thread.members[data[:id]])
-            old = ThreadChannel::Member.new(self, member.instance_variable_get(:@data))
+            old = ThreadChannel::Member.new(self, member.instance_variable_get(:@data), data[:guild_id])
             member.send(:_set_data, data)
           else
             old = nil
-            member = ThreadChannel::Member.new(self, data)
+            member = ThreadChannel::Member.new(self, data, data[:guild_id])
             thread.members[data[:user_id]] = member
           end
           dispatch(:thread_member_update, thread, old, member)
@@ -923,7 +354,7 @@ module Discorb
           thread.instance_variable_set(:@member_count, data[:member_count])
           members = []
           (data[:added_members] || []).each do |raw_member|
-            member = ThreadChannel::Member.new(self, raw_member)
+            member = ThreadChannel::Member.new(self, raw_member, data[:guild_id])
             thread.members[member.id] = member
             members << member
           end
@@ -1173,7 +604,7 @@ module Discorb
               target_reaction.instance_variable_set(:@count, target_reaction.count + 1)
             else
               target_message.reactions << Reaction.new(
-                self,
+                target_message,
                 {
                   count: 1,
                   me: @user.id == data[:user_id],
@@ -1257,6 +688,14 @@ module Discorb
         when "GUILD_SCHEDULED_EVENT_USER_REMOVE"
           logger.warn("Unknown guild id #{data[:guild_id]}, ignoring") unless (guild = @guilds[data[:guild_id]])
           dispatch(:scheduled_event_user_remove, ScheduledEventUserEvent.new(self, data))
+        when "AUTO_MODERATION_ACTION_EXECUTION"
+          dispatch(:auto_moderation_action_execution, AutoModerationActionExecutionEvent.new(self, data))
+        when "AUTO_MODERATION_RULE_CREATE"
+          dispatch(:auto_moderation_rule_create, AutoModRule.new(self, data))
+        when "AUTO_MODERATION_RULE_UPDATE"
+          dispatch(:auto_moderation_rule_update, AutoModRule.new(self, data))
+        when "AUTO_MODERATION_RULE_DELETE"
+          dispatch(:auto_moderation_rule_delete, AutoModRule.new(self, data))
         else
           if respond_to?("event_" + event_name.downcase)
             __send__("event_" + event_name.downcase, data)