update tests to reflect new 404 on playlist follow

adamint · adamint · commit 8e8daaf580df · 2019-05-02T23:55:42.000-04:00
additionally, update documentation for that method and change klaxon dependency to compile
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ dependencies {
 This library should work out of the box on Android.
 
 ## Documentation
-The `spotify-web-api-kotlin` KDocs are hosted at https://adamint.github.io/spotify-web-api-kotlin
+The `spotify-web-api-kotlin` JavaDocs are hosted at https://adamint.github.io/spotify-web-api-kotlin
 
 ## Creating a SpotifyAPI or SpotifyClientAPI object
 In order to use the methods in this library, you must create either a `SpotifyAPI` or `SpotifyClientAPI` object using their respective exposed builders. Client-specific methods are unable to be accessed with the generic SpotifyAPI, rather you must create an instance of the Client API.
diff --git a/build.gradle b/build.gradle
@@ -36,7 +36,7 @@ repositories {
 
 dependencies {
     // Actual library dependencies
-    implementation 'com.beust:klaxon:5.0.5'
+    compile 'com.beust:klaxon:5.0.5'
 
     compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
     compile "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/public/FollowingAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/public/FollowingAPI.kt
@@ -3,13 +3,7 @@ package com.adamratzman.spotify.endpoints.public
 
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
-import com.adamratzman.spotify.utils.BadRequestException
-import com.adamratzman.spotify.utils.EndpointBuilder
-import com.adamratzman.spotify.utils.PlaylistURI
-import com.adamratzman.spotify.utils.SpotifyEndpoint
-import com.adamratzman.spotify.utils.UserURI
-import com.adamratzman.spotify.utils.encode
-import com.adamratzman.spotify.utils.toArray
+import com.adamratzman.spotify.utils.*
 import java.util.function.Supplier
 
 /**
@@ -25,7 +19,7 @@ open class FollowingAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      *
      * @return List of Booleans representing whether the user follows the playlist. User IDs **not** found will return false
      *
-     * @throws [BadRequestException] if the playlist is not found
+     * @throws [BadRequestException] if the playlist is not found OR any user in the list does not exist
      */
     fun areFollowingPlaylist(
         playlistOwner: String,
@@ -50,7 +44,7 @@ open class FollowingAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      *
      * @return booleans representing whether the user follows the playlist. User IDs **not** found will return false
      *
-     * @throws [BadRequestException] if the playlist is not found
+     * @throws [BadRequestException] if the playlist is not found or if the user does not exist
      */
     fun isFollowingPlaylist(playlistOwner: String, playlist: String, user: String): SpotifyRestAction<Boolean> {
         return toAction(Supplier {
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/public/PlaylistsAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/public/PlaylistsAPI.kt
@@ -4,22 +4,7 @@ package com.adamratzman.spotify.endpoints.public
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.main.SpotifyRestAction
 import com.adamratzman.spotify.main.SpotifyRestActionPaging
-import com.adamratzman.spotify.utils.BadRequestException
-import com.adamratzman.spotify.utils.EndpointBuilder
-import com.adamratzman.spotify.utils.Market
-import com.adamratzman.spotify.utils.PagingObject
-import com.adamratzman.spotify.utils.Playlist
-import com.adamratzman.spotify.utils.PlaylistTrack
-import com.adamratzman.spotify.utils.PlaylistURI
-import com.adamratzman.spotify.utils.SimplePlaylist
-import com.adamratzman.spotify.utils.SpotifyEndpoint
-import com.adamratzman.spotify.utils.SpotifyImage
-import com.adamratzman.spotify.utils.UserURI
-import com.adamratzman.spotify.utils.catch
-import com.adamratzman.spotify.utils.encode
-import com.adamratzman.spotify.utils.toArray
-import com.adamratzman.spotify.utils.toObject
-import com.adamratzman.spotify.utils.toPagingObject
+import com.adamratzman.spotify.utils.*
 import java.util.function.Supplier
 
 /**
@@ -37,6 +22,8 @@ open class PlaylistsAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      * @return [PagingObject] of [SimplePlaylist]s **ONLY if** the user can be found. Otherwise, an empty paging object is returned.
      * This does not have the detail of full [Playlist] objects.
      *
+     * @throws BadRequestException if the user is not found (404)
+     *
      */
     fun getPlaylists(
         user: String,
diff --git a/src/main/kotlin/com/adamratzman/spotify/utils/Helpers.kt b/src/main/kotlin/com/adamratzman/spotify/utils/Helpers.kt
@@ -7,7 +7,7 @@ import com.beust.klaxon.Json
 import com.beust.klaxon.JsonBase
 import com.beust.klaxon.Klaxon
 import java.net.URLEncoder
-import java.util.Base64
+import java.util.*
 
 /**
  * The cursor to use as key to find the next (or previous) page of items.
@@ -33,8 +33,8 @@ internal inline fun <reified T> String.toObjectNullable(o: SpotifyAPI?): T? = tr
 internal inline fun <reified T> String.toObject(o: SpotifyAPI?): T {
     val klaxon = o?.klaxon ?: Klaxon()
     val obj = klaxon.parse<T>(this) ?: throw SpotifyException(
-        "Unable to parse $this",
-        IllegalArgumentException("$this not found")
+            "Unable to parse $this",
+            IllegalArgumentException("$this not found")
     )
     o?.let {
         if (obj is Linkable) obj.api = o
@@ -54,46 +54,46 @@ internal inline fun <reified T> String.toArray(o: SpotifyAPI?): List<T> {
             }
         }
     } ?: throw SpotifyException(
-        "Unable to parse $this",
-        IllegalArgumentException("$this not found")
+            "Unable to parse $this",
+            IllegalArgumentException("$this not found")
     )
 }
 
 internal inline fun <reified T> String.toPagingObject(
-    innerObjectName: String? = null,
-    endpoint: SpotifyEndpoint
+        innerObjectName: String? = null,
+        endpoint: SpotifyEndpoint
 ): PagingObject<T> {
     val jsonObject = endpoint.api.klaxon.parseJsonObject(this.reader())
-        .let { if (innerObjectName != null) it.obj(innerObjectName)!! else it }
+            .let { if (innerObjectName != null) it.obj(innerObjectName)!! else it }
 
     return PagingObject(
-        jsonObject.string("href")!!,
-        (jsonObject["items"] as JsonBase).toJsonString().toArray<T>(endpoint.api),
-        jsonObject.int("limit")!!,
-        jsonObject.string("next"),
-        jsonObject.int("offset")!!,
-        jsonObject.string("previous"),
-        jsonObject.int("total")!!
+            jsonObject.string("href")!!,
+            (jsonObject["items"] as JsonBase).toJsonString().toArray<T>(endpoint.api),
+            jsonObject.int("limit")!!,
+            jsonObject.string("next"),
+            jsonObject.int("offset")!!,
+            jsonObject.string("previous"),
+            jsonObject.int("total")!!
     ).apply {
         this.endpoint = endpoint
         this.itemClazz = T::class.java
     }
 }
 
 internal inline fun <reified T> String.toCursorBasedPagingObject(
-    innerObjectName: String? = null,
-    endpoint: SpotifyEndpoint
+        innerObjectName: String? = null,
+        endpoint: SpotifyEndpoint
 ): CursorBasedPagingObject<T> {
     val jsonObject = endpoint.api.klaxon.parseJsonObject(this.reader())
-        .let { if (innerObjectName != null) it.obj(innerObjectName)!! else it }
+            .let { if (innerObjectName != null) it.obj(innerObjectName)!! else it }
 
     return CursorBasedPagingObject(
-        jsonObject.string("href")!!,
-        (jsonObject["items"] as JsonBase).toJsonString().toArray<T>(endpoint.api),
-        jsonObject.int("limit")!!,
-        jsonObject.string("next"),
-        endpoint.api.klaxon.parseFromJsonObject(jsonObject.obj("cursors")!!)!!,
-        if (jsonObject.containsKey("total")) jsonObject.int("total")!! else -1
+            jsonObject.string("href")!!,
+            (jsonObject["items"] as JsonBase).toJsonString().toArray<T>(endpoint.api),
+            jsonObject.int("limit")!!,
+            jsonObject.string("next"),
+            endpoint.api.klaxon.parseFromJsonObject(jsonObject.obj("cursors")!!)!!,
+            if (jsonObject.containsKey("total")) jsonObject.int("total")!! else -1
     ).apply {
         this.endpoint = endpoint
         this.itemClazz = T::class.java
@@ -104,14 +104,14 @@ internal inline fun <reified T> String.toInnerObject(innerName: String, api: Spo
     val jsonObject = api.klaxon.parseJsonObject(this.reader())
 
     return jsonObject.obj(innerName)?.let { api.klaxon.parseFromJsonObject<T>(it) }
-        ?: throw SpotifyException("Unable to parse $this into $innerName (${T::class})", IllegalArgumentException())
+            ?: throw SpotifyException("Unable to parse $this into $innerName (${T::class})", IllegalArgumentException())
 }
 
 internal inline fun <reified T> String.toInnerArray(innerName: String, api: SpotifyAPI): List<T> {
     val jsonObject = api.klaxon.parseJsonObject(this.reader())
 
     return jsonObject.array(innerName)
-        ?: throw SpotifyException("Unable to parse $this into $innerName (${T::class})", IllegalArgumentException())
+            ?: throw SpotifyException("Unable to parse $this into $innerName (${T::class})", IllegalArgumentException())
 }
 
 internal fun <T> catch(function: () -> T): T? {
diff --git a/src/main/kotlin/com/adamratzman/spotify/utils/ResultObjects.kt b/src/main/kotlin/com/adamratzman/spotify/utils/ResultObjects.kt
@@ -403,20 +403,20 @@ data class Track(
  * "restrictions" : {"reason" : "market"}
  */
 data class SimpleAlbum(
-    @Json(name = "album_type", ignored = false) private val _albumType: String,
-    val artists: List<SimpleArtist>,
-    @Json(name = "available_markets") val availableMarkets: List<String>? = null,
-    @Json(name = "external_urls") val externalUrls: HashMap<String, String>,
-    val href: String,
-    val id: String,
-    val images: List<SpotifyImage>,
-    val name: String,
-    val type: String,
-    @Json(name = "uri", ignored = false) private val _uri: String,
-    @Json(ignored = true) val uri: AlbumURI = AlbumURI(_uri),
-    @Json(name = "release_date") val releaseDate: String,
-    @Json(name = "release_date_precision") val releaseDatePrecision: String,
-    @Json(name = "total_tracks") val totalTracks: Int? = null,
+    @Json(name = "album_type", ignored = false) private val _albumType: String,//
+    val artists: List<SimpleArtist>,//
+    @Json(name = "available_markets") val availableMarkets: List<String>? = null,//
+    @Json(name = "external_urls") val externalUrls: HashMap<String, String>,//
+    val href: String,//
+    val id: String,//
+    val images: List<SpotifyImage>,//
+    val name: String,//
+    val type: String,//
+    @Json(name = "uri", ignored = false) private val _uri: String,//
+    @Json(ignored = true) val uri: AlbumURI = AlbumURI(_uri),//
+    @Json(name = "release_date") val releaseDate: String,//
+    @Json(name = "release_date_precision") val releaseDatePrecision: String,//
+    @Json(name = "total_tracks") val totalTracks: Int? = null,//
     @Json(name = "album_group", ignored = false) private val albumGroupString: String? = null,
     val restrictions: Restrictions? = null,
     @Json(ignored = true) val albumGroup: AlbumResultType? = albumGroupString?.let { _ ->
diff --git a/src/test/kotlin/com/adamratzman/spotify/public/PublicFollowingAPITest.kt b/src/test/kotlin/com/adamratzman/spotify/public/PublicFollowingAPITest.kt
@@ -4,7 +4,6 @@ package com.adamratzman.spotify.public
 import com.adamratzman.spotify.api
 import com.adamratzman.spotify.utils.BadRequestException
 import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.Assertions.assertFalse
 import org.junit.jupiter.api.assertThrows
 import org.spekframework.spek2.Spek
 import org.spekframework.spek2.style.specification.describe
@@ -14,7 +13,7 @@ class PublicFollowingAPITest : Spek({
         val f = api.following
         describe("do users follow playlist") {
             it("invalid users, valid playlist") {
-                assertFalse(f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "udontexist89").complete()[0])
+                assertThrows<BadRequestException> { f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "udontexist89").complete()[0] }
             }
             it("no users, valid playlist") {
                 assertThrows<BadRequestException> {
@@ -31,8 +30,9 @@ class PublicFollowingAPITest : Spek({
                         f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "adamratzman1", "adamratzman").complete())
             }
             it("mix of valid and invalid users, valid playlist") {
-                assertEquals(listOf(false, true),
-                        f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "udontexist89", "adamratzman1").complete())
+                assertThrows<BadRequestException> {
+                    f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "udontexist89", "adamratzman1").complete()
+                }
             }
         }
     }
diff --git a/src/test/kotlin/com/adamratzman/spotify/public/PublicPlaylistsAPITest.kt b/src/test/kotlin/com/adamratzman/spotify/public/PublicPlaylistsAPITest.kt
@@ -3,9 +3,7 @@ package com.adamratzman.spotify.public
 
 import com.adamratzman.spotify.api
 import com.adamratzman.spotify.utils.BadRequestException
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.Assertions.assertNull
-import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.assertThrows
 import org.spekframework.spek2.Spek
 import org.spekframework.spek2.style.specification.describe
@@ -20,8 +18,8 @@ class PublicPlaylistsAPITest : Spek({
                 assertTrue(p.getPlaylists("adamratzman1").complete().isNotEmpty())
                 assertTrue(p.getPlaylists("adamratzman1").complete().isNotEmpty())
             }
-            it("unknown user should throw exception but doesn't. if the id is valid, the list should be empty") {
-                assertEquals(0, p.getPlaylists("non-existant-user").complete().size)
+            it("unknown user should throw exception") {
+                assertThrows<BadRequestException> { p.getPlaylists("non-existant-user").complete().size }
             }
         }
         describe("get playlist") {

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ package com.adamratzman.spotify.public`
`4`	`4`	`import com.adamratzman.spotify.api`
`5`	`5`	`import com.adamratzman.spotify.utils.BadRequestException`
`6`	`6`	`import org.junit.jupiter.api.Assertions.assertEquals`
`7`		`-import org.junit.jupiter.api.Assertions.assertFalse`
`8`	`7`	`import org.junit.jupiter.api.assertThrows`
`9`	`8`	`import org.spekframework.spek2.Spek`
`10`	`9`	`import org.spekframework.spek2.style.specification.describe`
`@@ -14,7 +13,7 @@ class PublicFollowingAPITest : Spek({`
`14`	`13`	`val f = api.following`
`15`	`14`	`describe("do users follow playlist") {`
`16`	`15`	`it("invalid users, valid playlist") {`
`17`		`- assertFalse(f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "udontexist89").complete()[0])`
	`16`	`+ assertThrows<BadRequestException> { f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "udontexist89").complete()[0] }`
`18`	`17`	`}`
`19`	`18`	`it("no users, valid playlist") {`
`20`	`19`	`assertThrows<BadRequestException> {`
`@@ -31,8 +30,9 @@ class PublicFollowingAPITest : Spek({`
`31`	`30`	`f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "adamratzman1", "adamratzman").complete())`
`32`	`31`	`}`
`33`	`32`	`it("mix of valid and invalid users, valid playlist") {`
`34`		`- assertEquals(listOf(false, true),`
`35`		`- f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "udontexist89", "adamratzman1").complete())`
	`33`	`+ assertThrows<BadRequestException> {`
	`34`	`+ f.areFollowingPlaylist("spotify", "37i9dQZF1DXcBWIGoYBM5M", "udontexist89", "adamratzman1").complete()`
	`35`	`+ }`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`	`}`