add samples for all public endpoints

adamint · adamint · commit c453c77e1941 · 2020-01-10T16:05:40.000-05:00
diff --git a/samples/src/main/kotlin/public/ArtistApiSample.kt b/samples/src/main/kotlin/public/ArtistApiSample.kt
@@ -9,4 +9,19 @@ fun main() {
             System.getenv("SPOTIFY_CLIENT_ID"),
             System.getenv("SPOTIFY_CLIENT_SECRET")
     ).build()
+
+    // get artist Cody G's total follower count
+    println(api.artists.getArtist("spotify:artist:26HkLAAIMh5qOFet57d1rg").complete()!!.followers.total)
+
+    // get artist Cody G and a non-existant artist
+    println(api.artists.getArtists("spotify:artist:26HkLAAIMh5qOFet57d1rg", "nonexistantartist"))
+
+    // get all of artist Cody G's albums
+    println(api.artists.getArtistAlbums("spotify:artist:26HkLAAIMh5qOFet57d1rg").getAllItems().complete().map { it.name })
+
+    // get Cody G's top tracks, in descending order, in France
+    println(api.artists.getArtistTopTracks("spotify:artist:26HkLAAIMh5qOFet57d1rg").complete().map { it.name })
+
+    // get Cody G's related artists
+    println(api.artists.getRelatedArtists("spotify:artist:26HkLAAIMh5qOFet57d1rg").complete().map { it.name })
 }
diff --git a/samples/src/main/kotlin/public/FollowingApiSample.kt b/samples/src/main/kotlin/public/FollowingApiSample.kt
@@ -9,4 +9,10 @@ fun main() {
             System.getenv("SPOTIFY_CLIENT_ID"),
             System.getenv("SPOTIFY_CLIENT_SECRET")
     ).build()
+
+    // check if adamratzman and adamratzman1 are following "Hit Rewind"
+    println(api.following.areFollowingPlaylist("spotify:playlist:37i9dQZF1DX0s5kDXi1oC5", "adamratzman", "adamratzman1"))
+
+    // check if adamratzman1 is following "Hit Rewind"
+    println(api.following.isFollowingPlaylist("spotify:playlist:37i9dQZF1DX0s5kDXi1oC5", "adamratzman1"))
 }
diff --git a/samples/src/main/kotlin/public/PlaylistApiSample.kt b/samples/src/main/kotlin/public/PlaylistApiSample.kt
@@ -2,11 +2,24 @@
 package public
 
 import com.adamratzman.spotify.SpotifyApi.Companion.spotifyAppApi
+import com.adamratzman.spotify.utils.Market
 
 fun main() {
     // instantiate api
     val api = spotifyAppApi(
             System.getenv("SPOTIFY_CLIENT_ID"),
             System.getenv("SPOTIFY_CLIENT_SECRET")
     ).build()
+
+    // get all playlists followed/owned by adamratzman1
+    println(api.playlists.getUserPlaylists("adamratzman1").getAllItems().complete().map { it.name })
+
+    // get playlist "Hit Rewind"'s description in Andorra's market
+    println(api.playlists.getPlaylist("spotify:playlist:37i9dQZF1DX0s5kDXi1oC5", Market.AD).complete()!!.description)
+
+    // get up to 20 tracks for playlist "Hit Rewind"
+    println(api.playlists.getPlaylistTracks("spotify:playlist:37i9dQZF1DX0s5kDXi1oC5").complete().items.map { it.track!!.name })
+
+    // get playlist covers for "Hit Rewind"
+    println(api.playlists.getPlaylistCovers("spotify:playlist:37i9dQZF1DX0s5kDXi1oC5").complete())
 }
diff --git a/samples/src/main/kotlin/public/SearchApiSample.kt b/samples/src/main/kotlin/public/SearchApiSample.kt
@@ -2,11 +2,19 @@
 package public
 
 import com.adamratzman.spotify.SpotifyApi.Companion.spotifyAppApi
+import com.adamratzman.spotify.endpoints.public.SearchApi.SearchType.ALBUM
+import com.adamratzman.spotify.endpoints.public.SearchApi.SearchType.TRACK
 
 fun main() {
     // instantiate api
     val api = spotifyAppApi(
             System.getenv("SPOTIFY_CLIENT_ID"),
             System.getenv("SPOTIFY_CLIENT_SECRET")
     ).build()
+
+    // search tracks and albums with the word "name" in them
+    println(api.search.search("name", TRACK, ALBUM).complete())
+
+    // get the first result of playlist "Today's Top Hits"
+    println(api.search.searchPlaylist("Today's Top Hits").complete().items[0])
 }
diff --git a/samples/src/main/kotlin/public/TrackApiSample.kt b/samples/src/main/kotlin/public/TrackApiSample.kt
@@ -9,4 +9,19 @@ fun main() {
             System.getenv("SPOTIFY_CLIENT_ID"),
             System.getenv("SPOTIFY_CLIENT_SECRET")
     ).build()
+
+    // get track "I'm Good" by the Mowgli's and check its popularity
+    println(api.tracks.getTrack("spotify:track:5KQDGl3vAkNGyfvSbaW89E").complete()!!.popularity)
+
+    // get track "I'm Good" and a non-existant track
+    println(api.tracks.getTracks("spotify:track:5KQDGl3vAkNGyfvSbaW89E", "nonexistanttrack").complete())
+
+    // get audio analysis for track "I'm Good"
+    println(api.tracks.getAudioAnalysis("spotify:track:5KQDGl3vAkNGyfvSbaW89E").complete())
+
+    // get audio features for track "I'm Good"
+    println(api.tracks.getAudioFeatures("spotify:track:5KQDGl3vAkNGyfvSbaW89E").complete())
+
+    // get audio features for an existing and non-existant track
+    println(api.tracks.getAudioFeatures("spotify:track:5KQDGl3vAkNGyfvSbaW89E", "nonexistanttrack"))
 }
diff --git a/samples/src/main/kotlin/public/UserApiSample.kt b/samples/src/main/kotlin/public/UserApiSample.kt
@@ -9,4 +9,11 @@ fun main() {
             System.getenv("SPOTIFY_CLIENT_ID"),
             System.getenv("SPOTIFY_CLIENT_SECRET")
     ).build()
+
+    // get profile for adamratzman1
+    println(api.users.getProfile("adamratzman1").complete())
+
+
+    // get profile of non-existant user
+    println(api.users.getProfile("nonexistantuserjjjjjjjjjjj"))
 }
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientFollowingApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientFollowingApi.kt
@@ -55,18 +55,16 @@ class ClientFollowingApi(api: SpotifyApi<*, *>) : FollowingApi(api) {
      *
      * **[Api Reference](https://developer.spotify.com/documentation/web-api/reference/follow/check-user-following-playlist/)**
      *
-     * @param playlistOwner id or uri of the creator of the playlist
      * @param playlistId playlist id or uri
      *
      * @return Boolean representing whether the user follows the playlist
      *
      * @throws [BadRequestException] if the playlist is not found
      * @return Whether the current user is following [playlistId]
      */
-    fun isFollowingPlaylist(playlistOwner: String, playlistId: String): SpotifyRestAction<Boolean> {
+    fun isFollowingPlaylist(playlistId: String): SpotifyRestAction<Boolean> {
         return toAction {
             isFollowingPlaylist(
-                playlistOwner,
                 playlistId,
                 (api as SpotifyClientApi).userId
             ).complete()
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/FollowingApi.kt b/src/commonMain/kotlin/com.adamratzman.spotify/endpoints/public/FollowingApi.kt
@@ -27,7 +27,6 @@ open class FollowingApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
      *
      * **[Api Reference](https://developer.spotify.com/documentation/web-api/reference/follow/check-user-following-playlist/)**
      *
-     * @param playlistOwner id or uri of the creator of the playlist
      * @param playlist playlist id or uri
      * @param users user ids or uris to check
      *
@@ -36,14 +35,12 @@ open class FollowingApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
      * @throws [BadRequestException] if the playlist is not found OR any user in the list does not exist
      */
     fun areFollowingPlaylist(
-        playlistOwner: String,
         playlist: String,
         vararg users: String
     ): SpotifyRestAction<List<Boolean>> {
         return toAction {
-            val user = UserUri(playlistOwner)
             get(
-                EndpointBuilder("/users/${user.id.encodeUrl()}/playlists/${PlaylistUri(playlist).id.encodeUrl()}/followers/contains")
+                EndpointBuilder("/playlists/${PlaylistUri(playlist).id.encodeUrl()}/followers/contains")
                     .with("ids", users.joinToString(",") { UserUri(it).id.encodeUrl() }).toString()
             ).toList(Boolean.serializer().list, api, json)
         }
@@ -54,18 +51,16 @@ open class FollowingApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
      *
      * **[Api Reference](https://developer.spotify.com/documentation/web-api/reference/follow/check-user-following-playlist/)**
      *
-     * @param playlistOwner id or uri of the creator of the playlist
      * @param playlist playlist id or uri
      * @param user Spotify user id
      *
      * @return booleans representing whether the user follows the playlist. User IDs **not** found will return false
      *
      * @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> {
+    fun isFollowingPlaylist(playlist: String, user: String): SpotifyRestAction<Boolean> {
         return toAction {
             areFollowingPlaylist(
-                playlistOwner,
                 playlist,
                 users = *arrayOf(user)
             ).complete()[0]
diff --git a/src/commonMain/kotlin/com.adamratzman.spotify/models/Search.kt b/src/commonMain/kotlin/com.adamratzman.spotify/models/Search.kt
@@ -4,7 +4,7 @@ package com.adamratzman.spotify.models
 import kotlinx.serialization.Serializable
 
 @Serializable
-class SpotifySearchResult(
+data class SpotifySearchResult(
     val albums: PagingObject<SimpleAlbum>? = null,
     val artists: PagingObject<Artist>? = null,
     val playlists: PagingObject<SimplePlaylist>? = null,

Original file line number	Diff line number	Diff line change
`@@ -55,18 +55,16 @@ class ClientFollowingApi(api: SpotifyApi<, >) : FollowingApi(api) {`
`55`	`55`	`*`
`56`	`56`	`* [Api Reference](https://developer.spotify.com/documentation/web-api/reference/follow/check-user-following-playlist/)`
`57`	`57`	`*`
`58`		`- * @param playlistOwner id or uri of the creator of the playlist`
`59`	`58`	`* @param playlistId playlist id or uri`
`60`	`59`	`*`
`61`	`60`	`* @return Boolean representing whether the user follows the playlist`
`62`	`61`	`*`
`63`	`62`	`* @throws [BadRequestException] if the playlist is not found`
`64`	`63`	`* @return Whether the current user is following [playlistId]`
`65`	`64`	`*/`
`66`		`- fun isFollowingPlaylist(playlistOwner: String, playlistId: String): SpotifyRestAction<Boolean> {`
	`65`	`+ fun isFollowingPlaylist(playlistId: String): SpotifyRestAction<Boolean> {`
`67`	`66`	`return toAction {`
`68`	`67`	`isFollowingPlaylist(`
`69`		`- playlistOwner,`
`70`	`68`	`playlistId,`
`71`	`69`	`(api as SpotifyClientApi).userId`
`72`	`70`	`).complete()`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,6 @@ open class FollowingApi(api: SpotifyApi<, >) : SpotifyEndpoint(api) {`
`27`	`27`	`*`
`28`	`28`	`* [Api Reference](https://developer.spotify.com/documentation/web-api/reference/follow/check-user-following-playlist/)`
`29`	`29`	`*`
`30`		`- * @param playlistOwner id or uri of the creator of the playlist`
`31`	`30`	`* @param playlist playlist id or uri`
`32`	`31`	`* @param users user ids or uris to check`
`33`	`32`	`*`
`@@ -36,14 +35,12 @@ open class FollowingApi(api: SpotifyApi<, >) : SpotifyEndpoint(api) {`
`36`	`35`	`* @throws [BadRequestException] if the playlist is not found OR any user in the list does not exist`
`37`	`36`	`*/`
`38`	`37`	`fun areFollowingPlaylist(`
`39`		`- playlistOwner: String,`
`40`	`38`	`playlist: String,`
`41`	`39`	`vararg users: String`
`42`	`40`	`): SpotifyRestAction<List<Boolean>> {`
`43`	`41`	`return toAction {`
`44`		`- val user = UserUri(playlistOwner)`
`45`	`42`	`get(`
`46`		`- EndpointBuilder("/users/${user.id.encodeUrl()}/playlists/${PlaylistUri(playlist).id.encodeUrl()}/followers/contains")`
	`43`	`+ EndpointBuilder("/playlists/${PlaylistUri(playlist).id.encodeUrl()}/followers/contains")`
`47`	`44`	`.with("ids", users.joinToString(",") { UserUri(it).id.encodeUrl() }).toString()`
`48`	`45`	`).toList(Boolean.serializer().list, api, json)`
`49`	`46`	`}`
`@@ -54,18 +51,16 @@ open class FollowingApi(api: SpotifyApi<, >) : SpotifyEndpoint(api) {`
`54`	`51`	`*`
`55`	`52`	`* [Api Reference](https://developer.spotify.com/documentation/web-api/reference/follow/check-user-following-playlist/)`
`56`	`53`	`*`
`57`		`- * @param playlistOwner id or uri of the creator of the playlist`
`58`	`54`	`* @param playlist playlist id or uri`
`59`	`55`	`* @param user Spotify user id`
`60`	`56`	`*`
`61`	`57`	`* @return booleans representing whether the user follows the playlist. User IDs not found will return false`
`62`	`58`	`*`
`63`	`59`	`* @throws [BadRequestException] if the playlist is not found or if the user does not exist`
`64`	`60`	`*/`
`65`		`- fun isFollowingPlaylist(playlistOwner: String, playlist: String, user: String): SpotifyRestAction<Boolean> {`
	`61`	`+ fun isFollowingPlaylist(playlist: String, user: String): SpotifyRestAction<Boolean> {`
`66`	`62`	`return toAction {`
`67`	`63`	`areFollowingPlaylist(`
`68`		`- playlistOwner,`
`69`	`64`	`playlist,`
`70`	`65`	`users = *arrayOf(user)`
`71`	`66`	`).complete()[0]`