discorb 0.0.1

data/lib/discorb/embed.rb

@@ -0,0 +1,345 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents an embed of discord.
+  #
+  class Embed
+    # @return [String, nil] The title of embed.
+    attr_accessor :title
+    # @return [String, nil] The description of embed.
+    attr_accessor :description
+    # @return [String, nil] The url of embed.
+    attr_accessor :url
+    # @return [Time, nil] The timestamp of embed.
+    attr_accessor :timestamp
+    # @return [Discorb::Color, nil] The color of embed.
+    attr_accessor :color
+    # @return [Discorb::Embed::Author, nil] The author of embed.
+    attr_accessor :author
+    # @return [Array<Discorb::Embed::Field>] The fields of embed.
+    attr_accessor :fields
+    # @return [Discorb::Embed::Footer, nil] The footer of embed.
+    attr_accessor :footer
+    # @return [Symbol] The type of embed.
+    attr_reader :type
+    attr_reader :image, :thumbnail
+
+    # @!attribute [rw] image
+    #   @return [Discorb::Embed::Image] The image of embed.
+    # @!attribute [rw] thumbnail
+    #   @return [Discorb::Embed::Thumbnail] The thumbnail of embed.
+
+    #
+    # Initialize a new Embed object.
+    #
+    # @param [String] title The title of embed.
+    # @param [String] description The description of embed.
+    # @param [Discorb::Color] color The color of embed.
+    # @param [String] url The url of embed.
+    # @param [Time] timestamp The timestamp of embed.
+    # @param [Discorb::Embed::Author] author The author field of embed.
+    # @param [Array<Discorb::Embed::Field>] fields The fields of embed.
+    # @param [Discorb::Embed::Footer] footer The footer of embed.
+    # @param [Discorb::Embed::Image] image The image of embed.
+    # @param [Discorb::Embed::Thumbnail] 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, data: nil)
+      if data.nil?
+        @title = title
+        @description = description
+        @url = url
+        @timestamp = timestamp
+        @color = color
+        @author = author
+        @fields = fields || []
+        @footer = footer
+        @image = image
+        @thumbnail = thumbnail
+        @type = "rich"
+      else
+        @title = data[:title]
+        @description = data[:description]
+        @url = data[:url]
+        @timestamp = data[:timestamp] && Time.iso8601(data[:timestamp])
+        @type = data[:type]
+        @color = data[:color] && Color.new(data[:color])
+        @footer = data[:footer] && Footer.new(data[:footer][:text], icon: data[:footer][:icon])
+        @author = if data[:author]
+            Author.new(data[:author][:name], icon: data[:author][:icon],
+                                             url: data[:author][:url])
+          end
+        @thumbnail = data[:thumbnail] && Thumbnail.new(data[:thumbnail])
+        @image = data[:image] && Image.new(data[:image])
+        @video = data[:video] && Video.new(data[:video])
+        @provider = data[:provider] && Provider.new(data[:provider])
+        @fields = data[:fields] ? data[:fields].map { |f| Field.new(f[:name], f[:value], inline: f[:inline]) } : []
+      end
+    end
+
+    def image=(value)
+      @image = value.is_a? String ? Image.new(value) : value
+    end
+
+    def thumbnail=(value)
+      @thumbnail = value.is_a? String ? Thumbnail.new(value) : value
+    end
+
+    #
+    # Convert embed to hash.
+    #
+    # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-structure Offical Discord API Docs
+    # @return [Hash] Converted embed.
+    #
+    def to_hash
+      {
+        title: @title,
+        description: @description,
+        url: @url,
+        timestamp: @timestamp&.iso8601,
+        color: @color&.to_i,
+        footer: @footer&.to_hash,
+        image: @image&.to_hash,
+        thumbnail: @thumbnail&.to_hash,
+        author: @author&.to_hash,
+        fields: @fields&.map { |f| f.to_hash },
+      }
+    end
+
+    #
+    # Represents an author of embed.
+    #
+    class Author
+      # @return [String] The name of author.
+      attr_accessor :name
+      # @return [String, nil] The url of author.
+      attr_accessor :url
+      # @return [String, nil] The icon url of author.
+      attr_accessor :icon
+
+      #
+      # Initialize a new Author object.
+      #
+      # @param [String] name The name of author.
+      # @param [String] url The url of author.
+      # @param [String] icon The icon url of author.
+      #
+      def initialize(name, url: nil, icon: nil)
+        @name = name
+        @url = url
+        @icon = icon
+      end
+
+      #
+      # Convert author to hash.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure Offical Discord API Docs
+      # @return [Hash] Converted author.
+      #
+      def to_hash
+        {
+          name: @name,
+          url: @url,
+          icon_url: @icon,
+        }
+      end
+    end
+
+    #
+    # Represemts a footer of embed.
+    #
+    class Footer
+      attr_accessor :text, :icon
+
+      #
+      # Initialize a new Footer object.
+      #
+      # @param [String] text The text of footer.
+      # @param [String] icon The icon url of footer.
+      #
+      def initialize(text, icon: nil)
+        @text = text
+        @icon = icon
+      end
+
+      #
+      # Convert footer to hash.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure Offical Discord API Docs
+      # @return [Hash] Converted footer.
+      #
+      def to_hash
+        {
+          text: @text,
+          icon_url: @icon,
+        }
+      end
+    end
+
+    #
+    # Represents a field of embed.
+    #
+    class Field
+      # @return [String] The name of field.
+      attr_accessor :name
+      # @return [String] The value of field.
+      attr_accessor :value
+      # @return [Boolean] Whether the field is inline.
+      attr_accessor :inline
+
+      #
+      # Initialize a new Field object.
+      #
+      # @param [String] name The name of field.
+      # @param [String] value The value of field.
+      # @param [Boolean] inline Whether the field is inline.
+      #
+      def initialize(name, value, inline: true)
+        @name = name
+        @value = value
+        @inline = inline
+      end
+
+      #
+      # Convert field to hash.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure Offical Discord API Docs
+      # @return [Hash] Converted field.
+      #
+      def to_hash
+        {
+          name: @name,
+          value: @value,
+          inline: @inline,
+        }
+      end
+    end
+
+    #
+    # Represents an image of embed.
+    #
+    class Image
+      # @return [String] The url of image.
+      attr_accessor :url
+      # @return [String] The proxy url of image.
+      # @return [nil] The Image object wasn't created from gateway.
+      attr_reader :proxy_url
+      # @return [Integer] The height of image.
+      # @return [nil] The Image object wasn't created from gateway.
+      attr_reader :height
+      # @return [Integer] The width of image.
+      # @return [nil] The Image object wasn't created from gateway.
+      attr_reader :width
+
+      #
+      # Initialize a new Image object.
+      #
+      # @param [String] url URL of image.
+      #
+      def initialize(url)
+        data = url
+        if data.is_a? String
+          @url = data
+        else
+          @url = data[:url]
+          @proxy_url = data[:proxy_url]
+          @height = data[:height]
+          @width = data[:width]
+        end
+      end
+
+      #
+      # Convert image to hash for sending.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure Offical Discord API Docs
+      # @return [Hash] Converted image.
+      #
+      def to_hash
+        { url: @url }
+      end
+    end
+
+    #
+    # Represents a thumbnail of embed.
+    #
+    class Thumbnail
+      # @return [String] The url of thumbnail.
+      attr_accessor :url
+      # @return [String] The proxy url of thumbnail.
+      # @return [nil] The Thumbnail object wasn't created from gateway.
+      attr_reader :proxy_url
+      # @return [Integer] The height of thumbnail.
+      # @return [nil] The Thumbnail object wasn't created from gateway.
+      attr_reader :height
+      # @return [Integer] The width of thumbnail.
+      # @return [nil] The Thumbnail object wasn't created from gateway.
+      attr_reader :width
+
+      #
+      # Initialize a new Thumbnail object.
+      #
+      # @param [String] url URL of thumbnail.
+      #
+      def initialize(url)
+        data = url
+        if data.is_a? String
+          @url = data
+        else
+          @url = data[:url]
+          @proxy_url = data[:proxy_url]
+          @height = data[:height]
+          @width = data[:width]
+        end
+      end
+
+      #
+      # Convert thumbnail to hash for sending.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure Offical Discord API Docs
+      # @return [Hash] Converted thumbnail.
+      #
+      def to_hash
+        { url: @url }
+      end
+    end
+
+    #
+    # Represents a video of embed.
+    #
+    class Video
+      # @return [String] The url of video.
+      attr_reader :url
+      # @return [String] The proxy url of video.
+      attr_reader :proxy_url
+      # @return [Integer] The height of video.
+      attr_reader :height
+      # @return [Integer] The width of video.
+      attr_reader :width
+
+      # @!visibility private
+      def initialize(data)
+        @url = data[:url]
+        @proxy_url = data[:proxy_url]
+        @height = data[:height]
+        @width = data[:width]
+      end
+    end
+
+    #
+    # Represents a provider of embed.
+    #
+    class Provider
+      # @return [String] The name of provider.
+      attr_reader :name
+      # @return [String] The url of provider.
+      attr_reader :url
+
+      # @!visibility private
+      def initialize(name, url)
+        @name = name
+        @url = url
+      end
+    end
+  end
+end

data/lib/discorb/emoji.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Discorb
+  # Represents a Discord emoji.
+  # @abstract
+  class Emoji
+  end
+
+  # Represents a custom emoji in discord.
+  class CustomEmoji < Emoji
+    # @return [Discorb::Snowflake] The ID of the emoji.
+    attr_reader :id
+    # @return [String] The name of the emoji.
+    attr_reader :name
+    # @return [Array<Discorb::Role>] The roles that can use this emoji.
+    attr_reader :roles
+    # @return [Discorb::User] The user that created this emoji.
+    attr_reader :user
+    # @return [Boolean] Whether the emoji requires colons.
+    attr_reader :guild
+    # @return [Boolean] whether the emoji is managed by integration (ex: Twitch).
+    attr_reader :managed
+    alias managed? managed
+    # @return [Boolean] whether the emoji requires colons.
+    attr_reader :require_colons
+    alias require_colons? require_colons
+    # @return [Boolean] whether the emoji is available.
+    attr_reader :available
+    alias available? available
+
+    # @!attribute [r] roles?
+    #   @return [Boolean] whether or not this emoji is restricted to certain roles.
+
+    # @!visibility private
+    def initialize(client, guild, data)
+      @client = client
+      @guild = guild
+      @data = {}
+      _set_data(data)
+    end
+
+    #
+    # Format the emoji for sending.
+    #
+    # @return [String] the formatted emoji.
+    #
+    def to_s
+      "<#{@animated ? "a" : ""}:#{@name}:#{id}>"
+    end
+
+    #
+    # Format the emoji for URI.
+    #
+    # @return [String] the formatted emoji.
+    #
+    def to_uri
+      "#{@name}:#{@id}"
+    end
+
+    def roles?
+      @roles != []
+    end
+
+    alias role? roles?
+
+    def inspect
+      "#<#{self.class} id=#{@id} :#{@name}:>"
+    end
+
+    #
+    # Edit the emoji.
+    # @macro async
+    # @macro http
+    # @macro edit
+    #
+    # @param [String] name The new name of the emoji.
+    # @param [Array<Discorb::Role>] roles The new roles that can use this emoji.
+    # @param [String] reason The reason for editing the emoji.
+    #
+    # @return [self] The edited emoji.
+    #
+    def edit(name: :unset, roles: :unset, reason: nil)
+      Async do
+        payload = {}
+        payload[:name] = name if name != :unset
+        payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != :unset
+        @client.internet.patch("/guilds/#{@guild.id}/emojis/#{@id}", payload, audit_log_reason: reason)
+        self
+      end
+    end
+
+    alias modify edit
+
+    #
+    # Delete the emoji.
+    # @macro async
+    # @macro http
+    #
+    # @param [String] reason The reason for deleting the emoji.
+    #
+    # @return [self] The deleted emoji.
+    #
+    def delete!(reason: nil)
+      Async do
+        @client.internet.delete("/guilds/#{@guild.id}/emojis/#{@id}", audit_log_reason: reason).wait
+        @available = false
+        self
+      end
+    end
+
+    alias destroy! delete!
+
+    private
+
+    def _set_data(data)
+      @id = Snowflake.new(data[:id])
+      @name = data[:name]
+      @roles = data[:role] ? data[:role].map { |r| Role.new(@client, r) } : []
+      @user = User.new(@client, data[:user]) if data[:user]
+      @require_colons = data[:require_colons]
+      @managed = data[:managed]
+      @animated = data[:animated]
+      @available = data[:available]
+      @guild.emojis[@id] = self unless data[:no_cache]
+      @data.update(data)
+    end
+  end
+
+  #
+  # Represents a partial custom emoji in discord.
+  #
+  class PartialEmoji < DiscordModel
+    # @return [Discorb::Snowflake] The ID of the emoji.
+    attr_reader :id
+    # @return [String] The name of the emoji.
+    attr_reader :name
+    # @return [Boolean] Whether the emoji is deleted.
+    attr_reader :deleted
+    alias deleted? deleted
+
+    # @!visibility private
+    def initialize(data)
+      @id = Snowflake.new(data[:id])
+      @name = data[:name]
+      @animated = data[:animated]
+      @deleted = @name.nil?
+    end
+
+    #
+    # Format the emoji for URI.
+    #
+    # @return [String] the formatted emoji.
+    #
+    def to_uri
+      "#{@name}:#{@id}"
+    end
+
+    def inspect
+      "#<#{self.class} id=#{@id} :#{@name}:>"
+    end
+
+    #
+    # Format the emoji for sending.
+    #
+    # @return [String] the formatted emoji.
+    #
+    def to_s
+      "<#{@animated ? "a" : ""}:#{@name}:#{@id}>"
+    end
+  end
+
+  #
+  # Represents a unicode emoji (default emoji) in discord.
+  #
+  class UnicodeEmoji < Emoji
+    # @return [String] The name of the emoji. (e.g. :grinning:)
+    attr_reader :name
+    # @return [String] The unicode value of the emoji. (e.g. U+1F600)
+    attr_reader :value
+
+    # @!visibility private
+    def initialize(name)
+      if EmojiTable::DISCORD_TO_UNICODE.key?(name)
+        @name = name
+        @value = EmojiTable::DISCORD_TO_UNICODE[name]
+      elsif EmojiTable::UNICODE_TO_DISCORD.key?(name)
+        @name = EmojiTable::UNICODE_TO_DISCORD[name][0]
+        @value = name
+      else
+        raise ArgumentError, "No such emoji: #{name}"
+      end
+    end
+
+    # @return [String] The unicode string of the emoji.
+    def to_s
+      @value
+    end
+
+    #
+    # Format the emoji for URI.
+    #
+    # @return [String] the formatted emoji.
+    #
+    def to_uri
+      URI.encode_www_form_component(@value)
+    end
+
+    def inspect
+      "#<#{self.class} :#{@name}:>"
+    end
+
+    class << self
+      alias [] new
+    end
+  end
+end