onyxcord 1.1.0

data/lib/onyxcord/data/embed.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+module OnyxCord
+  # 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 [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
+
+    # @return [Message, nil] the message this embed object is contained in.
+    def message
+      @message unless @message.is_a?(Snapshot)
+    end
+
+    # @return [Snapshot, nil] the message snapshot this embed object is contained in.
+    def snapshot
+      @message unless @message.is_a?(Message)
+    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/onyxcord/data/emoji.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module OnyxCord
+  # 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 [User, nil] the user who uploaded this emoji, or nil if the emoji's server is unknown
+    attr_reader :creator
+
+    # @return [Boolean, nil] if the emoji requires colons to be used, or nil if the emoji's server is unknown
+    attr_reader :requires_colons
+    alias_method :requires_colons?, :requires_colons
+
+    # @return [Boolean, nil] whether this emoji is managed by an integration, or nil if the emoji's server is unknown
+    attr_reader :managed
+    alias_method :managed?, :managed
+
+    # @return [Boolean, nil] if this emoji is currently usable, or nil if the emoji's server is unknown
+    attr_reader :available
+    alias_method :available?, :available
+
+    # @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']&.to_i
+      @animated = data['animated'] || false
+      @managed = data['managed']
+      @available = data['available']
+      @requires_colons = data['require_colons']
+      @creator = data['user'] ? bot.ensure_user(data['user']) : nil
+
+      process_roles(data['roles']) if server
+    end
+
+    # ID or name based comparison
+    def ==(other)
+      return false unless other.is_a? Emoji
+      return OnyxCord.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.inspect} id=#{id.inspect} animated=#{animated}>"
+    end
+
+    # Converts this Emoji into a hash that can be sent back to Discord in other endpoints.
+    # @return [Hash] A hash representation of this emoji.
+    def to_h
+      id.nil? ? { name: name } : { id: id }
+    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
+
+    # @!visibility private
+    def self.build_emoji_hash(emoji, prefix: true)
+      data = { id: nil, name: nil }
+
+      case emoji
+      when Emoji, Reaction
+        emoji.id ? data[:id] = emoji.id : data[:name] = emoji.name
+      when Integer, String
+        emoji.to_i.zero? ? data[:name] = emoji : data[:id] = emoji
+      else
+        raise TypeError, "Invalid emoji type: #{emoji.class}" unless emoji.nil?
+      end
+
+      prefix ? data.transform_keys!({ id: :emoji_id, name: :emoji_name }) : data
+    end
+  end
+end

data/lib/onyxcord/data/install_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OnyxCord
+  # Default installation parameters for an application.
+  class InstallParams
+    # @return [Array<String>] the default scopes to add an application to a server with.
+    attr_reader :scopes
+
+    # @return [Permissions, nil] the default permissions to add an application to a server with.
+    attr_reader :permissions
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @scopes = data['scopes'] || []
+      @permissions = data['permissions'] ? Permissions.new(data['permissions']) : nil
+    end
+
+    # @!visibility private
+    def to_h
+      { scopes: @scopes.any? ? @scopes : nil, permissions: @permissions&.bits&.to_s }.compact
+    end
+  end
+end

data/lib/onyxcord/data/integration.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module OnyxCord
+  # Integration Account
+  class IntegrationAccount
+    include IDObject
+
+    # @return [String] this account's name.
+    attr_reader :name
+
+    # @!visibility private
+    def initialize(data)
+      @id = data['id'].to_i
+      @name = data['name']
+    end
+  end
+
+  # Bot/OAuth2 application for discord integrations
+  class IntegrationApplication
+    include IDObject
+
+    # @return [String] the name of the application.
+    attr_reader :name
+
+    # @return [String, nil] the icon hash of the application.
+    attr_reader :icon
+
+    # @return [String] the description of the application.
+    attr_reader :description
+
+    # @return [User, nil] the bot associated with this application.
+    attr_reader :bot
+
+    # @!visibility private
+    def initialize(data, bot)
+      @id = data['id'].to_i
+      @name = data['name']
+      @icon = data['icon']
+      @description = data['description']
+      @bot = bot.ensure_user(data['bot']) if data['bot']
+    end
+  end
+
+  # Server integration
+  class Integration
+    include IDObject
+
+    # Map of expire behaviors.
+    EXPIRE_BEHAVIORS = {
+      remove: 0,
+      kick: 1
+    }.freeze
+
+    # @return [String] the integration name
+    attr_reader :name
+
+    # @return [Server] the server the integration is linked to
+    attr_reader :server
+
+    # @return [User, nil] the user who added the integration to the server. This will be `nil`
+    #  for very old integrations, or if the integration was sent via a Gateway event.
+    attr_reader :user
+
+    # @return [Integer, nil] the ID of the role that this integration uses for "subscribers"
+    attr_reader :role_id
+
+    # @return [true, false] whether or not emoticons are enabled
+    attr_reader :emoticon
+    alias_method :emoticon?, :emoticon
+    alias_method :emoticons?, :emoticon
+
+    # @return [String] the integration type (YouTube, Twitch, Discord, etc.)
+    attr_reader :type
+
+    # @return [true, false] whether the integration is enabled
+    attr_reader :enabled
+    alias_method :enabled?, :enabled
+
+    # @return [true, false] whether or not the integration is syncing
+    attr_reader :syncing
+    alias_method :syncing?, :syncing
+
+    # @return [IntegrationAccount] the integration account information
+    attr_reader :account
+
+    # @return [Time, nil] the time the integration was last synced at
+    attr_reader :synced_at
+
+    # @return [Symbol, nil] the behaviour of expiring subscribers. When this is `:remove`, the
+    #  associated role will be removed from the user. When this is `:kick`, the user will be
+    #  kicked out of the 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
+
+    # @return [Integer, nil] how many subscribers this integration has.
+    attr_reader :subscriber_count
+
+    # @return [true, false] whether or not this integration been revoked.
+    attr_reader :revoked
+    alias_method :revoked?, :revoked
+
+    # @return [IntegrationApplication, nil] the application for the integration.
+    attr_reader :application
+
+    # @return [Array<String>] the oauth2 scopes the application has been authorized for
+    attr_reader :scopes
+
+    # @!visibility private
+    def initialize(data, bot, server)
+      @bot = bot
+      @server = server
+      @id = data['id'].to_i
+      @name = data['name']
+      @enabled = data['enabled']
+      @syncing = data['syncing'] || false
+      @type = data['type']
+      @account = IntegrationAccount.new(data['account'])
+      @synced_at = Time.parse(data['synced_at']) if data['synced_at']
+      @expire_behaviour = EXPIRE_BEHAVIORS.key(data['expire_behavior']) if data['expire_behavior']
+      @expire_grace_period = data['expire_grace_period'] || 0
+      @user = @bot.ensure_user(data['user']) if data['user']
+      @role_id = data['role_id']&.to_i
+      @emoticon = data['enable_emoticons'] || false
+      @subscriber_count = data['subscriber_count']&.to_i
+      @revoked = data['revoked'] || false
+      @application = IntegrationApplication.new(data['application'], bot) if data['application']
+      @scopes = data['scopes'] || []
+    end
+
+    # Get the role that this integration uses for subscribers.
+    # @return [Role, nil] The role that this integration uses for subscribers.
+    def subscriber_role
+      @server.role(@role_id) if @role_id
+    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