discorb 0.15.0 → 0.17.0

data/lib/discorb/embed.rb

@@ -44,8 +44,18 @@ module Discorb
     # @param [Discorb::Embed::Image, String] image The image of embed.
     # @param [Discorb::Embed::Thumbnail, String] thumbnail The thumbnail of embed.
     #
-    def initialize(title = nil, description = nil, color: nil, url: nil, timestamp: nil, author: nil,
-                                                   fields: nil, footer: nil, image: nil, thumbnail: nil)
+    def initialize(
+      title = nil,
+      description = nil,
+      color: nil,
+      url: nil,
+      timestamp: nil,
+      author: nil,
+      fields: nil,
+      footer: nil,
+      image: nil,
+      thumbnail: nil
+    )
       @title = title
       @description = description
       @url = url
@@ -59,7 +69,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 +133,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.
@@ -145,7 +171,8 @@ module Discorb
       #
       # Convert author to hash.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted author.
       #
       def to_hash
@@ -160,7 +187,7 @@ module Discorb
     #
     # Represemts a footer of embed.
     #
-    class Footer
+    class Footer < Entry
       attr_accessor :text, :icon
 
       #
@@ -177,7 +204,8 @@ module Discorb
       #
       # Convert footer to hash.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted footer.
       #
       def to_hash
@@ -191,7 +219,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.
@@ -215,7 +243,8 @@ module Discorb
       #
       # Convert field to hash.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted field.
       #
       def to_hash
@@ -230,7 +259,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.
@@ -263,7 +292,8 @@ module Discorb
       #
       # Convert image to hash for sending.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted image.
       #
       def to_hash
@@ -274,7 +304,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.
@@ -307,7 +337,8 @@ module Discorb
       #
       # Convert thumbnail to hash for sending.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted thumbnail.
       #
       def to_hash
@@ -318,7 +349,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 +359,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 +376,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
@@ -96,7 +103,10 @@ module Discorb
         payload = {}
         payload[:name] = name if name != Discorb::Unset
         payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != Discorb::Unset
-        @client.http.request(Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id", :patch), payload, audit_log_reason: reason)
+        @client.http.request(
+          Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id",
+                    :patch), payload, audit_log_reason: reason,
+        )
         self
       end
     end
@@ -113,7 +123,10 @@ module Discorb
     #
     def delete!(reason: nil)
       Async do
-        @client.http.request(Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id", :delete), audit_log_reason: reason).wait
+        @client.http.request(
+          Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id",
+                    :delete), {}, audit_log_reason: reason,
+        ).wait
         @available = false
         self
       end
@@ -121,7 +134,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 +153,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 +176,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 +223,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
@@ -208,10 +236,31 @@ module Discorb
       elsif EmojiTable::UNICODE_TO_DISCORD.key?(name)
         @name = EmojiTable::UNICODE_TO_DISCORD[name][0]
         @value = name
+      elsif EmojiTable::SKIN_TONES.any? { |t| name.include?(t) }
+        name2 = name.dup
+        EmojiTable::SKIN_TONES.each.with_index do |t, i|
+          next unless name2.include?(t)
+
+          @skin_tone = i
+          name2.sub!(t, "")
+          break
+        end
+        raise ArgumentError, "Invalid skin tone: #{tone}" unless @skin_tone
+
+        @name = EmojiTable::UNICODE_TO_DISCORD[name2]
+        @value = name
       else
         raise ArgumentError, "No such emoji: #{name}"
       end
-      @value += EmojiTable::SKIN_TONES[tone] if tone.positive?
+      if tone.positive?
+        unless @value = EmojiTable::DISCORD_TO_UNICODE["#{name}_tone#{tone}"]
+          raise ArgumentError,
+                "Invalid skin tone for emoji: #{name}"
+        end
+
+        @name = "#{name}_tone#{tone}"
+        @skin_tone = tone
+      end
     end
 
     # @return [String] The unicode string of the emoji.
@@ -232,7 +281,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,