Merge pull request #230 from adamint/dev

fix paging object deserialization for SimpleAlbum

Author: adamint

README.md

@@ -37,7 +37,7 @@ repositories {
     jcenter()
 }
 
-implementation("com.adamratzman:spotify-api-kotlin-core:3.3.0")
+implementation("com.adamratzman:spotify-api-kotlin-core:3.3.01")
 ```
 
 Note that images and profiles are not supported on the Kotlin/JS target.
@@ -69,7 +69,7 @@ packagingOptions {
 ```
 
 ## Documentation
-The `spotify-web-api-kotlin` JavaDocs are hosted at https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/
+The `spotify-web-api-kotlin` JavaDocs are hosted [here](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/).
 
 ## Have a question?
 If you have a question, you can:
@@ -97,7 +97,7 @@ By default, the SpotifyApi `Token` automatically regenerates when needed.
 This can be changed by overriding the `automaticRefresh` builder setting.
 
 There are four exposed builders, depending on the level of control you need over api creation. 
-Please see the [spotifyAppApi builder docs](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-app-api.html) for a full list of available builders.
+Please see the [spotifyAppApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-app-api.html) for a full list of available builders.
 
 You will need:
 - Spotify application client id
@@ -165,7 +165,7 @@ This library contains helpful methods that can be used to simplify the PKCE auth
 This includes `getSpotifyPkceCodeChallenge` (not available in the Kotlin/JS target), which SHA256 hashes and base64url encodes the code 
 challenge, and `getPkceAuthorizationUrl`, which allows you to generate an easy authorization url for PKCE flow.
 
-Please see the [spotifyClientPkceApi builder docs](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-pkce-api.html) for a full list of available builders.
+Please see the [spotifyClientPkceApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-pkce-api.html) for a full list of available builders.
 
 **Takeaway**: Use PKCE authorization flow in applications where you cannot secure the client secret.
 
@@ -224,7 +224,7 @@ There are also several optional parameters, allowing you to set whether the auth
 for implicit grant flow, the state, and whether a re-authorization dialog should be shown to users.
 
 There are several exposed builders, depending on the level of control you need over api creation. 
-Please see the [spotifyClientApi builder docs](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-api.html) for a full list of available builders.
+Please see the [spotifyClientApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-api.html) for a full list of available builders.
 
 ##### Example: You've redirected the user back to your web server and have an authorization code (code).
 In this example, automatic token refresh is turned on by default.
@@ -275,7 +275,7 @@ Some highlights about the flow are:
 - It is client-side
 - It does not require a client secret
 
-Please see the [spotifyImplicitGrantApi builder docs](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-implicit-grant-api.html) for a full list of available builders.
+Please see the [spotifyImplicitGrantApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-implicit-grant-api.html) for a full list of available builders.
 
 The Kotlin/JS target contains the `parseSpotifyCallbackHashToToken` method, which will parse the hash 
 for the current url into a Token object, with which you can then instantiate the api.

build.gradle.kts

@@ -31,12 +31,8 @@ buildscript {
     }
 }
 
-dependencies {
-    dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.20")
-}
-
 group = "com.adamratzman"
-version = "3.3.0"
+version = "3.3.01"
 
 tasks.withType<Test> {
     this.testLogging {
@@ -67,6 +63,7 @@ android {
         }
     }
     testOptions {
+        this.unitTests.isReturnDefaultValues = true
         @Suppress("UNCHECKED_CAST")
         this.unitTests.all(closureOf<Test> {
           //  this.useJUnitPlatform()
@@ -216,17 +213,14 @@ kotlin {
                 }
 
                 dependencies {
-                    implementation("net.sourceforge.streamsupport:android-retrofuture:1.7.2")
                     implementation("io.ktor:ktor-client-okhttp:$ktorVersion")
-                    implementation("io.coil-kt:coil:1.1.0")
                 }
             }
 
             val androidTest by getting {
                 dependencies {
                     implementation(kotlin("test-junit"))
                     implementation("com.sparkjava:spark-core:2.9.3")
-                    implementation("org.mockito:mockito-core:3.3.3")
                     runtimeOnly(kotlin("reflect"))
                 }
             }
@@ -279,6 +273,18 @@ signing {
 tasks {
     val dokkaHtml by getting(DokkaTask::class) {
         outputDirectory.set(projectDir.resolve("docs"))
+
+        dokkaSourceSets {
+            configureEach {
+                skipDeprecated.set(true)
+
+                sourceLink {
+                    localDirectory.set(file("src"))
+                    remoteUrl.set(uri("https://github.com/adamint/spotify-web-api-kotlin/tree/master/src").toURL())
+                    remoteLineSuffix.set("#L")
+                }
+            }
+        }
     }
 
     spotless {

src/androidMain/kotlin/com/adamratzman/spotify/utils/Platform.kt

@@ -0,0 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2020; Original author: Adam Ratzman */
+package com.adamratzman.spotify.utils
+
+public actual val platform: Platform = Platform.ANDROID

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

@@ -116,9 +116,9 @@ public abstract class AbstractPagingObject<T : Any, Z : AbstractPagingObject<T,
         return (if (type == FORWARDS) next else previous)?.let { endpoint!!.get(it) }?.let { json ->
             when (itemClazz) {
                 SimpleTrack::class -> json.toPagingObject(SimpleTrack.serializer(), null, endpointFinal, endpointFinal.api.json, true)
-                SpotifyCategory::class -> json.toPagingObject(SpotifyCategory.serializer(), "categories", endpointFinal, endpointFinal.api.json, true)
-                SimpleAlbum::class -> json.toPagingObject(SimpleAlbum.serializer(), "albums", endpointFinal, endpointFinal.api.json, true)
-                SimplePlaylist::class -> json.toPagingObject(SimplePlaylist.serializer(), "playlists", endpointFinal, endpointFinal.api.json, true)
+                SpotifyCategory::class -> json.toPagingObject(SpotifyCategory.serializer(), null, endpointFinal, endpointFinal.api.json, true)
+                SimpleAlbum::class -> json.toPagingObject(SimpleAlbum.serializer(), null, endpointFinal, endpointFinal.api.json, true)
+                SimplePlaylist::class -> json.toPagingObject(SimplePlaylist.serializer(), null, endpointFinal, endpointFinal.api.json, true)
                 SavedTrack::class -> json.toPagingObject(SavedTrack.serializer(), null, endpointFinal, endpointFinal.api.json, true)
                 SavedAlbum::class -> json.toPagingObject(SavedAlbum.serializer(), null, endpointFinal, endpointFinal.api.json, true)
                 Artist::class -> json.toPagingObject(Artist.serializer(), null, endpointFinal, endpointFinal.api.json, true)
@@ -154,7 +154,6 @@ public abstract class AbstractPagingObject<T : Any, Z : AbstractPagingObject<T,
 
         @Suppress("UNCHECKED_CAST")
         pagingObjects.add(this as Z)
-
         var nxt = next?.let { getNext() }
         while (nxt != null) {
             pagingObjects.add(nxt)

src/commonMain/kotlin/com.adamratzman.spotify/utils/Platform.kt

@@ -0,0 +1,13 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2020; Original author: Adam Ratzman */
+package com.adamratzman.spotify.utils
+
+/**
+ * Actual platforms that this program can be run on.
+ */
+public enum class Platform {
+    JVM,
+    ANDROID,
+    JS
+}
+
+public expect val platform: Platform

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

@@ -9,12 +9,14 @@ import com.adamratzman.spotify.models.Playlist
 import com.adamratzman.spotify.models.SimplePlaylist
 import com.adamratzman.spotify.runBlockingTest
 import com.adamratzman.spotify.spotifyApi
-import kotlin.test.AfterTest
+import com.adamratzman.spotify.utils.Platform
+import com.adamratzman.spotify.utils.platform
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 import kotlinx.coroutines.async
 import kotlinx.coroutines.awaitAll
+import kotlinx.coroutines.coroutineScope
 
 class ClientPlaylistApiTest {
     lateinit var api: SpotifyClientApi
@@ -32,8 +34,18 @@ class ClientPlaylistApiTest {
 
     private suspend fun tearDown() {
         if (::createdPlaylist.isInitialized) {
-            api.playlists.deleteClientPlaylist(createdPlaylist.id)
-            assertTrue(api.playlists.getClientPlaylist(createdPlaylist.id) == null)
+            coroutineScope {
+                api.playlists.getClientPlaylists().getAllItemsNotNull()
+                        .filter { it.name == "this is a test playlist" }
+                        .map {
+                            async {
+                                if (api.following.isFollowingPlaylist(it.id)) {
+                                    api.playlists.deleteClientPlaylist(it.id)
+                                }
+                            }
+                        }
+                        .awaitAll()
+            }
         }
     }
 
@@ -94,10 +106,12 @@ class ClientPlaylistApiTest {
 
             api.playlists.addTracksToClientPlaylist(createdPlaylist.id, "3WDIhWoRWVcaHdRwMEHkkS", "7FjZU7XFs7P9jHI9Z0yRhK")
 
-            api.playlists.uploadClientPlaylistCover(
-                    createdPlaylist.id,
-                    imageUrl = "https://developer.spotify.com/assets/WebAPI_intro.png"
-            )
+            if (platform != Platform.ANDROID) {
+                api.playlists.uploadClientPlaylistCover(
+                        createdPlaylist.id,
+                        imageUrl = "https://developer.spotify.com/assets/WebAPI_intro.png"
+                )
+            }
 
             var updatedPlaylist = api.playlists.getClientPlaylist(createdPlaylist.id)!!
             val fullPlaylist = updatedPlaylist.toFullPlaylist()!!

src/jsMain/kotlin/com/adamratzman/spotify/utils/Platform.kt

@@ -0,0 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2020; Original author: Adam Ratzman */
+package com.adamratzman.spotify.utils
+
+public actual val platform: Platform = Platform.JS

src/jvmMain/kotlin/com/adamratzman/spotify/utils/Platform.kt

@@ -0,0 +1,7 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2020; Original author: Adam Ratzman */
+package com.adamratzman.spotify.utils
+
+/**
+ * The actual platform that this program is running on.
+ */
+public actual val platform: Platform = Platform.JVM