Merge pull request #112 from adamint/dev

Introduce a better way to create and read TuneableTrackAttributes

Author: adamint

README.md

@@ -28,7 +28,7 @@ repositories {
     jcenter()
 }
 
-compile group: 'com.adamratzman', name: 'spotify-api-kotlin', version: '2.3.03'
+compile group: 'com.adamratzman', name: 'spotify-api-kotlin', version: '2.3.06'
 ```
 
 To use the latest snapshot instead, you must add the Jitpack repository as well
@@ -50,7 +50,7 @@ dependencies {
 <dependency>
     <groupId>com.adamratzman</groupId>
     <artifactId>spotify-api-kotlin</artifactId>
-    <version>2.3.03</version>
+    <version>2.3.06</version>
 </dependency>
 
 <repository>

build.gradle

@@ -1,6 +1,7 @@
 buildscript {
     ext.kotlin_version = '1.3.41'
     ext.dokka_version = '0.9.17'
+    ext.junit_version = '5.5.1'
 
     repositories { jcenter() }
 
@@ -10,9 +11,8 @@ buildscript {
     }
 }
 
-
 plugins {
-    id "com.diffplug.gradle.spotless" version "3.23.1"
+    id "com.diffplug.gradle.spotless" version "3.24.0"
     id "base"
     id "io.codearte.nexus-staging" version "0.21.0"
     id "com.bmuschko.nexus" version "2.3.1"
@@ -22,7 +22,7 @@ apply plugin: 'kotlin'
 apply plugin: 'org.jetbrains.dokka'
 
 group 'com.adamratzman'
-version '2.3.03'
+version '2.3.06'
 
 archivesBaseName = 'spotify-api-kotlin'
 
@@ -37,7 +37,7 @@ dependencies {
     compile "com.squareup.moshi:moshi:1.8.0"
     compile "com.squareup.moshi:moshi-kotlin:1.8.0"
 
-    compile group: 'com.google.http-client', name: 'google-http-client', version: '1.30.2'
+    compile "com.google.http-client:google-http-client:1.31.0"
 
     compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
     compile "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
@@ -51,9 +51,9 @@ dependencies {
         exclude group: 'org.jetbrains.kotlin'
     }
 
-    testCompile('org.junit.jupiter:junit-jupiter-api:5.4.2')
-    testCompile(group: 'org.json', name: 'json', version: '20180130')
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.4.2'
+    testCompile "org.junit.jupiter:junit-jupiter-api:$junit_version"
+    testCompile "org.json:json:20180130"
+    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junit_version"
 }
 
 dokka {

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

@@ -16,8 +16,8 @@ fun spotifyApi(block: SpotifyApiBuilderDsl.() -> Unit) = SpotifyApiBuilderDsl().
  * Spotify traditional Java style API builder
  */
 class SpotifyApiBuilder(
-        private var clientId: String,
-        private var clientSecret: String
+    private var clientId: String,
+    private var clientSecret: String
 ) {
     private var redirectUri: String? = null
     private var authorizationCode: String? = null
@@ -190,17 +190,17 @@ data class SpotifyCredentials(val clientId: String?, val clientSecret: String?,
  * limited time constraint on these before the API automatically refreshes them
  */
 class SpotifyUserAuthorizationBuilder(
-        var authorizationCode: String? = null,
-        var tokenString: String? = null,
-        var token: Token? = null
+    var authorizationCode: String? = null,
+    var tokenString: String? = null,
+    var token: Token? = null
 ) {
     fun build() = SpotifyUserAuthorization(authorizationCode, tokenString, token)
 }
 
 data class SpotifyUserAuthorization(
-        val authorizationCode: String?,
-        val tokenString: String?,
-        val token: Token?
+    val authorizationCode: String?,
+    val tokenString: String?,
+    val token: Token?
 )
 
 /**
@@ -215,13 +215,13 @@ data class SpotifyUserAuthorization(
  * @property enableAllUtilities Whether to enable all provided utilities
  */
 class SpotifyUtilitiesBuilder(
-        var useCache: Boolean = true,
-        var cacheLimit: Int? = 200,
-        var automaticRefresh: Boolean = true,
-        var retryWhenRateLimited: Boolean = true,
-        var enableLogger: Boolean = true,
-        var testTokenValidity: Boolean = false,
-        var enableAllUtilities: Boolean = false
+    var useCache: Boolean = true,
+    var cacheLimit: Int? = 200,
+    var automaticRefresh: Boolean = true,
+    var retryWhenRateLimited: Boolean = true,
+    var enableLogger: Boolean = true,
+    var testTokenValidity: Boolean = false,
+    var enableAllUtilities: Boolean = false
 ) {
     fun build() =
             if (enableAllUtilities)
@@ -245,12 +245,12 @@ class SpotifyUtilitiesBuilder(
 }
 
 data class SpotifyUtilities(
-        val useCache: Boolean,
-        val cacheLimit: Int?,
-        val automaticRefresh: Boolean,
-        val retryWhenRateLimited: Boolean,
-        val enableLogger: Boolean,
-        val testTokenValidity: Boolean
+    val useCache: Boolean,
+    val cacheLimit: Int?,
+    val automaticRefresh: Boolean,
+    val retryWhenRateLimited: Boolean,
+    val enableLogger: Boolean,
+    val testTokenValidity: Boolean
 )
 
 /**
@@ -289,6 +289,20 @@ class SpotifyApiBuilderDsl {
         utilities = SpotifyUtilitiesBuilder().apply(block).build()
     }
 
+    /**
+     * Allows you to override default values for caching, token refresh, and logging
+     */
+    fun config(block: SpotifyUtilitiesBuilder.() -> Unit) {
+        utilities = SpotifyUtilitiesBuilder().apply(block).build()
+    }
+
+    /**
+     * Allows you to override default values for caching, token refresh, and logging
+     */
+    fun options(block: SpotifyUtilitiesBuilder.() -> Unit) {
+        utilities = SpotifyUtilitiesBuilder().apply(block).build()
+    }
+
     /**
      * Create a Spotify authorization URL from which client access can be obtained
      *
@@ -398,9 +412,9 @@ class SpotifyApiBuilderDsl {
      * @param token [Token] object (useful if you already have exchanged an authorization code yourself
      */
     private fun buildClient(
-            authorizationCode: String? = null,
-            tokenString: String? = null,
-            token: Token? = null
+        authorizationCode: String? = null,
+        tokenString: String? = null,
+        token: Token? = null
     ): SpotifyClientAPI {
         val clientId = credentials.clientId
         val clientSecret = credentials.clientSecret
@@ -413,7 +427,7 @@ class SpotifyApiBuilderDsl {
             authorizationCode != null -> try {
                 clientId ?: throw IllegalArgumentException()
                 clientSecret ?: throw IllegalArgumentException()
-                redirectUri ?: IllegalArgumentException()
+                redirectUri ?: throw IllegalArgumentException()
 
                 val response = executeTokenRequest(HttpConnection(
                         url = "https://accounts.spotify.com/api/token",
@@ -433,7 +447,7 @@ class SpotifyApiBuilderDsl {
                         clientSecret,
                         response.body.toObject(null),
                         utilities.automaticRefresh,
-                        redirectUri ?: throw IllegalArgumentException("No redirect uri provided"),
+                        redirectUri,
                         utilities.useCache,
                         utilities.cacheLimit,
                         utilities.retryWhenRateLimited,
@@ -482,5 +496,6 @@ class SpotifyApiBuilderDsl {
 }
 
 enum class AuthorizationType {
-    CLIENT, APPLICATION
+    CLIENT,
+    APPLICATION;
 }

src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientLibraryAPI.kt

@@ -185,7 +185,8 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
  * @param id How to transform an id (or uri) input into its Spotify id
  */
 enum class LibraryType(private val value: String, internal val id: (String) -> String) {
-    TRACK("tracks", { TrackURI(it).id }), ALBUM("albums", { AlbumURI(it).id });
+    TRACK("tracks", { TrackURI(it).id }),
+    ALBUM("albums", { AlbumURI(it).id });
 
     override fun toString() = value
 }

src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPersonalizationAPI.kt

@@ -22,7 +22,9 @@ class ClientPersonalizationAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      * @param id the Spotify id of the time frame
      */
     enum class TimeRange(val id: String) {
-        LONG_TERM("long_term"), MEDIUM_TERM("medium_term"), SHORT_TERM("short_term");
+        LONG_TERM("long_term"),
+        MEDIUM_TERM("medium_term"),
+        SHORT_TERM("short_term");
 
         override fun toString() = id
     }

src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPlayerAPI.kt

@@ -317,6 +317,6 @@ class ClientPlayerAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
         /**
          * Will turn repeat off
          */
-        OFF
+        OFF;
     }
 }

src/main/kotlin/com/adamratzman/spotify/endpoints/public/ArtistsAPI.kt

@@ -95,7 +95,10 @@ class ArtistsAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      * @param keyword The spotify id of the strategy
      */
     enum class AlbumInclusionStrategy(val keyword: String) {
-        ALBUM("album"), SINGLE("single"), APPEARS_ON("appears_on"), COMPILATION("compilation")
+        ALBUM("album"),
+        SINGLE("single"),
+        APPEARS_ON("appears_on"),
+        COMPILATION("compilation");
     }
 
     /**