discorb 0.15.0 → 0.15.1

data/lib/discorb/common.rb

@@ -4,7 +4,9 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v10"
   # @return [String] The version of discorb.
-  VERSION = "0.15.0"
+  VERSION = "0.15.1"
+  # @return [Array<Integer>] The version array of discorb.
+  VERSION_ARRAY = VERSION.split(".").map(&:to_i).freeze
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}".freeze
 
@@ -25,8 +27,11 @@ module Discorb
       end
     end
 
-    # @private
+    def inspect
+      "#<#{self.class}: #{@id}>"
+    end
 
+    # @private
     def hash
       @id.hash
     end
@@ -37,7 +42,12 @@ module Discorb
   #
   # @see https://discord.com/developers/docs/reference#snowflakes Official Discord API docs
   class Snowflake < String
+    #
+    # Initialize new snowflake.
     # @private
+    #
+    # @param [#to_s] value The value of the snowflake.
+    #
     def initialize(value)
       @value = value.to_i
       super(@value.to_s)
@@ -92,7 +102,7 @@ module Discorb
     end
 
     def timestamp
-      Time.at(((@value >> 22) + 1_420_070_400_000) / 1000)
+      Time.at(((@value >> 22) + 1_420_070_400_000) / 1000.0)
     end
 
     def worker_id
@@ -127,6 +137,10 @@ module Discorb
       @method = method
     end
 
+    def inspect
+      "#<#{self.class} #{self.identifier}>"
+    end
+
     def hash
       @url.hash
     end

data/lib/discorb/components/button.rb

@@ -21,7 +21,9 @@ module Discorb
     attr_accessor :disabled
     alias disabled? disabled
 
-    @styles = {
+    # @private
+    # @return [{Symbol => Integer}] The mapping of button styles.
+    STYLES = {
       primary: 1,
       secondary: 2,
       success: 3,
@@ -59,7 +61,7 @@ module Discorb
         {
           type: 2,
           label: @label,
-          style: self.class.styles[@style],
+          style: STYLES[@style],
           url: @url,
           emoji: @emoji&.to_hash,
           disabled: @disabled,
@@ -68,7 +70,7 @@ module Discorb
         {
           type: 2,
           label: @label,
-          style: self.class.styles[@style],
+          style: STYLES[@style],
           custom_id: @custom_id,
           emoji: @emoji&.to_hash,
           disabled: @disabled,
@@ -81,9 +83,6 @@ module Discorb
     end
 
     class << self
-      # @private
-      attr_reader :styles
-
       #
       # Creates a new button from a hash.
       #

data/lib/discorb/components/select_menu.rb

@@ -122,22 +122,8 @@ module Discorb
         }
       end
 
-      # @private
-      def hash_emoji(emoji)
-        case emoji
-        when UnicodeEmoji
-          {
-            id: nil,
-            name: emoji.to_s,
-            animated: false,
-          }
-        when CustomEmoji
-          {
-            id: emoji.id,
-            name: emoji.name,
-            animated: emoji.animated?,
-          }
-        end
+      def inspect
+        "#<#{self.class} #{@label}: #{@value}>"
       end
 
       class << self

data/lib/discorb/dictionary.rb

@@ -55,6 +55,8 @@ module Discorb
       @cache.delete(id.to_s)
     end
 
+    alias delete remove
+
     #
     # Get an item from the dictionary.
     #

data/lib/discorb/embed.rb

@@ -59,7 +59,12 @@ module Discorb
       @type = "rich"
     end
 
+    #
+    # Initialize embed from hash.
     # @private
+    #
+    # @param [Hash] data The hash data to initialize embed.
+    #
     def initialize_hash(data)
       @title = data[:title]
       @description = data[:description]
@@ -118,10 +123,21 @@ module Discorb
       inst
     end
 
+    #
+    # Represents an entry in embed.
+    # @abstract
+    # @private
+    #
+    class Entry
+      def inspect
+        "#<#{self.class}>"
+      end
+    end
+
     #
     # Represents an author of embed.
     #
-    class Author
+    class Author < Entry
       # @return [String] The name of author.
       attr_accessor :name
       # @return [String, nil] The url of author.
@@ -160,7 +176,7 @@ module Discorb
     #
     # Represemts a footer of embed.
     #
-    class Footer
+    class Footer < Entry
       attr_accessor :text, :icon
 
       #
@@ -191,7 +207,7 @@ module Discorb
     #
     # Represents a field of embed.
     #
-    class Field
+    class Field < Entry
       # @return [String] The name of field.
       attr_accessor :name
       # @return [String] The value of field.
@@ -230,7 +246,7 @@ module Discorb
     #
     # Represents an image of embed.
     #
-    class Image
+    class Image < Entry
       # @return [String] The url of image.
       attr_accessor :url
       # @return [String] The proxy url of image.
@@ -274,7 +290,7 @@ module Discorb
     #
     # Represents a thumbnail of embed.
     #
-    class Thumbnail
+    class Thumbnail < Entry
       # @return [String] The url of thumbnail.
       attr_accessor :url
       # @return [String] The proxy url of thumbnail.
@@ -318,7 +334,7 @@ module Discorb
     #
     # Represents a video of embed.
     #
-    class Video
+    class Video < Entry
       # @return [String] The url of video.
       attr_reader :url
       # @return [String] The proxy url of video.
@@ -328,7 +344,12 @@ module Discorb
       # @return [Integer] The width of video.
       attr_reader :width
 
+      #
+      # Initialize a new Video object.
       # @private
+      #
+      # @param [Hash] data The data of video.
+      #
       def initialize(data)
         @url = data[:url]
         @proxy_url = data[:proxy_url]
@@ -340,13 +361,18 @@ module Discorb
     #
     # Represents a provider of embed.
     #
-    class Provider
+    class Provider < Entry
       # @return [String] The name of provider.
       attr_reader :name
       # @return [String] The url of provider.
       attr_reader :url
 
+      #
+      # Initialize a new Provider object.
       # @private
+      #
+      # @param [Hash] data The data of provider.
+      #
       def initialize(data)
         @name = data[:name]
         @url = data[:url]

data/lib/discorb/emoji.rb

@@ -44,7 +44,14 @@ module Discorb
     # @!attribute [r] roles?
     #   @return [Boolean] whether or not this emoji is restricted to certain roles.
 
+    #
+    # Initialize a new custom emoji.
     # @private
+    #
+    # @param [Discorb::Client] client The client that owns this emoji.
+    # @param [Discorb::Guild] guild The guild that owns this emoji.
+    # @param [Hash] data The data of the emoji.
+    #
     def initialize(client, guild, data)
       @client = client
       @guild = guild
@@ -121,7 +128,12 @@ module Discorb
 
     alias destroy! delete!
 
+    #
+    # Converts the object to a hash.
     # @private
+    #
+    # @return [Hash] The hash represents the object.
+    #
     def to_hash
       {
         name: @name,
@@ -135,7 +147,7 @@ module Discorb
     def _set_data(data)
       @id = Snowflake.new(data[:id])
       @name = data[:name]
-      @roles = data[:role] ? data[:role].map { |r| Role.new(@client, r) } : []
+      @roles = data[:role] ? data[:role].map { |r| Role.new(@client, guild, r) } : []
       @user = User.new(@client, data[:user]) if data[:user]
       @require_colons = data[:require_colons]
       @managed = data[:managed]
@@ -158,7 +170,12 @@ module Discorb
     attr_reader :deleted
     alias deleted? deleted
 
+    #
+    # Initialize a new partial custom emoji.
     # @private
+    #
+    # @param [Hash] data The data of the emoji.
+    #
     def initialize(data)
       @id = Snowflake.new(data[:id])
       @name = data[:name]
@@ -200,7 +217,12 @@ module Discorb
     # @return [Integer] The skin tone of the emoji.
     attr_reader :skin_tone
 
-    # @private
+    #
+    # Initialize a new unicode emoji.
+    #
+    # @param [String] name The name of the emoji.
+    # @param [Integer] tone The skin tone of the emoji.
+    #
     def initialize(name, tone: 0)
       if EmojiTable::DISCORD_TO_UNICODE.key?(name)
         @name = name
@@ -232,7 +254,12 @@ module Discorb
       "#<#{self.class} :#{@name}:>"
     end
 
+    #
+    # Converts the object to a hash.
     # @private
+    #
+    # @return [Hash] The hash represents the object.
+    #
     def to_hash
       {
         name: @value,

data/lib/discorb/emoji_table.rb

@@ -3885,7 +3885,7 @@ module Discorb
       "\xf0\x9f\x8f\xbc",
       "\xf0\x9f\x8f\xbd",
       "\xf0\x9f\x8f\xbe",
-      "\xf0\x9f\x8f\xbf"
+      "\xf0\x9f\x8f\xbf",
     ].freeze
   end
 end

data/lib/discorb/error.rb

@@ -42,7 +42,10 @@ module Discorb
     # @return [Net::HTTPResponse] the HTTP response.
     attr_reader :response
 
+    #
+    # Initialize a new instance of the HTTPError class.
     # @private
+    #
     def initialize(resp, data)
       @code = data[:code]
       @response = resp
@@ -54,7 +57,10 @@ module Discorb
   # Represents a 400 error.
   #
   class BadRequestError < HTTPError
+    #
+    # Initialize a new instance of the BadRequestError class.
     # @private
+    #
     def initialize(resp, data)
       @code = data[:code]
       @response = resp
@@ -62,7 +68,7 @@ module Discorb
         [
           data[:message] + " (#{@code})", enumerate_errors(data[:errors])
             .map { |ek, ev| "#{ek}=>#{ev}" }
-            .join("\n")
+            .join("\n"),
         ].join("\n")
       )
     end

data/lib/discorb/event.rb

@@ -4,20 +4,26 @@ module Discorb
   # Represents an event in guild.
   #
   class ScheduledEvent < DiscordModel
-    @privacy_level = {
+    # @private
+    # @return [{Integer => Symbol}] The mapping of privacy level.
+    PRIVACY_LEVEL = {
       2 => :guild_only,
-    }
-    @status = {
+    }.freeze
+    # @private
+    # @return [{Integer => Symbol}] The mapping of status.
+    STATUS = {
       1 => :scheduled,
       2 => :active,
       3 => :completed,
       4 => :canceled,
-    }
-    @entity_type = {
+    }.freeze
+    # @private
+    # @return [{Integer => Symbol}] The mapping of entity_type.
+    ENTITY_TYPE = {
       1 => :stage_instance,
       2 => :voice,
       3 => :external,
-    }
+    }.freeze
 
     # @!visibility private
     def initialize(client, data)
@@ -36,6 +42,10 @@ module Discorb
       def initialize(data)
         @location = data[:location]
       end
+
+      def inspect
+        "#<#{self.class.name} #{@name}>"
+      end
     end
 
     # @return [Discorb::Snowflake] The ID of the event.
@@ -132,10 +142,10 @@ 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) || Discorb::Unset,
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
               channel_id: channel&.id,
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:stage_instance),
-              status: Discorb::ScheduledEvent.status.key(status) || Discorb::Unset,
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:stage_instance),
+              status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
             }.reject { |_, v| v == Discorb::Unset }
           when :voice
             raise ArgumentError, "channel must be provided for voice events" unless channel
@@ -144,10 +154,10 @@ 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) || Discorb::Unset,
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
               channel_id: channel&.id,
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:voice),
-              status: Discorb::ScheduledEvent.status.key(status) || Discorb::Unset,
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:voice),
+              status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
             }.reject { |_, v| v == Discorb::Unset }
           when :external
             raise ArgumentError, "location must be provided for external events" unless location
@@ -158,12 +168,12 @@ module Discorb
               channel_id: nil,
               scheduled_start_time: start_time.iso8601,
               scheduled_end_time: end_time.iso8601,
-              privacy_level: Discorb::ScheduledEvent.privacy_level.key(privacy_level) || Discorb::Unset,
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:external),
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:external),
               entity_metadata: {
                 location: location,
               },
-              status: Discorb::ScheduledEvent.status.key(status) || Discorb::Unset,
+              status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
             }.reject { |_, v| v == Discorb::Unset }
           else
             raise ArgumentError, "Invalid scheduled event type: #{type}"
@@ -264,8 +274,8 @@ module Discorb
       @scheduled_start_time = Time.iso8601(data[:scheduled_start_time])
       @scheduled_end_time = data[:scheduled_end_time] && Time.iso8601(data[:scheduled_end_time])
       @privacy_level = :guild_only # data[:privacy_level]
-      @status = self.class.status[data[:status]]
-      @entity_type = self.class.entity_type[data[:entity_type]]
+      @status = STATUS[data[:status]]
+      @entity_type = ENTITY_TYPE[data[:entity_type]]
       @entity_id = data[:entity_id] && Snowflake.new(data[:entity_id])
       @entity_metadata = data[:entity_metadata] && Metadata.new(data[:entity_metadata])
       @creator = @client.users[@creator_id] || (data[:creator] && User.new(@client, data[:creator]))

data/lib/discorb/gateway.rb

@@ -14,12 +14,22 @@ module Discorb
   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
 
     #
@@ -61,7 +71,13 @@ module Discorb
       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
@@ -121,7 +137,14 @@ module Discorb
       #   @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]
@@ -157,7 +180,13 @@ module Discorb
       # @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
@@ -207,7 +236,13 @@ module Discorb
       # @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
@@ -246,7 +281,13 @@ module Discorb
       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])
@@ -342,7 +383,13 @@ module Discorb
       #   @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
@@ -374,7 +421,13 @@ module Discorb
       #   @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
@@ -392,21 +445,6 @@ module Discorb
       end
     end
 
-    #
-    # Represents a `GUILD_INTEGRATIONS_UPDATE` event.
-    #
-    class GuildIntegrationsUpdateEvent < GatewayEvent
-      def initialize(client, data)
-        @client = client
-        @data = data
-        @guild_id = Snowflake.new(data[:guild_id])
-      end
-
-      def guild
-        @client.guilds[@guild_id]
-      end
-    end
-
     #
     # Represents a `TYPING_START` event.
     #
@@ -430,7 +468,13 @@ module Discorb
       #   @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
@@ -507,7 +551,13 @@ module Discorb
       #   @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
@@ -718,7 +768,7 @@ module Discorb
               ready
             end
           elsif @guilds.has?(data[:id])
-            @guilds[data[:id]].send(:_set_data, data)
+            @guilds[data[:id]].send(:_set_data, data, true)
             dispatch(:guild_available, guild)
           else
             guild = Guild.new(self, data, true)
@@ -741,7 +791,7 @@ module Discorb
           return @log.warn "Unknown guild id #{data[:id]}, ignoring" unless (guild = @guilds.delete(data[:id]))
 
           dispatch(:guild_delete, guild)
-          if guild.has?(:unavailable)
+          if data[:unavailable]
             dispatch(:guild_destroy, guild)
           else
             dispatch(:guild_leave, guild)
@@ -815,7 +865,7 @@ module Discorb
 
           if (member = thread.members[data[:id]])
             old = ThreadChannel::Member.new(self, member.instance_variable_get(:@data))
-            member._set_data(data)
+            member.send(:_set_data, data)
           else
             old = nil
             member = ThreadChannel::Member.new(self, data)
@@ -902,8 +952,7 @@ module Discorb
             guild.emojis.delete(emoji)
           end
         when "GUILD_INTEGRATIONS_UPDATE"
-          # dispatch(:guild_integrations_update, GuildIntegrationsUpdateEvent.new(self, data))
-          # Currently not implemented
+          dispatch(:guild_integrations_update, @guilds[data[:guild_id]])
         when "INTEGRATION_CREATE"
           dispatch(:integration_create, Integration.new(self, data, data[:guild_id]))
         when "INTEGRATION_UPDATE"
@@ -1095,7 +1144,7 @@ module Discorb
              (target_reaction = target_message.reactions.find { |r| data[:emoji][:id].nil? ? r.name == data[:emoji][:name] : r.id == data[:emoji][:id] })
             target_message.reactions.delete(target_reaction)
           end
-          dispatch(:reaction_remove_emoji, ReactionRemoveEmojiEvent.new(data))
+          dispatch(:reaction_remove_emoji, ReactionRemoveEmojiEvent.new(self, data))
         when "TYPING_START"
           dispatch(:typing_start, TypingStartEvent.new(self, data))
         when "INTERACTION_CREATE"
@@ -1179,6 +1228,10 @@ module Discorb
         @closed = false
       end
 
+      def inspect
+        "<#{self.class.name} #{io.fileno}>"
+      end
+
       def closed?
         @closed
       end
@@ -1191,10 +1244,14 @@ module Discorb
       end
 
       def force_close
-        @framer.instance_variable_get(:@stream).instance_variable_get(:@io).instance_variable_get(:@io).instance_variable_get(:@io).close
+        io.close
         @closed = true
       end
 
+      def io
+        @framer.instance_variable_get(:@stream).instance_variable_get(:@io).instance_variable_get(:@io).instance_variable_get(:@io)
+      end
+
       def parse(buffer)
         # noop
         buffer.to_s