Merge branch 'dev'

Author: adamint

README.md

@@ -1,16 +1,22 @@
 # Kotlin Spotify Web API 
+A [Kotlin](https://kotlinlang.org/) implementation of the [Spotify Web API](https://developer.spotify.com/web-api/),
+supporting Kotlin/JS, Kotlin/Android, Kotlin/JVM, and Kotlin/Native
+(macOS, Windows, Linux).
+
 [![JCenter](https://maven-badges.herokuapp.com/maven-central/com.adamratzman/spotify-api-kotlin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.adamratzman/spotify-api-kotlin)
-[![Build Status](http://144.217.240.243:8111/app/rest/builds/aggregated/strob:(buildType:(project:(id:SpotifyWebApiKotlin)))/statusIcon.svg)](http://144.217.240.243:8111/project.html?projectId=SpotifyWebApiKotlin) 
-[![](https://img.shields.io/badge/Documentation-latest-orange.svg)](https://adamint.github.io/spotify-web-api-kotlin/spotify-web-api-kotlin/)
+[![](https://img.shields.io/badge/Documentation-latest-orange.svg)](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/)
 ![](https://img.shields.io/badge/License-MIT-blue.svg)
 
-This is the [Kotlin](https://kotlinlang.org/) implementation of the [Spotify Web API](https://developer.spotify.com/web-api/). JS/Browser and Node, Android, and JVM targets are currently supported, with Kotlin/Native (Windows, macOS, Linux) support coming soon in the next minor version, 3.5.
 
-You can ask questions, get guidance, or get help contributing by joining our [Discord server](https://discord.gg/G6vqP3S). 
+![Android Tests](https://img.shields.io/teamcity/build/s/SpotifyWebApiKotlin_AndroidTests?label=Kotlin%2FAndroid%20Tests&server=https%3A%2F%2Fadam.beta.teamcity.com)
+![JS tests Status](https://img.shields.io/teamcity/build/s/SpotifyWebApiKotlin_JsTests?label=Kotlin%2FJS%20Tests&server=https%3A%2F%2Fadam.beta.teamcity.com)
+![JVM tests](https://img.shields.io/teamcity/build/s/SpotifyWebApiKotlin_JvmTests?label=Kotlin%2FJVM%20Tests&server=https%3A%2F%2Fadam.beta.teamcity.com)
+![Linux Tests](https://img.shields.io/teamcity/build/s/SpotifyWebApiKotlin_LinuxTests?label=Kotlin%2FLinux%20Tests&server=https%3A%2F%2Fadam.beta.teamcity.com)
+![macOS Tests](https://img.shields.io/teamcity/build/s/SpotifyWebApiKotlin_RunTestsMac?label=Kotlin%2FmacOS%20Tests&server=https%3A%2F%2Fadam.beta.teamcity.com)
 
 ## Table of Contents
 * [Library installing](#library-installing)
-    + [JVM, Android, JS](#jvm-android-js)
+    + [JVM, Android, JS, Native](#jvm-android-js)
     + [Android information](#android)
 * [Documentation](#documentation)
 * [Need help, have a question, or want to contribute?](#have-a-question)
@@ -26,20 +32,23 @@ You can ask questions, get guidance, or get help contributing by joining our [Di
 * [Tips](#tips)
     + [Building the API](#building-the-api)
 * [Notes](#notes)
-    + [The benefits of LinkedResults, PagingObjects, and Cursor-based Paging Objects](#the-benefits-of-linkedresults-pagingobjects-and-cursor-based-paging-objects)
+    + [LinkedResults, PagingObjects, and Cursor-based Paging Objects](#the-benefits-of-linkedresults-pagingobjects-and-cursor-based-paging-objects)
     + [Generic Requests](#generic-request)
     + [Track Relinking](#track-relinking)
 * [Contributing](#contributing)
 
 ## Library installing
+Current version:
+
+[![JCenter](https://maven-badges.herokuapp.com/maven-central/com.adamratzman/spotify-api-kotlin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.adamratzman/spotify-api-kotlin)
 
-### JVM, Android, JS
+### JVM, Android, JS, Native (macOS, Windows, Linux)
 ```
 repositories {
     jcenter()
 }
 
-implementation("com.adamratzman:spotify-api-kotlin-core:3.4.03")
+implementation("com.adamratzman:spotify-api-kotlin-core:VERSION")
 ```
 
 ### Android
@@ -74,7 +83,7 @@ The `spotify-web-api-kotlin` JavaDocs are hosted [here](https://adamint.github.i
 ## Have a question?
 If you have a question, you can:
 
-1. Create an [issue](https://github.com/adamint/spotify-web-api-kotlin/issues) or a discussion.
+1. Create an [issue](https://github.com/adamint/spotify-web-api-kotlin/issues)
 2. Join our [Discord server](https://discord.gg/G6vqP3S)
 3. Contact me using **Adam#9261** on [Discord](https://discordapp.com)
 
@@ -140,7 +149,7 @@ The `SpotifyClientApi` is a superset of `SpotifyApi`; thus, nothing changes if y
 access public data.
 This library does not provide a method to retrieve the code from your  callback url; instead,
 you must implement that with a web server. 
-Automatic refresh is available *only* when building with an authorization code or a 
+Automatic Token refresh is available *only* when building with an authorization code or a 
 `Token` object. Otherwise, it will expire `Token.expiresIn` seconds after creation.
 
 Make sure your application has requested the proper [Scopes](https://developer.spotify.com/web-api/using-spotifyScopes/) in order to 
@@ -373,7 +382,7 @@ runBlocking {
 ```
 
 ## Notes
-### The benefits of LinkedResults, PagingObjects, and Cursor-based Paging Objects
+### LinkedResults, PagingObjects, and Cursor-based Paging Objects
 Spotify provides these three object models in order to simplify our lives as developers. So let's see what we
 can do with them!
 

build.gradle.kts

@@ -32,7 +32,12 @@ buildscript {
 }
 
 group = "com.adamratzman"
-version = "3.5.0-rc.1"
+version = System.getenv("SPOTIFY_API_PUBLISH_VERSION") ?: "0.0.0.SNAPSHOT"
+
+System.getenv("signing.keyId")?.let { project.ext["signing.keyId"] = it }
+System.getenv("signing.password")?.let { project.ext["signing.password"] = it }
+System.getenv("signing.secretKeyRingFile")?.let { project.ext["signing.secretKeyRingFile"] = it }
+
 
 tasks.withType<Test> {
     this.testLogging {
@@ -195,8 +200,8 @@ kotlin {
                 url = uri(if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl)
 
                 credentials {
-                    val nexusUsername: String? by project.extra
-                    val nexusPassword: String? by project.extra
+                    val nexusUsername: String? = System.getenv("nexus.username")
+                    val nexusPassword: String? = System.getenv("nexus.password")
                     username = nexusUsername
                     password = nexusPassword
                 }
@@ -327,7 +332,6 @@ kotlin {
     }
 }
 
-
 signing {
     if (project.hasProperty("signing.keyId")
         && project.hasProperty("signing.password")
@@ -376,6 +380,7 @@ tasks {
 
 
 fun MavenPublication.setupPom(publicationName: String) {
+    artifactId = artifactId.replace("-web", "")
     artifact(dokkaJar.get())
 
     pom {
@@ -390,8 +395,8 @@ fun MavenPublication.setupPom(publicationName: String) {
         }
         licenses {
             license {
-                name.set("The Apache Software License, Version 2.0")
-                url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
+                name.set("MIT License")
+                url.set("https://github.com/adamint/spotify-web-api-kotlin/blob/master/LICENSE")
                 distribution.set("repo")
             }
         }

settings.gradle.kts

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

src/androidMain/kotlin/com/adamratzman/spotify/Pkce.kt

@@ -6,6 +6,9 @@ import android.os.Build.VERSION_CODES
 import android.util.Base64
 import java.security.MessageDigest
 
+/**
+ * A utility to get the pkce code challenge for a corresponding code verifier. Only available on JVM/Android
+ */
 public actual fun getSpotifyPkceCodeChallenge(codeVerifier: String): String {
     val sha256 = MessageDigest.getInstance("SHA-256").digest(codeVerifier.toByteArray())
     return if (VERSION.SDK_INT >= VERSION_CODES.O) {

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

@@ -1,4 +1,7 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * Represents a unit of time
+ */
 public actual typealias TimeUnit = java.util.concurrent.TimeUnit

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

@@ -1,4 +1,7 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * The current time in milliseconds since UNIX epoch.
+ */
 public actual fun getCurrentTimeMs(): Long = System.currentTimeMillis()

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

@@ -1,4 +1,7 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * Actual platform that this program is run on.
+ */
 public actual val platform: Platform = Platform.ANDROID

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

@@ -159,7 +159,7 @@ public class HttpConnection constructor(
                     )
                     throw AuthenticationException(error)
                 } catch (ignored: ParseException) {
-                    throw e
+                    throw BadRequestException(e)
                 }
             }
         }

src/commonMain/kotlin/com.adamratzman.spotify/utils/Concurrency.kt

@@ -1,6 +1,9 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * Represents a unit of time
+ */
 public expect enum class TimeUnit {
     MILLISECONDS, SECONDS;
 

src/commonMain/kotlin/com.adamratzman.spotify/utils/Utils.kt

@@ -8,6 +8,9 @@ import kotlinx.datetime.TimeZone
 import kotlinx.datetime.toLocalDateTime
 import kotlinx.serialization.json.JsonElement
 
+/**
+ * The current time in milliseconds since UNIX epoch.
+ */
 public expect fun getCurrentTimeMs(): Long
 
 internal fun jsonMap(vararg pairs: Pair<String, JsonElement>) = pairs.toMap().toMutableMap()