Merge branch 'dev' into serialization

Author: molikuner

build.gradle.kts

@@ -1,21 +1,20 @@
-
 import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.kotlin.gradle.dsl.KotlinJsCompile
 
 plugins {
     `maven-publish`
     signing
     `java-library`
-    id("io.codearte.nexus-staging") version "0.21.1"
+    id("io.codearte.nexus-staging") version "0.21.2"
     kotlin("multiplatform") version "1.3.61"
     kotlin("plugin.serialization") version "1.3.61"
-    id("com.diffplug.gradle.spotless") version "3.26.0"
+    id("com.diffplug.gradle.spotless") version "3.26.1"
     id("com.moowork.node") version "1.3.1"
     id("org.jetbrains.dokka") version "0.10.0"
 }
 
 group = "com.adamratzman"
-version = "3.0.0-rc.5"
+version = "3.0.0"
 
 java {
     withSourcesJar()
@@ -34,10 +33,10 @@ kotlin {
 
     targets {
         sourceSets {
-            val coroutineVersion = "1.3.2"
+            val coroutineVersion = "1.3.3"
             val serializationVersion = "0.14.0"
-            val spekVersion = "2.0.8"
-            val ktorVersion = "1.2.6"
+            val spekVersion = "2.0.9"
+            val ktorVersion = "1.3.0-rc2"
 
             val commonMain by getting {
                 dependencies {
@@ -62,7 +61,6 @@ kotlin {
                 }
 
                 dependencies {
-                    implementation("com.neovisionaries:nv-i18n:1.26")
                     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutineVersion")
                     implementation("org.jetbrains.kotlinx:kotlinx-serialization-runtime:$serializationVersion")
                     implementation("io.ktor:ktor-client-apache:$ktorVersion")
@@ -74,7 +72,7 @@ kotlin {
                 dependencies {
                     implementation(kotlin("test"))
                     implementation(kotlin("test-junit"))
-                    implementation("org.junit.jupiter:junit-jupiter:5.5.2")
+                    implementation("org.junit.jupiter:junit-jupiter:5.6.0-M1")
                     implementation("org.spekframework.spek2:spek-dsl-jvm:$spekVersion")
                     runtimeOnly("org.spekframework.spek2:spek-runner-junit5:$spekVersion")
                     runtimeOnly(kotlin("reflect"))
@@ -83,7 +81,7 @@ kotlin {
 
             val jsMain by getting {
                 dependencies {
-                    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core-js:1.3.2")
+                    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core-js:$coroutineVersion")
                     implementation("org.jetbrains.kotlinx:kotlinx-serialization-runtime-js:$serializationVersion")
                     implementation("io.ktor:ktor-client-js:$ktorVersion")
                     compileOnly(kotlin("stdlib-js"))

src/commonMain/kotlin/com.adamratzman.spotify/SpotifyApi.kt

@@ -413,7 +413,7 @@ class SpotifyClientApi internal constructor(
     val userId: String
 
     init {
-        userId = users.getUserProfile().complete().id
+        userId = users.getClientProfile().complete().id
     }
 
     /**

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

@@ -59,7 +59,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @return The created [Playlist] object with no tracks
      */
-    fun createPlaylist(
+    fun createClientPlaylist(
         name: String,
         description: String? = null,
         public: Boolean? = null,
@@ -95,8 +95,8 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      * @throws BadRequestException if any invalid track ids is provided or the playlist is not found
      */
 
-    fun addTrackToPlaylist(playlist: String, track: String, position: Int? = null) =
-        addTracksToPlaylist(playlist, track, position = position)
+    fun addTrackToClientPlaylist(playlist: String, track: String, position: Int? = null) =
+        addTracksToClientPlaylist(playlist, track, position = position)
 
     /**
      * Add one or more tracks to a user’s playlist.
@@ -112,7 +112,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @throws BadRequestException if any invalid track ids is provided or the playlist is not found
      */
-    fun addTracksToPlaylist(playlist: String, vararg tracks: String, position: Int? = null): SpotifyRestAction<Unit> {
+    fun addTracksToClientPlaylist(playlist: String, vararg tracks: String, position: Int? = null): SpotifyRestAction<Unit> {
         val body = jsonMap()
         body += json { "uris" to JsonArray(tracks.map { TrackUri(TrackUri(it).id.encodeUrl()).uri }.map(::JsonPrimitive)) }
         if (position != null) body += json { "position" to position }
@@ -139,7 +139,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @throws BadRequestException if the playlist is not found or parameters exceed the max length
      */
-    fun changePlaylistDetails(
+    fun changeClientPlaylistDetails(
         playlist: String,
         name: String? = null,
         public: Boolean? = null,
@@ -172,7 +172,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @throws BadRequestException if the filters provided are illegal
      */
-    fun getPlaylists(
+    fun getClientPlaylists(
         limit: Int? = null,
         offset: Int? = null
     ): SpotifyRestActionPaging<SimplePlaylist, PagingObject<SimplePlaylist>> {
@@ -185,7 +185,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
     }
 
     /**
-     * Find a client playlist by its id. If you want to find multiple playlists, consider using [getPlaylists]
+     * Find a client playlist by its id. If you want to find multiple playlists, consider using [getClientPlaylists]
      *
      * **Note that** private playlists are only retrievable for the current user and require the [SpotifyScope.PLAYLIST_READ_PRIVATE] scope
      * to have been authorized by the user. Note that this scope alone will not return a collaborative playlist, even
@@ -197,9 +197,9 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @return A possibly-null [SimplePlaylist] if the playlist doesn't exist
      */
-    fun getPlaylist(id: String): SpotifyRestAction<SimplePlaylist?> {
+    fun getClientPlaylist(id: String): SpotifyRestAction<SimplePlaylist?> {
         return toAction {
-            val playlists = getPlaylists().complete()
+            val playlists = getClientPlaylists().complete()
             playlists.items.find { it.id == id } ?: playlists.getAllItems().complete().find { it.id == id }
         }
     }
@@ -211,7 +211,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @param playlist playlist id
      */
-    fun deletePlaylist(playlist: String): SpotifyRestAction<Unit> {
+    fun deleteClientPlaylist(playlist: String): SpotifyRestAction<Unit> {
         return (api as SpotifyClientApi).following.unfollowPlaylist(PlaylistUri(playlist).id)
     }
 
@@ -235,7 +235,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @throws BadRequestException if the playlist is not found or illegal filters are applied
      */
-    fun reorderPlaylistTracks(
+    fun reorderClientPlaylistTracks(
         playlist: String,
         reorderRangeStart: Int,
         reorderRangeLength: Int? = null,
@@ -267,7 +267,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @throws BadRequestException if playlist is not found or illegal tracks are provided
      */
-    fun setPlaylistTracks(playlist: String, vararg tracks: String): SpotifyRestAction<Unit> {
+    fun setClientPlaylistTracks(playlist: String, vararg tracks: String): SpotifyRestAction<Unit> {
         return toAction {
             val body = jsonMap()
             body += json { "uris" to JsonArray(tracks.map { TrackUri(TrackUri(it).id.encodeUrl()).uri }.map(::JsonPrimitive)) }
@@ -291,14 +291,14 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      *
      * @throws BadRequestException if playlist is not found or illegal tracks are provided
      */
-    fun replacePlaylistTracks(playlist: String, vararg tracks: String) = setPlaylistTracks(playlist, *tracks)
+    fun replaceClientPlaylistTracks(playlist: String, vararg tracks: String) = setClientPlaylistTracks(playlist, *tracks)
 
     /**
      * Remove all the tracks in a playlist
      * @param playlist the spotify id or uri for the playlist.
      */
-    fun removeAllPlaylistTracks(playlist: String): SpotifyRestAction<Unit> {
-        return setPlaylistTracks(playlist)
+    fun removeAllClientPlaylistTracks(playlist: String): SpotifyRestAction<Unit> {
+        return setClientPlaylistTracks(playlist)
     }
 
     /**
@@ -322,7 +322,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      * @throws IIOException if the image is not found
      * @throws BadRequestException if invalid data is provided
      */
-    fun uploadPlaylistCover(
+    fun uploadClientPlaylistCover(
         playlist: String,
         imagePath: String? = null,
         imageFile: File? = null,
@@ -357,12 +357,12 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      * @param positions The positions at which the track is located in the playlist
      * @param snapshotId The playlist snapshot against which to apply this action. **recommended to have**
      */
-    fun removeTrackFromPlaylist(
+    fun removeTrackFromClientPlaylist(
         playlist: String,
         track: String,
         positions: SpotifyTrackPositions,
         snapshotId: String? = null
-    ) = removeTracksFromPlaylist(playlist, track to positions, snapshotId = snapshotId)
+    ) = removeTracksFromClientPlaylist(playlist, track to positions, snapshotId = snapshotId)
 
     /**
      * Remove all occurrences of a track from the specified playlist.
@@ -374,11 +374,11 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      * @param track The track id
      * @param snapshotId The playlist snapshot against which to apply this action. **recommended to have**
      */
-    fun removeTrackFromPlaylist(
+    fun removeTrackFromClientPlaylist(
         playlist: String,
         track: String,
         snapshotId: String? = null
-    ) = removeTracksFromPlaylist(playlist, track, snapshotId = snapshotId)
+    ) = removeTracksFromClientPlaylist(playlist, track, snapshotId = snapshotId)
 
     /**
      * Remove all occurrences of the specified tracks from the given playlist.
@@ -390,7 +390,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      * @param tracks An array of track ids
      * @param snapshotId The playlist snapshot against which to apply this action. **recommended to have**
      */
-    fun removeTracksFromPlaylist(
+    fun removeTracksFromClientPlaylist(
         playlist: String,
         vararg tracks: String,
         snapshotId: String? = null
@@ -406,7 +406,7 @@ class ClientPlaylistApi(api: SpotifyApi<*, *>) : PlaylistApi(api) {
      * @param tracks An array of [Pair]s of track ids *and* track positions (zero-based)
      * @param snapshotId The playlist snapshot against which to apply this action. **recommended to have**
      */
-    fun removeTracksFromPlaylist(
+    fun removeTracksFromClientPlaylist(
         playlist: String,
         vararg tracks: Pair<String, SpotifyTrackPositions>,
         snapshotId: String? = null

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

@@ -26,9 +26,12 @@ class ClientProfileApi(api: SpotifyApi<*, *>) : UserApi(api) {
      *
      * @return Never-null [SpotifyUserInformation] object with possibly-null country, email, subscription and birthday fields
      */
-    fun getUserProfile(): SpotifyRestAction<SpotifyUserInformation> {
+    fun getClientProfile(): SpotifyRestAction<SpotifyUserInformation> {
         return toAction {
             get(EndpointBuilder("/me").toString()).toObject(SpotifyUserInformation.serializer(), api, json)
         }
     }
+
+    @Deprecated("Renamed to use `client` instead of `user`", ReplaceWith("getClientProfile"))
+    fun getUserProfile() = getClientProfile()
 }

src/commonMain/kotlin/com.adamratzman.spotify/http/HttpConnection.kt

@@ -9,17 +9,17 @@ import io.ktor.client.HttpClient
 import io.ktor.client.features.ResponseException
 import io.ktor.client.request.HttpRequestBuilder
 import io.ktor.client.request.header
+import io.ktor.client.request.request
 import io.ktor.client.request.url
-import io.ktor.client.response.readText
+import io.ktor.client.statement.readText
 import io.ktor.client.utils.EmptyContent
 import io.ktor.http.ContentType
 import io.ktor.http.HttpMethod
 import io.ktor.http.content.ByteArrayContent
 import io.ktor.http.content.TextContent
+import io.ktor.utils.io.core.toByteArray
 import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.delay
-import kotlinx.io.core.toByteArray
-import kotlinx.io.core.use
 
 enum class HttpRequestMethod(internal val externalMethod: HttpMethod) {
     GET(HttpMethod.Get),
@@ -88,39 +88,38 @@ internal class HttpConnection constructor(
         val httpRequest = buildRequest(additionalHeaders)
 
         try {
-            return client.execute(httpRequest).use {
-                val resp = it.response
-                val respCode = resp.status.value
+            return client.request<io.ktor.client.statement.HttpResponse>(httpRequest).let { response ->
+                val respCode = response.status.value
 
                 if (respCode == 502 && retryIf502) {
                     api?.logger?.logError(
-                        false,
-                        "Received 502 (Invalid response) for URL $url and $this\nRetrying..",
-                        null
+                            false,
+                            "Received 502 (Invalid response) for URL $url and $this\nRetrying..",
+                            null
                     )
-                    return@use execute(additionalHeaders, retryIf502 = false)
+                    return@let execute(additionalHeaders, retryIf502 = false)
                 } else if (respCode == 502 && !retryIf502) {
                     api?.logger?.logWarning("Recieved 502 (Invalid response) for URL $url and $this\nNot retrying")
                 }
 
                 if (respCode == 429) {
-                    val ratelimit = resp.headers["Retry-After"]!!.toLong() + 1L
+                    val ratelimit = response.headers["Retry-After"]!!.toLong() + 1L
                     if (api?.retryWhenRateLimited == true) {
                         api.logger.logError(
-                            false,
-                            "The request ($url) was ratelimited for $ratelimit seconds at ${getCurrentTimeMs()}",
-                            null
+                                false,
+                                "The request ($url) was ratelimited for $ratelimit seconds at ${getCurrentTimeMs()}",
+                                null
                         )
 
                         delay(ratelimit * 1000)
-                        return@use execute(additionalHeaders, retryIf502 = retryIf502)
+                        return@let execute(additionalHeaders, retryIf502 = retryIf502)
                     } else throw SpotifyRatelimitedException(ratelimit)
                 }
 
-                val body = resp.readText()
+                val body = response.readText()
 
                 if (respCode == 401 && body.contains("access token") &&
-                    api != null && api.automaticRefresh
+                        api != null && api.automaticRefresh
                 ) {
                     api.suspendRefreshToken()
                     val newAdditionalHeaders = additionalHeaders?.toMutableList() ?: mutableListOf()
@@ -129,14 +128,14 @@ internal class HttpConnection constructor(
                 }
 
                 return HttpResponse(
-                    responseCode = respCode,
-                    body = body,
-                    headers = resp.headers.entries().map { (key, value) ->
-                        HttpHeader(
-                            key,
-                            value.getOrNull(0) ?: "null"
-                        )
-                    }
+                        responseCode = respCode,
+                        body = body,
+                        headers = response.headers.entries().map { (key, value) ->
+                            HttpHeader(
+                                    key,
+                                    value.getOrNull(0) ?: "null"
+                            )
+                        }
                 )
             }
         } catch (e: CancellationException) {

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

@@ -35,12 +35,12 @@ data class SpotifyCategory(
  */
 @Serializable
 data class RecommendationSeed(
-    @SerialName("href") override val href: String?,
+    @SerialName("href") override val href: String? = null,
     @SerialName("id") override val id: String,
 
     val initialPoolSize: Int,
     val afterFilteringSize: Int,
-    val afterRelinkingSize: Int?,
+    val afterRelinkingSize: Int? = null,
     val type: String
 ) : Identifiable()
 

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

@@ -62,9 +62,9 @@ class PagingObject<T : Any>(
     override val href: String,
     override val items: List<T>,
     override val limit: Int,
-    override val next: String?,
+    override val next: String? = null,
     override val offset: Int,
-    override val previous: String?,
+    override val previous: String? = null,
     override val total: Int = 0
 ) : AbstractPagingObject<T>(href, items, limit, next, offset, previous, total) {
     @Suppress("UNCHECKED_CAST")
@@ -135,7 +135,7 @@ class CursorBasedPagingObject<T : Any>(
     override val href: String,
     override val items: List<T>,
     override val limit: Int,
-    override val next: String?,
+    override val next: String? = null,
     @SerialName("cursors") val cursor: Cursor,
     override val total: Int = 0
 ) : AbstractPagingObject<T>(href, items, limit, next, 0, null, total) {