discorb 0.19.0 → 0.20.0

data/lib/discorb/integration.rb

@@ -1,161 +1,169 @@
-# frozen_string_literal: true
-
-module Discorb
-  #
-  # Represents a integration.
-  #
-  class Integration < DiscordModel
-    # @return [Discorb::Snowflake] The ID of the integration.
-    attr_reader :id
-    # @return [Symbol] The type of integration.
-    attr_reader :type
-    # @return [Boolean] Whether the integration is enabled.
-    attr_reader :enabled
-    alias enabled? enabled
-    # @return [Boolean] Whether the integration is syncing.
-    attr_reader :syncing
-    alias syncing? syncing
-    # @return [Boolean] Whether the integration is enabled emoticons.
-    attr_reader :enable_emoticons
-    alias enable_emoticons? enable_emoticons
-    # @return [:remove_role, :kick] The behavior of the integration when it expires.
-    attr_reader :expire_behavior
-    # @return [Integer] The grace period of the integration.
-    attr_reader :expire_grace_period
-    # @return [Discorb::User] The user for the integration.
-    attr_reader :user
-    # @return [Discorb::Integration::Account] The account for the integration.
-    attr_reader :account
-    # @return [Integer] The number of subscribers for the integration.
-    attr_reader :subscriber_count
-    # @return [Boolean] Whether the integration is revoked.
-    attr_reader :revoked
-    alias revoked? revoked
-    # @return [Discorb::Application] The application for the integration.
-    attr_reader :application
-
-    # @!attribute [r] guild
-    #   @macro client_cache
-    #   @return [Discorb::Guild] The guild this integration is in.
-
-    # @private
-    # @return [{Integer => String}] The map of the expire behavior.
-    EXPIRE_BEHAVIOR = {
-      0 => :remove_role,
-      1 => :kick,
-    }.freeze
-
-    #
-    # Initialize a new integration.
-    # @private
-    #
-    # @param [Discorb::Client] client The client.
-    # @param [Hash] data The data of the welcome screen.
-    # @param [Discorb::Guild] guild The guild this integration is in.
-    #
-    def initialize(client, data, guild_id)
-      @client = client
-      @data = data
-      @guild_id = guild_id
-      _set_data(data)
-    end
-
-    def guild
-      @client.guilds[@guild_id]
-    end
-
-    #
-    # Delete the integration.
-    # @async
-    #
-    # @param [String] reason The reason for deleting the integration.
-    #
-    # @return [Async::Task<void>] The task.
-    #
-    def delete(reason: nil)
-      Async do
-        @client.http.request(
-          Route.new("/guilds/#{@guild}/integrations/#{@id}", "//guilds/:guild_id/integrations/:integration_id",
-                    :delete), {}, audit_log_reason: reason
-        ).wait
-      end
-    end
-
-    alias destroy delete
-
-    private
-
-    def _set_data(data)
-      @id = Snowflake.new(data[:id])
-      @type = data[:type].to_sym
-      @enabled = data[:enabled]
-      @syncing = data[:syncing]
-      @role_id = Snowflake.new(data[:role_id])
-      @enable_emoticons = data[:enable_emoticons]
-      @expire_behavior = EXPIRE_BEHAVIOR[data[:expire_behavior]]
-      @expire_grace_period = data[:expire_grace_period]
-      @user = @client.users[data[:user][:id]] or Discorb::User.new(@client, data[:user])
-      @account = Account.new(data[:account])
-      @subscriber_count = data[:subscriber_count]
-      @revoked = data[:revoked]
-      @application = data[:application] and Application.new(@client, data[:application])
-    end
-
-    #
-    # Represents an account for an integration.
-    #
-    class Account < DiscordModel
-      # @return [String] The ID of the account.
-      attr_reader :id
-      # @return [String] The name of the account.
-      attr_reader :name
-
-      #
-      # Initialize a new account.
-      # @private
-      #
-      # @param [Hash] data The data from Discord.
-      #
-      def initialize(data)
-        @id = data[:id]
-        @name = data[:name]
-      end
-    end
-
-    #
-    # Represents an application for an integration.
-    #
-    class Application < DiscordModel
-      # @return [Discorb::Snowflake] The ID of the application.
-      attr_reader :id
-      # @return [String] The name of the application.
-      attr_reader :name
-      # @return [Asset] The icon of the application.
-      # @return [nil] If the application has no icon.
-      attr_reader :icon
-      # @return [String] The description of the application.
-      attr_reader :description
-      # @return [String] The summary of the application.
-      attr_reader :summary
-      # @return [Discorb::User] The bot user associated with the application.
-      # @return [nil] If the application has no bot user.
-      attr_reader :bot
-
-      #
-      # Initialize a new application.
-      # @private
-      #
-      # @param [Discorb::Client] client The client.
-      # @param [Hash] data The data from Discord.
-      #
-      def initialize(client, data)
-        @id = Snowflake.new(data[:id])
-        @name = data[:name]
-        @icon = data[:icon] && Asset.new(self, data[:icon])
-        @description = data[:description]
-        @summary = data[:summary]
-        @bot = data[:bot] and client.users[data[:bot][:id]] || Discorb::User.new(client, data[:bot])
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents a integration.
+  #
+  class Integration < DiscordModel
+    # @return [Discorb::Snowflake] The ID of the integration.
+    attr_reader :id
+    # @return [Symbol] The type of integration.
+    attr_reader :type
+    # @return [Boolean] Whether the integration is enabled.
+    attr_reader :enabled
+    alias enabled? enabled
+    # @return [Boolean] Whether the integration is syncing.
+    attr_reader :syncing
+    alias syncing? syncing
+    # @return [Boolean] Whether the integration is enabled emoticons.
+    attr_reader :enable_emoticons
+    alias enable_emoticons? enable_emoticons
+    # @return [:remove_role, :kick] The behavior of the integration when it expires.
+    attr_reader :expire_behavior
+    # @return [Integer] The grace period of the integration.
+    attr_reader :expire_grace_period
+    # @return [Discorb::User] The user for the integration.
+    attr_reader :user
+    # @return [Discorb::Integration::Account] The account for the integration.
+    attr_reader :account
+    # @return [Integer] The number of subscribers for the integration.
+    attr_reader :subscriber_count
+    # @return [Boolean] Whether the integration is revoked.
+    attr_reader :revoked
+    alias revoked? revoked
+    # @return [Discorb::Application] The application for the integration.
+    attr_reader :application
+
+    # @!attribute [r] guild
+    #   @macro client_cache
+    #   @return [Discorb::Guild] The guild this integration is in.
+
+    # @private
+    # @return [{Integer => String}] The map of the expire behavior.
+    EXPIRE_BEHAVIOR = { 0 => :remove_role, 1 => :kick }.freeze
+
+    #
+    # Initialize a new integration.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the welcome screen.
+    # @param [Discorb::Guild] guild The guild this integration is in.
+    #
+    def initialize(client, data, guild_id)
+      @client = client
+      @data = data
+      @guild_id = guild_id
+      _set_data(data)
+    end
+
+    def guild
+      @client.guilds[@guild_id]
+    end
+
+    #
+    # Delete the integration.
+    # @async
+    #
+    # @param [String] reason The reason for deleting the integration.
+    #
+    # @return [Async::Task<void>] The task.
+    #
+    def delete(reason: nil)
+      Async do
+        @client
+          .http
+          .request(
+            Route.new(
+              "/guilds/#{@guild}/integrations/#{@id}",
+              "//guilds/:guild_id/integrations/:integration_id",
+              :delete
+            ),
+            {},
+            audit_log_reason: reason
+          )
+          .wait
+      end
+    end
+
+    alias destroy delete
+
+    private
+
+    def _set_data(data)
+      @id = Snowflake.new(data[:id])
+      @type = data[:type].to_sym
+      @enabled = data[:enabled]
+      @syncing = data[:syncing]
+      @role_id = Snowflake.new(data[:role_id])
+      @enable_emoticons = data[:enable_emoticons]
+      @expire_behavior = EXPIRE_BEHAVIOR[data[:expire_behavior]]
+      @expire_grace_period = data[:expire_grace_period]
+      @user = @client.users[data[:user][:id]] or
+        Discorb::User.new(@client, data[:user])
+      @account = Account.new(data[:account])
+      @subscriber_count = data[:subscriber_count]
+      @revoked = data[:revoked]
+      @application = data[:application] and
+        Application.new(@client, data[:application])
+    end
+
+    #
+    # Represents an account for an integration.
+    #
+    class Account < DiscordModel
+      # @return [String] The ID of the account.
+      attr_reader :id
+      # @return [String] The name of the account.
+      attr_reader :name
+
+      #
+      # Initialize a new account.
+      # @private
+      #
+      # @param [Hash] data The data from Discord.
+      #
+      def initialize(data)
+        @id = data[:id]
+        @name = data[:name]
+      end
+    end
+
+    #
+    # Represents an application for an integration.
+    #
+    class Application < DiscordModel
+      # @return [Discorb::Snowflake] The ID of the application.
+      attr_reader :id
+      # @return [String] The name of the application.
+      attr_reader :name
+      # @return [Asset] The icon of the application.
+      # @return [nil] If the application has no icon.
+      attr_reader :icon
+      # @return [String] The description of the application.
+      attr_reader :description
+      # @return [String] The summary of the application.
+      attr_reader :summary
+      # @return [Discorb::User] The bot user associated with the application.
+      # @return [nil] If the application has no bot user.
+      attr_reader :bot
+
+      #
+      # Initialize a new application.
+      # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The data from Discord.
+      #
+      def initialize(client, data)
+        @id = Snowflake.new(data[:id])
+        @name = data[:name]
+        @icon = data[:icon] && Asset.new(self, data[:icon])
+        @description = data[:description]
+        @summary = data[:summary]
+        @bot = data[:bot] and
+          client.users[data[:bot][:id]] || Discorb::User.new(client, data[:bot])
+      end
+    end
+  end
+end

data/lib/discorb/intents.rb

@@ -1,163 +1,161 @@
-# frozen_string_literal: true
-
-module Discorb
-  # Represents intents.
-  class Intents
-    # @private
-    # @return [{Symbol => Integer}] The mapping of intent names to bit values.
-    INTENT_BITS = {
-      guilds: 1 << 0,
-      members: 1 << 1,
-      bans: 1 << 2,
-      emojis: 1 << 3,
-      integrations: 1 << 4,
-      webhooks: 1 << 5,
-      invites: 1 << 6,
-      voice_states: 1 << 7,
-      presences: 1 << 8,
-      messages: 1 << 9,
-      reactions: 1 << 10,
-      typing: 1 << 11,
-      dm_messages: 1 << 12,
-      dm_reactions: 1 << 13,
-      dm_typing: 1 << 14,
-      message_content: 1 << 15,
-      scheduled_events: 1 << 16,
-      automod_configuration: 1 << 20,
-      automod_execution: 1 << 21,
-    }.freeze
-
-    #
-    # Create new intents object with default (no members and presence) intents.
-    #
-    # @param guilds [Boolean] Whether guild related events are enabled.
-    # @param members [Boolean] Whether guild members related events are enabled.
-    # @param bans [Boolean] Whether guild ban related events are enabled.
-    # @param emojis [Boolean] Whether guild emojis related events are enabled.
-    # @param integrations [Boolean] Whether guild integration related events are enabled.
-    # @param webhooks [Boolean] Whether guild webhooks related events are enabled.
-    # @param invites [Boolean] Whether guild invite related events are enabled.
-    # @param voice_states [Boolean] Whether guild voice state related events are enabled.
-    # @param presences [Boolean] Whether guild presences related events are enabled.
-    # @param messages [Boolean] Whether guild messages related events are enabled.
-    # @param reactions [Boolean] Whether guild reaction related events are enabled.
-    # @param dm_messages [Boolean] Whether dm messages related events are enabled.
-    # @param dm_reactions [Boolean] Whether dm reactions related events are enabled.
-    # @param dm_typing [Boolean] Whether dm typing related events are enabled.
-    # @param message_content [Boolean] Whether message content will be sent with events.
-    # @param scheduled_events [Boolean] Whether events related scheduled events are enabled.
-    # @param automod_configuration [Boolean] Whether automod configuration related events are enabled.
-    # @param automod_execution [Boolean] Whether automod execution related events are enabled.
-    # @note You must enable privileged intents to use `members` and/or `presences` intents.
-    # @note Message Content Intent is not required to use `message_content` intents for now,
-    #   this will be required in September 1, 2022. [Learn More](https://support-dev.discord.com/hc/en-us/articles/4404772028055).
-    #   You should specify `message_content` intent for preventing unexpected changes in the future.
-    #
-    def initialize(
-      guilds: true,
-      members: false,
-      bans: true,
-      emojis: true,
-      integrations: true,
-      webhooks: true,
-      invites: true,
-      voice_states: true,
-      presences: false,
-      messages: true,
-      reactions: true,
-      typing: true,
-      dm_messages: true,
-      dm_reactions: true,
-      dm_typing: true,
-      message_content: nil,
-      scheduled_events: true,
-      automod_configuration: true,
-      automod_execution: true
-    )
-      @raw_value = {
-        guilds: guilds,
-        members: members,
-        bans: bans,
-        emojis: emojis,
-        integrations: integrations,
-        webhooks: webhooks,
-        invites: invites,
-        voice_states: voice_states,
-        presences: presences,
-        messages: messages,
-        reactions: reactions,
-        typing: typing,
-        dm_messages: dm_messages,
-        dm_reactions: dm_reactions,
-        dm_typing: dm_typing,
-        message_content: message_content,
-        scheduled_events: scheduled_events,
-        automod_configuration: automod_configuration,
-        automod_execution: automod_execution,
-      }
-    end
-
-    #
-    # (see Flag#method_missing)
-    #
-    def method_missing(name, args = nil)
-      if @raw_value.key?(name)
-        @raw_value[name]
-      elsif name.end_with?("=") && @raw_value.key?(name[0..-2].to_sym)
-        raise ArgumentError, "true/false expected" unless args.is_a?(TrueClass) || args.is_a?(FalseClass)
-
-        @raw_value[name[0..-2].to_sym] = args
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(name, include_private)
-      @raw_value.key?(name) ? true : super
-    end
-
-    # Returns value of the intent.
-    # @return [Integer] The value of the intent.
-    def value
-      res = 0
-      INTENT_BITS.each do |intent, bit|
-        res += bit if @raw_value[intent]
-      end
-      res
-    end
-
-    def inspect
-      "#<#{self.class} value=#{value}>"
-    end
-
-    def to_h
-      @raw_value
-    end
-
-    class << self
-      # Create new intent object from raw value.
-      # @param value [Integer] The value of the intent.
-      def from_value(value)
-        raw_value = {}
-        INTENT_BITS.each do |intent, bit|
-          raw_value[intent] = value & bit != 0
-        end
-        new(**raw_value)
-      end
-
-      # Create new intent object with default values.
-      # This will return intents without members and presence.
-      alias default new
-
-      # Create new intent object with all intents.
-      def all
-        from_value(INTENT_BITS.values.reduce(:+))
-      end
-
-      # Create new intent object with no intents.
-      def none
-        from_value(0)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Discorb
+  # Represents intents.
+  class Intents
+    # @private
+    # @return [{Symbol => Integer}] The mapping of intent names to bit values.
+    INTENT_BITS = {
+      guilds: 1 << 0,
+      members: 1 << 1,
+      bans: 1 << 2,
+      emojis: 1 << 3,
+      integrations: 1 << 4,
+      webhooks: 1 << 5,
+      invites: 1 << 6,
+      voice_states: 1 << 7,
+      presences: 1 << 8,
+      messages: 1 << 9,
+      reactions: 1 << 10,
+      typing: 1 << 11,
+      dm_messages: 1 << 12,
+      dm_reactions: 1 << 13,
+      dm_typing: 1 << 14,
+      message_content: 1 << 15,
+      scheduled_events: 1 << 16,
+      automod_configuration: 1 << 20,
+      automod_execution: 1 << 21
+    }.freeze
+
+    #
+    # Create new intents object with default (no members and presence) intents.
+    #
+    # @param guilds [Boolean] Whether guild related events are enabled.
+    # @param members [Boolean] Whether guild members related events are enabled.
+    # @param bans [Boolean] Whether guild ban related events are enabled.
+    # @param emojis [Boolean] Whether guild emojis related events are enabled.
+    # @param integrations [Boolean] Whether guild integration related events are enabled.
+    # @param webhooks [Boolean] Whether guild webhooks related events are enabled.
+    # @param invites [Boolean] Whether guild invite related events are enabled.
+    # @param voice_states [Boolean] Whether guild voice state related events are enabled.
+    # @param presences [Boolean] Whether guild presences related events are enabled.
+    # @param messages [Boolean] Whether guild messages related events are enabled.
+    # @param reactions [Boolean] Whether guild reaction related events are enabled.
+    # @param dm_messages [Boolean] Whether dm messages related events are enabled.
+    # @param dm_reactions [Boolean] Whether dm reactions related events are enabled.
+    # @param dm_typing [Boolean] Whether dm typing related events are enabled.
+    # @param message_content [Boolean] Whether message content will be sent with events.
+    # @param scheduled_events [Boolean] Whether events related scheduled events are enabled.
+    # @param automod_configuration [Boolean] Whether automod configuration related events are enabled.
+    # @param automod_execution [Boolean] Whether automod execution related events are enabled.
+    # @note You must enable privileged intents to use `members` and/or `presences` intents.
+    # @note Message Content Intent is not required to use `message_content` intents for now,
+    #   this will be required in September 1, 2022. [Learn More](https://support-dev.discord.com/hc/en-us/articles/4404772028055).
+    #   You should specify `message_content` intent for preventing unexpected changes in the future.
+    #
+    def initialize(
+      guilds: true,
+      members: false,
+      bans: true,
+      emojis: true,
+      integrations: true,
+      webhooks: true,
+      invites: true,
+      voice_states: true,
+      presences: false,
+      messages: true,
+      reactions: true,
+      typing: true,
+      dm_messages: true,
+      dm_reactions: true,
+      dm_typing: true,
+      message_content: nil,
+      scheduled_events: true,
+      automod_configuration: true,
+      automod_execution: true
+    )
+      @raw_value = {
+        guilds: guilds,
+        members: members,
+        bans: bans,
+        emojis: emojis,
+        integrations: integrations,
+        webhooks: webhooks,
+        invites: invites,
+        voice_states: voice_states,
+        presences: presences,
+        messages: messages,
+        reactions: reactions,
+        typing: typing,
+        dm_messages: dm_messages,
+        dm_reactions: dm_reactions,
+        dm_typing: dm_typing,
+        message_content: message_content,
+        scheduled_events: scheduled_events,
+        automod_configuration: automod_configuration,
+        automod_execution: automod_execution
+      }
+    end
+
+    #
+    # (see Flag#method_missing)
+    #
+    def method_missing(name, args = nil)
+      if @raw_value.key?(name)
+        @raw_value[name]
+      elsif name.end_with?("=") && @raw_value.key?(name[0..-2].to_sym)
+        unless args.is_a?(TrueClass) || args.is_a?(FalseClass)
+          raise ArgumentError, "true/false expected"
+        end
+
+        @raw_value[name[0..-2].to_sym] = args
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private)
+      @raw_value.key?(name) ? true : super
+    end
+
+    # Returns value of the intent.
+    # @return [Integer] The value of the intent.
+    def value
+      res = 0
+      INTENT_BITS.each { |intent, bit| res += bit if @raw_value[intent] }
+      res
+    end
+
+    def inspect
+      "#<#{self.class} value=#{value}>"
+    end
+
+    def to_h
+      @raw_value
+    end
+
+    class << self
+      # Create new intent object from raw value.
+      # @param value [Integer] The value of the intent.
+      def from_value(value)
+        raw_value = {}
+        INTENT_BITS.each { |intent, bit| raw_value[intent] = value & bit != 0 }
+        new(**raw_value)
+      end
+
+      # Create new intent object with default values.
+      # This will return intents without members and presence.
+      alias default new
+
+      # Create new intent object with all intents.
+      def all
+        from_value(INTENT_BITS.values.reduce(:+))
+      end
+
+      # Create new intent object with no intents.
+      def none
+        from_value(0)
+      end
+    end
+  end
+end