discordrb 3.3.0 → 3.5.0

data/lib/discordrb/container.rb

@@ -5,6 +5,7 @@ require 'discordrb/events/typing'
 require 'discordrb/events/lifetime'
 require 'discordrb/events/presence'
 require 'discordrb/events/voice_state_update'
+require 'discordrb/events/voice_server_update'
 require 'discordrb/events/channels'
 require 'discordrb/events/members'
 require 'discordrb/events/roles'
@@ -12,6 +13,7 @@ require 'discordrb/events/guilds'
 require 'discordrb/events/await'
 require 'discordrb/events/bans'
 require 'discordrb/events/reactions'
+require 'discordrb/events/interactions'
 
 require 'discordrb/await'
 
@@ -89,7 +91,7 @@ module Discordrb
 
     # This **event** is raised when a message is edited in a channel.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [#resolve_id] :id Matches the ID of the message that was edited.
+    # @option attributes [String, Integer] :id Matches the ID of the message that was edited.
     # @option attributes [String, Integer, Channel] :in Matches the channel the message was edited in.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [MessageEditEvent] The event that was raised.
@@ -100,7 +102,7 @@ module Discordrb
 
     # This **event** is raised when a message is deleted in a channel.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [#resolve_id] :id Matches the ID of the message that was deleted.
+    # @option attributes [String, Integer] :id Matches the ID of the message that was deleted.
     # @option attributes [String, Integer, Channel] :in Matches the channel the message was deleted in.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [MessageDeleteEvent] The event that was raised.
@@ -109,9 +111,26 @@ module Discordrb
       register_event(MessageDeleteEvent, attributes, block)
     end
 
+    # This **event** is raised whenever a message is updated. Message updates can be triggered from
+    # a user editing their own message, or from Discord automatically attaching embeds to the
+    # user's message for URLs contained in the message's content. If you only want to listen
+    # for users editing their own messages, use the {message_edit} handler instead.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer] :id Matches the ID of the message that was updated.
+    # @option attributes [String, Integer, Channel] :in Matches the channel the message was updated in.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [MessageUpdateEvent] The event that was raised.
+    # @return [MessageUpdateEventHandler] the event handler that was registered.
+    def message_update(attributes = {}, &block)
+      register_event(MessageUpdateEvent, attributes, block)
+    end
+
     # This **event** is raised when somebody reacts to a message.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [Integer, String] :emoji Matches the ID of the emoji that was reacted with, or its name.
+    # @option attributes [String, Integer] :emoji Matches the ID of the emoji that was reacted with, or its name.
+    # @option attributes [String, Integer, User] :from Matches the user who added the reaction.
+    # @option attributes [String, Integer, Message] :message Matches the message to which the reaction was added.
+    # @option attributes [String, Integer, Channel] :in Matches the channel the reaction was added in.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ReactionAddEvent] The event that was raised.
     # @return [ReactionAddEventHandler] The event handler that was registered.
@@ -121,8 +140,11 @@ module Discordrb
 
     # This **event** is raised when somebody removes a reaction from a message.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [Integer, String] :emoji Matches the ID of the emoji that was removed from the reactions, or
+    # @option attributes [String, Integer] :emoji Matches the ID of the emoji that was removed from the reactions, or
     #   its name.
+    # @option attributes [String, Integer, User] :from Matches the user who removed the reaction.
+    # @option attributes [String, Integer, Message] :message Matches the message to which the reaction was removed.
+    # @option attributes [String, Integer, Channel] :in Matches the channel the reaction was removed in.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ReactionRemoveEvent] The event that was raised.
     # @return [ReactionRemoveEventHandler] The event handler that was registered.
@@ -132,6 +154,9 @@ module Discordrb
 
     # This **event** is raised when somebody removes all reactions from a message.
     # @param attributes [Hash] The event's attributes.
+    # @option attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Message] :message Matches the message to which the reactions were removed.
+    # @option attributes [String, Integer, Channel] :in Matches the channel the reactions were removed in.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ReactionRemoveAllEvent] The event that was raised.
     # @return [ReactionRemoveAllEventHandler] The event handler that was registered.
@@ -143,6 +168,8 @@ module Discordrb
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Integer, User] :from Matches the user whose status changed.
     # @option attributes [:offline, :idle, :online] :status Matches the status the user has now.
+    # @option attributes [Hash<Symbol, Symbol>] :client_status Matches the current online status (`:online`, `:idle` or `:dnd`) of the user
+    #   on various device types (`:desktop`, `:mobile`, or `:web`). The value will be `nil` when the user is offline or invisible
     # @yield The block is executed when the event is raised.
     # @yieldparam event [PresenceEvent] The event that was raised.
     # @return [PresenceEventHandler] the event handler that was registered.
@@ -216,8 +243,8 @@ module Discordrb
     # This **event** is raised when a recipient is added to a group channel.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String] :name Matches the name of the group channel that the recipient is added to.
-    # @option attributes [#resolve_id] :owner_id Matches the id of the group channel's owner.
-    # @option attributes [#resolve_id] :id Matches the id of the recipient added to the group channel.
+    # @option attributes [String, Integer] :owner_id Matches the ID of the group channel's owner.
+    # @option attributes [String, Integer] :id Matches the ID of the recipient added to the group channel.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ChannelRecipientAddEvent] The event that was raised.
     # @return [ChannelRecipientAddHandler] the event handler that was registered.
@@ -228,8 +255,8 @@ module Discordrb
     # This **event** is raised when a recipient is removed from a group channel.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String] :name Matches the name of the group channel that the recipient is added to.
-    # @option attributes [#resolve_id] :owner_id Matches the id of the group channel's owner.
-    # @option attributes [#resolve_id] :id Matches the id of the recipient removed from the group channel.
+    # @option attributes [String, Integer] :owner_id Matches the ID of the group channel's owner.
+    # @option attributes [String, Integer] :id Matches the ID of the recipient removed from the group channel.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ChannelRecipientRemoveEvent] The event that was raised.
     # @return [ChannelRecipientRemoveHandler] the event handler that was registered.
@@ -254,6 +281,16 @@ module Discordrb
       register_event(VoiceStateUpdateEvent, attributes, block)
     end
 
+    # This **event** is raised when first connecting to a server's voice channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User] :from Matches the server that the update is for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [VoiceServerUpdateEvent] The event that was raised.
+    # @return [VoiceServerUpdateEventHandler] The event handler that was registered.
+    def voice_server_update(attributes = {}, &block)
+      register_event(VoiceServerUpdateEvent, attributes, block)
+    end
+
     # This **event** is raised when a new user joins a server.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String] :username Matches the username of the joined user.
@@ -352,7 +389,7 @@ module Discordrb
     # This **event** is raised when an emoji is created.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Integer, Server] :server Matches the server.
-    # @option attributes [String, Integer] :id Matches the id of the emoji.
+    # @option attributes [String, Integer] :id Matches the ID of the emoji.
     # @option attributes [String] :name Matches the name of the emoji.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ServerEmojiCreateEvent] The event that was raised.
@@ -364,7 +401,7 @@ module Discordrb
     # This **event** is raised when an emoji is deleted.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Integer, Server] :server Matches the server.
-    # @option attributes [String, Integer] :id Matches the id of the emoji.
+    # @option attributes [String, Integer] :id Matches the ID of the emoji.
     # @option attributes [String] :name Matches the name of the emoji.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ServerEmojiDeleteEvent] The event that was raised.
@@ -376,7 +413,7 @@ module Discordrb
     # This **event** is raised when an emoji is updated.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Integer, Server] :server Matches the server.
-    # @option attributes [String, Integer] :id Matches the id of the emoji.
+    # @option attributes [String, Integer] :id Matches the ID of the emoji.
     # @option attributes [String] :name Matches the name of the emoji.
     # @option attributes [String] :old_name Matches the name of the emoji before the update.
     # @yield The block is executed when the event is raised.
@@ -398,7 +435,7 @@ module Discordrb
 
     # This **event** is raised when a role is deleted.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [#resolve_id] :id Matches the role id.
+    # @option attributes [String, Integer] :id Matches the role ID.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [ServerRoleDeleteEvent] The event that was raised.
     # @return [ServerRoleDeleteEventHandler] the event handler that was registered.
@@ -418,9 +455,9 @@ module Discordrb
 
     # This **event** is raised when a webhook is updated.
     # @param attributes [Hash] The event's attributes.
-    # @option attributes [String, Integer, Server] :server Matches the server by name, id or instance.
-    # @option attributes [String, Integer, Channel] :channel Matches the channel by name, id or instance.
-    # @option attribute [String, Integer, Webhook] :webhook Matches the webhook by name, id or instance.
+    # @option attributes [String, Integer, Server] :server Matches the server by name, ID or instance.
+    # @option attributes [String, Integer, Channel] :channel Matches the channel by name, ID or instance.
+    # @option attribute [String, Integer, Webhook] :webhook Matches the webhook by name, ID or instance.
     # @yield The block is executed when the event is raised.
     # @yieldparam event [WebhookUpdateEvent] The event that was raised.
     # @return [WebhookUpdateEventHandler] the event handler that was registered.
@@ -462,6 +499,142 @@ module Discordrb
     alias_method :direct_message, :pm
     alias_method :dm, :pm
 
+    # This **event** is raised when an invite is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User] :inviter Matches the user that created the invite.
+    # @option attributes [String, Integer, Channel] :channel Matches the channel the invite was created for.
+    # @option attributes [String, Integer, Server] :server Matches the server the invite was created for.
+    # @option attributes [true, false] :temporary Matches whether the invite is temporary or not.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [InviteCreateEvent] The event that was raised.
+    # @return [InviteCreateEventHandler] The event handler that was registered.
+    def invite_create(attributes = {}, &block)
+      register_event(InviteCreateEvent, attributes, block)
+    end
+
+    # This **event** is raised when an invite is deleted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Channel] :channel Matches the channel the deleted invite was for.
+    # @option attributes [String, Integer, Server] :server Matches the server the deleted invite was for.
+    # @yield The block is executed when the event is raised
+    # @yieldparam event [InviteDeleteEvent] The event that was raised.
+    # @return [InviteDeleteEventHandler] The event handler that was registered.
+    def invite_delete(attributes = {}, &block)
+      register_event(InviteDeleteEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an interaction event is received.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [Integer, Symbol, String] :type The interaction type, can be the integer value or the name
+    #   of the key in {Discordrb::Interaction::TYPES}.
+    # @option attributes [String, Integer, Server, nil] :server The server where this event was created. `nil` for DM channels.
+    # @option attributes [String, Integer, Channel] :channel The channel where this event was created.
+    # @option attributes [String, Integer, User] :user The user that triggered this event.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [InteractionCreateEvent] The event that was raised.
+    # @return [InteractionCreateEventHandler] The event handler that was registered.
+    def interaction_create(attributes = {}, &block)
+      register_event(InteractionCreateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an application command (slash command) is executed.
+    # @param name [Symbol] The name of the application command this handler is for.
+    # @param attributes [Hash] The event's attributes.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ApplicationCommandEvent] The event that was raised.
+    # @return [ApplicationCommandEventHandler] The event handler that was registered.
+    def application_command(name, attributes = {}, &block)
+      @application_commands ||= {}
+
+      unless block
+        @application_commands[name] ||= ApplicationCommandEventHandler.new(attributes, nil)
+        return @application_commands[name]
+      end
+
+      @application_commands[name] = ApplicationCommandEventHandler.new(attributes, block)
+    end
+
+    # This **event** is raised whenever an button interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ButtonEvent] The event that was raised.
+    # @return [ButtonEventHandler] The event handler that was registered.
+    def button(attributes = {}, &block)
+      register_event(ButtonEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select string interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [StringSelectEvent] The event that was raised.
+    # @return [StringSelectEventHandler] The event handler that was registered.
+    def string_select(attributes = {}, &block)
+      register_event(StringSelectEvent, attributes, block)
+    end
+
+    alias_method :select_menu, :string_select
+
+    # This **event** is raised whenever a modal is submitted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @option attributes [String, Integer, Server, nil] :server The server where this event was created. `nil` for DM channels.
+    # @option attributes [String, Integer, Channel] :channel The channel where this event was created.
+    # @option attributes [String, Integer, User] :user The user that triggered this event.    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ModalSubmitEvent] The event that was raised.
+    # @return [ModalSubmitEventHandler] The event handler that was registered.
+    def modal_submit(attributes = {}, &block)
+      register_event(ModalSubmitEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select user interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [UserSelectEvent] The event that was raised.
+    # @return [UserSelectEventHandler] The event handler that was registered.
+    def user_select(attributes = {}, &block)
+      register_event(UserSelectEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select role interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [RoleSelectEvent] The event that was raised.
+    # @return [RoleSelectEventHandler] The event handler that was registered.
+    def role_select(attributes = {}, &block)
+      register_event(RoleSelectEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select mentionable interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [MentionableSelectEvent] The event that was raised.
+    # @return [MentionableSelectEventHandler] The event handler that was registered.
+    def mentionable_select(attributes = {}, &block)
+      register_event(MentionableSelectEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an select channel interaction is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Regexp] :custom_id A custom_id to match against.
+    # @option attributes [String, Integer, Message] :message The message to filter for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelSelectEvent] The event that was raised.
+    # @return [ChannelSelectEventHandler] The event handler that was registered.
+    def channel_select(attributes = {}, &block)
+      register_event(ChannelSelectEvent, attributes, block)
+    end
+
     # This **event** is raised for every dispatch received over the gateway, whether supported by discordrb or not.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Symbol, Regexp] :type Matches the event type of the dispatch.
@@ -492,9 +665,16 @@ module Discordrb
       @event_handlers[clazz].delete(handler)
     end
 
+    # Remove an application command handler
+    # @param name [String, Symbol] The name of the command handler to remove.
+    def remove_application_command_handler(name)
+      @application_commands.delete(name)
+    end
+
     # Removes all events from this event handler.
     def clear!
-      @event_handlers.clear if @event_handlers
+      @event_handlers&.clear
+      @application_commands&.clear
     end
 
     # Adds an event handler to this container. Usually, it's more expressive to just use one of the shorthand adder
@@ -510,11 +690,19 @@ module Discordrb
     # Adds all event handlers from another container into this one. Existing event handlers will be overwritten.
     # @param container [Module] A module that `extend`s {EventContainer} from which the handlers will be added.
     def include_events(container)
-      handlers = container.instance_variable_get '@event_handlers'
-      return unless handlers
+      application_command_handlers = container.instance_variable_get(:@application_commands)
+      handlers = container.instance_variable_get :@event_handlers
+      return unless handlers || application_command_handlers
 
       @event_handlers ||= {}
-      @event_handlers.merge!(handlers) { |_, old, new| old + new }
+      @event_handlers.merge!(handlers || {}) { |_, old, new| old + new }
+
+      @application_commands ||= {}
+
+      @application_commands.merge!(application_command_handlers || {}) do |_, old, new|
+        old.subcommands.merge!(new.subcommands)
+        old
+      end
     end
 
     alias_method :include!, :include_events
@@ -525,7 +713,7 @@ module Discordrb
     # @param event_class [Class] The event type
     # @return [Class] the handler type
     def self.handler_class(event_class)
-      class_from_string(event_class.to_s + 'Handler')
+      class_from_string("#{event_class}Handler")
     end
 
     # Returns the event class for a handler class type
@@ -552,6 +740,7 @@ module Discordrb
 
     include Discordrb::Events
 
+    # @return [EventHandler]
     def register_event(clazz, attributes, block)
       handler = EventContainer.handler_class(clazz).new(attributes, block)
 

data/lib/discordrb/data/activity.rb

@@ -0,0 +1,271 @@
+# frozen_string_literal: true
+
+module Discordrb
+  # Contains information about user activities such as the game they are playing,
+  # music they are listening to, or their live stream.
+  class Activity
+    # Values corresponding to the flags bitmask
+    FLAGS = {
+      instance: 1 << 0, # this activity is an instanced game session
+      join: 1 << 1, # this activity is joinable
+      spectate: 1 << 2, # this activity can be spectated
+      join_request: 1 << 3, # this activity allows asking to join
+      sync: 1 << 4, # this activity is a spotify track
+      play: 1 << 5 # this game can be played or opened from discord
+    }.freeze
+
+    # @return [String] the activity's name
+    attr_reader :name
+
+    # @return [Integer, nil] activity type. Can be {GAME}, {STREAMING}, {LISTENING}, {CUSTOM}, or {COMPETING}
+    attr_reader :type
+
+    # @return [String, nil] stream URL, when the activity type is {STREAMING}
+    attr_reader :url
+
+    # @return [String, nil] the application ID for the game
+    attr_reader :application_id
+
+    # @return [String, nil] details about what the player is currently doing
+    attr_reader :details
+
+    # @return [String, nil] the user's current party status
+    attr_reader :state
+
+    # @return [true, false] whether or not the activity is an instanced game session
+    attr_reader :instance
+
+    # @return [Integer] a bitmask of activity flags
+    # @see FLAGS
+    attr_reader :flags
+
+    # @return [Timestamps, nil] times for the start and/or end of the activity
+    attr_reader :timestamps
+
+    # @return [Secrets, nil] secrets for rich presence, joining, and spectating
+    attr_reader :secrets
+
+    # @return [Assets, nil] images for the presence and their texts
+    attr_reader :assets
+
+    # @return [Party, nil] information about the player's current party
+    attr_reader :party
+
+    # @return [Emoji, nil] emoji data for custom statuses
+    attr_reader :emoji
+
+    # @return [Time] the time when the activity was added to the user's session
+    attr_reader :created_at
+
+    # Type indicating the activity is for a game
+    GAME = 0
+    # Type indicating the activity is a stream
+    STREAMING = 1
+    # Type indicating the activity is for music
+    LISTENING = 2
+    # This type is currently unused in the client but can be reported by bots
+    WATCHING = 3
+    # Type indicating the activity is a custom status
+    CUSTOM = 4
+    # Type indicating the activity is for a competitive game
+    COMPETING = 5
+
+    # @!visibility private
+    def initialize(data, bot)
+      @name = data['name']
+      @type = data['type']
+      @url = data['url']
+      @application_id = data['application_id']
+      @details = data['details']
+      @state = data['state']
+      @instance = data['instance']
+      @flags = data['flags'] || 0
+      @created_at = Time.at(data['created_at'].to_i)
+
+      @timestamps = Timestamps.new(data['timestamps']) if data['timestamps']
+      @secrets = Secret.new(data['secrets']) if data['secrets']
+      @assets = Assets.new(data['assets'], @application_id) if data['assets']
+      @party = Party.new(data['party']) if data['party']
+      @emoji = Emoji.new(data['emoji'], bot, nil) if data['emoji']
+    end
+
+    # @return [true, false] Whether or not the `join` flag is set for this activity
+    def join?
+      flag_set? :join
+    end
+
+    # @return [true, false] Whether or not the `spectate` flag is set for this activity
+    def spectate?
+      flag_set? :spectate
+    end
+
+    # @return [true, false] Whether or not the `join_request` flag is set for this activity
+    def join_request?
+      flag_set? :join_request
+    end
+
+    # @return [true, false] Whether or not the `sync` flag is set for this activity
+    def sync?
+      flag_set? :sync
+    end
+
+    # @return [true, false] Whether or not the `play` flag is set for this activity
+    def play?
+      flag_set? :play
+    end
+
+    # @return [true, false] Whether or not the `instance` flag is set for this activity
+    def instance?
+      @instance || flag_set?(:instance)
+    end
+
+    # @!visibility private
+    def flag_set?(sym)
+      !(@flags & FLAGS[sym]).zero?
+    end
+
+    # Timestamps for the start and end of instanced activities
+    class Timestamps
+      # @return [Time, nil]
+      attr_reader :start
+
+      # @return [Time, nil]
+      attr_reader :end
+
+      # @!visibility private
+      def initialize(data)
+        @start = Time.at(data['start'] / 1000) if data['start']
+        @end = Time.at(data['end'] / 1000) if data['end']
+      end
+    end
+
+    # Contains secrets used for rich presence
+    class Secrets
+      # @return [String, nil] secret for joining a party
+      attr_reader :join
+
+      # @return [String, nil] secret for spectating
+      attr_reader :spectate
+
+      # @return [String, nil] secret for a specific instanced match
+      attr_reader :match
+
+      # @!visibility private
+      def initialize(data)
+        @join = data['join']
+        @spectate = data['spectate']
+        @match = data['match']
+      end
+    end
+
+    # Assets for rich presence images and hover text
+    class Assets
+      # @return [String, nil] the asset ID for the large image of this activity
+      attr_reader :large_image_id
+
+      # @return [String, nil] text displayed when hovering over the large iamge
+      attr_reader :large_text
+
+      # @return [String, nil] the asset ID for the small image of this activity
+      attr_reader :small_image_id
+
+      # @return [String, nil]
+      attr_reader :small_text
+
+      # @return [String, nil] the application ID for these assets.
+      attr_reader :application_id
+
+      # @!visibility private
+      def initialize(data, application_id)
+        @application_id = application_id
+        @large_image_id = data['large_image']
+        @large_text = data['large_text']
+        @small_image_id = data['small_image']
+        @small_text = data['small_text']
+      end
+
+      # Utility function to get an Asset's large image URL.
+      # @param format [String, nil] If `nil`, the URL will default to `webp`. You can otherwise specify one of `webp`, `jpg`, or `png`.
+      # @return [String] the URL to the large image asset.
+      def large_image_url(format = 'webp')
+        API.asset_url(@application_id, @large_image_id, format)
+      end
+
+      # Utility function to get an Asset's large image URL.
+      # @param format [String, nil] If `nil`, the URL will default to `webp`. You can otherwise specify one of `webp`, `jpg`, or `png`.
+      # @return [String] the URL to the small image asset.
+      def small_image_url(format = 'webp')
+        API.asset_url(@application_id, @small_image_id, format)
+      end
+    end
+
+    # Contains information about an activity's party
+    class Party
+      # @return [String, nil]
+      attr_reader :id
+
+      # @return [Integer, nil]
+      attr_reader :current_size
+
+      # @return [Integer, nil]
+      attr_reader :max_size
+
+      # @!visibility private
+      def initialize(data)
+        @id = data['id']
+        @current_size, @max_size = data['size']
+      end
+    end
+  end
+
+  # A collection of the user's activities.
+  class ActivitySet
+    include Enumerable
+
+    # @!visibility private
+    def initialize(activities = [])
+      @activities = activities
+    end
+
+    # @!visibility private
+    # Implement each for Enumerable
+    def each(&block)
+      @activities.each(&block)
+    end
+
+    # @return [Array<Activity>] all activities
+    def to_a
+      @activities
+    end
+
+    # @return [Array<Activity>] all activities of type {Activity::GAME}
+    def games
+      @activities.select { |act| act.type == Activity::GAME }
+    end
+
+    # @return [Array<Activity>] all activities of type {Activity::STREAMING}
+    def streaming
+      @activities.select { |act| act.type == Activity::STREAMING }
+    end
+
+    # @return [Array<Activity>] all activities of type {Activity::LISTENING}
+    def listening
+      @activities.select { |act| act.type == Activity::LISTENING }
+    end
+
+    # @return [Array<Activity>] all activities of type {Activity::WATCHING}
+    def watching
+      @activities.select { |act| act.type == Activity::WATCHING }
+    end
+
+    # @return [Array<Activity>] all activities of type {Activity::CUSTOM}
+    def custom_status
+      @activities.select { |act| act.type == Activity::CUSTOM }
+    end
+
+    # @return [Array<Activity>] all activities of type {Activity::COMPETING}
+    def competing
+      @activities.select { |act| act.type == Activity::COMPETING }
+    end
+  end
+end