discorb 0.15.0 → 0.15.1

data/lib/discorb/gateway_requests.rb

@@ -5,7 +5,9 @@ module Discorb
   # Represents an activity for Gateway Command.
   #
   class Activity
-    @types = {
+    # @private
+    # @return [{Symbol => Integer}] The mapping of activity types.
+    TYPES = {
       playing: 0,
       streaming: 1,
       listening: 2,
@@ -22,7 +24,7 @@ module Discorb
     #
     def initialize(name, type = :playing, url = nil)
       @name = name
-      @type = self.class.types[type]
+      @type = TYPES[type] or raise ArgumentError, "Invalid activity type: #{type}"
       @url = url
     end
 
@@ -42,10 +44,5 @@ module Discorb
     def inspect
       "#<#{self.class} @type=#{@type}>"
     end
-
-    class << self
-      # @private
-      attr_reader :types
-    end
   end
 end

data/lib/discorb/guild.rb

@@ -115,27 +115,36 @@ module Discorb
     # @!attribute [r] me
     #   @return [Discorb::Member] The client's member in the guild.
 
-    @mfa_levels = %i[none elevated].freeze
-    @nsfw_levels = %i[default explicit safe age_restricted].freeze
-    @verification_levels = %i[none low medium high very_high].freeze
-    @default_message_notifications = %i[all_messages only_mentions].freeze
-    @explicit_content_filter = %i[disabled_in_text members_without_roles all_members].freeze
+    # @private
+    # @return [Array<Symbol>] The mapping of mfa_level.
+    MFA_LEVELS = %i[none elevated].freeze
+    # @private
+    # @return [Array<Symbol>] The mapping of nsfw_level.
+    NSFW_LEVELS = %i[default explicit safe age_restricted].freeze
+    # @private
+    # @return [Array<Symbol>] The mapping of verification_level.
+    VERIFICATION_LEVELS = %i[none low medium high very_high].freeze
+    # @private
+    # @return [Array<Symbol>] The mapping of default_message_notifications.
+    DEFAULT_MESSAGE_NOTIFICATIONS = %i[all_messages only_mentions].freeze
+    # @private
+    # @return [Array<Symbol>] The mapping of explicit_content_filter.
+    EXPLICIT_CONTENT_FILTER = %i[disabled_in_text members_without_roles all_members].freeze
 
+    #
+    # Creates a new guild object.
     # @private
+    #
+    # @param [Discorb::Client] client The client that owns this guild.
+    # @param [Hash] data The data of the guild.
+    # @param [Boolean] is_create_event Whether the guild is created by a `GUILD_CREATE` event.
+    #
     def initialize(client, data, is_create_event)
       @client = client
       @data = {}
       _set_data(data, is_create_event)
     end
 
-    # @private
-    def update!
-      Async do
-        _, data = @client.get("/guilds/#{@id}").wait
-        _set_data(data, false)
-      end
-    end
-
     def afk_channel
       @client.channels[@afk_channel_id]
     end
@@ -242,9 +251,9 @@ module Discorb
               description: description,
               scheduled_start_time: start_time.iso8601,
               scheduled_end_time: end_time&.iso8601,
-              privacy_level: Discorb::ScheduledEvent.privacy_level.key(privacy_level),
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level),
               channel_id: channel&.id,
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:stage_instance),
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:stage_instance),
             }
           when :voice
             raise ArgumentError, "channel must be provided for voice events" unless channel
@@ -253,9 +262,9 @@ module Discorb
               description: description,
               scheduled_start_time: start_time.iso8601,
               scheduled_end_time: end_time&.iso8601,
-              privacy_level: Discorb::ScheduledEvent.privacy_level.key(privacy_level),
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level),
               channel_id: channel&.id,
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:voice),
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:voice),
             }
           when :external
             raise ArgumentError, "location must be provided for external events" unless location
@@ -265,8 +274,8 @@ module Discorb
               description: description,
               scheduled_start_time: start_time.iso8601,
               scheduled_end_time: end_time.iso8601,
-              privacy_level: Discorb::ScheduledEvent.privacy_level.key(privacy_level),
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:external),
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level),
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:external),
               entity_metadata: {
                 location: location,
               },
@@ -858,7 +867,7 @@ module Discorb
     def fetch_voice_regions
       Async do
         _resp, data = @client.http.request(Route.new("/guilds/#{@id}/voice", "//guilds/:guild_id/voice", :get)).wait
-        data.map { |d| VoiceRegion.new(@client, d) }
+        data.map { |d| VoiceRegion.new(d) }
       end
     end
 
@@ -871,7 +880,7 @@ module Discorb
     def fetch_invites
       Async do
         _resp, data = @client.http.request(Route.new("/guilds/#{@id}/invites", "//guilds/:guild_id/invites", :get)).wait
-        data.map { |d| Invite.new(@client, d) }
+        data.map { |d| Invite.new(@client, d, false) }
       end
     end
 
@@ -884,7 +893,7 @@ module Discorb
     def fetch_integrations
       Async do
         _resp, data = @client.http.request(Route.new("/guilds/#{@id}/integrations", "//guilds/:guild_id/integrations", :get)).wait
-        data.map { |d| Integration.new(@client, d) }
+        data.map { |d| Integration.new(@client, d, @id) }
       end
     end
 
@@ -1012,7 +1021,14 @@ module Discorb
       # @!attribute [r] url
       #   @return [String] The vanity URL.
 
+      #
+      # Initialize a new instance of the {VanityInvite} class.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Discorb::Guild] guild The guild.
+      # @param [Hash] data The data of the invite.
+      #
       def initialize(client, guild, data)
         @client = client
         @guild = guild
@@ -1047,7 +1063,14 @@ module Discorb
       # @!attribute [r] json_url
       #   @return [String] The JSON URL.
 
+      #
+      # Initialize a new instance of the {Widget} class.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Discorb::Snowflake] guild_id The guild ID.
+      # @param [Hash] data The data from Discord.
+      #
       def initialize(client, guild_id, data)
         @client = client
         @enabled = data[:enabled]
@@ -1097,7 +1120,7 @@ module Discorb
       def iframe(theme: "dark", width: 350, height: 500)
         [
           %(<iframe src="https://canary.discord.com/widget?id=#{@guild_id}&theme=#{theme}" width="#{width}" height="#{height}"),
-          %(allowtransparency="true" frameborder="0" sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts"></iframe>)
+          %(allowtransparency="true" frameborder="0" sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts"></iframe>),
         ].join
       end
     end
@@ -1111,7 +1134,14 @@ module Discorb
       # @return [String] The reason for the ban.
       attr_reader :reason
 
+      #
+      # Initialize a new instance of the {Ban} class.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Discorb::Guild] guild The guild.
+      # @param [Hash] data The data from Discord.
+      #
       def initialize(client, guild, data)
         @client = client
         @guild = guild
@@ -1121,9 +1151,6 @@ module Discorb
     end
 
     class << self
-      # @private
-      attr_reader :nsfw_levels, :mfa_levels, :verification_levels, :default_message_notifications, :explicit_content_filter
-
       #
       # Returns a banner url from the guild's ID.
       #
@@ -1151,8 +1178,8 @@ module Discorb
       @name = data[:name]
       @members = Discorb::Dictionary.new
       data[:members]&.each do |m|
-          Member.new(@client, @id, m[:user], m)
-        end
+        Member.new(@client, @id, m[:user], m)
+      end
       @splash = data[:splash] && Asset.new(self, data[:splash], path: "splashes/#{@id}")
       @discovery_splash = data[:discovery_splash] && Asset.new(self, data[:discovery_splash], path: "discovery-splashes/#{@id}")
       @owner_id = data[:owner_id]
@@ -1170,10 +1197,10 @@ module Discorb
         @emojis[e[:id]] = CustomEmoji.new(@client, self, e)
       end
       @features = data[:features].map { |f| f.downcase.to_sym }
-      @mfa_level = self.class.mfa_levels[data[:mfa_level]]
-      @verification_level = self.class.verification_levels[data[:verification_level]]
-      @default_message_notifications = self.class.default_message_notifications[data[:default_message_notifications]]
-      @explicit_content_filter = self.class.explicit_content_filter[data[:explicit_content_filter]]
+      @mfa_level = MFA_LEVELS[data[:mfa_level]]
+      @verification_level = VERIFICATION_LEVELS[data[:verification_level]]
+      @default_message_notifications = DEFAULT_MESSAGE_NOTIFICATIONS[data[:default_message_notifications]]
+      @explicit_content_filter = EXPLICIT_CONTENT_FILTER[data[:explicit_content_filter]]
       @system_channel_id = data[:system_channel_id]
       @system_channel_flag = SystemChannelFlag.new(0b111 - data[:system_channel_flags])
       @rules_channel_id = data[:rules_channel_id]
@@ -1188,7 +1215,7 @@ module Discorb
       @approximate_member_count = data[:approximate_member_count]
       @approximate_presence_count = data[:approximate_presence_count]
       @welcome_screen = data[:welcome_screen].nil? ? nil : WelcomeScreen.new(@client, self, data[:welcome_screen])
-      @nsfw_level = self.class.nsfw_levels[data[:nsfw_level]]
+      @nsfw_level = NSFW_LEVELS[data[:nsfw_level]]
       return unless is_create_event
 
       @stickers = data[:stickers].nil? ? [] : data[:stickers].map { |s| Sticker::GuildSticker.new(self, s) }
@@ -1239,7 +1266,14 @@ module Discorb
     # @return [Discorb::Guild] The guild the welcome screen belongs to.
     attr_reader :guild
 
+    #
+    # Initializes the welcome screen.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Discorb::Guild] guild The guild the welcome screen belongs to.
+    # @param [Hash] data The data of the welcome screen.
+    #
     def initialize(client, guild, data)
       @client = client
       @description = data[:description]

data/lib/discorb/guild_template.rb

@@ -33,7 +33,13 @@ module Discorb
     #   @return [Discorb::Guild] The guild this template is based on.
     #   @return [nil] Client wasn't able to find the guild this template is based on.
 
+    #
+    # Initialize a new template.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data from Discord.
+    #
     def initialize(client, data)
       @client = client
       _set_data(data)
@@ -120,14 +126,19 @@ module Discorb
       attr_reader :widget_enabled
       alias widget_enabled? widget_enabled
 
+      #
+      # Initialize a new guild in guild template.
       # @private
+      #
+      # @param [Hash] data The data from Discord.
+      #
       def initialize(data)
         @name = data[:name]
         @description = data[:description]
         @region = data[:region]
-        @verification_level = Discorb::Guild.mfa_levels[data[:verification_level]]
-        @default_message_notifications = Discorb::Guild.notification_levels[data[:default_message_notifications]]
-        @explicit_content_filter = Discorb::Guild.explicit_content_filter[data[:explicit_content_filter]]
+        @verification_level = Discorb::Guild::MFA_LEVELS[data[:verification_level]]
+        @default_message_notifications = Discorb::Guild::NOTIFICATION_LEVELS[data[:default_message_notifications]]
+        @explicit_content_filter = Discorb::Guild::EXPLICIT_CONTENT_FILTERS[data[:explicit_content_filter]]
         @preferred_locale = data[:preferred_locale]
         @afk_timeout = data[:afk_timeout]
         @roles = data[:roles].map { |r| Role.new(r) }
@@ -146,7 +157,12 @@ module Discorb
         # @return [Discorb::Color] The color of the role.
         attr_reader :color
 
+        #
+        # Initialize a new role in guild template.
         # @private
+        #
+        # @param [Hash] data The data from Discord.
+        #
         def initialize(data)
           @name = data[:name]
           @permissions = Permission.new(data[:permissions])
@@ -177,7 +193,12 @@ module Discorb
         # @return [Class] The class of the channel.
         attr_reader :type
 
+        #
+        # Initialize a new channel in guild template.
         # @private
+        #
+        # @param [Hash] data The data from Discord.
+        #
         def initialize(data)
           @name = data[:name]
           @position = data[:position]

data/lib/discorb/http.rb

@@ -10,7 +10,12 @@ module Discorb
   class HTTP
     @nil_body = nil
 
+    #
+    # Initializes the http client.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    #
     def initialize(client)
       @client = client
       @ratelimit_handler = RatelimitHandler.new(client)
@@ -66,7 +71,7 @@ module Discorb
         @ratelimit_handler.wait(path)
         req = Net::HTTP.const_get(path.method.to_s.capitalize).new(get_path(path), get_headers(headers, body, audit_log_reason), **kwargs)
         data = [
-          ["payload_json", get_body(body)]
+          ["payload_json", get_body(body)],
         ]
         files&.each_with_index do |file, i|
           next if file.nil?
@@ -123,7 +128,7 @@ module Discorb
           { "User-Agent" => USER_AGENT, "authorization" => "Bot #{@client.token}" }
         else
           { "User-Agent" => USER_AGENT, "authorization" => "Bot #{@client.token}",
-            "content-type" => "application/json" }
+            "content-type" => "application/json", }
         end
       ret.merge!(headers) if !headers.nil? && headers.length.positive?
       ret["X-Audit-Log-Reason"] = audit_log_reason unless audit_log_reason.nil?

data/lib/discorb/integration.rb

@@ -38,12 +38,21 @@ module Discorb
     #   @macro client_cache
     #   @return [Discorb::Guild] The guild this integration is in.
 
-    @expire_behavior = {
+    # @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
@@ -80,7 +89,7 @@ module Discorb
       @syncing = data[:syncing]
       @role_id = Snowflake.new(data[:role_id])
       @enable_emoticons = data[:enable_emoticons]
-      @expire_behavior = self.class.expire_behavior[data[:expire_behavior]]
+      @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])
@@ -89,11 +98,6 @@ module Discorb
       @application = data[:application] and Application.new(@client, data[:application])
     end
 
-    class << self
-      # @private
-      attr_reader :expire_behavior
-    end
-
     #
     # Represents an account for an integration.
     #
@@ -103,7 +107,12 @@ module Discorb
       # @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]
@@ -129,7 +138,13 @@ module Discorb
       # @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]

data/lib/discorb/intents.rb

@@ -3,7 +3,9 @@
 module Discorb
   # Represents intents.
   class Intents
-    @intent_bits = {
+    # @private
+    # @return [{Symbol => Integer}] The mapping of intent names to bit values.
+    INTENT_BITS = {
       guilds: 1 << 0,
       members: 1 << 1,
       bans: 1 << 2,
@@ -101,7 +103,7 @@ module Discorb
       end
     end
 
-    def respond_to_missing?(sym, include_private)
+    def respond_to_missing?(name, include_private)
       @raw_value.key?(name) ? true : super
     end
 
@@ -109,7 +111,7 @@ module Discorb
     # @return [Integer] The value of the intent.
     def value
       res = 0
-      self.class.intent_bits.each do |intent, bit|
+      INTENT_BITS.each do |intent, bit|
         res += bit if @raw_value[intent]
       end
       res
@@ -128,7 +130,7 @@ module Discorb
       # @param value [Integer] The value of the intent.
       def from_value(value)
         raw_value = {}
-        @intent_bits.each do |intent, bit|
+        INTENT_BITS.each do |intent, bit|
           raw_value[intent] = value & bit != 0
         end
         new(**raw_value)
@@ -140,15 +142,13 @@ module Discorb
 
       # Create new intent object with all intents.
       def all
-        from_value(@intent_bits.values.reduce(:+))
+        from_value(INTENT_BITS.values.reduce(:+))
       end
 
       # Create new intent object with no intents.
       def none
         from_value(0)
       end
-
-      attr_reader :intent_bits
     end
   end
 end

data/lib/discorb/interaction/autocomplete.rb

@@ -7,7 +7,8 @@ module Discorb
     @interaction_type = 4
     @interaction_name = :auto_complete
 
-    # @private
+    private
+
     def _set_data(data)
       super
       Sync do
@@ -26,7 +27,6 @@ module Discorb
       end
     end
 
-    # @private
     def send_complete_result(val)
       @client.http.request(Route.new("/interactions/#{@id}/#{@token}/callback", "//interactions/:interaction_id/:token/callback", :post), {
         type: 8,

data/lib/discorb/interaction/command.rb

@@ -14,6 +14,7 @@ module Discorb
     #
     class SlashCommand < CommandInteraction
       @command_type = 1
+      @event_name = :slash_command
 
       private
 
@@ -34,7 +35,12 @@ module Discorb
       end
 
       class << self
+        #
+        # Get command data from the given data.
         # @private
+        #
+        # @param [Hash] data The data of the command.
+        #
         def get_command_data(data)
           name = data[:name]
           options = nil
@@ -60,7 +66,15 @@ module Discorb
           [name, options]
         end
 
+        #
+        # Modify the option map with the given options.
         # @private
+        #
+        # @param [Hash] option_map The option map to modify.
+        # @param [Array<Hash>] options The options for modifying.
+        # @param [Discorb::Guild] guild The guild where the command is executed.
+        # @param [{Discorb::Snowflake => Discorb::Member}] members The cached members of the guild.
+        # @param [{Integer => Discorb::Attachment}] attachments The cached attachments of the message.
         def modify_option_map(option_map, options, guild, members, attachments)
           options ||= []
           options.each do |option|
@@ -68,7 +82,7 @@ module Discorb
               when 3, 4, 5, 10
                 option[:value]
               when 6
-                guild.members[option[:value]] || guild.fetch_member(option[:value]).wait
+                members[option[:value]] || guild.members[option[:value]] || guild.fetch_member(option[:value]).wait
               when 7
                 guild.channels[option[:value]] || guild.fetch_channels.wait.find { |channel| channel.id == option[:value] }
               when 8
@@ -89,6 +103,7 @@ module Discorb
     #
     class UserMenuCommand < CommandInteraction
       @command_type = 2
+      @event_name = :user_command
 
       # @return [Discorb::Member, Discorb::User] The target user.
       attr_reader :target
@@ -107,6 +122,7 @@ module Discorb
     #
     class MessageMenuCommand < CommandInteraction
       @command_type = 3
+      @event_name = :message_command
 
       # @return [Discorb::Message] The target message.
       attr_reader :target
@@ -147,18 +163,31 @@ module Discorb
 
     class << self
       # @private
-      attr_reader :command_type
+      attr_reader :command_type, :event_name
 
+      #
+      # Creates a new CommandInteraction instance for the given data.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The data for the command.
+      #
       def make_interaction(client, data)
         nested_classes.each do |klass|
-          return klass.new(client, data) if !klass.command_type.nil? && klass.command_type == data[:data][:type]
+          if !klass.command_type.nil? && klass.command_type == data[:data][:type]
+            interaction = klass.new(client, data)
+            client.dispatch(klass.event_name, interaction)
+            return interaction
+          end
         end
         client.log.warn("Unknown command type #{data[:type]}, initialized CommandInteraction")
         CommandInteraction.new(client, data)
       end
 
+      #
+      # Returns the classes under this class.
       # @private
+      #
       def nested_classes
         constants.select { |c| const_get(c).is_a? Class }.map { |c| const_get(c) }
       end

data/lib/discorb/interaction/components.rb

@@ -18,17 +18,27 @@ module Discorb
     @interaction_type = 3
     @interaction_name = :message_component
 
+    #
+    # Initialize a new message component interaction.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data.
+    #
     def initialize(client, data)
       super
-      @message = Message.new(@client, data[:message].merge({ member: data[:member] }))
+      @message = Message.new(@client, data[:message].merge({ member: data[:member], guild_id: data[:guild_id] }))
     end
 
     class << self
       # @private
+      # @return [Integer] The component type.
       attr_reader :component_type
 
+      #
+      # Create a MessageComponentInteraction instance for the given data.
       # @private
+      #
       def make_interaction(client, data)
         nested_classes.each do |klass|
           return klass.new(client, data) if !klass.component_type.nil? && klass.component_type == data[:data][:component_type]
@@ -37,7 +47,10 @@ module Discorb
         MessageComponentInteraction.new(client, data)
       end
 
+      #
+      # Returns the classes under this class.
       # @private
+      #
       def nested_classes
         constants.select { |c| const_get(c).is_a? Class }.map { |c| const_get(c) }
       end

data/lib/discorb/interaction/response.rb

@@ -74,7 +74,15 @@ module Discorb
       # Represents of a callback message of interaction.
       #
       class CallbackMessage
+        #
+        # Initializes a new instance of CallbackMessage.
         # @private
+        #
+        # @param [Client] client The client.
+        # @param [Hash] data The payload.
+        # @param [String] application_id The application ID.
+        # @param [String] token The token.
+        #
         def initialize(client, data, application_id, token)
           @client = client
           @data = data
@@ -128,6 +136,10 @@ module Discorb
             @client.http.request(Route.new("/webhooks/#{@application_id}/#{@token}/messages/@original", "//webhooks/:webhook_id/:token/messages/@original", :delete)).wait
           end
         end
+
+        def inspect
+          "#<#{self.class.name} application_id=#{@application_id}"
+        end
       end
     end
 

data/lib/discorb/interaction/root.rb

@@ -38,7 +38,13 @@ module Discorb
     @interaction_type = nil
     @interaction_name = nil
 
+    #
+    # Initialize a new interaction.
     # @private
+    #
+    # @param [Discorb::Client] client The client this interaction belongs to.
+    # @param [Hash] data The data of the interaction.
+    #
     def initialize(client, data)
       @client = client
       @id = Snowflake.new(data[:id])
@@ -81,7 +87,13 @@ module Discorb
       # @private
       attr_reader :interaction_type, :interaction_name, :event_name
 
+      #
+      # Create a new Interaction instance from the data.
       # @private
+      #
+      # @param [Discorb::Client] client The client this interaction belongs to.
+      # @param [Hash] data The data of the interaction.
+      #
       def make_interaction(client, data)
         interaction = nil
         descendants.each do |klass|
@@ -94,7 +106,10 @@ module Discorb
         interaction
       end
 
+      #
+      # Returns the descendants of the class.
       # @private
+      #
       def descendants
         ObjectSpace.each_object(Class).select { |klass| klass < self }
       end