add getQueue function for player

Author: adamint

src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientPlayerApi.kt

@@ -8,6 +8,7 @@ import com.adamratzman.spotify.SpotifyException.BadRequestException
 import com.adamratzman.spotify.SpotifyScope
 import com.adamratzman.spotify.http.SpotifyEndpoint
 import com.adamratzman.spotify.models.ContextUri
+import com.adamratzman.spotify.models.CurrentUserQueue
 import com.adamratzman.spotify.models.CurrentlyPlayingContext
 import com.adamratzman.spotify.models.CurrentlyPlayingObject
 import com.adamratzman.spotify.models.CurrentlyPlayingType
@@ -93,6 +94,21 @@ public class ClientPlayerApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
         return if (obj?.timestamp == null) null else obj
     }
 
+    /**
+     * Get the list of objects that make up the user's queue.
+     *
+     * **Requires** the [SpotifyScope.USER_READ_CURRENTLY_PLAYING] scope
+     *
+     * Note that queue length may, in some cases, contain tracks that will play after the user-specified queue.
+     *
+     * **[Api Reference](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-queue)**
+     */
+    public suspend fun getUserQueue(): CurrentUserQueue {
+        return get(
+            endpointBuilder("/me/player/queue").toString()
+        ).toObject(CurrentUserQueue.serializer(), api = api, json = json)
+    }
+
     /**
      * Get tracks from the current user’s recently played tracks. Note: Currently doesn't support podcast episodes.
      *

src/commonMain/kotlin/com.adamratzman.spotify/models/Player.kt

@@ -168,6 +168,12 @@ public data class PlaybackActions(
         }
 }
 
+@Serializable
+public data class CurrentUserQueue(
+    @SerialName("currently_playing") val currentlyPlaying: Playable? = null,
+    @SerialName("queue") val queue: List<Playable>
+)
+
 /**
  * Maps a playback action to whether the user is disallowed from doing it
  *

src/commonMain/kotlin/com.adamratzman.spotify/models/SpotifyUris.kt

@@ -38,7 +38,6 @@ private fun String.add(type: String, allowColon: Boolean): String {
 }
 
 private fun String.remove(type: String, allowColon: Boolean): String {
-    println(type)
     if (type == UserCollectionUriType && matchesUserCollectionUri()) {
         return "collection"
     } else {

src/commonTest/kotlin/com.adamratzman/spotify/priv/ClientPlayerApiTest.kt

@@ -13,6 +13,7 @@ import com.adamratzman.spotify.models.SpotifyContextType
 import com.adamratzman.spotify.models.SpotifyTrackUri
 import com.adamratzman.spotify.models.toAlbumUri
 import com.adamratzman.spotify.models.toArtistUri
+import com.adamratzman.spotify.models.toEpisodeUri
 import com.adamratzman.spotify.models.toPlaylistUri
 import com.adamratzman.spotify.models.toShowUri
 import com.adamratzman.spotify.models.toTrackUri
@@ -271,4 +272,40 @@ class ClientPlayerApiTest : AbstractTest<SpotifyClientApi>() {
 
         assertEquals(toDevice.id, api.player.getCurrentContext()!!.device.id)
     }
+
+    @Test
+    fun testGetCurrentQueue(): TestResult = runTestOnDefaultDispatcher {
+        buildApi<SpotifyClientApi>(::testGetCurrentQueue.name)
+        if (!arePlayerTestsEnabled()) return@runTestOnDefaultDispatcher
+        if (!isApiInitialized()) return@runTestOnDefaultDispatcher
+
+        val device = api.player.getDevices().first()
+
+        val trackId = "1VsVY1ySdH3nVSWnLT5vCf"
+        api.player.startPlayback(
+            playableUrisToPlay = listOf(PlayableUri("spotify:track:$trackId")),
+            deviceId = device.id
+        )
+        delay(playbackRelatedDelayMs)
+
+        api.player.getUserQueue().let { playedSingleTrackNoQueueQueueResponse ->
+            assertEquals(trackId, playedSingleTrackNoQueueQueueResponse.currentlyPlaying?.asTrack?.id)
+        }
+
+        api.player.skipForward(deviceId = device.id)
+        delay(playbackRelatedDelayMs)
+
+        val episodeId = "4gQNhlqd3jg5QTh7umdRXT"
+        api.player.startPlayback(
+            playableUrisToPlay = listOf(episodeId.toEpisodeUri(), trackId.toTrackUri()),
+            deviceId = device.id
+        )
+        delay(playbackRelatedDelayMs)
+
+        api.player.getUserQueue().let { playingWithQueueResponse ->
+            assertEquals(episodeId, playingWithQueueResponse.currentlyPlaying?.id)
+            assertEquals(trackId, playingWithQueueResponse.queue[0].id)
+        }
+
+    }
 }