refractor paging objects into their own utility file

adamint · adamint · commit 6d4e9d5650d2 · 2019-01-03T00:55:22.000-07:00
fix paging object iteration

Signed-off-by: Adam Ratzman &lt;adam@adamratzman.com&gt;
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientFollowingAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientFollowingAPI.kt
@@ -5,6 +5,7 @@ import com.adamratzman.spotify.endpoints.public.FollowingAPI
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyClientAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.Artist
 import com.adamratzman.spotify.utils.ArtistURI
 import com.adamratzman.spotify.utils.CursorBasedPagingObject
@@ -108,8 +109,8 @@ class ClientFollowingAPI(api: SpotifyAPI) : FollowingAPI(api) {
     fun getFollowedArtists(
         limit: Int? = null,
         after: String? = null
-    ): SpotifyRestAction<CursorBasedPagingObject<Artist>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<Artist,CursorBasedPagingObject<Artist>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/me/following").with("type", "artist").with("limit", limit).with(
                     "after",
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientLibraryAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientLibraryAPI.kt
@@ -3,6 +3,7 @@ package com.adamratzman.spotify.endpoints.client
 
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.AlbumURI
 import com.adamratzman.spotify.utils.EndpointBuilder
 import com.adamratzman.spotify.utils.Market
@@ -29,8 +30,8 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<SavedTrack>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SavedTrack,PagingObject<SavedTrack>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/me/tracks").with("limit", limit).with("offset", offset).with("market", market?.code)
                     .toString()
@@ -47,8 +48,8 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<SavedAlbum>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SavedAlbum,PagingObject<SavedAlbum>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/me/albums").with("limit", limit).with("offset", offset).with("market", market?.code)
                     .toString()
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPersonalizationAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPersonalizationAPI.kt
@@ -2,7 +2,7 @@
 package com.adamratzman.spotify.endpoints.client
 
 import com.adamratzman.spotify.main.SpotifyAPI
-import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.Artist
 import com.adamratzman.spotify.utils.EndpointBuilder
 import com.adamratzman.spotify.utils.PagingObject
@@ -37,8 +37,8 @@ class ClientPersonalizationAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         timeRange: TimeRange? = null
-    ): SpotifyRestAction<PagingObject<Artist>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<Artist, PagingObject<Artist>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/me/top/artists").with("limit", limit).with("offset", offset)
                     .with("time_range", timeRange).toString()
@@ -63,8 +63,8 @@ class ClientPersonalizationAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         timeRange: TimeRange? = null
-    ): SpotifyRestAction<PagingObject<Track>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<Track,PagingObject<Track>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/me/top/tracks").with("limit", limit).with("offset", offset)
                     .with("time_range", timeRange).toString()
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPlayerAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPlayerAPI.kt
@@ -3,6 +3,7 @@ package com.adamratzman.spotify.endpoints.client
 
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.AlbumURI
 import com.adamratzman.spotify.utils.ArtistURI
 import com.adamratzman.spotify.utils.BadRequestException
@@ -46,8 +47,8 @@ class ClientPlayerAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         })
     }
 
-    fun getRecentlyPlayed(): SpotifyRestAction<CursorBasedPagingObject<PlayHistory>> {
-        return toAction(Supplier {
+    fun getRecentlyPlayed(): SpotifyRestActionPaging<PlayHistory,CursorBasedPagingObject<PlayHistory>> {
+        return toActionPaging(Supplier {
             get(EndpointBuilder("/me/player/recently-played").toString()).toCursorBasedPagingObject<PlayHistory>(
                 endpoint = this
             )
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPlaylistAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPlaylistAPI.kt
@@ -5,6 +5,7 @@ import com.adamratzman.spotify.endpoints.public.PlaylistsAPI
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyClientAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.BadRequestException
 import com.adamratzman.spotify.utils.EndpointBuilder
 import com.adamratzman.spotify.utils.ErrorObject
@@ -129,10 +130,10 @@ class ClientPlaylistAPI(api: SpotifyAPI) : PlaylistsAPI(api) {
     fun getClientPlaylists(
         limit: Int? = null,
         offset: Int? = null
-    ): SpotifyRestAction<PagingObject<SimplePlaylist>> {
+    ): SpotifyRestActionPaging<SimplePlaylist,PagingObject<SimplePlaylist>> {
         if (limit != null && limit !in 1..50) throw IllegalArgumentException("Limit must be between 1 and 50. Provided $limit")
         if (offset != null && offset !in 0..100000) throw IllegalArgumentException("Offset must be between 0 and 100,000. Provided $limit")
-        return toAction(Supplier {
+        return toActionPaging(Supplier {
             get(EndpointBuilder("/me/playlists").with("limit", limit).with("offset", offset).toString())
                 .toPagingObject<SimplePlaylist>(endpoint = this)
         })
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/public/AlbumAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/public/AlbumAPI.kt
@@ -3,6 +3,7 @@ package com.adamratzman.spotify.endpoints.public
 
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.Album
 import com.adamratzman.spotify.utils.AlbumURI
 import com.adamratzman.spotify.utils.AlbumsResponse
@@ -66,8 +67,8 @@ class AlbumAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<SimpleTrack>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SimpleTrack, PagingObject<SimpleTrack>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/albums/${AlbumURI(album).id.encode()}/tracks").with("limit", limit).with(
                     "offset",
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/public/BrowseAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/public/BrowseAPI.kt
@@ -3,6 +3,7 @@ package com.adamratzman.spotify.endpoints.public
 
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.ArtistURI
 import com.adamratzman.spotify.utils.BadRequestException
 import com.adamratzman.spotify.utils.EndpointBuilder
@@ -59,8 +60,8 @@ class BrowseAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<SimpleAlbum>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SimpleAlbum,PagingObject<SimpleAlbum>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/browse/new-releases").with("limit", limit).with("offset", offset).with(
                     "country",
@@ -129,8 +130,8 @@ class BrowseAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         offset: Int? = null,
         locale: String? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<SpotifyCategory>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SpotifyCategory,PagingObject<SpotifyCategory>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/browse/categories").with("limit", limit).with("offset", offset).with(
                     "market",
@@ -184,8 +185,8 @@ class BrowseAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<SimplePlaylist>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SimplePlaylist,PagingObject<SimplePlaylist>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/browse/categories/${categoryId.encode()}/playlists").with(
                     "limit",
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/public/PlaylistsAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/public/PlaylistsAPI.kt
@@ -3,6 +3,7 @@ package com.adamratzman.spotify.endpoints.public
 
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.BadRequestException
 import com.adamratzman.spotify.utils.EndpointBuilder
 import com.adamratzman.spotify.utils.LinkedResult
@@ -43,8 +44,8 @@ open class PlaylistsAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         user: String,
         limit: Int? = null,
         offset: Int? = null
-    ): SpotifyRestAction<PagingObject<SimplePlaylist>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SimplePlaylist,PagingObject<SimplePlaylist>> {
+        return toActionPaging(Supplier {
             get(
                 EndpointBuilder("/users/${UserURI(user).id.encode()}/playlists").with("limit", limit).with(
                     "offset", offset
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/public/SearchAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/public/SearchAPI.kt
@@ -2,7 +2,7 @@
 package com.adamratzman.spotify.endpoints.public
 
 import com.adamratzman.spotify.main.SpotifyAPI
-import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.utils.Artist
 import com.adamratzman.spotify.utils.BadRequestException
 import com.adamratzman.spotify.utils.EndpointBuilder
@@ -43,8 +43,8 @@ class SearchAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<SimplePlaylist>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SimplePlaylist, PagingObject<SimplePlaylist>> {
+        return toActionPaging(Supplier {
             get(build(SearchType.PLAYLIST, query, limit, offset, market)).toPagingObject<SimplePlaylist>(
                 "playlists", this
             )
@@ -68,8 +68,8 @@ class SearchAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<Artist>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<Artist, PagingObject<Artist>> {
+        return toActionPaging(Supplier {
             get(build(SearchType.ARTIST, query, limit, offset, market)).toPagingObject<Artist>(
                 "artists", this
             )
@@ -93,8 +93,8 @@ class SearchAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<SimpleAlbum>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<SimpleAlbum, PagingObject<SimpleAlbum>> {
+        return toActionPaging(Supplier {
             get(build(SearchType.ALBUM, query, limit, offset, market)).toPagingObject<SimpleAlbum>(
                 "albums", this
             )
@@ -118,8 +118,8 @@ class SearchAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         limit: Int? = null,
         offset: Int? = null,
         market: Market? = null
-    ): SpotifyRestAction<PagingObject<Track>> {
-        return toAction(Supplier {
+    ): SpotifyRestActionPaging<Track, PagingObject<Track>> {
+        return toActionPaging(Supplier {
             get(build(SearchType.TRACK, query, limit, offset, market)).toPagingObject<Track>(
                 "tracks", this
             )
diff --git a/src/main/kotlin/com/adamratzman/spotify/main/SpotifyRestAction.kt b/src/main/kotlin/com/adamratzman/spotify/main/SpotifyRestAction.kt
@@ -2,12 +2,11 @@
 package com.adamratzman.spotify.main
 
 import com.adamratzman.spotify.utils.AbstractPagingObject
-import com.adamratzman.spotify.utils.PagingObject
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.TimeUnit
 import java.util.function.Supplier
 
-class SpotifyRestAction<T>(private val api: SpotifyAPI, private val supplier: Supplier<T>) {
+open class SpotifyRestAction<T>(protected val api: SpotifyAPI, private val supplier: Supplier<T>) {
     fun complete(): T {
         return try {
             supplier.get()
@@ -41,4 +40,10 @@ class SpotifyRestAction<T>(private val api: SpotifyAPI, private val supplier: Su
     }
 
     override fun toString() = complete().toString()
+}
+
+class SpotifyRestActionPaging<Z, T:AbstractPagingObject<Z>>(api: SpotifyAPI, supplier: Supplier<T>) :
+    SpotifyRestAction<T>(api, supplier) {
+    fun getAll() = api.tracks.toAction(Supplier { complete().getAllImpl() })
+    fun getAllItems() = api.tracks.toAction(Supplier { complete().getAllImpl().toList().map { it.items }.flatten() })
 }
diff --git a/src/main/kotlin/com/adamratzman/spotify/utils/Endpoints.kt b/src/main/kotlin/com/adamratzman/spotify/utils/Endpoints.kt
@@ -4,6 +4,7 @@ package com.adamratzman.spotify.utils
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyAppAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
+import com.adamratzman.spotify.main.SpotifyRestActionPaging
 import com.adamratzman.spotify.main.base
 import java.net.HttpURLConnection
 import java.util.function.Supplier
@@ -112,6 +113,7 @@ abstract class SpotifyEndpoint(val api: SpotifyAPI) {
     )
 
     fun <T> toAction(supplier: Supplier<T>) = SpotifyRestAction(api, supplier)
+    fun <Z, T:AbstractPagingObject<Z>> toActionPaging(supplier: Supplier<T>) = SpotifyRestActionPaging(api, supplier)
 }
 
 internal class EndpointBuilder(private val path: String) {
diff --git a/src/main/kotlin/com/adamratzman/spotify/utils/Helpers.kt b/src/main/kotlin/com/adamratzman/spotify/utils/Helpers.kt
@@ -94,7 +94,10 @@ internal inline fun <reified T> String.toPagingObject(
         jsonObject.get("offset") as Int,
         jsonObject.get("previous") as? String,
         jsonObject.getInt("total")
-    ).apply { this.endpoint = endpoint }
+    ).apply {
+        this.endpoint = endpoint
+        this.itemClazz = T::class.java
+    }
 }
 
 internal inline fun <reified T> String.toCursorBasedPagingObject(
@@ -109,7 +112,10 @@ internal inline fun <reified T> String.toCursorBasedPagingObject(
         jsonObject.get("next") as? String,
         jsonObject.getJSONObject("cursors").toString().toObject(endpoint.api),
         if (jsonObject.keySet().contains("total")) jsonObject.getInt("total") else -1
-    ).apply { this.endpoint = endpoint }
+    ).apply {
+        this.endpoint = endpoint
+        this.itemClazz = T::class.java
+    }
 }
 
 internal inline fun <reified T> String.toLinkedResult(api: SpotifyAPI): LinkedResult<T> {
diff --git a/src/main/kotlin/com/adamratzman/spotify/utils/HttpConnection.kt b/src/main/kotlin/com/adamratzman/spotify/utils/HttpConnection.kt
@@ -33,11 +33,16 @@ class HttpConnection(
 
         connection.connect()
 
+        val responseCode = connection.responseCode
+        val body = (connection.errorStream ?: connection.inputStream).bufferedReader().use {
+            val text = it.readText()
+            it.close()
+            text
+        }
+
         return HttpResponse(
-            responseCode = connection.responseCode,
-            body = (connection.errorStream ?: connection.inputStream).bufferedReader().use {
-                it.readText()
-            },
+            responseCode = responseCode,
+            body = body,
             headers = connection.headerFields.keys.filterNotNull().map { HttpHeader(it, connection.getHeaderField(it)) }
         ).also { connection.disconnect() }
     }
diff --git a/src/main/kotlin/com/adamratzman/spotify/utils/PagingObjects.kt b/src/main/kotlin/com/adamratzman/spotify/utils/PagingObjects.kt
@@ -52,15 +52,15 @@ class PagingObject<T>(
     override fun getImpl(type: PagingTraversalType): AbstractPagingObject<T>? {
         return (if (type == PagingTraversalType.FORWARDS) next else previous)?.let { endpoint.get(it) }?.let { json ->
             when {
-                this as? PagingObject<SimpleTrack> != null -> json.toPagingObject<SimpleTrack>(null, endpoint)
-                this as? PagingObject<SpotifyCategory> != null -> json.toPagingObject<SpotifyCategory>(null, endpoint)
-                this as? PagingObject<SimpleAlbum> != null -> json.toPagingObject<SimpleAlbum>(null, endpoint)
-                this as? PagingObject<SimplePlaylist> != null -> json.toPagingObject<SimplePlaylist>(null, endpoint)
-                this as? PagingObject<SavedTrack> != null -> json.toPagingObject<SavedTrack>(null, endpoint)
-                this as? PagingObject<SavedAlbum> != null -> json.toPagingObject<SavedAlbum>(null, endpoint)
-                this as? PagingObject<Artist> != null -> json.toPagingObject<Artist>(null, endpoint)
-                this as? PagingObject<Track> != null -> json.toPagingObject<Track>(null, endpoint)
-                this as? PagingObject<PlaylistTrack> != null -> json.toPagingObject<PlaylistTrack>(null, endpoint)
+                itemClazz == SimpleTrack::class.java -> json.toPagingObject<SimpleTrack>(null, endpoint)
+                itemClazz == SpotifyCategory::class.java -> json.toPagingObject<SpotifyCategory>(null, endpoint)
+                itemClazz == SimpleAlbum::class.java -> json.toPagingObject<SimpleAlbum>(null, endpoint)
+                itemClazz == SimplePlaylist::class.java -> json.toPagingObject<SimplePlaylist>(null, endpoint)
+                itemClazz == SavedTrack::class.java -> json.toPagingObject<SavedTrack>(null, endpoint)
+                itemClazz == SavedAlbum::class.java -> json.toPagingObject<SavedAlbum>(null, endpoint)
+                itemClazz == Artist::class.java -> json.toPagingObject<Artist>(null, endpoint)
+                itemClazz == Track::class.java -> json.toPagingObject<Track>(null, endpoint)
+                itemClazz == PlaylistTrack::class.java -> json.toPagingObject<PlaylistTrack>(null, endpoint)
                 else -> throw IllegalArgumentException("Unknown type in $href response")
             } as? PagingObject<T>
         }
@@ -119,11 +119,11 @@ class CursorBasedPagingObject<T>(
         return next?.let {
             val url = endpoint.get(it)
             when {
-                this as? CursorBasedPagingObject<PlayHistory> != null -> url.toCursorBasedPagingObject<PlayHistory>(
+                itemClazz == PlayHistory::class.java -> url.toCursorBasedPagingObject<PlayHistory>(
                     null,
                     endpoint
                 )
-                this as? CursorBasedPagingObject<Artist> != null -> url.toCursorBasedPagingObject<Artist>(
+                itemClazz == Artist::class.java -> url.toCursorBasedPagingObject<Artist>(
                     null,
                     endpoint
                 )
@@ -145,10 +145,13 @@ abstract class AbstractPagingObject<T>(
     val offset: Int = 0,
     val previous: String? = null,
     val total: Int
-) {
+) : ArrayList<T>(items) {
     @Json(ignored = true)
     lateinit var endpoint: SpotifyEndpoint
 
+    @Json(ignored = true)
+    lateinit var itemClazz: Class<T>
+
     internal abstract fun getImpl(type: PagingTraversalType): AbstractPagingObject<T>?
     internal abstract fun getAllImpl(): Sequence<AbstractPagingObject<T>>
 
diff --git a/src/test/kotlin/com/adamratzman/spotify/private/ClientLibraryAPITest.kt b/src/test/kotlin/com/adamratzman/spotify/private/ClientLibraryAPITest.kt
