feat: auto moderation

Author: Droid00000

lib/discordrb.rb

@@ -32,7 +32,9 @@ module Discordrb
     server_message_typing: 1 << 11,
     direct_messages: 1 << 12,
     direct_message_reactions: 1 << 13,
-    direct_message_typing: 1 << 14
+    direct_message_typing: 1 << 14,
+    server_automod: 1 << 20,
+    server_automod_execution: 1 << 21
   }.freeze
 
   # All available intents

lib/discordrb/api/server.rb

@@ -598,4 +598,71 @@ def bulk_ban(token, server_id, users, message_seconds, reason = nil)
       'X-Audit-Log-Reason': reason
     )
   end
+
+  # Get a list of all the configured auto-moderation rules in the server.
+  # https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild
+  def list_automod_rules(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_auto_moderation_rules,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/auto-moderation/rules",
+      Authorization: token
+    )
+  end
+
+  # Get a single auto-moderation rule in the server.
+  # https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule
+  def get_automod_rule(token, server_id, rule_id)
+    Discordrb::API.request(
+      :guilds_sid_auto_moderation_rules_rid,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/auto-moderation/rules/#{rule_id}",
+      Authorization: token
+    )
+  end
+
+  # Create an auto-moderation rule in the server.
+  # https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule
+  def create_automod_rule(token, server_id, name, event_type, trigger_type, trigger_metadata, actions, enabled, exempt_roles, exempt_channels, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_auto_moderation_rules,
+      server_id,
+      :post,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/auto-moderation/rules",
+      { name: name, event_type: event_type, trigger_type: trigger_type, trigger_metadata: trigger_metadata, actions: actions, enabled: enabled, exempt_roles: exempt_roles, exempt_channels: exempt_channels }.to_json,
+      content_type: :json,
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Update an auto-moderation rule in the server.
+  # https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule
+  def update_automod_rule(token, server_id, rule_id, name = nil, event_type = nil, trigger_metadata = nil, actions = nil, enabled = nil, exempt_roles = nil, exempt_channels = nil, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_auto_moderation_rules_rid,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/auto-moderation/rules/#{rule_id}",
+      { name: name, event_type: event_type, trigger_metadata: trigger_metadata, actions: actions, enabled: enabled, exempt_roles: exempt_roles, exempt_channels: exempt_channels }.compact.to_json,
+      content_type: :json,
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Delete an auto-moderation rule in the server.
+  # https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule
+  def delete_automod_rule(token, server_id, rule_id, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_auto_moderation_rules_rid,
+      server_id,
+      :delete,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/auto-moderation/rules/#{rule_id}",
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
 end

lib/discordrb/bot.rb

@@ -20,6 +20,7 @@
 require 'discordrb/events/invites'
 require 'discordrb/events/interactions'
 require 'discordrb/events/threads'
+require 'discordrb/events/auto_moderation'
 
 require 'discordrb/api'
 require 'discordrb/api/channel'
@@ -1167,6 +1168,18 @@ def update_guild_emoji(data)
       server.update_emoji_data(data)
     end
 
+    # Internal handler for AUTO_MODERATION_RULE_UPDATE and AUTO_MODERATION_RULE_CREATE
+    def update_guild_automod_rule(data)
+      server = self.server(data['guild_id'].to_i)
+      rule = server&.automod_rule(data['id'].to_i, request: false)
+
+      if rule
+        rule.from_other(data)
+      else
+        server&.cache_automod_rule(AutoModRule.new(data, self, server))
+      end
+    end
+
     # Internal handler for MESSAGE_CREATE
     def create_message(data); end
 
@@ -1669,6 +1682,24 @@ def handle_dispatch(type, data)
 
         event = ThreadMembersUpdateEvent.new(data, self)
         raise_event(event)
+      when :AUTO_MODERATION_RULE_CREATE
+        update_guild_automod_rule(data)
+
+        event = AutoModRuleCreateEvent.new(data, self)
+        raise_event(event)
+      when :AUTO_MODERATION_RULE_UPDATE
+        update_guild_automod_rule(data)
+
+        event = AutoModRuleUpdateEvent.new(data, self)
+        raise_event(event)
+      when :AUTO_MODERATION_RULE_DELETE
+        self.server(data['guild_id'].to_i).delete_automod_rule(data['id'].to_i)
+
+        event = AutoModRuleDeleteEvent.new(data, self)
+        raise_event(event)
+      when :AUTO_MODERATION_ACTION_EXECUTION
+        event = AutoModActionEvent.new(data, self)
+        raise_event(event)
       else
         # another event that we don't support yet
         debug "Event #{type} has been received but is unsupported. Raising UnknownEvent"

lib/discordrb/container.rb

@@ -673,6 +673,74 @@ def application_command_permissions_update(attributes = {}, &block)
       register_event(ApplicationCommandPermissionsUpdateEvent, attributes, block)
     end
 
+    # This **event** is raised whenever an automod rule is deleted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Regexp] :name A name to match against.
+    # @option attributes [String, Integer, AutoModRule] :automod_rule An automod rule to match against.
+    # @option attributes [String, Integer, User, Member] :creator A creator to match against.
+    # @option attributes [Symbol, Integer] :event_type An event type to match against.
+    # @option attributes [Symbol, Integer] :trigger_type A trigger type to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [AutoModRuleDeleteEvent] The event that was raised.
+    # @return [AutoModRuleDeleteEventHandler] The event handler that was registered.
+    # @note This event requires the `:server_automod` intent in order to be received.
+    def automod_rule_create(attributes = {}, &block)
+      register_event(AutoModRuleCreateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an automod rule is deleted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Regexp] :name A name to match against.
+    # @option attributes [String, Integer, AutoModRule] :automod_rule An automod rule to match against.
+    # @option attributes [String, Integer, User, Member] :creator A creator to match against.
+    # @option attributes [Symbol, Integer] :event_type An event type to match against.
+    # @option attributes [Symbol, Integer] :trigger_type A trigger type to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [AutoModRuleDeleteEvent] The event that was raised.
+    # @return [AutoModRuleDeleteEventHandler] The event handler that was registered.
+    # @note This event requires the `:server_automod` intent in order to be received.
+    def automod_rule_update(attributes = {}, &block)
+      register_event(AutoModRuleUpdateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an automod rule is deleted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Regexp] :name A name to match against.
+    # @option attributes [String, Integer, AutoModRule] :automod_rule An automod rule to match against.
+    # @option attributes [String, Integer, User, Member] :creator A creator to match against.
+    # @option attributes [Symbol, Integer] :event_type An event type to match against.
+    # @option attributes [Symbol, Integer] :trigger_type A trigger type to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [AutoModRuleDeleteEvent] The event that was raised.
+    # @return [AutoModRuleDeleteEventHandler] The event handler that was registered.
+    # @note This event requires the `:server_automod` intent in order to be received.
+    def automod_rule_delete(attributes = {}, &block)
+      register_event(AutoModRuleDeleteEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an automod rule is triggered and takes an action, e.g. blocking a message.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Member] :user The user which generated the content that triggered the rule to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Channel] :channel The channel in which user content was posted to match against.
+    # @option attributes [String, Integer, AutoModRule] :automod_rule An automod rule to match against.
+    # @option attributes [String, Regexp] :content The user generated content which triggered the rule to match against.
+    # @option attributes [Symbol, Integer] :trigger_type A trigger type to match against.
+    # @option attributes [String, Regexp] :matched_content The substring in content that triggered the rule to match against.
+    # @option attributes [String, Regexp] :matched_keyword The keyword or phrase that triggered the rule to match against.
+    # @option attributes [Symbol, Integer] :event_type An event type to match against.
+    # @option attributes [Symbol, Integer] :action_type An action type to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [AutoModActionEvent] The event that was raised.
+    # @return [AutoModActionEventHandler] The event handler that was registered.
+    # @note This event requires the `:server_automod_execution` intent in order to be received.
+    def automod_rule_action(attributes = {}, &block)
+      register_event(AutoModActionEvent, 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.

lib/discordrb/data.rb

@@ -44,3 +44,4 @@
 require 'discordrb/data/collectibles'
 require 'discordrb/data/primary_server'
 require 'discordrb/data/server_preview'
+require 'discordrb/data/auto_moderation'