Merge pull request #239 from adamint/dev

native support

Author: adamint

README.md

@@ -42,8 +42,6 @@ repositories {
 implementation("com.adamratzman:spotify-api-kotlin-core:3.4.03")
 ```
 
-Note that images and profiles are not supported on the Kotlin/JS target.
-
 ### Android
 **If you declare any release types not named debug or release, you may see "Could not resolve com.adamratzman:spotify-api-kotlin-android:VERSION". You need to do the following for each release type not named debug or release:**
 ```
@@ -80,6 +78,17 @@ If you have a question, you can:
 2. Join our [Discord server](https://discord.gg/G6vqP3S)
 3. Contact me using **Adam#9261** on [Discord](https://discordapp.com)
 
+## Unsupported features on each platform:
+| Feature                     | JVM                | Android            | JS                 | Native (Mac/Windows/Linux) |
+|-----------------------------|--------------------|--------------------|--------------------|----------------------------|
+| Images (Playlist covers)    | :heavy_check_mark: | :heavy_check_mark: | Unsupported        | Unsupported                |
+| getSpotifyPkceCodeChallenge | :heavy_check_mark: | :heavy_check_mark: | Unsupported        | Unsupported                |
+| Edit client playlist        | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Unsupported                |
+| Remove playlist tracks      | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Unsupported                |
+
+Please feel free to open an issue/discussion on GitHub or Discord if you need access to one of these features 
+or have an interest in implementing one, as direction can be provided.
+
 ## Creating a new api instance
 To decide which api you need (SpotifyAppApi, SpotifyClientApi, SpotifyImplicitGrantApi), you can refer 
 to the sections below or the [Spotify authorization guide](https://developer.spotify.com/documentation/general/guides/authorization-guide/). In general:

build.gradle.kts

@@ -6,12 +6,12 @@ plugins {
     `maven-publish`
     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.21"
     id("com.diffplug.gradle.spotless") version "4.4.0"
     id("com.moowork.node") version "1.3.1"
     id("org.jetbrains.dokka") version "1.4.20"
-    id("com.android.library")
     id("kotlin-android-extensions")
 }
 
@@ -32,7 +32,7 @@ buildscript {
 }
 
 group = "com.adamratzman"
-version = "3.4.03"
+version = "3.5.0-rc.1"
 
 tasks.withType<Test> {
     this.testLogging {
@@ -94,7 +94,6 @@ kotlin {
         }
 
         mavenPublication {
-            artifactId = "spotify-api-kotlin-android"
             setupPom(artifactId)
         }
 
@@ -112,14 +111,12 @@ kotlin {
         }
 
         mavenPublication {
-            artifactId = "spotify-api-kotlin"
             setupPom(artifactId)
         }
     }
 
     js(KotlinJsCompilerType.LEGACY) {
         mavenPublication {
-            artifactId = "spotify-api-kotlin-js"
             setupPom(artifactId)
         }
 
@@ -146,19 +143,83 @@ kotlin {
         }
     }
 
+    val hostOs = System.getProperty("os.name")
+    val isMainHost = hostOs.contains("mac", true)
+    //val isMainPlatform =
+    val isMingwX64 = hostOs.startsWith("Windows")
+
+    macosX64 {
+        mavenPublication {
+            setupPom(artifactId)
+        }
+    }
+    linuxX64 {
+        mavenPublication {
+            setupPom(artifactId)
+        }
+    }
+    mingwX64 {
+        mavenPublication {
+            setupPom(artifactId)
+        }
+    }
+
+    val publicationsFromMainHost =
+        listOf(jvm(), js()).map { it.name } + "kotlinMultiplatform"
+
+    publishing {
+        publications {
+            matching { it.name in publicationsFromMainHost }.all {
+                val targetPublication = this@all
+                tasks.withType<AbstractPublishToMaven>()
+                    .matching { it.publication == targetPublication }
+                    .configureEach { onlyIf { findProperty("isMainHost") == "true" } }
+            }
+
+            val kotlinMultiplatform by getting(MavenPublication::class) {
+                artifactId = "spotify-api-kotlin-core"
+                setupPom(artifactId)
+            }
+
+            /*val metadata by getting(MavenPublication::class) {
+                artifactId = "spotify-api-kotlin-metadata"
+                setupPom(artifactId)
+            }*/
+        }
+
+        repositories {
+            maven {
+                name = "nexus"
+                val releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
+                val snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/"
+                url = uri(if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl)
+
+                credentials {
+                    val nexusUsername: String? by project.extra
+                    val nexusPassword: String? by project.extra
+                    username = nexusUsername
+                    password = nexusPassword
+                }
+            }
+        }
+    }
+
     targets {
         sourceSets {
-            val coroutineVersion = "1.4.2"
+            val coroutineVersion = "1.4.2-native-mt"
             val serializationVersion = "1.0.1"
             val ktorVersion = "1.4.1"
+            val kotlinxDatetimeVersion = "0.1.1"
 
             val commonMain by getting {
                 dependencies {
                     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutineVersion")
                     implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$serializationVersion")
                     implementation("io.ktor:ktor-client-core:$ktorVersion")
+                    implementation("org.jetbrains.kotlinx:kotlinx-datetime:$kotlinxDatetimeVersion")
                 }
             }
+
             val commonTest by getting {
                 dependencies {
                     implementation(kotlin("test-common"))
@@ -221,47 +282,57 @@ kotlin {
                 }
             }
 
-            all {
-                languageSettings.useExperimentalAnnotation("kotlin.Experimental")
+            val desktopMain by creating {
+                dependsOn(commonMain)
+
+                dependencies {
+                    implementation("io.ktor:ktor-client-curl:$ktorVersion")
+                }
             }
-        }
-    }
-}
 
-publishing {
-    publications {
-        val kotlinMultiplatform by getting(MavenPublication::class) {
-            artifactId = "spotify-api-kotlin-core"
-            setupPom(artifactId)
-        }
+            val desktopTest by creating {
+                dependencies {
 
-        val metadata by getting(MavenPublication::class) {
-            artifactId = "spotify-api-kotlin-metadata"
-            setupPom(artifactId)
-        }
-    }
+                }
+            }
 
-    repositories {
-        maven {
-            name = "nexus"
-            val releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
-            val snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/"
-            url = uri(if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl)
-
-            credentials {
-                val nexusUsername: String? by project.extra
-                val nexusPassword: String? by project.extra
-                username = nexusUsername
-                password = nexusPassword
+            val linuxX64Main by getting {
+                dependsOn(desktopMain)
+            }
+
+            val linuxX64Test by getting {
+                dependsOn(desktopTest)
+            }
+
+            val mingwX64Main by getting {
+                dependsOn(desktopMain)
+            }
+
+            val mingwX64Test by getting {
+                dependsOn(desktopTest)
+            }
+
+            val macosX64Main by getting {
+                dependsOn(desktopMain)
+            }
+
+            val macosX64Test by getting {
+                dependsOn(desktopTest)
+            }
+
+            all {
+                languageSettings.useExperimentalAnnotation("kotlin.Experimental")
             }
         }
     }
 }
 
+
 signing {
     if (project.hasProperty("signing.keyId")
-            && project.hasProperty("signing.password")
-            && project.hasProperty("signing.secretKeyRingFile")) {
+        && project.hasProperty("signing.password")
+        && project.hasProperty("signing.secretKeyRingFile")
+    ) {
         sign(publishing.publications)
     }
 }
@@ -333,3 +404,4 @@ fun MavenPublication.setupPom(publicationName: String) {
         }
     }
 }
+

gradle.properties

@@ -1,3 +1,5 @@
 systemProp.org.gradle.internal.publish.checksums.insecure=true
 org.gradle.daemon=true
-org.gradle.jvmargs=-Xmx4000m
+org.gradle.jvmargs=-Xmx8000m
+kotlin.mpp.enableGranularSourceSetsMetadata=true
+kotlin.native.enableDependencyPropagation=false

settings.gradle.kts

@@ -28,5 +28,5 @@ pluginManagement {
     }
 }
 
-rootProject.name = "spotify-web-api-kotlin"
+rootProject.name = "spotify-api-kotlin"
 

src/androidMain/kotlin/com/adamratzman/spotify/http/Endpoints.kt

@@ -11,8 +11,8 @@ internal actual fun String.encodeUrl() = URLEncoder.encode(this, "UTF-8")!!
 internal actual fun String.base64ByteEncode(): String {
     return if (VERSION.SDK_INT >= VERSION_CODES.O) {
         java.util.Base64.getUrlEncoder()
-                .withoutPadding()
-                .encodeToString(toByteArray())
+            .withoutPadding()
+            .encodeToString(toByteArray())
     } else {
         Base64.encodeToString(toByteArray(), Base64.DEFAULT)
     }

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

@@ -1,13 +1,4 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
-import android.annotation.SuppressLint
-import java.text.SimpleDateFormat
-import java.util.Date
-
 public actual fun getCurrentTimeMs(): Long = System.currentTimeMillis()
-
-@SuppressLint("SimpleDateFormat")
-internal actual fun formatDate(format: String, date: Long): String {
-        return SimpleDateFormat(format).format(Date(date))
-}

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

@@ -846,6 +846,8 @@ public class SpotifyUserAuthorization(
  * @param requiredScopes Scopes that your application requires to function (only applicable to [SpotifyClientApi] and [SpotifyImplicitGrantApi]).
  * @param proxyBaseUrl Provide if you have a proxy base URL that you would like to use instead of the Spotify API base
  * (https://api.spotify.com/v1).
+ * @param retryIfInternalServerError Whether to retry once if an internal server error (500..599) has been received
+ *
  */
 public data class SpotifyApiOptions(
     public var useCache: Boolean = true,
@@ -861,5 +863,6 @@ public data class SpotifyApiOptions(
     public var refreshTokenProducer: (suspend (GenericSpotifyApi) -> Token)? = null,
     public var onTokenRefresh: (suspend (GenericSpotifyApi) -> Unit)? = null,
     public var requiredScopes: List<SpotifyScope>? = null,
-    public var proxyBaseUrl: String? = null
+    public var proxyBaseUrl: String? = null,
+    public var retryIfInternalServerError: Boolean = true
 )

src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/BrowseApi.kt

@@ -101,9 +101,7 @@ public class BrowseApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
         endpointBuilder("/browse/featured-playlists").with("limit", limit).with("offset", offset).with(
             "market",
             market?.name
-        ).with("locale", locale).with("timestamp", timestamp?.let {
-            formatDate("yyyy-MM-dd'T'HH:mm:ss", it)
-        }).toString()
+        ).with("locale", locale).with("timestamp", timestamp?.let { formatDate(it) }).toString()
     ).toObject(FeaturedPlaylists.serializer(), api, json)
 
     /**
@@ -183,7 +181,7 @@ public class BrowseApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
             limit
         ).with("offset", offset)
             .with("market", market?.name).toString()
-    ).toPagingObject(SimplePlaylist.serializer(), "playlists", endpoint = this, json = json)
+    ).toPagingObject((SimplePlaylist.serializer()), "playlists", endpoint = this, json = json)
 
     /**
      * Create a playlist-style listening experience based on seed artists, tracks and genres.

src/commonMain/kotlin/com.adamratzman.spotify/http/Endpoints.kt

@@ -87,9 +87,10 @@ public abstract class SpotifyEndpoint(public val api: GenericSpotifyApi) {
             return withTimeout(api.spotifyApiOptions.requestTimeoutMillis ?: 100 * 1000L) {
                 try {
                     val document = createConnection(url, body, method, contentType).execute(
-                        cacheState?.eTag?.let {
+                        additionalHeaders = cacheState?.eTag?.let {
                             listOf(HttpHeader("If-None-Match", it))
-                        }
+                        },
+                        retryIfInternalServerError = api.spotifyApiOptions.retryIfInternalServerError
                     )
 
                     handleResponse(document, cacheState, spotifyRequest, retry202) ?: execute(
@@ -100,7 +101,7 @@ public abstract class SpotifyEndpoint(public val api: GenericSpotifyApi) {
                         contentType
                     )
                 } catch (e: BadRequestException) {
-                    if (e.statusCode?.equals(401) == true && !attemptedRefresh) {
+                    if (e.statusCode == 401 && !attemptedRefresh) {
                         api.refreshToken()
 
                         execute(
@@ -147,7 +148,7 @@ public abstract class SpotifyEndpoint(public val api: GenericSpotifyApi) {
             }
         }
 
-        if (document.responseCode / 200 != 1 /* Check if status is not 2xx or 3xx */) {
+        if (document.responseCode !in 200..399 /* Check if status is not 2xx or 3xx */) {
             val response = try {
                 document.body.toObject(ErrorResponse.serializer(), api, api.spotifyApiOptions.json)
             } catch (e: Exception) {