discordrb 3.5.0 → 3.6.0

data/lib/discordrb/data/snapshot.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Discordrb
+  # A partial and immutable copy of a message that has been forwarded.
+  class Snapshot
+    # @return [Integer] the message type of the message snapshot.
+    attr_reader :type
+
+    # @return [String] the text content of the message snapshot.
+    attr_reader :content
+
+    # @return [Array<Embed>] the embeds attached to the message snapshot.
+    attr_reader :embeds
+
+    # @return [Array<Attachment>] the files attached to the message snapshot.
+    attr_reader :attachments
+
+    # @return [Time] the time at which the message snapshot was created.
+    attr_reader :created_at
+
+    # @return [Time, nil] the time at which the message snapshot was edited.
+    attr_reader :edited_at
+
+    # @return [Integer] the flags that have been set on the message snapshot.
+    attr_reader :flags
+
+    # @return [Array<User>] the users that were mentioned in the message snapshot.
+    attr_reader :mentions
+
+    # @return [Array<Component>] the interaction components associated with the message snapshot.
+    attr_reader :components
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @type = data['type']
+      @flags = data['flags'] || 0
+      @content = data['content']
+      @mention_roles = data['mention_roles']&.map(&:resolve_id) || []
+      @embeds = data['embeds']&.map { |embed| Embed.new(embed, self) } || []
+      @attachments = data['attachments']&.map { |file| Attachment.new(file, self, bot) } || []
+      @created_at = data['timestamp'] ? Time.parse(data['timestamp']) : nil
+      @edited_at = data['edited_timestamp'] ? Time.parse(data['edited_timestamp']) : nil
+      @mentions = data['mentions']&.map { |mention| bot.ensure_user(mention) } || []
+      @components = data['components']&.map { |component| Components.from_data(component, bot) } || []
+    end
+
+    # Check whether the message snapshot has been edited.
+    # @return [true, false] whether the snapshot was edited or not.
+    def edited?
+      !@edited_at.nil?
+    end
+
+    # Check whether the message snapshot contains any custom emojis.
+    # @return [true, false]  whether or not any emoji were used in the snapshot.
+    def emojis?
+      emojis.any?
+    end
+
+    # Get the custom emojis that were used in the message snapshot.
+    # @return [Array<Emoji>] the emojis used in the message snapshot.
+    def emojis
+      return [] if @content.nil? || @content.empty?
+
+      @emojis ||= @bot.parse_mentions(@content).select { |parsed| parsed.is_a?(Emoji) }
+    end
+
+    # Get the roles that were mentioned in the message snapshot.
+    # @return [Array<Role>] the roles that were mentioned in the message snapshot.
+    # @note this can only resolve roles in servers that the bot has access to via {Bot#servers}.
+    def role_mentions
+      return [] if @mention_roles.empty?
+
+      return @role_mentions if @role_mentions
+
+      roles = @bot.servers.values.flat_map(&:roles)
+
+      @role_mentions = @mention_roles.filter_map { |id| roles.find { |r| r.id == id } }
+    end
+
+    # Get the buttons that were used in the message snapshot.
+    # @return [Array<Components::Button>] the button components used in the message snapshot.
+    def buttons
+      buttons = @components.flat_map do |component|
+        case component
+        when Components::Button
+          component
+        when Components::ActionRow
+          component.buttons
+        end
+      end
+
+      buttons.compact
+    end
+
+    # @see Discordrb::Message::FLAGS
+    Message::FLAGS.each do |name, value|
+      define_method("#{name}?") do
+        @flags.anybits?(value)
+      end
+    end
+
+    # @see Discordrb::Message::TYPES
+    Message::TYPES.each do |name, value|
+      define_method("#{name}?") do
+        @type == value
+      end
+    end
+  end
+end

data/lib/discordrb/data/user.rb

@@ -49,6 +49,20 @@ module Discordrb
     # @see #avatar_url
     attr_accessor :avatar_id
 
+    # @return [true, false] whether the user is an offical Discord System user (part of the urgent message system).
+    attr_reader :system_account
+    alias_method :system_account?, :system_account
+
+    # @return [AvatarDecoration, nil] the current user's avatar decoration, or nil if the user doesn't have one.
+    attr_reader :avatar_decoration
+
+    # @return [Collectibles] the collectibles that this user has collected.
+    attr_reader :collectibles
+
+    # @return [PrimaryServer, nil] the server tag the user has adopted, or nil if the user doesn't have one displayed.
+    attr_reader :primary_server
+    alias_method :server_tag, :primary_server
+
     # Utility function to get Discord's display name of a user not in server
     # @return [String] the name the user displays as (global_name if they have one, username otherwise)
     def display_name
@@ -91,9 +105,17 @@ module Discordrb
 
     FLAGS.each do |name, value|
       define_method("#{name}?") do
-        (@public_flags & value).positive?
+        @public_flags.anybits?(value)
       end
     end
+
+    # Utility function to get a user's banner URL.
+    # @param format [String, nil] If `nil`, the URL will default to `png` for static banners and will detect if the user has a `gif` banner.
+    # You can otherwise specify one of `webp`, `jpg`, `png`, or `gif` to override this.
+    # @return [String, nil] the URL to the banner image or nil if the user doesn't have one.
+    def banner_url(format = nil)
+      API::User.banner_url(@id, banner_id, format) if banner_id
+    end
   end
 
   # User on Discord, including internal data like discriminators
@@ -120,18 +142,19 @@ module Discordrb
       @id = data['id'].to_i
       @discriminator = data['discriminator']
       @avatar_id = data['avatar']
-      @roles = {}
       @activities = Discordrb::ActivitySet.new
       @public_flags = data['public_flags'] || 0
-
-      @bot_account = false
-      @bot_account = true if data['bot']
-
-      @webhook_account = false
-      @webhook_account = true if data['_webhook']
+      @bot_account = data['bot'] || false
+      @webhook_account = data['_webhook'] || false
 
       @status = :offline
       @client_status = process_client_status(data['client_status'])
+      @banner_id = data['banner']
+      @system_account = data['system'] || false
+      @avatar_decoration = process_avatar_decoration(data['avatar_decoration_data'])
+      @collectibles = Collectibles.new(data['collectibles'] || {}, bot)
+
+      @primary_server = process_primary_server(data['primary_guild'] || {})
     end
 
     # Get a user's PM channel or send them a PM
@@ -167,6 +190,12 @@ module Discordrb
       pm.send_file(file, caption: caption, filename: filename, spoiler: spoiler)
     end
 
+    # @return [String, nil] the ID of this user's current banner, can be used to generate a banner URL.
+    # @see #banner_url
+    def banner_id
+      @banner_id ||= JSON.parse(API::User.resolve(@bot.token, @id))['banner']
+    end
+
     # Set the user's username
     # @note for internal use only
     # @!visibility private
@@ -181,6 +210,27 @@ module Discordrb
       @global_name = global_name
     end
 
+    # Set the user's avatar_decoration
+    # @note For internal use only.
+    # @!visibility private
+    def update_avatar_decoration(decoration)
+      @avatar_decoration = process_avatar_decoration(decoration)
+    end
+
+    # Set the user's collectibles
+    # @note For internal use only.
+    # @!visibility private
+    def update_collectibles(collectibles)
+      @collectibles = Collectibles.new(collectibles || {}, @bot)
+    end
+
+    # Set the user's primary server
+    # @note For internal use only.
+    # @!visibility private
+    def update_primary_server(server)
+      @primary_server = process_primary_server(server || {})
+    end
+
     # Set the user's presence data
     # @note for internal use only
     # @!visibility private
@@ -224,6 +274,16 @@ module Discordrb
       (client_status || {}).to_h { |k, v| [k.to_sym, v.to_sym] }
     end
 
+    # @!visibility private
+    def process_avatar_decoration(decoration)
+      decoration ? AvatarDecoration.new(decoration, @bot) : nil
+    end
+
+    # @!visibility private
+    def process_primary_server(server)
+      PrimaryServer.new(server, @bot) if server['identity_enabled']
+    end
+
     # @!method offline?
     #   @return [true, false] whether this user is offline.
     # @!method idle?

data/lib/discordrb/data/voice_region.rb

@@ -28,6 +28,7 @@ module Discordrb
     # @return [true, false] whether this is a custom voice region (used for events/etc)
     attr_reader :custom
 
+    # @!visibility private
     def initialize(data)
       @id = data['id']
 

data/lib/discordrb/data/webhook.rb

@@ -31,6 +31,7 @@ module Discordrb
     # @return [Member, User, nil] the user object of the owner or nil if the webhook was requested using the token.
     attr_reader :owner
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 
@@ -211,11 +212,7 @@ module Discordrb
     private
 
     def avatarise(avatar)
-      if avatar.respond_to? :read
-        "data:image/jpg;base64,#{Base64.strict_encode64(avatar.read)}"
-      else
-        avatar
-      end
+      avatar.respond_to?(:read) ? Discordrb.encode64(avatar) : avatar
     end
 
     def update_internal(data)

data/lib/discordrb/data.rb

@@ -40,3 +40,9 @@ require 'discordrb/data/webhook'
 require 'discordrb/data/audit_logs'
 require 'discordrb/data/interaction'
 require 'discordrb/data/component'
+require 'discordrb/data/avatar_decoration'
+require 'discordrb/data/collectibles'
+require 'discordrb/data/primary_server'
+require 'discordrb/data/server_preview'
+require 'discordrb/data/call'
+require 'discordrb/data/snapshot'

data/lib/discordrb/errors.rb

@@ -73,7 +73,7 @@ module Discordrb
           if (errs = sub_err['_errors'])
             "#{key}: #{errs.map { |e| e['message'] }.join(' ')}"
           elsif sub_err['message'] || sub_err['code']
-            "#{sub_err['code'] ? "#{sub_err['code']}: " : nil}#{err_msg}"
+            "#{"#{sub_err['code']}: " if sub_err['code']}#{err_msg}"
           elsif sub_err.is_a? String
             sub_err
           else
@@ -99,7 +99,7 @@ module Discordrb
     # @param code [Integer] The code to check
     # @return [Class] the error class for the given code
     def self.error_class_for(code)
-      @code_classes[code] || UnknownError
+      @code_classes[code] || Code(code)
     end
 
     # Used when Discord doesn't provide a more specific code
@@ -174,6 +174,9 @@ module Discordrb
     # Unauthorized
     Unauthorized = Unauthorised = Code(40_001)
 
+    # Unable to bulk ban any users
+    UnableToBulkBanUsers = Code(500_000)
+
     # Missing Access
     MissingAccess = Code(50_001)
 

data/lib/discordrb/events/await.rb

@@ -25,7 +25,7 @@ module Discordrb::Events
     #   @see Await#attributes
     delegate :key, :type, :attributes, to: :await
 
-    # For internal use only
+    # @!visibility private
     def initialize(await, event, bot)
       @await = await
       @event = event

data/lib/discordrb/events/channels.rb

@@ -29,6 +29,7 @@ module Discordrb::Events
     #   @see Channel#server
     delegate :name, :server, :type, :owner_id, :recipients, :topic, :user_limit, :position, :permission_overwrites, to: :channel
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
       @channel = data.is_a?(Discordrb::Channel) ? data : bot.channel(data['id'].to_i)
@@ -83,6 +84,7 @@ module Discordrb::Events
     # @return [Integer, nil] the channel's owner ID if this is a group channel
     attr_reader :owner_id
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 
@@ -134,6 +136,7 @@ module Discordrb::Events
 
     delegate :id, to: :recipient
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 
@@ -168,6 +171,40 @@ module Discordrb::Events
     end
   end
 
+  # Raised when a message is pinned or unpinned.
+  class ChannelPinsUpdateEvent < Event
+    # @return [Time, nil] Time at which the most recent pinned message was pinned.
+    attr_reader :last_pin_timestamp
+
+    # @return [Channel] The channel this event originates from.
+    attr_reader :channel
+
+    # @return [Server, nil] The server this event originates from.
+    attr_reader :server
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+
+      @server = bot.server(data['guild_id']) if data['guild_id']
+      @channel = bot.channel(data['channel_id'])
+      @last_pin_timestamp = Time.iso8601(data['last_pin_timestamp']) if data['last_pin_timestamp']
+    end
+  end
+
+  # Event handler for ChannelPinsUpdateEvent.
+  class ChannelPinsUpdateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type.
+      return false unless event.is_a? ChannelPinsUpdateEvent
+
+      [
+        matches_all(@attributes[:server], event.server) { |a, e| a.resolve_id == e&.id },
+        matches_all(@attributes[:channel], event.channel) { |a, e| a.resolve_id == e.id }
+      ].reduce(true, &:&)
+    end
+  end
+
   # Raised when a user is added to a private channel
   class ChannelRecipientAddEvent < ChannelRecipientEvent; end
 

data/lib/discordrb/events/generic.rb

@@ -7,6 +7,7 @@ module Discordrb::Events
   class Negated
     attr_reader :object
 
+    # @!visibility private
     def initialize(object)
       @object = object
     end
@@ -75,6 +76,7 @@ module Discordrb::Events
 
   # Generic event handler that can be extended
   class EventHandler
+    # @!visibility private
     def initialize(attributes, block)
       @attributes = attributes
       @block = block

data/lib/discordrb/events/guilds.rb

@@ -9,6 +9,7 @@ module Discordrb::Events
     # @return [Server] the server in question.
     attr_reader :server
 
+    # @!visibility private
     def initialize(data, bot)
       @bot = bot
 
@@ -64,7 +65,8 @@ module Discordrb::Events
     # @return [Integer] The ID of the server that was left.
     attr_reader :server
 
-    # Override init_server to account for the deleted server
+    # @!visibility private
+    # @note Override init_server to account for the deleted server
     def init_server(data, _bot)
       @server = data['id'].to_i
     end
@@ -81,6 +83,7 @@ module Discordrb::Events
     # @return [Array<Emoji>] array of emojis.
     attr_reader :emoji
 
+    # @!visibility private
     def initialize(server, data, bot)
       @bot = bot
       @server = server
@@ -103,6 +106,7 @@ module Discordrb::Events
     # @return [Emoji] the emoji data.
     attr_reader :emoji
 
+    # @!visibility private
     def initialize(server, emoji, bot)
       @bot = bot
       @emoji = emoji
@@ -127,6 +131,7 @@ module Discordrb::Events
     # @return [Emoji, nil] the updated emoji data.
     attr_reader :emoji
 
+    # @!visibility private
     def initialize(server, old_emoji, emoji, bot)
       @bot = bot
       @old_emoji = old_emoji