discordrb 3.4.0 → 3.5.0

data/lib/discordrb/data/channel.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'discordrb/webhooks/view'
+require 'time'
+
 module Discordrb
   # A Discord channel, including data like the topic
   class Channel
@@ -13,23 +16,28 @@ module Discordrb
       group: 3,
       category: 4,
       news: 5,
-      store: 6
+      store: 6,
+      news_thread: 10,
+      public_thread: 11,
+      private_thread: 12,
+      stage_voice: 13,
+      directory: 14,
+      forum: 15
     }.freeze
 
     # @return [String] this channel's name.
     attr_reader :name
 
-    # @return [Server, nil] the server this channel is on. If this channel is a PM channel, it will be nil.
-    attr_reader :server
-
-    # @return [Integer, nil] the ID of the parent channel, if this channel is inside a category
+    # @return [Integer, nil] the ID of the parent channel, if this channel is inside a category. If this channel is a
+    #   thread, this is the text channel it is a child to.
     attr_reader :parent_id
 
     # @return [Integer] the type of this channel
     # @see TYPES
     attr_reader :type
 
-    # @return [Integer, nil] the ID of the owner of the group channel or nil if this is not a group channel.
+    # @return [Integer, nil] the ID of the owner of the group channel or nil if this is not a group channel. If this
+    #   channel is a thread, this is the member that started the thread.
     attr_reader :owner_id
 
     # @return [Array<Recipient>, nil] the array of recipients of the private messages, or nil if this is not a Private channel
@@ -56,6 +64,35 @@ module Discordrb
     attr_reader :rate_limit_per_user
     alias_method :slowmode_rate, :rate_limit_per_user
 
+    # @return [Integer, nil] An approximate count of messages sent in a thread. Stops counting at 50.
+    attr_reader :message_count
+
+    # @return [Integer, nil] An approximate count of members in a thread. Stops counting at 50.
+    attr_reader :member_count
+
+    # @return [true, false, nil] Whether or not this thread is archived.
+    attr_reader :archived
+
+    # @return [Integer, nil] How long after the last message before a thread is automatically archived.
+    attr_reader :auto_archive_duration
+
+    # @return [Time, nil] The timestamp of when this threads status last changed.
+    attr_reader :archive_timestamp
+
+    # @return [true, false, nil] Whether this thread is locked or not.
+    attr_reader :locked
+    alias_method :locked?, :locked
+
+    # @return [Time, nil] When the current user joined this thread.
+    attr_reader :join_timestamp
+
+    # @return [Integer, nil] Member flags for this thread, used for notifications.
+    attr_reader :member_flags
+
+    # @return [true, false] For private threads, determines whether non-moderators can add other non-moderators to
+    #   a thread.
+    attr_reader :invitable
+
     # @return [true, false] whether or not this channel is a PM or group channel.
     def private?
       pm? || group?
@@ -99,15 +136,44 @@ module Discordrb
         end
       else
         @name = data['name']
-        @server = server || bot.server(data['guild_id'].to_i)
+        @server_id = server&.id || data['guild_id'].to_i
+        @server = server
       end
 
       @nsfw = data['nsfw'] || false
       @rate_limit_per_user = data['rate_limit_per_user'] || 0
+      @message_count = data['message_count']
+      @member_count = data['member_count']
+
+      if (metadata = data['thread_metadata'])
+        @archived = metadata['archived']
+        @auto_archive_duration = metadata['auto_archive_duration']
+        @archive_timestamp = Time.iso8601(metadata['archive_timestamp'])
+        @locked = metadata['locked']
+        @invitable = metadata['invitable']
+      end
+
+      if (member = data['member'])
+        @member_join = Time.iso8601(member['join_timestamp'])
+        @member_flags = member['flags']
+      end
 
       process_permission_overwrites(data['permission_overwrites'])
     end
 
+    # @return [Server, nil] the server this channel is on. If this channel is a PM channel, it will be nil.
+    # @raise [Discordrb::Errors::NoPermission] This can happen when receiving interactions for servers in which the bot is not
+    #   authorized with the `bot` scope.
+    def server
+      return @server if @server
+      return nil if private?
+
+      @server = @bot.server(@server_id)
+      raise Discordrb::Errors::NoPermission, 'The bot does not have access to this server' unless @server
+
+      @server
+    end
+
     # @return [true, false] whether or not this channel is a text channel
     def text?
       @type.zero?
@@ -143,6 +209,26 @@ module Discordrb
       @type == 6
     end
 
+    # @return [true, false] whether or not this channel is a news thread.
+    def news_thread?
+      @type == 10
+    end
+
+    # @return [true, false] whether or not this channel is a public thread.
+    def public_thread?
+      @type == 11
+    end
+
+    # @return [true, false] whether or not this channel is a private thread.
+    def private_thread?
+      @type == 12
+    end
+
+    # @return [true, false] whether or not this channel is a thread.
+    def thread?
+      news_thread? || public_thread? || private_thread?
+    end
+
     # @return [Channel, nil] the category channel, if this channel is in a category
     def category
       @bot.channel(@parent_id) if @parent_id
@@ -199,7 +285,7 @@ module Discordrb
       ids = if parent
               parent.children
             else
-              @server.channels.reject(&:parent_id).select { |c| c.type == @type }
+              server.channels.reject(&:parent_id).select { |c| c.type == @type }
             end.sort_by(&:position).map(&:id)
 
       # Move our channel ID after the target ID by deleting it,
@@ -225,7 +311,7 @@ module Discordrb
         move_argument << hash
       end
 
-      API::Server.update_channel_positions(@bot.token, @server.id, move_argument)
+      API::Server.update_channel_positions(@bot.token, @server_id, move_argument)
     end
 
     # Sets whether this channel is NSFW
@@ -262,9 +348,9 @@ module Discordrb
 
     # Sets the amount of time (in seconds) users have to wait in between sending messages.
     # @param rate [Integer]
-    # @raise [ArgumentError] if value isn't between 0 and 120
+    # @raise [ArgumentError] if value isn't between 0 and 21600
     def rate_limit_per_user=(rate)
-      raise ArgumentError, 'rate_limit_per_user must be between 0 and 120' unless rate.between?(0, 120)
+      raise ArgumentError, 'rate_limit_per_user must be between 0 and 21600' unless rate.between?(0, 21_600)
 
       update_channel_data(rate_limit_per_user: rate)
     end
@@ -341,9 +427,10 @@ module Discordrb
     # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
+    # @param components [View, Array<Hash>] Interaction components to associate with this message.
     # @return [Message] the message that was sent.
-    def send_message(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil)
-      @bot.send_message(@id, content, tts, embed, attachments, allowed_mentions, message_reference)
+    def send_message(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil)
+      @bot.send_message(@id, content, tts, embed, attachments, allowed_mentions, message_reference, components)
     end
 
     alias_method :send, :send_message
@@ -356,8 +443,9 @@ module Discordrb
     # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
-    def send_temporary_message(content, timeout, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil)
-      @bot.send_temporary_message(@id, content, timeout, tts, embed, attachments, allowed_mentions, message_reference)
+    # @param components [View, Array<Hash>] Interaction components to associate with this message.
+    def send_temporary_message(content, timeout, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil)
+      @bot.send_temporary_message(@id, content, timeout, tts, embed, attachments, allowed_mentions, message_reference, components)
     end
 
     # Convenience method to send a message with an embed.
@@ -372,13 +460,17 @@ module Discordrb
     # @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
     # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
+    # @param components [View, Array<Hash>] Interaction components to associate with this message.
     # @yield [embed] Yields the embed to allow for easy building inside a block.
     # @yieldparam embed [Discordrb::Webhooks::Embed] The embed from the parameters, or a new one.
     # @return [Message] The resulting message.
-    def send_embed(message = '', embed = nil, attachments = nil, tts = false, allowed_mentions = nil, message_reference = nil)
+    def send_embed(message = '', embed = nil, attachments = nil, tts = false, allowed_mentions = nil, message_reference = nil, components = nil)
       embed ||= Discordrb::Webhooks::Embed.new
-      yield(embed) if block_given?
-      send_message(message, tts, embed, attachments, allowed_mentions, message_reference)
+      view = Discordrb::Webhooks::View.new
+
+      yield(embed, view) if block_given?
+
+      send_message(message, tts, embed, attachments, allowed_mentions, message_reference, components || view.to_a)
     end
 
     # Sends multiple messages to a channel
@@ -518,9 +610,9 @@ module Discordrb
     # @return [Array<Member>] the users in this channel
     def users
       if text?
-        @server.online_members(include_idle: true).select { |u| u.can_read_messages? self }
+        server.online_members(include_idle: true).select { |u| u.can_read_messages? self }
       elsif voice?
-        @server.voice_states.map { |id, voice_state| @server.member(id) if !voice_state.voice_channel.nil? && voice_state.voice_channel.id == @id }.compact
+        server.voice_states.filter_map { |id, voice_state| server.member(id) if !voice_state.voice_channel.nil? && voice_state.voice_channel.id == @id }
       end
     end
 
@@ -554,9 +646,11 @@ module Discordrb
     # @param message_id [Integer] The ID of the message to retrieve.
     # @return [Message, nil] the retrieved message, or `nil` if it couldn't be found.
     def load_message(message_id)
+      raise ArgumentError, 'message_id cannot be nil' if message_id.nil?
+
       response = API::Channel.message(@bot.token, @id, message_id)
       Message.new(JSON.parse(response), @bot)
-    rescue RestClient::ResourceNotFound
+    rescue Discordrb::Errors::UnknownMessage
       nil
     end
 
@@ -742,9 +836,59 @@ module Discordrb
       invites.map { |invite_data| Invite.new(invite_data, @bot) }
     end
 
+    # Start a thread.
+    # @param name [String] The name of the thread.
+    # @param auto_archive_duration [60, 1440, 4320, 10080] How long before a thread is automatically
+    #   archived.
+    # @param message [Message, Integer, String] The message to reference when starting this thread.
+    # @param type [Symbol, Integer] The type of thread to create. Can be a key from {TYPES} or the value.
+    # @return [Channel]
+    def start_thread(name, auto_archive_duration, message: nil, type: 11)
+      message_id = message&.id || message
+      type = TYPES[type] || type
+
+      data = if message
+               API::Channel.start_thread_with_message(@bot.token, @id, message_id, name, auto_archive_duration)
+             else
+               API::Channel.start_thread_without_message(@bot.token, @id, name, auto_archive_duration, type)
+             end
+
+      Channel.new(JSON.parse(data), @bot, @server)
+    end
+
+    # @!group Threads
+
+    # Join this thread.
+    def join_thread
+      @bot.join_thread(@id)
+    end
+
+    # Leave this thread
+    def leave_thread
+      @bot.leave_thread(@id)
+    end
+
+    # Members in the thread.
+    def members
+      @bot.thread_members[@id].collect { |id| @server_id ? @bot.member(@server_id, id) : @bot.user(id) }
+    end
+
+    # Add a member to the thread
+    # @param member [Member, Integer, String] The member, or ID of the member, to add to this thread.
+    def add_member(member)
+      @bot.add_thread_member(@id, member)
+    end
+
+    # @param member [Member, Integer, String] The member, or ID of the member, to remove from a thread.
+    def remove_member(member)
+      @bot.remove_thread_member(@id, member)
+    end
+
+    # @!endgroup
+
     # The default `inspect` method is overwritten to give more useful output.
     def inspect
-      "<Channel name=#{@name} id=#{@id} topic=\"#{@topic}\" type=#{@type} position=#{@position} server=#{@server}>"
+      "<Channel name=#{@name} id=#{@id} topic=\"#{@topic}\" type=#{@type} position=#{@position} server=#{@server || @server_id}>"
     end
 
     # Adds a recipient to a group channel.
@@ -790,7 +934,7 @@ module Discordrb
 
     # @return [String] a URL that a user can use to navigate to this channel in the client
     def link
-      "https://discord.com/channels/#{@server&.id || '@me'}/#{@channel.id}"
+      "https://discord.com/channels/#{@server_id || '@me'}/#{@channel.id}"
     end
 
     alias_method :jump_link, :link

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/integration.rb

@@ -15,6 +15,36 @@ module Discordrb
     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
@@ -28,8 +58,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 +87,12 @@ 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
+
     def initialize(data, bot, server)
       @bot = bot
 
@@ -71,8 +107,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