document and test track removal endpoints

adamint · adamint · commit b6a6e29e85d3 · 2019-01-04T12:56:42.000-07:00
Signed-off-by: Adam Ratzman &lt;adam@adamratzman.com&gt;
diff --git a/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPlaylistAPI.kt b/src/main/kotlin/com/adamratzman/spotify/endpoints/client/ClientPlaylistAPI.kt
@@ -69,6 +69,22 @@ class ClientPlaylistAPI(api: SpotifyAPI) : PlaylistsAPI(api) {
         })
     }
 
+
+    /**
+     * Add a track to a user’s playlist.
+     *
+     * @param playlist The Spotify ID for the playlist.
+     * @param tracks Spotify track id
+     * @param position The position to insert the tracks, a zero-based index. For example, to insert the tracks in the
+     * first position: position=0; to insert the tracks in the third position: position=2 . If omitted, the tracks will
+     * be appended to the playlist. Tracks are added in the order they are listed in the query string or request body.
+     *
+     * @throws BadRequestException if any invalid track ids is provided or the playlist is not found
+     */
+
+    fun addTrackToPlaylist(playlist: String,track: String,position: Int?=null)
+    = addTracksToPlaylist(playlist,track,position = position)
+
     /**
      * Add one or more tracks to a user’s playlist.
      *
@@ -185,7 +201,7 @@ class ClientPlaylistAPI(api: SpotifyAPI) : PlaylistsAPI(api) {
      *
      * @throws BadRequestException if the playlist is not found or illegal filters are applied
      */
-    fun reorderTracks(
+    fun reorderPlaylistTracks(
         playlist: String,
         reorderRangeStart: Int,
         reorderRangeLength: Int? = null,
@@ -273,26 +289,55 @@ class ClientPlaylistAPI(api: SpotifyAPI) : PlaylistsAPI(api) {
         })
     }
 
-    fun removePlaylistTrack(
+    /**
+     * Remove a track in the specified positions (zero-based) from the specified playlist.
+     *
+     * @param playlist the playlist id
+     * @param track the track id
+     * @param positions the positions at which the track is located in the playlist
+     * @param snapshotId the playlist snapshot against which to apply the track removals. **recommended to have**
+     */
+    fun removeTrackFromPlaylist(
         playlist: String,
         track: String,
         positions: SpotifyTrackPositions,
         snapshotId: String? = null
-    ) = removePlaylistTracks(playlist, track to positions, snapshotId = snapshotId)
+    ) = removeTracksFromPlaylist(playlist, track to positions, snapshotId = snapshotId)
 
-    fun removePlaylistTrack(
+    /**
+     * Remove all occurrences of a track from the specified playlist.
+     *
+     * @param playlist the playlist id
+     * @param track the track id
+     * @param snapshotId the playlist snapshot against which to apply the track removals. **recommended to have**
+     */
+    fun removeTrackFromPlaylist(
         playlist: String,
         track: String,
         snapshotId: String? = null
-    ) = removePlaylistTracks(playlist, track, snapshotId = snapshotId)
+    ) = removeTracksFromPlaylist(playlist, track, snapshotId = snapshotId)
 
-    fun removePlaylistTracks(
+    /**
+     * Remove all occurrences of the specified tracks from the given playlist.
+     *
+     * @param playlist the playlist id
+     * @param tracks an array of track ids
+     * @param snapshotId the playlist snapshot against which to apply the track removals. **recommended to have**
+     */
+    fun removeTracksFromPlaylist(
         playlist: String,
         vararg tracks: String,
         snapshotId: String? = null
     ) = removePlaylistTracksImpl(playlist, tracks.map { it to null }.toTypedArray(), snapshotId)
 
-    fun removePlaylistTracks(
+    /**
+     * Remove tracks (each with their own positions) from the given playlist.
+     *
+     * @param playlist the playlist id
+     * @param tracks an array of [Pair]s of track ids *and* track positions (zero-based)
+     * @param snapshotId the playlist snapshot against which to apply the track removals. **recommended to have**
+     */
+    fun removeTracksFromPlaylist(
         playlist: String,
         vararg tracks: Pair<String, SpotifyTrackPositions>,
         snapshotId: String? = null
@@ -302,7 +347,7 @@ class ClientPlaylistAPI(api: SpotifyAPI) : PlaylistsAPI(api) {
         playlist: String,
         tracks: Array<Pair<String, SpotifyTrackPositions?>>,
         snapshotId: String?
-    ): SpotifyRestAction<String> {
+    ): SpotifyRestAction<Snapshot> {
         return toAction(Supplier {
             if (tracks.isEmpty()) throw IllegalArgumentException("You need to provide at least one track to remove")
 
@@ -311,29 +356,15 @@ class ClientPlaylistAPI(api: SpotifyAPI) : PlaylistsAPI(api) {
             tracks.map { (track, positions) ->
                 JsonObject().apply {
                     this["uri"] = TrackURI(track).uri
-                    if (positions?.positions?.isNotEmpty() == true) this.put("positions", positions.positions)
-                }.also { if (positions?.positions?.isNotEmpty() == true) it["positions"] = positions.positions }
+                    if (positions?.positions?.isNotEmpty() == true) this["positions"] = positions.positions
+                }.also { if (positions?.positions?.isNotEmpty() == true) it["positions"] = positions }
             }.let { json.put("tracks", JsonArray(it)) }
             delete(
                 EndpointBuilder("/playlists/${PlaylistURI(playlist).id}/tracks").toString(), body = json.toJsonString()
-            )
+            ).toObject<Snapshot>(api)
         })
     }
 
-    /*
-    fun removeAllOccurances(user: String, playlist: String, vararg tracks: String): SpotifyRestAction<Unit> {
-        if (tracks.isEmpty()) throw IllegalArgumentException("Tracks to remove must not be empty")
-        return toAction(Supplier {
-            val json = JSONObject()
-            json.put("tracks", tracks.map { JSONObject().put("uri", TrackURI(it).uri) })
-            println(json.toString())
-            val userURI = UserURI(user)
-            delete("https://api.spotify.com/v1/users/${userURI.id}/playlists/${userURI.PlaylistURI(playlist).id}/tracks",
-                    body =  json.toString(), contentType = "application/json")
-            Unit
-        })
-    }
-*/
     private fun encode(image: BufferedImage): String {
         val bos = ByteArrayOutputStream()
         ImageIO.write(image, "jpg", bos)
@@ -344,4 +375,4 @@ class ClientPlaylistAPI(api: SpotifyAPI) : PlaylistsAPI(api) {
     data class Snapshot(val snapshot_id: String)
 }
 
-class SpotifyTrackPositions(vararg val positions: Int)
+class SpotifyTrackPositions(vararg val positions: Int) : ArrayList<Int>(positions.toList())
diff --git a/src/main/kotlin/com/adamratzman/spotify/utils/Helpers.kt b/src/main/kotlin/com/adamratzman/spotify/utils/Helpers.kt
@@ -53,22 +53,17 @@ internal inline fun <reified T> String.toObjectNullable(o: SpotifyAPI?): T? = tr
 }
 
 internal inline fun <reified T> String.toObject(o: SpotifyAPI?): T {
-    try {
-        val klaxon = o?.klaxon ?: Klaxon()
-        val obj = klaxon.parse<T>(this) ?: throw SpotifyException(
-            "Unable to parse $this",
-            IllegalArgumentException("$this not found")
-        )
-        o?.let {
-            if (obj is Linkable) obj.api = o
-            if (obj is AbstractPagingObject<*>) obj.endpoint = o.tracks
-            obj.instantiatePagingObjects(o)
-        }
-        return obj
-    } catch (e: java.lang.Exception) {
-        println(this)
-        throw e
+    val klaxon = o?.klaxon ?: Klaxon()
+    val obj = klaxon.parse<T>(this) ?: throw SpotifyException(
+        "Unable to parse $this",
+        IllegalArgumentException("$this not found")
+    )
+    o?.let {
+        if (obj is Linkable) obj.api = o
+        if (obj is AbstractPagingObject<*>) obj.endpoint = o.tracks
+        obj.instantiatePagingObjects(o)
     }
+    return obj
 }
 
 internal inline fun <reified T> String.toArray(o: SpotifyAPI?): List<T> {
diff --git a/src/test/kotlin/com/adamratzman/spotify/private/ClientPlaylistAPITest.kt b/src/test/kotlin/com/adamratzman/spotify/private/ClientPlaylistAPITest.kt
@@ -2,9 +2,12 @@
 package com.adamratzman.spotify.private
 
 import com.adamratzman.spotify.api
+import com.adamratzman.spotify.endpoints.client.SpotifyTrackPositions
 import com.adamratzman.spotify.main.SpotifyClientAPI
+import com.adamratzman.spotify.utils.BadRequestException
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.assertThrows
 import org.spekframework.spek2.Spek
 import org.spekframework.spek2.style.specification.describe
 
@@ -13,29 +16,36 @@ class ClientPlaylistAPITest : Spek({
         val cp = (api as? SpotifyClientAPI)?.playlists
         val playlistsBefore = cp?.getClientPlaylists()?.complete()
         val createdPlaylist = cp?.createPlaylist("this is a test playlist", "description")
-                ?.complete()
+            ?.complete()
 
         createdPlaylist ?: return@describe
         it("get playlists for user, then see if we can create/delete playlists") {
             assertTrue(cp.getClientPlaylists().complete().size - 1 == playlistsBefore?.size)
         }
         it("edit playlists") {
-            cp.changePlaylistDescription(createdPlaylist.id, "test playlist", false,
-                    true, "description 2").complete()
+            cp.changePlaylistDescription(
+                createdPlaylist.id, "test playlist", false,
+                true, "description 2"
+            ).complete()
 
             cp.addTracksToPlaylist(createdPlaylist.id, "3WDIhWoRWVcaHdRwMEHkkS", "7FjZU7XFs7P9jHI9Z0yRhK").complete()
 
-            cp.uploadPlaylistCover(createdPlaylist.id, imageUrl = "https://developer.spotify.com/assets/WebAPI_intro.png").complete()
+            cp.uploadPlaylistCover(
+                createdPlaylist.id,
+                imageUrl = "https://developer.spotify.com/assets/WebAPI_intro.png"
+            ).complete()
 
             var updatedPlaylist = cp.getClientPlaylist(createdPlaylist.id).complete()!!
             val fullPlaylist = updatedPlaylist.toFullPlaylist().complete()!!
 
-            assertTrue(updatedPlaylist.collaborative && updatedPlaylist.public == false &&
-                    updatedPlaylist.name == "test playlist" && fullPlaylist.description == "description 2")
+            assertTrue(
+                updatedPlaylist.collaborative && updatedPlaylist.public == false &&
+                    updatedPlaylist.name == "test playlist" && fullPlaylist.description == "description 2"
+            )
 
             assertTrue(updatedPlaylist.tracks.total == 2 && updatedPlaylist.images.isNotEmpty())
 
-            cp.reorderTracks(updatedPlaylist.id, 1, insertionPoint = 0).complete()
+            cp.reorderPlaylistTracks(updatedPlaylist.id, 1, insertionPoint = 0).complete()
 
             updatedPlaylist = cp.getClientPlaylist(createdPlaylist.id).complete()!!
 
@@ -55,9 +65,41 @@ class ClientPlaylistAPITest : Spek({
 
             assertTrue(cp.getPlaylistTracks(createdPlaylist.id).complete().items.size == 4)
 
-            cp.removePlaylistTrack(createdPlaylist.id, trackIdOne).complete()
+            cp.removeTrackFromPlaylist(createdPlaylist.id, trackIdOne).complete()
 
-            assertEquals(listOf(trackIdTwo, trackIdTwo), cp.getPlaylistTracks(createdPlaylist.id).complete().items.map { it.track.id })
+            assertEquals(
+                listOf(trackIdTwo, trackIdTwo),
+                cp.getPlaylistTracks(createdPlaylist.id).complete().items.map { it.track.id })
+
+            cp.addTrackToPlaylist(createdPlaylist.id, trackIdOne).complete()
+
+            cp.removeTrackFromPlaylist(createdPlaylist.id, trackIdTwo, SpotifyTrackPositions(1)).complete()
+
+            assertEquals(
+                listOf(trackIdTwo, trackIdOne),
+                cp.getPlaylistTracks(createdPlaylist.id).complete().items.map { it.track.id })
+
+            cp.setPlaylistTracks(createdPlaylist.id, trackIdOne, trackIdOne, trackIdTwo, trackIdTwo).complete()
+
+            cp.removeTracksFromPlaylist(createdPlaylist.id, trackIdOne, trackIdTwo).complete()
+
+            assertTrue(cp.getPlaylistTracks(createdPlaylist.id).complete().items.isEmpty())
+
+            cp.setPlaylistTracks(createdPlaylist.id, trackIdTwo, trackIdOne, trackIdTwo, trackIdTwo, trackIdOne)
+                .complete()
+
+            cp.removeTracksFromPlaylist(
+                createdPlaylist.id, Pair(trackIdOne, SpotifyTrackPositions(4)),
+                Pair(trackIdTwo, SpotifyTrackPositions(0))
+            ).complete()
+
+            assertEquals(
+                listOf(trackIdOne, trackIdTwo, trackIdTwo),
+                cp.getPlaylistTracks(createdPlaylist.id).complete().items.map { it.track.id })
+
+            assertThrows<BadRequestException> {
+                cp.removeTracksFromPlaylist(createdPlaylist.id, Pair(trackIdOne, SpotifyTrackPositions(3))).complete()
+            }
         }
 
         it("destroy (unfollow) playlist") {
