Merge pull request #228 from adamint/dev

3.3.0 release

Author: adamint

README.md

@@ -23,8 +23,6 @@ This is the [Kotlin](https://kotlinlang.org/) implementation of the [Spotify Web
     + [Using the API](#using-the-api)
 * [Tips](#tips)
     + [Building the API](#building-the-api)
-    + [What is the SpotifyRestAction class?](#what-is-the-spotifyrestaction-class)
-    + [SpotifyRestPagingAction](#spotifyrestpagingaction)
 * [Notes](#notes)
     + [The benefits of LinkedResults, PagingObjects, and Cursor-based Paging Objects](#the-benefits-of-linkedresults-pagingobjects-and-cursor-based-paging-objects)
     + [Generic Requests](#generic-request)
@@ -39,7 +37,7 @@ repositories {
     jcenter()
 }
 
-implementation("com.adamratzman:spotify-api-kotlin-core:3.2.15")
+implementation("com.adamratzman:spotify-api-kotlin-core:3.3.0")
 ```
 
 Note that images and profiles are not supported on the Kotlin/JS target.
@@ -109,7 +107,7 @@ Example creation (default settings)
 
 ```kotlin
 val api = spotifyAppApi("clientId", "clientSecret").build() // create and build api
-println(api.browse.getNewReleases().complete()) // use it
+println(api.browse.getNewReleases()) // use it
 ```
 
 Example creation, using an existing Token and setting automatic token refresh to false
@@ -123,7 +121,7 @@ val api = spotifyAppApi(
         automaticRefresh = false
     )
 )
-println(api.browse.getNewReleases().complete()) // use it
+println(api.browse.getNewReleases()) // use it
 ```
 
 ### SpotifyClientApi
@@ -205,7 +203,7 @@ val api = spotifyClientPkceApi(
         retryWhenRateLimited = false
     )
 ).build()
-println(api.library.getSavedTracks().complete().take(10).filterNotNull().map { it.track.name })
+println(api.library.getSavedTracks().take(10).filterNotNull().map { it.track.name })
 ```
 
 #### Non-PKCE (backend applications, requires client secret)
@@ -238,7 +236,7 @@ val api = spotifyClientApi(
     "your-redirect-uri",
     authCode
 ).build() // create and build api
-println(api.personalization.getTopTracks(limit = 5).complete().items.map { it.name }) // print user top tracks
+println(api.personalization.getTopTracks(limit = 5).items.map { it.name }) // print user top tracks
 ```
 
 ##### Example: You've saved a user's token from previous authorization and need to create an api instance.
@@ -256,7 +254,7 @@ val api = spotifyClientApi(
         }
     )
 ).build()
-println(api.personalization.getTopTracks(limit = 5).complete().items.map { it.name })
+println(api.personalization.getTopTracks(limit = 5).items.map { it.name })
 ```
 
 
@@ -293,7 +291,7 @@ val api = spotifyImplicitGrantApi(
     null,
     token
 ) // create api. there is no need to build it 
-println(api.personalization.getTopArtists(limit = 1).complete()[0].name) // use it
+println(api.personalization.getTopArtists(limit = 1)[0].name) // use it
 ```
 
 ### SpotifyApiBuilder Block & setting API options 
@@ -356,45 +354,13 @@ APIs available only in `SpotifyClientApi` and `SpotifyImplicitGrantApi` instance
 ## Tips
 
 ### Building the API
-The easiest way to build the API is synchronously using .build() after a builder
-
-```kotlin
-spotifyAppApi(clientId, clientSecret).build()
-```
-
-You can also build the API asynchronously using Kotlin coroutines.
+The easiest way to build the API is using .build() after a builder
 ```kotlin
 runBlocking {
-    spotifyAppApi(clientId, clientSecret).buildAsyncAt(this) { api ->
-        // do things
-    }
+    val api = spotifyAppApi(clientId, clientSecret).build()
 }
 ```
 
-### What is the SpotifyRestAction class?
-Abstracting requests into a `SpotifyRestAction` class allows for a lot of flexibility in sending and receiving requests. 
-This class includes options for asynchronous and blocking execution in all endpoints. However, 
- due to this, you **must** call one of the provided methods in order for the call 
- to execute! The `SpotifyRestAction` provides many methods and fields for use, including blocking and asynchronous ones. For example,
- - `hasRun()` tells you whether the rest action has been *started*
- - `hasCompleted()` tells you whether this rest action has been fully executed and *completed*
-- `complete()` blocks the current thread and returns the result
-- `suspendComplete(context: CoroutineContext = Dispatchers.Default)` switches to given context, invokes the supplier, and synchronously retrieves the result.
-- `suspendQueue()` suspends the coroutine, invokes the supplier asynchronously, and resumes with the result
-- `queue()` executes and immediately returns
-- `queue(consumer: (T) -> Unit)` executes the provided callback as soon as the request 
-is asynchronously evaluated
-- `queueAfter(quantity: Int, timeUnit: TimeUnit, consumer: (T) -> Unit)` executes the 
-provided callback after the provided time. As long as supplier execution is less than the provided 
-time, this will likely be accurate within a few milliseconds.
-- `asFuture()` transforms the supplier into a `CompletableFuture` (only JVM)
-
-### SpotifyRestPagingAction
-Separate from, but a superset of SpotifyRestAction, this specialized implementation of RestActions includes extensions
-for `AbstractPagingObject` (`PagingObject` and `CursorBasedPagingObject`). This class gives you the same functionality as SpotifyRestAction, 
-but you also have the ability to retrieve *all* of its items or linked PagingObjects, or a *subset* of its items or linked PagingObjects with one call, with 
-a single method call to `getAllItems()` or `getAllPagingObjects()`, or `getWithNext(total: Int, context: CoroutineContext = Dispatchers.Default)` or `getWithNextItems(total: Int, context: CoroutineContext = Dispatchers.Default)` respectively
-
 ## Notes
 ### The benefits of 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
@@ -430,22 +396,17 @@ val api = spotifyAppApi(
         System.getenv("SPOTIFY_CLIENT_SECRET")
 ).build()
 
-// block and print out the names of the twenty most similar songs to the search
-println(api.search.searchTrack("Début de la Suite").complete().joinToString { it.name })
-
-// now, let's do it asynchronously
-api.search.searchTrack("Début de la Suite").queue { tracks -> println(tracks.joinToString { track -> track.name }) }
+// print out the names of the twenty most similar songs to the search
+println(api.search.searchTrack("Début de la Suite").joinToString { it.name })
 
 // simple, right? what about if we want to print out the featured playlists message from the "Overview" tab?
-println(api.browse.getFeaturedPlaylists().complete().message)
+println(api.browse.getFeaturedPlaylists().message)
 
 // easy! let's try something a little harder
 // let's find out Bénabar's Spotify ID, find his top tracks, and print them out
-
-val benabarId = api.search.searchArtist("Bénabar").complete()[0].id
-// this works; a redundant way would be: api.artists.getArtist("spotify:artist:6xoAWsIOZxJVPpo7Qvqaqv").complete().id
-
-println(api.artists.getArtistTopTracks(benabarId).complete().joinToString { it.name })
+val benabarId = api.search.searchArtist("Bénabar")[0].id
+// this works; a redundant way would be: api.artists.getArtist("spotify:artist:6xoAWsIOZxJVPpo7Qvqaqv").id
+println(api.artists.getArtistTopTracks(benabarId).joinToString { it.name })
 ```
 
 ### Track Relinking

build.gradle.kts

@@ -1,12 +1,13 @@
 import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.kotlin.gradle.plugin.KotlinJsCompilerType
 import org.jetbrains.kotlin.gradle.targets.js.webpack.KotlinWebpackOutput.Target
 
 plugins {
     `maven-publish`
     signing
     id("io.codearte.nexus-staging") version "0.22.0"
     kotlin("multiplatform") version "1.4.21"
-    kotlin("plugin.serialization") version "1.4.10"
+    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"
@@ -35,7 +36,7 @@ dependencies {
 }
 
 group = "com.adamratzman"
-version = "3.2.15"
+version = "3.3.0"
 
 tasks.withType<Test> {
     this.testLogging {
@@ -68,7 +69,7 @@ android {
     testOptions {
         @Suppress("UNCHECKED_CAST")
         this.unitTests.all(closureOf<Test> {
-            this.useJUnitPlatform()
+          //  this.useJUnitPlatform()
         } as groovy.lang.Closure<Test>)
     }
     sourceSets {
@@ -95,6 +96,10 @@ kotlin {
     explicitApiWarning()
 
     android {
+        compilations.all {
+            kotlinOptions.jvmTarget = "1.8"
+        }
+
         mavenPublication {
             artifactId = "spotify-api-kotlin-android"
             setupPom(artifactId)
@@ -106,40 +111,52 @@ kotlin {
     }
 
     jvm {
+        compilations.all {
+            kotlinOptions.jvmTarget = "1.8"
+        }
+        testRuns["test"].executionTask.configure {
+            useJUnit()
+        }
+
         mavenPublication {
             artifactId = "spotify-api-kotlin"
             setupPom(artifactId)
         }
     }
 
-    js(BOTH) {
+    js(KotlinJsCompilerType.LEGACY) {
         mavenPublication {
             artifactId = "spotify-api-kotlin-js"
             setupPom(artifactId)
         }
 
         browser {
-            dceTask {
-                keep("ktor-ktor-io.\$\$importsForInline\$\$.ktor-ktor-io.io.ktor.utils.io")
-            }
-
             webpackTask {
                 output.libraryTarget = Target.UMD
             }
 
             testTask {
-                enabled = false
+                useKarma {
+                    useChromeHeadless()
+                    webpackConfig.cssSupport.enabled = true
+                }
+                //   this.
             }
         }
 
-        nodejs()
+        nodejs {
+            testTask {
+                useMocha {
+                    timeout = "5000"
+                }
+            }
+        }
     }
 
     targets {
         sourceSets {
             val coroutineVersion = "1.4.2"
             val serializationVersion = "1.0.1"
-            val spekVersion = "2.0.15"
             val ktorVersion = "1.4.1"
 
             val commonMain by getting {
@@ -153,7 +170,6 @@ kotlin {
                 dependencies {
                     implementation(kotlin("test-common"))
                     implementation(kotlin("test-annotations-common"))
-                    implementation("org.spekframework.spek2:spek-dsl-metadata:$spekVersion")
                 }
             }
 
@@ -170,12 +186,8 @@ kotlin {
 
             val jvmTest by getting {
                 dependencies {
-                    implementation(kotlin("test"))
                     implementation(kotlin("test-junit"))
-                    implementation("org.junit.jupiter:junit-jupiter:5.6.2")
                     implementation("com.sparkjava:spark-core:2.9.3")
-                    implementation("org.spekframework.spek2:spek-dsl-jvm:$spekVersion")
-                    runtimeOnly("org.spekframework.spek2:spek-runner-junit5:$spekVersion")
                     runtimeOnly(kotlin("reflect"))
                 }
             }
@@ -186,13 +198,14 @@ kotlin {
                     implementation("io.ktor:ktor-client-js:$ktorVersion")
                     implementation(npm("abort-controller", "3.0.0"))
                     implementation(npm("node-fetch", "2.6.0"))
+                    implementation(kotlin("stdlib-js"))
+
                 }
             }
 
             val jsTest by getting {
                 dependencies {
                     implementation(kotlin("test-js"))
-                    implementation("org.spekframework.spek2:spek-dsl-js:$spekVersion")
                 }
             }
 
@@ -211,13 +224,9 @@ kotlin {
 
             val androidTest by getting {
                 dependencies {
-                    implementation(kotlin("test"))
                     implementation(kotlin("test-junit"))
-                    implementation("org.junit.jupiter:junit-jupiter:5.6.2")
                     implementation("com.sparkjava:spark-core:2.9.3")
                     implementation("org.mockito:mockito-core:3.3.3")
-                    implementation("org.spekframework.spek2:spek-dsl-jvm:$spekVersion")
-                    runtimeOnly("org.spekframework.spek2:spek-runner-junit5:$spekVersion")
                     runtimeOnly(kotlin("reflect"))
                 }
             }
@@ -270,40 +279,6 @@ signing {
 tasks {
     val dokkaHtml by getting(DokkaTask::class) {
         outputDirectory.set(projectDir.resolve("docs"))
-
-        dokkaSourceSets {
-            val js by creating {
-                sourceLink {
-                    localDirectory.set(file("src"))
-                    remoteUrl.set(uri("https://github.com/adamint/spotify-web-api-kotlin/tree/master/").toURL())
-                    remoteLineSuffix.set("#L")
-                }
-            }
-            val jvm by creating {
-                sourceLink {
-                    localDirectory.set(file("src"))
-                    remoteUrl.set(uri("https://github.com/adamint/spotify-web-api-kotlin/tree/master/").toURL())
-                    remoteLineSuffix.set("#L")
-
-                }
-            }
-
-            register("common") {
-                sourceLink {
-                    localDirectory.set(file("src"))
-                    remoteUrl.set(uri("https://github.com/adamint/spotify-web-api-kotlin/tree/master/").toURL())
-                    remoteLineSuffix.set("#L")
-                }
-            }
-
-            register("global") {
-                sourceLink {
-                    localDirectory.set(file("src"))
-                    remoteUrl.set(uri("https://github.com/adamint/spotify-web-api-kotlin/tree/master/").toURL())
-                    remoteLineSuffix.set("#L")
-                }
-            }
-        }
     }
 
     spotless {
@@ -319,10 +294,6 @@ tasks {
     }
 
 
-    getByName<Test>("jvmTest") {
-        useJUnitPlatform()
-    }
-
     val publishJvm by registering(Task::class) {
         dependsOn.add(check)
         dependsOn.add(dokkaHtml)

karma.config.d/karma.config.js

@@ -0,0 +1,7 @@
+config.set({
+    client: {
+        mocha: {
+            timeout: 5000
+        }
+    }
+})

settings.gradle.kts

@@ -1,5 +1,5 @@
 pluginManagement {
-    val mainKotlinVersion = "1.4.0"
+    val mainKotlinVersion = "1.4.21"
 
     resolutionStrategy {
         eachPlugin {