discordrb 3.1.1 → 3.4.0

data/lib/discordrb/data/embed.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+module Discordrb
+  # An Embed object that is contained in a message
+  # A freshly generated embed object will not appear in a message object
+  # unless grabbed from its ID in a channel.
+  class Embed
+    # @return [Message] the message this embed object is contained in.
+    attr_reader :message
+
+    # @return [String] the URL this embed object is based on.
+    attr_reader :url
+
+    # @return [String, nil] the title of the embed object. `nil` if there is not a title
+    attr_reader :title
+
+    # @return [String, nil] the description of the embed object. `nil` if there is not a description
+    attr_reader :description
+
+    # @return [Symbol] the type of the embed object. Possible types are:
+    #
+    #   * `:link`
+    #   * `:video`
+    #   * `:image`
+    attr_reader :type
+
+    # @return [Time, nil] the timestamp of the embed object. `nil` if there is not a timestamp
+    attr_reader :timestamp
+
+    # @return [String, nil] the color of the embed object. `nil` if there is not a color
+    attr_reader :color
+    alias_method :colour, :color
+
+    # @return [EmbedFooter, nil] the footer of the embed object. `nil` if there is not a footer
+    attr_reader :footer
+
+    # @return [EmbedProvider, nil] the provider of the embed object. `nil` if there is not a provider
+    attr_reader :provider
+
+    # @return [EmbedImage, nil] the image of the embed object. `nil` if there is not an image
+    attr_reader :image
+
+    # @return [EmbedThumbnail, nil] the thumbnail of the embed object. `nil` if there is not a thumbnail
+    attr_reader :thumbnail
+
+    # @return [EmbedVideo, nil] the video of the embed object. `nil` if there is not a video
+    attr_reader :video
+
+    # @return [EmbedAuthor, nil] the author of the embed object. `nil` if there is not an author
+    attr_reader :author
+
+    # @return [Array<EmbedField>, nil] the fields of the embed object. `nil` if there are no fields
+    attr_reader :fields
+
+    # @!visibility private
+    def initialize(data, message)
+      @message = message
+
+      @url = data['url']
+      @title = data['title']
+      @type = data['type'].to_sym
+      @description = data['description']
+      @timestamp = data['timestamp'].nil? ? nil : Time.parse(data['timestamp'])
+      @color = data['color']
+      @footer = data['footer'].nil? ? nil : EmbedFooter.new(data['footer'], self)
+      @image = data['image'].nil? ? nil : EmbedImage.new(data['image'], self)
+      @video = data['video'].nil? ? nil : EmbedVideo.new(data['video'], self)
+      @provider = data['provider'].nil? ? nil : EmbedProvider.new(data['provider'], self)
+      @thumbnail = data['thumbnail'].nil? ? nil : EmbedThumbnail.new(data['thumbnail'], self)
+      @author = data['author'].nil? ? nil : EmbedAuthor.new(data['author'], self)
+      @fields = data['fields'].nil? ? nil : data['fields'].map { |field| EmbedField.new(field, self) }
+    end
+  end
+
+  # An Embed footer for the embed object.
+  class EmbedFooter
+    # @return [Embed] the embed object this is based on.
+    attr_reader :embed
+
+    # @return [String] the footer text.
+    attr_reader :text
+
+    # @return [String] the URL of the footer icon.
+    attr_reader :icon_url
+
+    # @return [String] the proxied URL of the footer icon.
+    attr_reader :proxy_icon_url
+
+    # @!visibility private
+    def initialize(data, embed)
+      @embed = embed
+
+      @text = data['text']
+      @icon_url = data['icon_url']
+      @proxy_icon_url = data['proxy_icon_url']
+    end
+  end
+
+  # An Embed image for the embed object.
+  class EmbedImage
+    # @return [Embed] the embed object this is based on.
+    attr_reader :embed
+
+    # @return [String] the source URL of the image.
+    attr_reader :url
+
+    # @return [String] the proxy URL of the image.
+    attr_reader :proxy_url
+
+    # @return [Integer] the width of the image, in pixels.
+    attr_reader :width
+
+    # @return [Integer] the height of the image, in pixels.
+    attr_reader :height
+
+    # @!visibility private
+    def initialize(data, embed)
+      @embed = embed
+
+      @url = data['url']
+      @proxy_url = data['proxy_url']
+      @width = data['width']
+      @height = data['height']
+    end
+  end
+
+  # An Embed video for the embed object
+  class EmbedVideo
+    # @return [Embed] the embed object this is based on.
+    attr_reader :embed
+
+    # @return [String] the source URL of the video.
+    attr_reader :url
+
+    # @return [Integer] the width of the video, in pixels.
+    attr_reader :width
+
+    # @return [Integer] the height of the video, in pixels.
+    attr_reader :height
+
+    # @!visibility private
+    def initialize(data, embed)
+      @embed = embed
+
+      @url = data['url']
+      @width = data['width']
+      @height = data['height']
+    end
+  end
+
+  # An Embed thumbnail for the embed object
+  class EmbedThumbnail
+    # @return [Embed] the embed object this is based on.
+    attr_reader :embed
+
+    # @return [String] the CDN URL this thumbnail can be downloaded at.
+    attr_reader :url
+
+    # @return [String] the thumbnail's proxy URL - I'm not sure what exactly this does, but I think it has something to
+    #   do with CDNs.
+    attr_reader :proxy_url
+
+    # @return [Integer] the width of this thumbnail file, in pixels.
+    attr_reader :width
+
+    # @return [Integer] the height of this thumbnail file, in pixels.
+    attr_reader :height
+
+    # @!visibility private
+    def initialize(data, embed)
+      @embed = embed
+
+      @url = data['url']
+      @proxy_url = data['proxy_url']
+      @width = data['width']
+      @height = data['height']
+    end
+  end
+
+  # An Embed provider for the embed object
+  class EmbedProvider
+    # @return [Embed] the embed object this is based on.
+    attr_reader :embed
+
+    # @return [String] the provider's name.
+    attr_reader :name
+
+    # @return [String, nil] the URL of the provider, or `nil` if there is no URL.
+    attr_reader :url
+
+    # @!visibility private
+    def initialize(data, embed)
+      @embed = embed
+
+      @name = data['name']
+      @url = data['url']
+    end
+  end
+
+  # An Embed author for the embed object
+  class EmbedAuthor
+    # @return [Embed] the embed object this is based on.
+    attr_reader :embed
+
+    # @return [String] the author's name.
+    attr_reader :name
+
+    # @return [String, nil] the URL of the author's website, or `nil` if there is no URL.
+    attr_reader :url
+
+    # @return [String, nil] the icon of the author, or `nil` if there is no icon.
+    attr_reader :icon_url
+
+    # @return [String, nil] the Discord proxy URL, or `nil` if there is no `icon_url`.
+    attr_reader :proxy_icon_url
+
+    # @!visibility private
+    def initialize(data, embed)
+      @embed = embed
+
+      @name = data['name']
+      @url = data['url']
+      @icon_url = data['icon_url']
+      @proxy_icon_url = data['proxy_icon_url']
+    end
+  end
+
+  # An Embed field for the embed object
+  class EmbedField
+    # @return [Embed] the embed object this is based on.
+    attr_reader :embed
+
+    # @return [String] the field's name.
+    attr_reader :name
+
+    # @return [String] the field's value.
+    attr_reader :value
+
+    # @return [true, false] whether this field is inline.
+    attr_reader :inline
+
+    # @!visibility private
+    def initialize(data, embed)
+      @embed = embed
+
+      @name = data['name']
+      @value = data['value']
+      @inline = data['inline']
+    end
+  end
+end

data/lib/discordrb/data/emoji.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Discordrb
+  # Server emoji
+  class Emoji
+    include IDObject
+
+    # @return [String] the emoji name
+    attr_reader :name
+
+    # @return [Server, nil] the server of this emoji
+    attr_reader :server
+
+    # @return [Array<Role>, nil] roles this emoji is active for, or nil if the emoji's server is unknown
+    attr_reader :roles
+
+    # @return [true, false] if the emoji is animated
+    attr_reader :animated
+    alias_method :animated?, :animated
+
+    # @!visibility private
+    def initialize(data, bot, server = nil)
+      @bot = bot
+      @roles = nil
+
+      @name = data['name']
+      @server = server
+      @id = data['id'].nil? ? nil : data['id'].to_i
+      @animated = data['animated']
+
+      process_roles(data['roles']) if server
+    end
+
+    # ID or name based comparison
+    def ==(other)
+      return false unless other.is_a? Emoji
+      return Discordrb.id_compare(@id, other) if @id
+
+      name == other.name
+    end
+
+    alias_method :eql?, :==
+
+    # @return [String] the layout to mention it (or have it used) in a message
+    def mention
+      return name if id.nil?
+
+      "<#{'a' if animated}:#{name}:#{id}>"
+    end
+
+    alias_method :use, :mention
+    alias_method :to_s, :mention
+
+    # @return [String] the layout to use this emoji in a reaction
+    def to_reaction
+      return name if id.nil?
+
+      "#{name}:#{id}"
+    end
+
+    # @return [String] the icon URL of the emoji
+    def icon_url
+      API.emoji_icon_url(id)
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "<Emoji name=#{name} id=#{id} animated=#{animated}>"
+    end
+
+    # @!visibility private
+    def process_roles(roles)
+      @roles = []
+      return unless roles
+
+      roles.each do |role_id|
+        role = server.role(role_id)
+        @roles << role
+      end
+    end
+  end
+end

data/lib/discordrb/data/integration.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Discordrb
+  # Integration Account
+  class IntegrationAccount
+    # @return [String] this account's name.
+    attr_reader :name
+
+    # @return [Integer] this account's ID.
+    attr_reader :id
+
+    def initialize(data)
+      @name = data['name']
+      @id = data['id'].to_i
+    end
+  end
+
+  # Server integration
+  class Integration
+    include IDObject
+
+    # @return [String] the integration name
+    attr_reader :name
+
+    # @return [Server] the server the integration is linked to
+    attr_reader :server
+
+    # @return [User] the user the integration is linked to
+    attr_reader :user
+
+    # @return [Role, nil] the role that this integration uses for "subscribers"
+    attr_reader :role
+
+    # @return [true, false] whether emoticons are enabled
+    attr_reader :emoticon
+    alias_method :emoticon?, :emoticon
+
+    # @return [String] the integration type (YouTube, Twitch, etc.)
+    attr_reader :type
+
+    # @return [true, false] whether the integration is enabled
+    attr_reader :enabled
+
+    # @return [true, false] whether the integration is syncing
+    attr_reader :syncing
+
+    # @return [IntegrationAccount] the integration account information
+    attr_reader :account
+
+    # @return [Time] the time the integration was synced at
+    attr_reader :synced_at
+
+    # @return [Symbol] the behaviour of expiring subscribers (:remove = Remove User from role; :kick = Kick User from server)
+    attr_reader :expire_behaviour
+    alias_method :expire_behavior, :expire_behaviour
+
+    # @return [Integer] the grace period before subscribers expire (in days)
+    attr_reader :expire_grace_period
+
+    def initialize(data, bot, server)
+      @bot = bot
+
+      @name = data['name']
+      @server = server
+      @id = data['id'].to_i
+      @enabled = data['enabled']
+      @syncing = data['syncing']
+      @type = data['type']
+      @account = IntegrationAccount.new(data['account'])
+      @synced_at = Time.parse(data['synced_at'])
+      @expire_behaviour = %i[remove kick][data['expire_behavior']]
+      @expire_grace_period = data['expire_grace_period']
+      @user = @bot.ensure_user(data['user'])
+      @role = server.role(data['role_id']) || nil
+      @emoticon = data['enable_emoticons']
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "<Integration name=#{@name} id=#{@id} type=#{@type} enabled=#{@enabled}>"
+    end
+  end
+end

data/lib/discordrb/data/invite.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Discordrb
+  # A channel referenced by an invite. It has less data than regular channels, so it's a separate class
+  class InviteChannel
+    include IDObject
+
+    # @return [String] this channel's name.
+    attr_reader :name
+
+    # @return [Integer] this channel's type (0: text, 1: private, 2: voice, 3: group).
+    attr_reader :type
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+
+      @id = data['id'].to_i
+      @name = data['name']
+      @type = data['type']
+    end
+  end
+
+  # A server referenced to by an invite
+  class InviteServer
+    include IDObject
+
+    # @return [String] this server's name.
+    attr_reader :name
+
+    # @return [String, nil] the hash of the server's invite splash screen (for partnered servers) or nil if none is
+    #   present
+    attr_reader :splash_hash
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+
+      @id = data['id'].to_i
+      @name = data['name']
+      @splash_hash = data['splash_hash']
+    end
+  end
+
+  # A Discord invite to a channel
+  class Invite
+    # @return [InviteChannel, Channel] the channel this invite references.
+    attr_reader :channel
+
+    # @return [InviteServer, Server] the server this invite references.
+    attr_reader :server
+
+    # @return [Integer] the amount of uses left on this invite.
+    attr_reader :uses
+    alias_method :max_uses, :uses
+
+    # @return [User, nil] the user that made this invite. May also be nil if the user can't be determined.
+    attr_reader :inviter
+    alias_method :user, :inviter
+
+    # @return [true, false] whether or not this invite grants temporary membership. If someone joins a server with this invite, they will be removed from the server when they go offline unless they've received a role.
+    attr_reader :temporary
+    alias_method :temporary?, :temporary
+
+    # @return [true, false] whether this invite is still valid.
+    attr_reader :revoked
+    alias_method :revoked?, :revoked
+
+    # @return [String] this invite's code
+    attr_reader :code
+
+    # @return [Integer, nil] the amount of members in the server. Will be nil if it has not been resolved.
+    attr_reader :member_count
+    alias_method :user_count, :member_count
+
+    # @return [Integer, nil] the amount of online members in the server. Will be nil if it has not been resolved.
+    attr_reader :online_member_count
+    alias_method :online_user_count, :online_member_count
+
+    # @return [Integer, nil] the invites max age before it expires, or nil if it's unknown. If the max age is 0, the invite will never expire unless it's deleted.
+    attr_reader :max_age
+
+    # @return [Time, nil] when this invite was created, or nil if it's unknown
+    attr_reader :created_at
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+
+      @channel = if data['channel_id'] || bot.channel
+                   bot.channel(data['channel_id'])
+                 else
+                   InviteChannel.new(data['channel'], bot)
+                 end
+
+      @server = if data['guild_id']
+                  bot.server(data['guild_id'])
+                else
+                  InviteServer.new(data['guild'], bot)
+                end
+
+      @uses = data['uses']
+      @inviter = data['inviter'] ? (@bot.user(data['inviter']['id'].to_i) || User.new(data['inviter'], bot)) : nil
+      @temporary = data['temporary']
+      @revoked = data['revoked']
+      @online_member_count = data['approximate_presence_count']
+      @member_count = data['approximate_member_count']
+      @max_age = data['max_age']
+      @created_at = data['created_at']
+
+      @code = data['code']
+    end
+
+    # Code based comparison
+    def ==(other)
+      other.respond_to?(:code) ? (@code == other.code) : (@code == other)
+    end
+
+    # Deletes this invite
+    # @param reason [String] The reason the invite is being deleted.
+    def delete(reason = nil)
+      API::Invite.delete(@bot.token, @code, reason)
+    end
+
+    alias_method :revoke, :delete
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "<Invite code=#{@code} channel=#{@channel} uses=#{@uses} temporary=#{@temporary} revoked=#{@revoked} created_at=#{@created_at} max_age=#{@max_age}>"
+    end
+
+    # Creates an invite URL.
+    def url
+      "https://discord.gg/#{@code}"
+    end
+  end
+end