fix spotify URIs and remove URI deserialization

Author: adamint

build.gradle.kts

@@ -1,3 +1,4 @@
+
 import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.kotlin.gradle.dsl.KotlinJsCompile
 
@@ -14,7 +15,7 @@ plugins {
 }
 
 group = "com.adamratzman"
-version = "3.0.0-rc.3"
+version = "3.0.0-rc.5"
 
 java {
     withSourcesJar()
@@ -34,9 +35,9 @@ kotlin {
     targets {
         sourceSets {
             val coroutineVersion = "1.3.2"
-            val serializationVersion = "0.13.0"
+            val serializationVersion = "0.14.0"
             val spekVersion = "2.0.8"
-            val ktorVersion = "1.2.5"
+            val ktorVersion = "1.2.6"
 
             val commonMain by getting {
                 dependencies {
@@ -123,6 +124,7 @@ nexusStaging {
     packageGroup = "com.adamratzman"
 }
 
+
 publishing {
     publications {
         val jvm by getting(MavenPublication::class) {
@@ -258,4 +260,4 @@ tasks {
         dependsOn.add(dokka)
         dependsOn.add("publishJvmPublicationToNexusRepository")
     }
-}
+}

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
+#Sat Nov 30 21:26:10 EST 2019
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-all.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip
-zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME

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

@@ -1,13 +1,9 @@
 /* Spotify Web API - Kotlin Wrapper; MIT License, 2019; Original author: Adam Ratzman */
 package com.adamratzman.spotify.models
 
-import kotlinx.serialization.Decoder
-import kotlinx.serialization.Encoder
-import kotlinx.serialization.KSerializer
-import kotlinx.serialization.SerialDescriptor
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.Serializer
-import kotlinx.serialization.internal.StringDescriptor
+import kotlinx.serialization.Transient
 
 private fun String.matchType(type: String): String? {
     val typeRegex = "^spotify:(?:.*:)*$type:([^:]+)(?::.*)*$|^([^:]+)$".toRegex()
@@ -29,20 +25,14 @@ private fun String.remove(type: String): String {
     throw SpotifyUriException("Illegal Spotify ID/URI: '$this' isn't convertible to '$type' id")
 }
 
-private class SimpleUriSerializer<T : SpotifyUri>(val ctor: (String) -> T) : KSerializer<T> {
-    override val descriptor: SerialDescriptor = StringDescriptor
-    override fun deserialize(decoder: Decoder): T = ctor(decoder.decodeString())
-    override fun serialize(encoder: Encoder, obj: T) = encoder.encodeString(obj.uri)
-}
-
 /**
  * Represents a Spotify URI, parsed from either a Spotify ID or taken from an endpoint.
  *
  * @property uri retrieve this URI as a string
  * @property id representation of this uri as an id
  */
 @Serializable
-sealed class SpotifyUri(val input: String, type: String) {
+sealed class SpotifyUri(val input: String, val type: String) {
     val uri: String
     val id: String
 
@@ -54,7 +44,7 @@ sealed class SpotifyUri(val input: String, type: String) {
     }
 
     override fun equals(other: Any?): Boolean {
-        val spotifyUri = other as? SpotifyUri ?: return false
+        val spotifyUri = other as? SpotifyUri ?: return (other as? String)?.let { this.uri == it } ?: false
         return spotifyUri.uri == this.uri
     }
 
@@ -68,12 +58,7 @@ sealed class SpotifyUri(val input: String, type: String) {
         return "SpotifyUri($uri)"
     }
 
-    @Serializer(forClass = SpotifyUri::class)
-    companion object : KSerializer<SpotifyUri> {
-        override val descriptor: SerialDescriptor = StringDescriptor
-        override fun deserialize(decoder: Decoder): SpotifyUri = SpotifyUri(decoder.decodeString())
-        override fun serialize(encoder: Encoder, obj: SpotifyUri) = encoder.encodeString(obj.uri)
-
+    companion object {
         /**
          * This function safely instantiates a SpotifyUri from given constructor.
          * */
@@ -89,9 +74,12 @@ sealed class SpotifyUri(val input: String, type: String) {
          * Creates a abstract SpotifyUri of given input. Doesn't allow ambiguity by disallowing creation by id.
          * */
         operator fun invoke(input: String): SpotifyUri {
-            val constructors = listOf(::AlbumUri, ::ArtistUri, TrackUri.Companion::invoke, ::UserUri, ::PlaylistUri)
+            val constructors = listOf(::AlbumUri, ::ArtistUri, ::LocalTrackUri, ::PlaylistUri, ::SpotifyTrackUri, ::UserUri)
             for (ctor in constructors) {
-                safeInitiate(input, ctor)?.takeIf { it.uri == input }?.also { return it }
+                safeInitiate(input, ctor)?.takeIf {
+                    @Suppress("ReplaceCallWithBinaryOperator")
+                    it.equals(input)
+                }?.also { return it }
             }
 
             throw SpotifyUriException("Illegal Spotify ID/URI: '$input' isn't convertible to any arbitrary id")
@@ -129,10 +117,7 @@ sealed class SpotifyUri(val input: String, type: String) {
  * Represents a Spotify **Album** URI, parsed from either a Spotify ID or taken from an endpoint.
  */
 @Serializable
-class AlbumUri(input: String) : SpotifyUri(input, "album") {
-    @Serializer(forClass = AlbumUri::class)
-    companion object : KSerializer<AlbumUri> by SimpleUriSerializer(::AlbumUri)
-}
+class AlbumUri(@Transient private val _input: String = TRANSIENT_EMPTY_STRING) : SpotifyUri(_input, "album")
 
 @Deprecated("renamed", ReplaceWith("AlbumUri", "com.adamratzman.spotify.models.AlbumUri"))
 typealias AlbumURI = AlbumUri
@@ -141,22 +126,15 @@ typealias AlbumURI = AlbumUri
  * Represents a Spotify **Artist** URI, parsed from either a Spotify ID or taken from an endpoint.
  */
 @Serializable
-class ArtistUri(input: String) : SpotifyUri(input, "artist") {
-    @Serializer(forClass = ArtistUri::class)
-    companion object : KSerializer<ArtistUri> by SimpleUriSerializer(::ArtistUri)
-}
-
+class ArtistUri(@Transient private val _input: String = TRANSIENT_EMPTY_STRING) : SpotifyUri(_input, "artist")
 @Deprecated("renamed", ReplaceWith("ArtistUri", "com.adamratzman.spotify.models.ArtistUri"))
 typealias ArtistURI = ArtistUri
 
 /**
  * Represents a Spotify **User** URI, parsed from either a Spotify ID or taken from an endpoint.
  */
 @Serializable
-class UserUri(input: String) : SpotifyUri(input, "user") {
-    @Serializer(forClass = UserUri::class)
-    companion object : KSerializer<UserUri> by SimpleUriSerializer(::UserUri)
-}
+class UserUri(@Transient private val _input: String = TRANSIENT_EMPTY_STRING) : SpotifyUri(_input, "user")
 
 @Deprecated("renamed", ReplaceWith("UserUri", "com.adamratzman.spotify.models.UserUri"))
 typealias UserURI = UserUri
@@ -165,9 +143,17 @@ typealias UserURI = UserUri
  * Represents a Spotify **Playlist** URI, parsed from either a Spotify ID or taken from an endpoint.
  */
 @Serializable
-class PlaylistUri(input: String) : SpotifyUri(input, "playlist") {
-    @Serializer(forClass = PlaylistUri::class)
-    companion object : KSerializer<PlaylistUri> by SimpleUriSerializer(::PlaylistUri)
+class PlaylistUri(@Transient private val _input: String = TRANSIENT_EMPTY_STRING) : SpotifyUri(_input, "playlist") {
+    override fun equals(other: Any?): Boolean {
+        val spotifyUri = other as? SpotifyUri ?: return (other as? String)?.endsWith(this.uri.removePrefix("spotify")) ?: false
+        return spotifyUri.uri == this.uri
+    }
+
+    override fun hashCode(): Int {
+        var result = super.hashCode()
+        result = 31 * result + _input.hashCode()
+        return result
+    }
 }
 
 @Deprecated("renamed", ReplaceWith("PlaylistUri", "com.adamratzman.spotify.models.PlaylistUri"))
@@ -178,13 +164,14 @@ typealias PlaylistURI = PlaylistUri
  * from an endpoint
  * */
 @Serializable
-sealed class TrackUri(input: String, type: String) : SpotifyUri(input, type) {
-    @Serializer(forClass = TrackUri::class)
-    companion object : KSerializer<TrackUri> {
-        override val descriptor: SerialDescriptor = StringDescriptor
-        override fun deserialize(decoder: Decoder): TrackUri = TrackUri(decoder.decodeString())
-        override fun serialize(encoder: Encoder, obj: TrackUri) = encoder.encodeString(obj.uri)
+sealed class TrackUri(
+    @Transient private val _input: String = TRANSIENT_EMPTY_STRING,
+    @Transient private val _type: String = TRANSIENT_EMPTY_STRING
+) :
+    SpotifyUri(_input, _type) {
 
+    @Serializer(forClass = TrackUri::class)
+    companion object {
         /**
          * Creates a abstract TrackURI of given input. Prefers SpotifyTrackUri if the input is ambiguous.
          * */
@@ -205,19 +192,13 @@ typealias TrackURI = TrackUri
  * Represents a Spotify **Track** URI, parsed from either a Spotify ID or taken from an endpoint.
  */
 @Serializable
-class SpotifyTrackUri(input: String) : TrackUri(input, "track") {
-    @Serializer(forClass = SpotifyTrackUri::class)
-    companion object : KSerializer<SpotifyTrackUri> by SimpleUriSerializer(::SpotifyTrackUri)
-}
+class SpotifyTrackUri(@Transient private val _input: String = TRANSIENT_EMPTY_STRING) : TrackUri(_input, "track")
 
 /**
  * Represents a Spotify **local track** URI
  */
 @Serializable
-class LocalTrackUri(input: String) : TrackUri(input, "local") {
-    @Serializer(forClass = LocalTrackUri::class)
-    companion object : KSerializer<LocalTrackUri> by SimpleUriSerializer(::LocalTrackUri)
-}
+class LocalTrackUri(@Transient private val _input: String = TRANSIENT_EMPTY_STRING) : TrackUri(_input, "local")
 
 @Deprecated("renamed", ReplaceWith("LocalTrackUri", "com.adamratzman.spotify.models.LocalTrackUri"))
 typealias LocalTrackURI = LocalTrackUri

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

@@ -10,14 +10,12 @@ import com.adamratzman.spotify.models.SpotifyUri
 import com.adamratzman.spotify.models.SpotifyUriException
 import com.adamratzman.spotify.models.TrackUri
 import com.adamratzman.spotify.models.UserUri
+import org.spekframework.spek2.Spek
+import org.spekframework.spek2.style.specification.describe
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 import kotlin.test.assertFalse
 import kotlin.test.assertTrue
-import kotlinx.serialization.json.Json
-import kotlinx.serialization.json.JsonConfiguration
-import org.spekframework.spek2.Spek
-import org.spekframework.spek2.style.specification.describe
 
 class UrisTests : Spek({
     describe("Uris tests") {
@@ -186,6 +184,16 @@ class UrisTests : Spek({
                     UserUri("spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83").uri
                 )
 
+                assertEquals(
+                        "spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83",
+                        SpotifyUri("spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83").uri
+                )
+
+                assertEquals(
+                        UserUri::class,
+                        SpotifyUri("spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83")::class
+                )
+
                 assertEquals(
                     "7r7uq6qxa4ymx3wnjd9mm6i83",
                     UserUri("spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83").id
@@ -255,7 +263,12 @@ class UrisTests : Spek({
 
                 assertEquals(
                     "spotify:playlist:66wcLiS5R50akaQ3onDyZd",
-                    PlaylistUri("spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83:playlist:66wcLiS5R50akaQ3onDyZd").uri
+                    SpotifyUri("spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83:playlist:66wcLiS5R50akaQ3onDyZd").uri
+                )
+
+                assertEquals(
+                        PlaylistUri::class,
+                        SpotifyUri("spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83:playlist:66wcLiS5R50akaQ3onDyZd")::class
                 )
 
                 assertEquals(
@@ -349,40 +362,7 @@ class UrisTests : Spek({
             }
         }
     }
-    describe("Uri serialization test") {
-        val json = Json(JsonConfiguration.Stable)
-        it("create UserUri from json by using SpotifyUri.serializer()") {
-            val spotifyUri: SpotifyUri =
-                json.parse(SpotifyUri.serializer(), "\"spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83\"")
-            assertEquals(
-                UserUri::class,
-                spotifyUri::class
-            )
-            assertEquals(
-                "spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83",
-                spotifyUri.uri
-            )
-        }
-        it("create UserUri from json by using UserUri.serializer()") {
-            val userUri = json.parse(UserUri.serializer(), "\"spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83\"")
-            assertEquals(
-                "spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83",
-                userUri.uri
-            )
-        }
-        it("try creating UserUri from json with id by using SpotifyUri.serializer()") {
-            assertFailsWith<SpotifyUriException> {
-                json.parse(SpotifyUri.serializer(), "\"7r7uq6qxa4ymx3wnjd9mm6i83\"")
-            }
-        }
-        it("create UserUri from json with id by using UserUri.serializer()") {
-            val userUri = json.parse(UserUri.serializer(), "\"7r7uq6qxa4ymx3wnjd9mm6i83\"")
-            assertEquals(
-                "spotify:user:7r7uq6qxa4ymx3wnjd9mm6i83",
-                userUri.uri
-            )
-        }
-    }
+
     describe("Uri types test") {
         it("test user uri string is a UserUri") {
             assertTrue {