make pkce multiplatform (fixes #252 and #253)

adamint · adamint · commit fc6678a7ab3c · 2021-02-06T09:17:00.000-05:00
Signed-off-by: Adam Ratzman &lt;adam@adamratzman.com&gt;
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -7,8 +7,8 @@ plugins {
     signing
     id("io.codearte.nexus-staging") version "0.22.0"
     id("com.android.library")
-    kotlin("multiplatform") version "1.4.21"
-    kotlin("plugin.serialization") version "1.4.20"
+    kotlin("multiplatform") version "1.4.30"
+    kotlin("plugin.serialization") version "1.4.30"
     id("com.diffplug.spotless") version "5.9.0"
     id("com.moowork.node") version "1.3.1"
     id("org.jetbrains.dokka") version "1.4.20"
@@ -27,7 +27,7 @@ buildscript {
     }
     dependencies {
         classpath("com.android.tools.build:gradle:3.5.4")
-        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.21")
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.30")
     }
 }
 
@@ -132,6 +132,7 @@ kotlin {
             testTask {
                 useKarma {
                     useChromeHeadless()
+                    //useChrome()
                     webpackConfig.cssSupport.enabled = true
                 }
             }
@@ -183,6 +184,7 @@ kotlin {
                     implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$serializationVersion")
                     implementation("io.ktor:ktor-client-core:$ktorVersion")
                     implementation("com.soywiz.korlibs.klock:klock:$klockVersion")
+                    implementation("com.soywiz.korlibs.krypto:krypto:2.0.6")
                 }
             }
 
@@ -226,6 +228,10 @@ kotlin {
             val jsTest by getting {
                 dependencies {
                     implementation(kotlin("test-js"))
+
+                   // implementation("io.kotest:kotest-assertions-core-js:4.3.2")
+                   // implementation("io.kotest:kotest-framework-api-js:4.3.2")
+                   // implementation("io.kotest:kotest-framework-engine-js:4.3.2")
                 }
             }
 
@@ -394,8 +400,10 @@ fun PublishingExtension.registerPublishing() {
             url = uri(if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl)
 
             credentials {
-                val nexusUsername: String? = System.getenv("nexus.username") ?: if (project.extra.has("nexusUsername")) project.extra["nexusUsername"] as? String else null
-                val nexusPassword: String? = System.getenv("nexus.password") ?: if (project.extra.has("nexusPassword")) project.extra["nexusPassword"] as? String else null
+                val nexusUsername: String? = System.getenv("nexus.username")
+                    ?: if (project.extra.has("nexusUsername")) project.extra["nexusUsername"] as? String else null
+                val nexusPassword: String? = System.getenv("nexus.password")
+                    ?: if (project.extra.has("nexusPassword")) project.extra["nexusPassword"] as? String else null
                 username = nexusUsername
                 password = nexusPassword
             }
diff --git a/src/androidMain/kotlin/com/adamratzman/spotify/Pkce.kt b/src/androidMain/kotlin/com/adamratzman/spotify/Pkce.kt
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/Builder.kt b/src/commonMain/kotlin/com.adamratzman.spotify/Builder.kt
@@ -7,7 +7,9 @@ import com.adamratzman.spotify.http.HttpRequestMethod
 import com.adamratzman.spotify.models.Token
 import com.adamratzman.spotify.models.serialization.nonstrictJson
 import com.adamratzman.spotify.models.serialization.toObject
+import com.soywiz.krypto.SHA256
 import io.ktor.client.features.ServerResponseException
+import io.ktor.utils.io.core.toByteArray
 import kotlinx.coroutines.CancellationException
 import kotlinx.serialization.json.Json
 
@@ -76,7 +78,14 @@ public fun getPkceAuthorizationUrl(
 /**
  * A utility to get the pkce code challenge for a corresponding code verifier. Only available on JVM/Android
  */
-public expect fun getSpotifyPkceCodeChallenge(codeVerifier: String): String
+public fun getSpotifyPkceCodeChallenge(codeVerifier: String): String {
+    if (codeVerifier.length !in 43..128) throw IllegalArgumentException("Code verifier must be between 43 and 128 characters long")
+
+    var sha256 = SHA256.digest(codeVerifier.toByteArray()).base64
+    while (sha256.endsWith("=")) sha256 = sha256.removeSuffix("=")
+
+    return sha256.replace("/", "_").replace("+", "-")
+}
 
 // ==============================================
 
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/SearchApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/SearchApi.kt
@@ -37,7 +37,7 @@ public open class SearchApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
      *
      * @param id The internal id
      */
-    public enum class SearchType(internal val id: String) {
+    public enum class SearchType(public val id: String) {
         ALBUM("album"),
         TRACK("track"),
         ARTIST("artist"),
diff --git a/src/commonTest/kotlin/com.adamratzman/spotify/TestUtilities.kt b/src/commonTest/kotlin/com.adamratzman/spotify/TestUtilities.kt
@@ -0,0 +1,20 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
+package com.adamratzman.spotify
+
+abstract class AbstractTest<T : GenericSpotifyApi> {
+    lateinit var api: T
+
+    suspend fun build(): Boolean {
+        return try {
+            @Suppress("UNCHECKED_CAST")
+            (buildSpotifyApi() as? T)?.let { api = it }
+            println(api as? T)
+            ::api.isInitialized
+        } catch (cce: ClassCastException) {
+            false
+        }
+    }
+}
+
+typealias GenericSpotifyApiTest = AbstractTest<GenericSpotifyApi>
+typealias SpotifyClientApiTest = AbstractTest<SpotifyClientApi>
diff --git a/src/commonTest/kotlin/com.adamratzman/spotify/utilities/UtilityTests.kt b/src/commonTest/kotlin/com.adamratzman/spotify/utilities/UtilityTests.kt
@@ -8,6 +8,7 @@ import com.adamratzman.spotify.SpotifyUserAuthorization
 import com.adamratzman.spotify.assertFailsWithSuspend
 import com.adamratzman.spotify.buildSpotifyApi
 import com.adamratzman.spotify.getEnvironmentVariable
+import com.adamratzman.spotify.getSpotifyPkceCodeChallenge
 import com.adamratzman.spotify.runBlockingTest
 import com.adamratzman.spotify.spotifyAppApi
 import com.adamratzman.spotify.spotifyClientApi
@@ -26,6 +27,12 @@ class UtilityTests {
 
     fun testPrereq() = ::api.isInitialized
 
+    @Test
+    fun testGeneratePkceCodeChallenge() {
+        assertEquals("c7jV_d4sQ658HgwINAR77Idumz1ik1lIb1JNlOva75E", getSpotifyPkceCodeChallenge("thisisaveryrandomalphanumericcodeverifierandisgreaterthan43characters"))
+        assertEquals("9Y__uhKapn7GO_ElcaQpd8C3hdOyqTzAU4VXyR2iEV0", getSpotifyPkceCodeChallenge("12345678901234567890123456789012345678901234567890"))
+    }
+
     @Test
     fun testPagingObjectTakeItemsSize() {
         runBlockingTest {
diff --git a/src/desktopMain/kotlin/com/adamratzman/spotify/Pkce.kt b/src/desktopMain/kotlin/com/adamratzman/spotify/Pkce.kt
diff --git a/src/jsMain/kotlin/co.scdn.sdk/SpotifyPlayerJs.kt b/src/jsMain/kotlin/co.scdn.sdk/SpotifyPlayerJs.kt
@@ -0,0 +1,9 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
+package co.scdn.sdk
+
+import kotlinx.browser.window
+
+public fun setOnSpotifyWebPlaybackSDKReady(callback: suspend () -> Unit) {
+    val dynamicWindow: dynamic = window
+    dynamicWindow["onSpotifyWebPlaybackSDKReady"] = callback
+}
diff --git a/src/jsMain/kotlin/com/adamratzman/spotify/Pkce.kt b/src/jsMain/kotlin/com/adamratzman/spotify/Pkce.kt
diff --git a/src/jsMain/kotlin/com/adamratzman/spotify/webplayer/Typealiases.kt b/src/jsMain/kotlin/com/adamratzman/spotify/webplayer/Typealiases.kt
@@ -0,0 +1,6 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
+package com.adamratzman.spotify.webplayer
+
+typealias ErrorListener = (err: Error) -> Unit
+typealias PlaybackInstanceListener = (inst: WebPlaybackInstance) -> Unit
+typealias PlaybackStateListener = (s: PlaybackState) -> Unit
diff --git a/src/jsMain/kotlin/com/adamratzman/spotify/webplayer/WebPlaybackSdk.kt b/src/jsMain/kotlin/com/adamratzman/spotify/webplayer/WebPlaybackSdk.kt
@@ -0,0 +1,117 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
+@file:JsQualifier("window.Spotify")
+package com.adamratzman.spotify.webplayer
+
+import kotlin.js.Promise
+
+external interface Album {
+    var uri: String
+    var name: String
+    var images: Array<Image>
+}
+
+external interface Artist {
+    var name: String
+    var uri: String
+}
+
+external interface Error {
+    var message: String
+}
+
+external interface Image {
+    var height: Number?
+        get() = definedExternally
+        set(value) = definedExternally
+    var url: String
+    var width: Number?
+        get() = definedExternally
+        set(value) = definedExternally
+}
+
+external interface PlaybackContext {
+    var metadata: Any
+    var uri: String?
+}
+
+external interface PlaybackDisallows {
+    var pausing: Boolean
+    var peeking_next: Boolean
+    var peeking_prev: Boolean
+    var resuming: Boolean
+    var seeking: Boolean
+    var skipping_next: Boolean
+    var skipping_prev: Boolean
+}
+
+external interface PlaybackRestrictions {
+    var disallow_pausing_reasons: Array<String>
+    var disallow_peeking_next_reasons: Array<String>
+    var disallow_peeking_prev_reasons: Array<String>
+    var disallow_resuming_reasons: Array<String>
+    var disallow_seeking_reasons: Array<String>
+    var disallow_skipping_next_reasons: Array<String>
+    var disallow_skipping_prev_reasons: Array<String>
+}
+
+external interface PlaybackState {
+    var context: PlaybackContext
+    var disallows: PlaybackDisallows
+    var duration: Number
+    var paused: Boolean
+    var position: Number
+    var repeat_mode: Number /* 0 | 1 | 2 */
+    var shuffle: Boolean
+    var restrictions: PlaybackRestrictions
+    var track_window: PlaybackTrackWindow
+}
+
+external interface PlaybackTrackWindow {
+    var current_track: Track
+    var previous_tracks: Array<Track>
+    var next_tracks: Array<Track>
+}
+
+external interface PlayerInit {
+    var name: String
+    fun getOAuthToken(cb: (token: String) -> Unit)
+    var volume: Number?
+        get() = definedExternally
+        set(value) = definedExternally
+}
+
+open external class Player(options: PlayerInit) {
+    open fun connect(): Promise<Boolean>
+    open fun disconnect()
+    open fun getCurrentState(): Promise<PlaybackState?>
+    open fun getVolume(): Promise<Number>
+    open fun nextTrack(): Promise<Unit>
+    open var addListener: (event: String /* "ready" | "not_ready" */, cb: PlaybackInstanceListener) -> Unit /* (event: String /* "ready" | "not_ready" */, cb: PlaybackInstanceListener) -> Unit & (event: String /* "player_state_changed" */, cb: PlaybackStateListener) -> Unit & (event: String /* "account_error" | "authentication_error" | "initialization_error" | "playback_error" */, cb: ErrorListener) -> Unit */
+    open var on: (event: String /* "ready" | "not_ready" */, cb: PlaybackInstanceListener) -> Unit /* (event: String /* "ready" | "not_ready" */, cb: PlaybackInstanceListener) -> Unit & (event: String /* "player_state_changed" */, cb: PlaybackStateListener) -> Unit & (event: String /* "account_error" | "authentication_error" | "initialization_error" | "playback_error" */, cb: ErrorListener) -> Unit */
+    open fun removeListener(event: String /* "ready" | "not_ready" | "player_state_changed" | "account_error" | "authentication_error" | "initialization_error" | "playback_error" */, cb: ErrorListener = definedExternally)
+    open fun removeListener(event: String /* "ready" | "not_ready" | "player_state_changed" | "account_error" | "authentication_error" | "initialization_error" | "playback_error" */)
+    open fun removeListener(event: String /* "ready" | "not_ready" | "player_state_changed" | "account_error" | "authentication_error" | "initialization_error" | "playback_error" */, cb: PlaybackInstanceListener = definedExternally)
+    open fun removeListener(event: String /* "ready" | "not_ready" | "player_state_changed" | "account_error" | "authentication_error" | "initialization_error" | "playback_error" */, cb: PlaybackStateListener = definedExternally)
+    open fun pause(): Promise<Unit>
+    open fun previousTrack(): Promise<Unit>
+    open fun resume(): Promise<Unit>
+    open fun seek(pos_ms: Number): Promise<Unit>
+    open fun setName(name: String): Promise<Unit>
+    open fun setVolume(volume: Number): Promise<Unit>
+    open fun togglePlay(): Promise<Unit>
+}
+
+external interface Track {
+    var uri: String
+    var id: String?
+    var type: String /* "track" | "episode" | "ad" */
+    var media_type: String /* "audio" | "video" */
+    var name: String
+    var is_playable: Boolean
+    var album: Album
+    var artists: Array<Artist>
+}
+
+external interface WebPlaybackInstance {
+    var device_id: String
+}
diff --git a/src/jsTest/kotlin/com/adamratzman/spotify/webplayer/WebPlaybackSdkTest.kt b/src/jsTest/kotlin/com/adamratzman/spotify/webplayer/WebPlaybackSdkTest.kt
@@ -0,0 +1,35 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
+package com.adamratzman.spotify.webplayer
+
+/*
+class WebPlaybackSdkTestK: FunSpec({
+    test("test") {
+        println("test ran")
+    }
+})
+
+class WebPlaybackSdkTest {
+    fun testCreateDevice() {
+        GlobalScope.launch {
+            loadSpotifyJs()
+            delay(10000)
+            println("l")
+
+            val player = SpotifyPlayer(
+                object : PlayerInit {
+                    override var name: String = "Test Player"
+                    override fun getOAuthToken(cb: (token: String) -> Unit) {
+                        cb(api.token.accessToken)
+                    }
+                }
+            )
+            player.connect().then { success ->
+                println("Success? $success")
+            }
+        }
+        val time = getCurrentTimeMs()
+        // while (getCurrentTimeMs() - time < 50000) {}
+
+    }
+}
+*/
diff --git a/src/jvmMain/kotlin/com/adamratzman/spotify/Pkce.kt b/src/jvmMain/kotlin/com/adamratzman/spotify/Pkce.kt

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,8 @@ plugins {`
`7`	`7`	`signing`
`8`	`8`	`id("io.codearte.nexus-staging") version "0.22.0"`
`9`	`9`	`id("com.android.library")`
`10`		`- kotlin("multiplatform") version "1.4.21"`
`11`		`- kotlin("plugin.serialization") version "1.4.20"`
	`10`	`+ kotlin("multiplatform") version "1.4.30"`
	`11`	`+ kotlin("plugin.serialization") version "1.4.30"`
`12`	`12`	`id("com.diffplug.spotless") version "5.9.0"`
`13`	`13`	`id("com.moowork.node") version "1.3.1"`
`14`	`14`	`id("org.jetbrains.dokka") version "1.4.20"`
`@@ -27,7 +27,7 @@ buildscript {`
`27`	`27`	`}`
`28`	`28`	`dependencies {`
`29`	`29`	`classpath("com.android.tools.build:gradle:3.5.4")`
`30`		`- classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.21")`
	`30`	`+ classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.30")`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
`@@ -132,6 +132,7 @@ kotlin {`
`132`	`132`	`testTask {`
`133`	`133`	`useKarma {`
`134`	`134`	`useChromeHeadless()`
	`135`	`+ //useChrome()`
`135`	`136`	`webpackConfig.cssSupport.enabled = true`
`136`	`137`	`}`
`137`	`138`	`}`
`@@ -183,6 +184,7 @@ kotlin {`
`183`	`184`	`implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$serializationVersion")`
`184`	`185`	`implementation("io.ktor:ktor-client-core:$ktorVersion")`
`185`	`186`	`implementation("com.soywiz.korlibs.klock:klock:$klockVersion")`
	`187`	`+ implementation("com.soywiz.korlibs.krypto:krypto:2.0.6")`
`186`	`188`	`}`
`187`	`189`	`}`
`188`	`190`
`@@ -226,6 +228,10 @@ kotlin {`
`226`	`228`	`val jsTest by getting {`
`227`	`229`	`dependencies {`
`228`	`230`	`implementation(kotlin("test-js"))`
	`231`	`+`
	`232`	`+ // implementation("io.kotest:kotest-assertions-core-js:4.3.2")`
	`233`	`+ // implementation("io.kotest:kotest-framework-api-js:4.3.2")`
	`234`	`+ // implementation("io.kotest:kotest-framework-engine-js:4.3.2")`
`229`	`235`	`}`
`230`	`236`	`}`
`231`	`237`
`@@ -394,8 +400,10 @@ fun PublishingExtension.registerPublishing() {`
`394`	`400`	`url = uri(if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl)`
`395`	`401`
`396`	`402`	`credentials {`
`397`		`- val nexusUsername: String? = System.getenv("nexus.username") ?: if (project.extra.has("nexusUsername")) project.extra["nexusUsername"] as? String else null`
`398`		`- val nexusPassword: String? = System.getenv("nexus.password") ?: if (project.extra.has("nexusPassword")) project.extra["nexusPassword"] as? String else null`
	`403`	`+ val nexusUsername: String? = System.getenv("nexus.username")`
	`404`	`+ ?: if (project.extra.has("nexusUsername")) project.extra["nexusUsername"] as? String else null`
	`405`	`+ val nexusPassword: String? = System.getenv("nexus.password")`
	`406`	`+ ?: if (project.extra.has("nexusPassword")) project.extra["nexusPassword"] as? String else null`
`399`	`407`	`username = nexusUsername`
`400`	`408`	`password = nexusPassword`
`401`	`409`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public open class SearchApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {`
`37`	`37`	`*`
`38`	`38`	`* @param id The internal id`
`39`	`39`	`*/`
`40`		`- public enum class SearchType(internal val id: String) {`
	`40`	`+ public enum class SearchType(public val id: String) {`
`41`	`41`	`ALBUM("album"),`
`42`	`42`	`TRACK("track"),`
`43`	`43`	`ARTIST("artist"),`