Merge pull request #171 from adamint/dev

adamint · web-flow · commit a63df4b9a33c · 2019-11-29T23:26:23.000-05:00
deprecate typealiases
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -14,7 +14,7 @@ plugins {
 }
 
 group = "com.adamratzman"
-version = "3.0.0-rc.4"
+version = "3.0.0-rc.5"
 
 java {
     withSourcesJar()
@@ -258,5 +258,4 @@ tasks {
         dependsOn.add(dokka)
         dependsOn.add("publishJvmPublicationToNexusRepository")
     }
-
 }
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/Builder.kt b/src/commonMain/kotlin/com.adamratzman.spotify/Builder.kt
@@ -529,5 +529,7 @@ data class SpotifyApiOptions(
     var json: Json
 )
 
+@Deprecated("Name has been replaced by `options`", ReplaceWith("SpotifyApiOptions"))
 typealias SpotifyUtilities = SpotifyApiOptions
+@Deprecated("Name has been replaced by `options`", ReplaceWith("SpotifyApiOptionsBuilder"))
 typealias SpotifyUtilitiesBuilder = SpotifyApiOptionsBuilder
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/SpotifyApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/SpotifyApi.kt
@@ -524,8 +524,10 @@ class SpotifyClientApi internal constructor(
                 scopes.all { token.scopes.contains(it) }
 }
 
+@Deprecated("API name has been updated for kotlin convention consistency", ReplaceWith("SpotifyApi"))
 typealias SpotifyAPI<T, B> = SpotifyApi<T, B>
 typealias SpotifyClientAPI = SpotifyClientApi
+@Deprecated("API name has been updated for kotlin convention consistency", ReplaceWith("SpotifyAppApi"))
 typealias SpotifyAppAPI = SpotifyAppApi
 
 fun getAuthUrlFull(vararg scopes: SpotifyScope, clientId: String, redirectUri: String): String {
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientFollowingApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientFollowingApi.kt
@@ -19,6 +19,7 @@ import com.adamratzman.spotify.models.serialization.toList
 import kotlinx.serialization.list
 import kotlinx.serialization.serializer
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("ClientFollowingApi"))
 typealias ClientFollowingAPI = ClientFollowingApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientLibraryApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientLibraryApi.kt
@@ -19,6 +19,7 @@ import com.adamratzman.spotify.models.serialization.toPagingObject
 import kotlinx.serialization.list
 import kotlinx.serialization.serializer
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("ClientLibraryApi"))
 typealias ClientLibraryAPI = ClientLibraryApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientPersonalizationApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientPersonalizationApi.kt
@@ -11,6 +11,7 @@ import com.adamratzman.spotify.models.PagingObject
 import com.adamratzman.spotify.models.Track
 import com.adamratzman.spotify.models.serialization.toPagingObject
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("ClientPersonalizationApi"))
 typealias ClientPersonalizationAPI = ClientPersonalizationApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientPlayerApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientPlayerApi.kt
@@ -28,6 +28,7 @@ import kotlinx.serialization.json.JsonPrimitive
 import kotlinx.serialization.json.json
 import kotlinx.serialization.list
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("ClientPlayerApi"))
 typealias ClientPlayerAPI = ClientPlayerApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientPlaylistApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientPlaylistApi.kt
@@ -34,6 +34,7 @@ import kotlinx.serialization.json.JsonObject
 import kotlinx.serialization.json.JsonPrimitive
 import kotlinx.serialization.json.json
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("ClientPlaylistApi"))
 typealias ClientPlaylistAPI = ClientPlaylistApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientProfileApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientProfileApi.kt
@@ -9,6 +9,7 @@ import com.adamratzman.spotify.http.EndpointBuilder
 import com.adamratzman.spotify.models.SpotifyUserInformation
 import com.adamratzman.spotify.models.serialization.toObject
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("ClientProfileApi"))
 typealias ClientUserAPI = ClientProfileApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/AlbumApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/AlbumApi.kt
@@ -17,6 +17,7 @@ import com.adamratzman.spotify.models.serialization.toPagingObject
 import com.adamratzman.spotify.utils.Market
 import com.adamratzman.spotify.utils.catch
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("AlbumApi"))
 typealias AlbumAPI = AlbumApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/ArtistApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/ArtistApi.kt
@@ -21,7 +21,9 @@ import com.adamratzman.spotify.utils.Market
 import com.adamratzman.spotify.utils.catch
 import kotlinx.serialization.list
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("ArtistApi"))
 typealias ArtistsAPI = ArtistApi
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("ArtistApi"))
 typealias ArtistAPI = ArtistApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/BrowseApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/BrowseApi.kt
@@ -28,6 +28,7 @@ import kotlin.reflect.KClass
 import kotlinx.serialization.list
 import kotlinx.serialization.serializer
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("BrowseApi"))
 typealias BrowseAPI = BrowseApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/FollowingApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/FollowingApi.kt
@@ -12,6 +12,7 @@ import com.adamratzman.spotify.models.serialization.toList
 import kotlinx.serialization.list
 import kotlinx.serialization.serializer
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("FollowingApi"))
 typealias FollowingAPI = FollowingApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/PlaylistApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/PlaylistApi.kt
@@ -22,6 +22,7 @@ import com.adamratzman.spotify.utils.Market
 import com.adamratzman.spotify.utils.catch
 import kotlinx.serialization.list
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("PlaylistApi"))
 typealias PlaylistAPI = PlaylistApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/SearchApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/SearchApi.kt
@@ -21,6 +21,7 @@ import com.adamratzman.spotify.utils.Market
 import kotlinx.serialization.json.JsonObject
 import kotlinx.serialization.serializer
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("SearchApi"))
 typealias SearchAPI = SearchApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/TrackApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/TrackApi.kt
@@ -16,7 +16,10 @@ import com.adamratzman.spotify.models.serialization.toObject
 import com.adamratzman.spotify.utils.Market
 import com.adamratzman.spotify.utils.catch
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("TrackApi"))
 typealias TracksAPI = TrackApi
+
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("TrackApi"))
 typealias TrackAPI = TrackApi
 
 /**
@@ -35,10 +38,10 @@ class TrackApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
         return toAction {
             catch {
                 get(
-                    EndpointBuilder("/tracks/${TrackUri(track).id.encodeUrl()}").with(
-                        "market",
-                        market?.name
-                    ).toString()
+                        EndpointBuilder("/tracks/${TrackUri(track).id.encodeUrl()}").with(
+                                "market",
+                                market?.name
+                        ).toString()
                 ).toObject(Track.serializer(), api, json)
             }
         }
@@ -55,10 +58,10 @@ class TrackApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
     fun getTracks(vararg tracks: String, market: Market? = null): SpotifyRestAction<List<Track?>> {
         return toAction {
             get(
-                EndpointBuilder("/tracks").with("ids", tracks.joinToString(",") { TrackUri(it).id.encodeUrl() })
-                    .with("market", market?.name).toString()
+                    EndpointBuilder("/tracks").with("ids", tracks.joinToString(",") { TrackUri(it).id.encodeUrl() })
+                            .with("market", market?.name).toString()
             )
-                .toObject(TrackList.serializer(), api, json).tracks
+                    .toObject(TrackList.serializer(), api, json).tracks
         }
     }
 
@@ -81,7 +84,7 @@ class TrackApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
     fun getAudioAnalysis(track: String): SpotifyRestAction<AudioAnalysis> {
         return toAction {
             get(EndpointBuilder("/audio-analysis/${TrackUri(track).id.encodeUrl()}").toString())
-                .toObject(AudioAnalysis.serializer(), api, json)
+                    .toObject(AudioAnalysis.serializer(), api, json)
         }
     }
 
@@ -95,7 +98,7 @@ class TrackApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
     fun getAudioFeatures(track: String): SpotifyRestAction<AudioFeatures> {
         return toAction {
             get(EndpointBuilder("/audio-features/${TrackUri(track).id.encodeUrl()}").toString())
-                .toObject(AudioFeatures.serializer(), api, json)
+                    .toObject(AudioFeatures.serializer(), api, json)
         }
     }
 
@@ -109,11 +112,11 @@ class TrackApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
     fun getAudioFeatures(vararg tracks: String): SpotifyRestAction<List<AudioFeatures?>> {
         return toAction {
             get(
-                EndpointBuilder("/audio-features").with(
-                    "ids",
-                    tracks.joinToString(",") { TrackUri(it).id.encodeUrl() }).toString()
+                    EndpointBuilder("/audio-features").with(
+                            "ids",
+                            tracks.joinToString(",") { TrackUri(it).id.encodeUrl() }).toString()
             )
-                .toObject(AudioFeaturesResponse.serializer(), api, json).audioFeatures
+                    .toObject(AudioFeaturesResponse.serializer(), api, json).audioFeatures
         }
     }
 }
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/UserApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/UserApi.kt
@@ -11,6 +11,7 @@ import com.adamratzman.spotify.models.UserUri
 import com.adamratzman.spotify.models.serialization.toObject
 import com.adamratzman.spotify.utils.catch
 
+@Deprecated("Endpoint name has been updated for kotlin convention consistency", ReplaceWith("UserApi"))
 typealias UserAPI = UserApi
 
 /**
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/models/ResultObjects.kt b/src/commonMain/kotlin/com.adamratzman.spotify/models/ResultObjects.kt
@@ -120,4 +120,5 @@ class SpotifyUriException(message: String) : SpotifyException.BadRequestExceptio
 class SpotifyRatelimitedException(time: Long) :
     SpotifyException.UnNullableException("Calls to the Spotify API have been ratelimited for $time seconds until ${getCurrentTimeMs() + time * 1000}ms")
 
+@Deprecated("Country enum has been updated to preserve consistency with Spotify documentation", ReplaceWith("Market"))
 typealias CountryCode = Market

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ plugins {`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`group = "com.adamratzman"`
`17`		`-version = "3.0.0-rc.4"`
	`17`	`+version = "3.0.0-rc.5"`
`18`	`18`
`19`	`19`	`java {`
`20`	`20`	`withSourcesJar()`
`@@ -258,5 +258,4 @@ tasks {`
`258`	`258`	`dependsOn.add(dokka)`
`259`	`259`	`dependsOn.add("publishJvmPublicationToNexusRepository")`
`260`	`260`	`}`
`261`		`-`
`262`	`261`	`}`
Original file line number	Diff line number	Diff line change
`@@ -529,5 +529,7 @@ data class SpotifyApiOptions(`
`529`	`529`	`var json: Json`
`530`	`530`	`)`
`531`	`531`
	`532`	+@Deprecated("Name has been replaced by `options`", ReplaceWith("SpotifyApiOptions"))
`532`	`533`	`typealias SpotifyUtilities = SpotifyApiOptions`
	`534`	+@Deprecated("Name has been replaced by `options`", ReplaceWith("SpotifyApiOptionsBuilder"))
`533`	`535`	`typealias SpotifyUtilitiesBuilder = SpotifyApiOptionsBuilder`
Original file line number	Diff line number	Diff line change
`@@ -524,8 +524,10 @@ class SpotifyClientApi internal constructor(`
`524`	`524`	`scopes.all { token.scopes.contains(it) }`
`525`	`525`	`}`
`526`	`526`
	`527`	`+@Deprecated("API name has been updated for kotlin convention consistency", ReplaceWith("SpotifyApi"))`
`527`	`528`	`typealias SpotifyAPI<T, B> = SpotifyApi<T, B>`
`528`	`529`	`typealias SpotifyClientAPI = SpotifyClientApi`
	`530`	`+@Deprecated("API name has been updated for kotlin convention consistency", ReplaceWith("SpotifyAppApi"))`
`529`	`531`	`typealias SpotifyAppAPI = SpotifyAppApi`
`530`	`532`
`531`	`533`	`fun getAuthUrlFull(vararg scopes: SpotifyScope, clientId: String, redirectUri: String): String {`