rubycord 1.0.0

data/lib/rubycord/data/activity.rb

@@ -0,0 +1,269 @@
+module Rubycord
+  # 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(&)
+      @activities.each(&)
+    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

data/lib/rubycord/data/application.rb

@@ -0,0 +1,48 @@
+module Rubycord
+  # OAuth Application information
+  class Application
+    include IDObject
+
+    # @return [String] the application name
+    attr_reader :name
+
+    # @return [String] the application description
+    attr_reader :description
+
+    # @return [Array<String>] the application's origins permitted to use RPC
+    attr_reader :rpc_origins
+
+    # @return [Integer]
+    attr_reader :flags
+
+    # Gets the user object of the owner. May be limited to username, discriminator,
+    # ID, and avatar if the bot cannot reach the owner.
+    # @return [User] the user object of the owner
+    attr_reader :owner
+
+    def initialize(data, bot)
+      @bot = bot
+
+      @name = data["name"]
+      @id = data["id"].to_i
+      @description = data["description"]
+      @icon_id = data["icon"]
+      @rpc_origins = data["rpc_origins"]
+      @flags = data["flags"]
+      @owner = @bot.ensure_user(data["owner"])
+    end
+
+    # Utility function to get a application's icon URL.
+    # @return [String, nil] the URL of the icon image (nil if no image is set).
+    def icon_url
+      return nil if @icon_id.nil?
+
+      API.app_icon_url(@id, @icon_id)
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "<Application name=#{@name} id=#{@id}>"
+    end
+  end
+end

data/lib/rubycord/data/attachment.rb

@@ -0,0 +1,109 @@
+module Rubycord
+  # Mixin for the attributes attachments should have
+  module AttachmentAttributes
+    # Types of attachment's flags mapped to their API value.
+    #   List of flags available here: https://discord.com/developers/docs/resources/message#attachment-object-attachment-flags
+    FLAGS = {
+      remix: 1 << 2,  # IS_REMIX : this attachment has been edited using the remix feature on mobile
+      spoiler: 1 << 3 #          : this attachment has been set to spoiler mode (not officially listed in doc, but seems to be the case after several tests)
+    }.freeze
+
+    # @return [Integer] attachment flags combined as a bitfield.
+    attr_reader :flags
+
+    # @!method remix?
+    #   @return [true, false] whether this file has flag IS_REMIX.
+    # @!method spoiler?
+    #   @note Unofficial flag
+    #   @return [true, false] whether this file has flag IS_SPOILER.
+    FLAGS.each do |name, value|
+      define_method(:"#{name}?") do
+        (@flags & value).positive?
+      end
+    end
+  end
+
+  # An attachment to a message
+  class Attachment
+    include IDObject
+    include AttachmentAttributes
+
+    # @return [Message] the message this attachment belongs to.
+    attr_reader :message
+
+    # @return [String] the attachment's filename.
+    attr_reader :filename
+
+    # @return [String, nil] the attachment's title.
+    attr_reader :title
+
+    # @return [String, nil] the attachment's description.
+    attr_reader :description
+
+    # @return [String, nil] the attachment's media type.
+    attr_reader :content_type
+
+    # @return [Integer] the attachment's file size in bytes.
+    attr_reader :size
+
+    # @return [String] the CDN URL this attachment can be downloaded at.
+    attr_reader :url
+
+    # @return [String] the attachment'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, nil] the height of an image file, in pixels, or `nil` if the file is not an image.
+    attr_reader :height
+
+    # @return [Integer, nil] the width of an image file, in pixels, or `nil` if the file is not an image.
+    attr_reader :width
+
+    # @return [Float, nil] the duration of the audio file (currently for voice messages).
+    attr_reader :duration_secs
+
+    # @return [String, nil] base64 encoded bytearray representing a sampled waveform (currently for voice messages).
+    attr_reader :waveform
+
+    # @!visibility private
+    def initialize(data, message, bot)
+      @bot = bot
+      @message = message
+
+      @id = data["id"].resolve_id
+
+      @filename = data["filename"]
+      @title = data["title"]
+      @description = data["description"]
+
+      @content_type = data["content_type"]
+      @size = data["size"]
+
+      @url = data["url"]
+      @proxy_url = data["proxy_url"]
+
+      @height = data["height"]
+      @width = data["width"]
+      @duration_secs = data["duration_secs"]
+      @waveform = data["waveform"]
+
+      @flags = data["flags"].to_i
+      @ephemeral = data["ephemeral"]
+    end
+
+    # @return [true, false] whether this file is an image file.
+    def image?
+      !(@width.nil? || @height.nil?)
+    end
+
+    # @return [true, false] whether this file is an audio file.
+    def audio?
+      !@duration_secs.nil?
+    end
+
+    # @return [true, false] whether this attachment is ephemeral.
+    def ephemeral?
+      @ephemeral
+    end
+  end
+end