rename getPkceAuthorizationUrl to getSpotifyPkceAuthorizationUrl, add pkce builder

Signed-off-by: Adam Ratzman <[email protected]>

Author: adamint

README.md

@@ -190,18 +190,18 @@ the code challenge used to authorize the user.
 
 This library contains helpful methods that can be used to simplify the PKCE authorization process.
 This includes `getSpotifyPkceCodeChallenge`, which SHA256 hashes and base64url encodes the code 
-challenge, and `getPkceAuthorizationUrl`, which allows you to generate an easy authorization url for PKCE flow.
+challenge, and `getSpotifyPkceAuthorizationUrl`, 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-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.
 
-To get a PKCE authorization url, to which you can redirect a user, you can use the `getPkceAuthorizationUrl`
+To get a PKCE authorization url, to which you can redirect a user, you can use the `getSpotifyPkceAuthorizationUrl`
 top-level method. An example is shown below, requesting 4 different scopes.
 ```kotlin
 val codeVerifier = "thisisaveryrandomalphanumericcodeverifierandisgreaterthan43characters"
 val codeChallenge = getSpotifyPkceCodeChallenge(codeVerifier) // helper method
-val url: String = getPkceAuthorizationUrl(
+val url: String = getSpotifyPkceAuthorizationUrl(
     SpotifyScope.PLAYLIST_READ_PRIVATE,
     SpotifyScope.PLAYLIST_MODIFY_PRIVATE,
     SpotifyScope.USER_FOLLOW_READ,

src/androidMain/kotlin/com/adamratzman/spotify/auth/pkce/AbstractSpotifyPkceLoginActivity.kt

@@ -15,7 +15,7 @@ import com.adamratzman.spotify.SpotifyScope
 import com.adamratzman.spotify.SpotifyUserAuthorization
 import com.adamratzman.spotify.auth.SpotifyDefaultCredentialStore
 import com.adamratzman.spotify.auth.getDefaultCredentialStore
-import com.adamratzman.spotify.getPkceAuthorizationUrl
+import com.adamratzman.spotify.getSpotifyPkceAuthorizationUrl
 import com.adamratzman.spotify.getSpotifyPkceCodeChallenge
 import com.adamratzman.spotify.spotifyClientPkceApi
 import com.adamratzman.spotify.utils.logToConsole
@@ -59,7 +59,7 @@ public abstract class AbstractSpotifyPkceLoginActivity : AppCompatActivity() {
     /**
      * Get the authorization url that the client will be redirected to during PKCE authorization.
      */
-    public fun getAuthorizationUrl(): Uri = getPkceAuthorizationUrl(
+    public fun getAuthorizationUrl(): Uri = getSpotifyPkceAuthorizationUrl(
         *scopes.toTypedArray(),
         clientId = clientId,
         redirectUri = redirectUri,

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

@@ -60,7 +60,7 @@ public fun getSpotifyAuthorizationUrl(
  * Then, base64url encode the hash that you generated.
  *
  */
-public fun getPkceAuthorizationUrl(
+public fun getSpotifyPkceAuthorizationUrl(
     vararg scopes: SpotifyScope,
     clientId: String,
     redirectUri: String,
@@ -345,6 +345,40 @@ public fun spotifyClientPkceApi(
     usesPkceAuth = true
 }
 
+/**
+ * Instantiate a new [SpotifyClientApiBuilder]. This is for **PKCE authorization**.
+ *
+ * Use case: I am using the PKCE client authorization flow.
+ *
+ * @param clientId Spotify [client id](https://developer.spotify.com/documentation/general/guides/app-settings/)
+ * @param redirectUri Spotify [redirect uri](https://developer.spotify.com/documentation/general/guides/app-settings/)
+ * @param pkceCodeVerifier The code verifier generated that the client authenticated with (using its code challenge)
+ * @param authorizationCode Only available when building [SpotifyClientApi]. Spotify auth code
+ * @param block Override default API options such as the cache limit
+ *
+ * @return Configurable [SpotifyClientApiBuilder] that, when built, creates a new [SpotifyClientApi]
+ */
+public fun spotifyClientPkceApi(
+    clientId: String?,
+    redirectUri: String?,
+    authorizationCode: String,
+    pkceCodeVerifier: String,
+    block: SpotifyApiOptions.() -> Unit = {}
+): SpotifyClientApiBuilder = SpotifyClientApiBuilder().apply {
+    credentials {
+        this.clientId = clientId
+        this.redirectUri = redirectUri
+    }
+
+    authorization {
+        this.authorizationCode = authorizationCode
+        this.pkceCodeVerifier = pkceCodeVerifier
+    }
+    options(block)
+
+    usesPkceAuth = true
+}
+
 /**
  *  Spotify API builder
  */

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

@@ -169,7 +169,7 @@ public sealed class SpotifyApi<T : SpotifyApi<T, B>, B : ISpotifyApiBuilder<T, B
         )
     }
 
-    public fun getPkceAuthorizationUrl(
+    public fun getSpotifyPkceAuthorizationUrl(
         vararg scopes: SpotifyScope,
         redirectUri: String,
         codeChallenge: String,

src/jvmTest/kotlin/com/adamratzman/spotify/PkceTest.kt

@@ -22,7 +22,7 @@ class PkceTest {
             val state = Random.nextLong().toString()
 
             println(
-                getPkceAuthorizationUrl(
+                getSpotifyPkceAuthorizationUrl(
                     *SpotifyScope.values(),
                     clientId = clientId,
                     redirectUri = serverRedirectUri,