discordrb 3.4.3 → 3.6.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

@@ -5,9 +5,6 @@ module Discordrb
   # 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
 
@@ -70,6 +67,16 @@ module Discordrb
       @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.

data/lib/discordrb/data/emoji.rb

@@ -14,6 +14,21 @@ module Discordrb
     # @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
@@ -25,8 +40,12 @@ module Discordrb
 
       @name = data['name']
       @server = server
-      @id = data['id'].nil? ? nil : data['id'].to_i
+      @id = data['id']&.to_i
       @animated = data['animated']
+      @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

data/lib/discordrb/data/integration.rb

@@ -9,12 +9,44 @@ module Discordrb
     # @return [Integer] this account's ID.
     attr_reader :id
 
+    # @!visibility private
     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
+
+    # @!visibility private
+    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
@@ -28,8 +60,8 @@ module Discordrb
     # @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 [Integer, nil] the role that this integration uses for "subscribers"
+    attr_reader :role_id
 
     # @return [true, false] whether emoticons are enabled
     attr_reader :emoticon
@@ -57,6 +89,13 @@ module Discordrb
     # @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
+
+    # @!visibility private
     def initialize(data, bot, server)
       @bot = bot
 
@@ -71,8 +110,11 @@ module Discordrb
       @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
+      @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