make PagingObject inherit from List<T>, not List<T?>

Signed-off-by: Adam Ratzman <[email protected]>

Author: adamint

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

@@ -199,23 +199,24 @@ public class ClientPlayerApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
     /**
      * Start or resume playback.
      *
-     * **Note:** You can only use one of the following: [offsetNum] or [offsetPlayableUri]
+     * **Note:** You can only use one of the following: [offsetNum], [offsetPlayableUri], or [collectionUri]
      *
      * **Specify nothing to play to simply resume playback**
      *
      * **Requires** the [SpotifyScope.USER_MODIFY_PLAYBACK_STATE] scope
      *
      * **[Api Reference](https://developer.spotify.com/documentation/web-api/reference/player/start-a-users-playback/)**
      *
+     * @param collectionUri Start playing an album, artist, or playlist
      * @param playableUrisToPlay [PlayableUri] (Track or Local track URIs) uris to play. these are converted into URIs. Max 100
      * @param offsetNum Indicates from where in the context playback should start. Only available when [playableUrisToPlay] is used.
-     * @param offsetPlayableUri Does the same as [offsetNum] but with a track/local track uri instead of place number
+     * @param offsetPlayableUri Start playing at a track/local track uri instead of place number ([offsetNum])
      * @param deviceId The device to play on
      *
      * @throws BadRequestException if more than one type of play type is specified or the offset is illegal.
      */
     public suspend fun startPlayback(
-        collection: CollectionUri? = null,
+        collectionUri: CollectionUri? = null,
         offsetNum: Int? = null,
         offsetPlayableUri: PlayableUri? = null,
         deviceId: String? = null,
@@ -224,7 +225,7 @@ public class ClientPlayerApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
         val url = endpointBuilder("/me/player/play").with("device_id", deviceId).toString()
         val body = jsonMap()
         when {
-            collection != null -> body += buildJsonObject { put("context_uri", collection.uri) }
+            collectionUri != null -> body += buildJsonObject { put("context_uri", collectionUri.uri) }
             playableUrisToPlay.isNotEmpty() -> body += buildJsonObject {
                 put(
                     "uris", JsonArray(

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

@@ -65,8 +65,6 @@ public class NullablePagingObject<T : Any>(
     override val previous: String? = null,
     override val total: Int = 0
 ) : AbstractPagingObject<T, NullablePagingObject<T>>() {
-    override fun get(index: Int): T? = items[index]
-
     public fun toPagingObject(): PagingObject<T> {
         val pagingObject = PagingObject(
             href, items.filterNotNull(), limit, next, offset, previous, total
@@ -75,6 +73,12 @@ public class NullablePagingObject<T : Any>(
 
         return pagingObject
     }
+
+    override fun get(index: Int): T? = items[index]
+    override fun iterator(): Iterator<T?> = items.iterator()
+    override fun listIterator(): ListIterator<T?> = items.listIterator()
+    override fun listIterator(index: Int): ListIterator<T?> = items.listIterator(index)
+    override fun subList(fromIndex: Int, toIndex: Int): List<T?> = items.subList(fromIndex, toIndex)
 }
 
 /**
@@ -93,6 +97,11 @@ public data class PagingObject<T : Any>(
     override val total: Int = 0
 ) : AbstractPagingObject<T, PagingObject<T>>() {
     override fun get(index: Int): T = items[index]
+
+    override fun iterator(): Iterator<T> = items.iterator()
+    override fun listIterator(): ListIterator<T> = items.listIterator()
+    override fun listIterator(index: Int): ListIterator<T> = items.listIterator(index)
+    override fun subList(fromIndex: Int, toIndex: Int): List<T> = items.subList(fromIndex, toIndex)
 }
 
 /**
@@ -257,8 +266,6 @@ public data class CursorBasedPagingObject<T : Any>(
     override val offset: Int = 0,
     override val previous: String? = null
 ) : PagingObjectBase<T, CursorBasedPagingObject<T>>() {
-    override fun get(index: Int): T = items[index]
-
     /**
      * Synchronously retrieve the next [total] paging objects associated with this [CursorBasedPagingObject], including this [CursorBasedPagingObject].
      *
@@ -324,6 +331,12 @@ public data class CursorBasedPagingObject<T : Any>(
 
         return pagingObjects.distinctBy { it.href }
     }
+
+    override fun get(index: Int): T = items[index]
+    override fun iterator(): Iterator<T> = items.iterator()
+    override fun listIterator(): ListIterator<T> = items.listIterator()
+    override fun listIterator(index: Int): ListIterator<T> = items.listIterator(index)
+    override fun subList(fromIndex: Int, toIndex: Int): List<T> = items.subList(fromIndex, toIndex)
 }
 
 /**
@@ -491,11 +504,7 @@ public abstract class PagingObjectBase<T : Any, Z : PagingObjectBase<T, Z>> : Li
     override fun containsAll(elements: Collection<T?>): Boolean = items.containsAll(elements)
     override fun indexOf(element: T?): Int = items.indexOf(element)
     override fun isEmpty(): Boolean = items.isEmpty()
-    override fun iterator(): Iterator<T?> = items.iterator()
     override fun lastIndexOf(element: T?): Int = items.lastIndexOf(element)
-    override fun listIterator(): ListIterator<T?> = items.listIterator()
-    override fun listIterator(index: Int): ListIterator<T?> = items.listIterator(index)
-    override fun subList(fromIndex: Int, toIndex: Int): List<T?> = items.subList(fromIndex, toIndex)
 }
 
 internal fun Any.instantiateLateinitsIfPagingObjects(api: GenericSpotifyApi) = when (this) {

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

@@ -0,0 +1,70 @@
+package com.adamratzman.spotify.priv
+
+import com.adamratzman.spotify.SpotifyClientApi
+import com.adamratzman.spotify.buildSpotifyApi
+import com.adamratzman.spotify.models.SpotifyTrackUri
+import com.adamratzman.spotify.models.Track
+import com.adamratzman.spotify.runBlockingTest
+import kotlin.test.Test
+import kotlin.test.assertTrue
+
+class ClientPlayerApiTest {
+    lateinit var api: SpotifyClientApi
+
+    init {
+        runBlockingTest {
+            (buildSpotifyApi() as? SpotifyClientApi)?.let { api = it }
+        }
+    }
+
+    fun testPrereq() = ::api.isInitialized
+
+    @Test
+    fun testGetDevices() {
+        runBlockingTest {
+            if (!testPrereq()) return@runBlockingTest
+
+            assertTrue(api.player.getDevices().isNotEmpty())
+        }
+    }
+
+    @Test
+    fun testGetCurrentContext() {
+        runBlockingTest {
+            if (!testPrereq()) return@runBlockingTest
+            val device = api.player.getDevices().first()
+            api.player.startPlayback(
+                playableUrisToPlay = listOf(SpotifyTrackUri("spotify:track:6WcinC5nKan2DMFUfjVerX")),
+                deviceId = device.id
+            )
+            val getCurrentContext = suspend { api.player.getCurrentContext() }
+            var context = getCurrentContext()
+            assertTrue(context != null && context.isPlaying && context.track?.id == "6WcinC5nKan2DMFUfjVerX")
+            api.player.pause()
+            context = getCurrentContext()!!
+
+            assertTrue(!context.isPlaying && context.track?.id != null)
+
+            val playlist = api.playlists.getPlaylist("37i9dQZF1DXcBWIGoYBM5M")!!
+            api.player.startPlayback(
+                collectionUri = playlist.uri
+            )
+            context = getCurrentContext()
+            assertTrue(context != null && context.isPlaying && context.track?.id == playlist.tracks.items.first().track!!.id)
+            api.player.pause()
+
+
+        }
+    }
+
+    @Test
+    fun testGetRecentlyPlayed() {
+        runBlockingTest {
+            if (!testPrereq()) return@runBlockingTest
+            val device = api.player.getDevices().first()
+            api.player.getRecentlyPlayed()
+        }
+    }
+
+
+}

src/commonTest/kotlin/com.adamratzman/spotify/utilities/UtilityTests.kt

@@ -12,6 +12,7 @@ import com.adamratzman.spotify.runBlockingTest
 import com.adamratzman.spotify.spotifyAppApi
 import com.adamratzman.spotify.spotifyClientApi
 import kotlin.test.Test
+import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 
 class UtilityTests {
@@ -26,6 +27,15 @@ class UtilityTests {
     fun testPrereq() = ::api.isInitialized
 
     @Test
+    fun testPagingObjectTakeItemsSize() {
+        runBlockingTest {
+            if (!testPrereq()) return@runBlockingTest
+
+            assertEquals(60, api.browse.getNewReleases(limit = 12).take(60).size)
+        }
+    }
+
+            @Test
     fun testInvalidApiBuilderParameters() {
         runBlockingTest {
             if (!testPrereq()) return@runBlockingTest