discordrb 3.3.0 → 3.5.0

data/lib/discordrb/data/component.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+module Discordrb
+  # Components are interactable interfaces that can be attached to messages.
+  module Components
+    # @deprecated This alias will be removed in future releases.
+    class View < Webhooks::View
+    end
+
+    # @!visibility private
+    def self.from_data(data, bot)
+      case data['type']
+      when Webhooks::View::COMPONENT_TYPES[:action_row]
+        ActionRow.new(data, bot)
+      when Webhooks::View::COMPONENT_TYPES[:button]
+        Button.new(data, bot)
+      when Webhooks::View::COMPONENT_TYPES[:string_select]
+        SelectMenu.new(data, bot)
+      when Webhooks::Modal::COMPONENT_TYPES[:text_input]
+        TextInput.new(data, bot)
+      end
+    end
+
+    # Represents a row of components
+    class ActionRow
+      include Enumerable
+
+      # @return [Array<Button>]
+      attr_reader :components
+
+      # @!visibility private
+      def initialize(data, bot)
+        @bot = bot
+        @components = data['components'].map { |component_data| Components.from_data(component_data, @bot) }
+      end
+
+      # Iterate over each component in the row.
+      def each(&block)
+        @components.each(&block)
+      end
+
+      # Get all buttons in this row
+      # @return [Array<Button>]
+      def buttons
+        select { |component| component.is_a? Button }
+      end
+
+      # Get all buttons in this row
+      # @return [Array<Button>]
+      def text_inputs
+        select { |component| component.is_a? TextInput }
+      end
+
+      # @!visibility private
+      def to_a
+        @components
+      end
+    end
+
+    # An interactable button component.
+    class Button
+      # @return [String]
+      attr_reader :label
+
+      # @return [Integer]
+      attr_reader :style
+
+      # @return [String]
+      attr_reader :custom_id
+
+      # @return [true, false]
+      attr_reader :disabled
+
+      # @return [String, nil]
+      attr_reader :url
+
+      # @return [Emoji, nil]
+      attr_reader :emoji
+
+      # @!visibility private
+      def initialize(data, bot)
+        @bot = bot
+
+        @label = data['label']
+        @style = data['style']
+        @custom_id = data['custom_id']
+        @disabled = data['disabled']
+        @url = data['url']
+        @emoji = Emoji.new(data['emoji'], @bot) if data['emoji']
+      end
+
+      # @method primary?
+      #   @return [true, false]
+      # @method secondary?
+      #   @return [true, false]
+      # @method success?
+      #   @return [true, false]
+      # @method danger?
+      #   @return [true, false]
+      # @method link?
+      #   @return [true, false]
+      Webhooks::View::BUTTON_STYLES.each do |name, value|
+        define_method("#{name}?") do
+          @style == value
+        end
+      end
+
+      # Await a button click
+      def await_click(key, **attributes, &block)
+        @bot.add_await(key, Discordrb::Events::ButtonEvent, { custom_id: @custom_id }.merge(attributes), &block)
+      end
+
+      # Await a button click, blocking.
+      def await_click!(**attributes, &block)
+        @bot.add_await!(Discordrb::Events::ButtonEvent, { custom_id: @custom_id }.merge(attributes), &block)
+      end
+    end
+
+    # An interactable select menu component.
+    class SelectMenu
+      # A select menu option.
+      class Option
+        # @return [String]
+        attr_reader :label
+
+        # @return [String]
+        attr_reader :value
+
+        # @return [String, nil]
+        attr_reader :description
+
+        # @return [Emoji, nil]
+        attr_reader :emoji
+
+        # @!visibility hidden
+        def initialize(data)
+          @label = data['label']
+          @value = data['value']
+          @description = data['description']
+          @emoji = Emoji.new(data['emoji'], @bot) if data['emoji']
+        end
+      end
+
+      # @return [String]
+      attr_reader :custom_id
+
+      # @return [Integer, nil]
+      attr_reader :max_values
+
+      # @return [Integer, nil]
+      attr_reader :min_values
+
+      # @return [String, nil]
+      attr_reader :placeholder
+
+      # @return [Array<Option>]
+      attr_reader :options
+
+      # @!visibility private
+      def initialize(data, bot)
+        @bot = bot
+
+        @max_values = data['max_values']
+        @min_values = data['min_values']
+        @placeholder = data['placeholder']
+        @custom_id = data['custom_id']
+        @emoji = Emoji.new(data['emoji'], @bot) if data['emoji']
+        @options = data['options'].map { |opt| Option.new(opt) }
+      end
+    end
+
+    # Text input component for use in modals. Can be either a line (`short`), or a multi line (`paragraph`) block.
+    class TextInput
+      # Single line text input
+      SHORT = 1
+      # Multi-line text input
+      PARAGRAPH = 2
+
+      # @return [String]
+      attr_reader :custom_id
+
+      # @return [Symbol]
+      attr_reader :style
+
+      # @return [String]
+      attr_reader :label
+
+      # @return [Integer, nil]
+      attr_reader :min_length
+
+      # @return [Integer, nil]
+      attr_reader :max_length
+
+      # @return [true, false]
+      attr_reader :required
+
+      # @return [String, nil]
+      attr_reader :value
+
+      # @return [String, nil]
+      attr_reader :placeholder
+
+      # @!visibility private
+      def initialize(data, bot)
+        @bot = bot
+        @style = data['style'] == SHORT ? :short : :paragraph
+        @label = data['label']
+        @min_length = data['min_length']
+        @max_length = data['max_length']
+        @required = data['required']
+        @value = data['value']
+        @placeholder = data['placeholder']
+        @custom_id = data['custom_id']
+      end
+
+      def short?
+        @style == :short
+      end
+
+      def paragraph?
+        @style == :paragraph
+      end
+
+      def required?
+        @required
+      end
+    end
+  end
+end

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,122 @@
+# 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
+
+  # Bot/OAuth2 application for discord integrations
+  class IntegrationApplication
+    # @return [Integer] the ID of the application.
+    attr_reader :id
+
+    # @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 [String] the summary of the application.
+    attr_reader :summary
+
+    # @return [User, nil] the bot associated with this application.
+    attr_reader :bot
+
+    def initialize(data, bot)
+      @id = data['id'].to_i
+      @name = data['name']
+      @icon = data['icon']
+      @description = data['description']
+      @summary = data['summary']
+      @bot = Discordrb::User.new(data['user'], bot) if data['user']
+    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 [Integer, nil] the role that this integration uses for "subscribers"
+    attr_reader :role_id
+
+    # @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
+
+    # @return [Integer, nil] how many subscribers this integration has.
+    attr_reader :subscriber_count
+
+    # @return [true, false] has this integration been revoked.
+    attr_reader :revoked
+
+    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_id = data['role_id']&.to_i
+      @emoticon = data['enable_emoticons']
+      @subscriber_count = data['subscriber_count']&.to_i
+      @revoked = data['revoked']
+      @application = IntegrationApplication.new(data['application'], bot) if data['application']
+    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