Merge pull request #280 from adamint/dev

Add scope checks

Author: adamint

build.gradle.kts

@@ -5,22 +5,22 @@ import org.jetbrains.kotlin.gradle.targets.js.webpack.KotlinWebpackOutput.Target
 
 plugins {
    // id("lt.petuska.npm.publish") version "1.1.2"
-    kotlin("multiplatform") version "1.4.31"
+    kotlin("multiplatform") version "1.5.0"
     `maven-publish`
     signing
-    id("io.codearte.nexus-staging") version "0.22.0"
+    id("io.codearte.nexus-staging") version "0.30.0"
     id("com.android.library")
-    kotlin("plugin.serialization") version "1.4.30"
-    id("com.diffplug.spotless") version "5.9.0"
+    kotlin("plugin.serialization") version "1.5.0"
+    id("com.diffplug.spotless") version "5.12.4"
     id("com.moowork.node") version "1.3.1"
-    id("org.jetbrains.dokka") version "1.4.20"
+    id("org.jetbrains.dokka") version "1.4.30"
     id("kotlin-android-extensions")
 }
 
 repositories {
-    jcenter()
     google()
     maven("https://kotlin.bintray.com/kotlinx")
+    mavenCentral()
 }
 
 buildscript {
@@ -29,7 +29,7 @@ buildscript {
     }
     dependencies {
         classpath("com.android.tools.build:gradle:3.5.4")
-        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.31")
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.0")
     }
 }
 
@@ -211,19 +211,20 @@ kotlin {
 
     targets {
         sourceSets {
-            val serializationVersion = "1.1.0"
-            val ktorVersion = "1.5.1"
-            val korlibsVersion = "2.0.6"
+            val serializationVersion = "1.2.0"
+            val ktorVersion = "1.5.4"
+            val korlibsVersion = "2.0.7"
             val sparkVersion = "2.9.3"
             val androidSpotifyAuthVersion = "1.2.3"
             val androidCryptoVersion = "1.1.0-alpha03"
-            val coroutineMTVersion = "1.4.2-native-mt"
+            val coroutineMTVersion = "1.4.3-native-mt"
+            val kotlinxDatetimeVersion = "0.2.0"
 
             val commonMain by getting {
                 dependencies {
                     implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$serializationVersion")
                     implementation("io.ktor:ktor-client-core:$ktorVersion")
-                    implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.1.1")
+                    implementation("org.jetbrains.kotlinx:kotlinx-datetime:$kotlinxDatetimeVersion")
                     implementation("com.soywiz.korlibs.krypto:krypto:$korlibsVersion")
                     implementation("com.soywiz.korlibs.korim:korim:$korlibsVersion")
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.0-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

settings.gradle.kts

@@ -1,5 +1,5 @@
 pluginManagement {
-    val mainKotlinVersion = "1.4.31"
+    val mainKotlinVersion = "1.5.0"
 
     resolutionStrategy {
         eachPlugin {

src/androidMain/kotlin/com/adamratzman/spotify/auth/SpotifyDefaultCredentialStore.kt

@@ -194,8 +194,7 @@ public class SpotifyDefaultCredentialStore(
     public fun canApiBeRefreshed(): Boolean {
         return spotifyRefreshToken != null
     }
-    
-    
+
     /**
      * Clear the [SharedPreferences] instance corresponding to the Spotify credentials.
      */

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

@@ -5,9 +5,8 @@ import android.app.Activity
 import android.content.Context
 import android.util.Log
 import android.widget.Toast
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.runBlocking
 import java.net.URLEncoder
+import kotlinx.coroutines.runBlocking
 
 internal actual fun String.encodeUrl() = URLEncoder.encode(this, "UTF-8")!!
 
@@ -38,4 +37,4 @@ internal fun logToConsole(message: String) {
 
 public actual fun <T> runBlockingOnJvmAndNative(block: suspend () -> T): T {
     return runBlocking { block() }
-}
+}

src/androidTest/kotlin/com/adamratzman/spotify/CommonImpl.kt

@@ -31,4 +31,4 @@ public actual fun Exception.stackTrace() {
 public actual val testCoroutineContext: CoroutineContext =
         Executors.newSingleThreadExecutor().asCoroutineDispatcher()
 
-public actual fun runBlockingTest(block: suspend () -> Unit): Unit = runBlocking(testCoroutineContext) { this.block() }
+public actual fun runBlockingTest(block: suspend CoroutineScope.() -> Unit): Unit = runBlocking(testCoroutineContext) { this.block() }

src/commonJvmLikeMain/kotlin/com/adamratzman/spotify/javainterop/SpotifyContinuation.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 @file:JvmName("SpotifyContinuation")
 
 package com.adamratzman.spotify.javainterop
@@ -31,4 +32,4 @@ public abstract class SpotifyContinuation<in T> : Continuation<T> {
     }
 
     override val context: CoroutineContext = EmptyCoroutineContext
-}
+}

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

@@ -11,7 +11,6 @@ import com.adamratzman.spotify.endpoints.client.ClientPersonalizationApi
 import com.adamratzman.spotify.endpoints.client.ClientPlayerApi
 import com.adamratzman.spotify.endpoints.client.ClientPlaylistApi
 import com.adamratzman.spotify.endpoints.client.ClientProfileApi
-import com.adamratzman.spotify.endpoints.client.ClientSearchApi
 import com.adamratzman.spotify.endpoints.client.ClientShowApi
 import com.adamratzman.spotify.endpoints.pub.AlbumApi
 import com.adamratzman.spotify.endpoints.pub.ArtistApi
@@ -37,8 +36,8 @@ import com.adamratzman.spotify.models.serialization.nonstrictJson
 import com.adamratzman.spotify.models.serialization.toObject
 import com.adamratzman.spotify.utils.asList
 import com.adamratzman.spotify.utils.base64ByteEncode
-import kotlinx.serialization.json.Json
 import kotlin.jvm.JvmOverloads
+import kotlinx.serialization.json.Json
 
 /**
  * Represents an instance of the Spotify API client, with common
@@ -491,8 +490,7 @@ public open class SpotifyClientApi(
     override val browse: BrowseApi = BrowseApi(this)
     override val artists: ArtistApi = ArtistApi(this)
     override val tracks: TrackApi = TrackApi(this)
-
-    override val search: ClientSearchApi = ClientSearchApi(this)
+    override val search: SearchApi = SearchApi(this)
 
     override val episodes: ClientEpisodeApi = ClientEpisodeApi(this)
     override val shows: ClientShowApi = ClientShowApi(this)
@@ -783,5 +781,3 @@ public fun refreshSpotifyClientTokenRestAction(
     usesPkceAuth: Boolean
 ): SpotifyRestAction<Token> =
     SpotifyRestAction { refreshSpotifyClientToken(clientId, clientSecret, refreshToken, usesPkceAuth) }
-
-

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

@@ -113,14 +113,13 @@ public fun getSpotifyPkceCodeChallenge(codeVerifier: String): String {
  */
 public fun spotifyImplicitGrantApi(
     clientId: String?,
-    token: Token,
+    token: Token
 ): SpotifyImplicitGrantApi = SpotifyImplicitGrantApi(
     clientId,
     token,
     SpotifyApiOptions()
 )
 
-
 /**
  * Instantiate a new [SpotifyImplicitGrantApi] using a Spotify [clientId], and [token] retrieved from the implicit
  * grant flow.
@@ -323,7 +322,6 @@ public fun spotifyClientApi(
     }
 }
 
-
 /**
  * Instantiate a new [SpotifyClientApiBuilder] using a Spotify [clientId], [clientSecret], and [redirectUri], with the ability to configure
  * the api settings by providing a builder initialization [block]
@@ -707,7 +705,7 @@ public class SpotifyApiBuilder(
     /**
     * Create a new [SpotifyAppApi] that only has access to *public* endpoints and data
     */
-    public fun buildPublicRestAction(): SpotifyRestAction<SpotifyAppApi> = SpotifyRestAction{ buildPublic() }
+    public fun buildPublicRestAction(): SpotifyRestAction<SpotifyAppApi> = SpotifyRestAction { buildPublic() }
 
     /**
      * Create a new [SpotifyAppApi] that only has access to *public* endpoints and data

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

@@ -9,45 +9,74 @@ public sealed class SpotifyException(message: String, cause: Throwable? = null)
     public abstract class UnNullableException(message: String) : SpotifyException(message)
 
     /**
-     * Thrown when a request fails
+     * Thrown when a request fails.
+     *
+     * @param statusCode The status code of the request, if this exception is thrown after the completion of an HTTP request.
+     * @param reason The reason for the failure, as a readable message.
      */
-    public open class BadRequestException(message: String, public val statusCode: Int? = null, public val reason: String? = null, cause: Throwable? = null) :
-            SpotifyException(message, cause) {
+    public open class BadRequestException(
+        message: String,
+        public val statusCode: Int? = null,
+        public val reason: String? = null,
+        cause: Throwable? = null
+    ) :
+        SpotifyException(message, cause) {
         public constructor(message: String, cause: Throwable? = null) : this(message, null, null, cause)
         public constructor(error: ErrorObject?, cause: Throwable? = null) : this(
-                "Received Status Code ${error?.status}. Error cause: ${error?.message}" + (error?.reason?.let { ". Reason: ${error.reason}" }
-                        ?: ""),
-                error?.status,
-                error?.reason,
-                cause
+            "Received Status Code ${error?.status}. Error cause: ${error?.message}" + (error?.reason?.let { ". Reason: ${error.reason}" }
+                ?: ""),
+            error?.status,
+            error?.reason,
+            cause
         )
 
         public constructor(authenticationError: AuthenticationError) :
                 this(
-                        "Authentication error: ${authenticationError.error}. Description: ${authenticationError.description}",
-                        401
+                    "Authentication error: ${authenticationError.error}. Description: ${authenticationError.description}",
+                    401
                 )
 
         public constructor(responseException: ResponseException) :
                 this(
-                        responseException.message ?: "Bad Request",
-                        responseException.response.status.value,
-                        null,
-                        responseException
+                    responseException.message ?: "Bad Request",
+                    responseException.response.status.value,
+                    null,
+                    responseException
                 )
     }
 
+    /**
+     * Exception signifying that JSON (de)serialization failed. This is likely a library error rather than user error.
+     */
     public class ParseException(message: String, cause: Throwable? = null) : SpotifyException(message, cause)
 
+    /**
+     * Exception signifying that authentication (via token or code) was unsuccessful, likely due to an invalid access token, code,
+     * or refresh token.
+     */
     public class AuthenticationException(message: String, cause: Throwable? = null) : SpotifyException(message, cause) {
         public constructor(authenticationError: AuthenticationError?) :
                 this("Authentication error: ${authenticationError?.error}. Description: ${authenticationError?.description}")
     }
 
+    /**
+     * Exception signifying that the HTTP request associated with this API endpoint timed out (by default, after 100 seconds).
+     */
     public class TimeoutException(message: String, cause: Throwable? = null) : SpotifyException(message, cause)
 
     /**
      * Exception signifying that re-authentication via spotify-auth is necessary. Thrown by default when refreshTokenProducer is null.
      */
-    public class ReAuthenticationNeededException(cause: Throwable? = null, message: String? = null) : SpotifyException(message ?: "Re-authentication is needed.", cause)
+    public class ReAuthenticationNeededException(cause: Throwable? = null, message: String? = null) :
+        SpotifyException(message ?: "Re-authentication is needed.", cause)
+
+    /**
+     * Exception signifying that the current api token does not have the necessary scope to complete this request
+     *
+     */
+    public class SpotifyScopesNeededException(cause: Throwable? = null, public val missingScopes: List<SpotifyScope>) :
+        BadRequestException(
+            cause = cause,
+            message = "You tried to call a method that requires the following missing scopes: $missingScopes. Please make sure that your token is requested with these scopes."
+        )
 }