Merge pull request #8 from adamint/develop

Develop

Author: adamint

.circleci/config.yml

@@ -0,0 +1,42 @@
+# Java Gradle CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-java/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/openjdk:8-jdk
+      
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    environment:
+      # Customize the JVM maximum heap limit
+      JVM_OPTS: -Xmx3200m
+      TERM: dumb
+    
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "build.gradle" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run: gradle dependencies
+
+      - save_cache:
+          paths:
+            - ~/.gradle
+          key: v1-dependencies-{{ checksum "build.gradle" }}
+        
+      # run tests!
+      - run: gradle test

.idea/modules/SpotifyKotlinWrapper.iml

@@ -1,5 +1,5 @@
 group 'com.adamratzman'
-version '1.0.2'
+version '1.0.3'
 
 buildscript {
     ext.kotlin_version = '1.2.31'

.idea/modules/SpotifyKotlinWrapper_main.iml

@@ -30,7 +30,8 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun isFollowingUsers(vararg userIds: String): SpotifyRestAction<List<Boolean>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/following/contains?type=user&ids=${userIds.joinToString(",") { it.encode() }}").toObject<List<Boolean>>(api)
+            get(EndpointBuilder("/me/following/contains").with("type", "user")
+                    .with("ids", userIds.joinToString(",") { it.encode() }).build()).toObject<List<Boolean>>(api)
         })
     }
 
@@ -56,7 +57,8 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun isFollowingArtists(vararg artistIds: String): SpotifyRestAction<List<Boolean>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/following/contains?type=artist&ids=${artistIds.joinToString(",") { it.encode() }}").toObject<List<Boolean>>(api)
+            get(EndpointBuilder("/me/following/contains").with("type", "artist")
+                    .with("ids", artistIds.joinToString(",") { it.encode() }).build()).toObject<List<Boolean>>(api)
         })
     }
 
@@ -66,14 +68,14 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      * @return [CursorBasedPagingObject] ([Information about them](https://github.com/adamint/spotify-web-api-kotlin/blob/master/README.md#the-benefits-of-linkedresults-pagingobjects-and-cursor-based-paging-objects)
      * with full [Artist] objects
      */
-    fun getFollowedArtists(): SpotifyRestAction<CursorBasedPagingObject<Artist>> {
+    fun getFollowedArtists(limit: Int? = null, after: String? = null): SpotifyRestAction<CursorBasedPagingObject<Artist>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/following?type=artist").toCursorBasedPagingObject<Artist>("artists", api)
+            get(EndpointBuilder("/me/following").with("type", "artist").with("limit", limit).with("after", after).build())
+                    .toCursorBasedPagingObject<Artist>("artists", this)
         })
     }
 
-    fun getFollowedUsers(): SpotifyRestAction<SpotifyPublicUser>
-            = throw NotImplementedError("Though Spotify will implement this in the future, it is not currently supported.")
+    fun getFollowedUsers(): SpotifyRestAction<SpotifyPublicUser> = throw NotImplementedError("Though Spotify will implement this in the future, it is not currently supported.")
 
     /**
      * Add the current user as a follower of another user
@@ -93,7 +95,8 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun followUsers(vararg userIds: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            put("https://api.spotify.com/v1/me/following?type=user&ids=${userIds.joinToString(",") { it.encode() }}")
+            put(EndpointBuilder("/me/following").with("type", "user")
+                    .with("ids", userIds.joinToString(",") { it.encode() }).build())
             Unit
         })
     }
@@ -116,7 +119,8 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun followArtists(vararg artistIds: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            put("https://api.spotify.com/v1/me/following?type=artist&ids=${artistIds.joinToString(",")}")
+            put(EndpointBuilder("/me/following").with("type", "artist")
+                    .with("ids", artistIds.joinToString(",") { it.encode() }).build())
             Unit
         })
     }
@@ -134,7 +138,7 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun followPlaylist(ownerId: String, playlistId: String, followPublicly: Boolean = true): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            put("https://api.spotify.com/v1/users/$ownerId/playlists/$playlistId/followers", "{\"public\": $followPublicly}")
+            put(EndpointBuilder("/users/$ownerId/playlists/$playlistId/followers").build(), "{\"public\": $followPublicly}")
             Unit
         })
 
@@ -162,7 +166,8 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun unfollowUsers(vararg userIds: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            delete("https://api.spotify.com/v1/me/following?type=user&ids=${userIds.joinToString(",") { it.encode() }}")
+            delete(EndpointBuilder("/me/following").with("type", "user")
+                    .with("ids", userIds.joinToString(",") { it.encode() }).build())
             Unit
         })
     }
@@ -189,7 +194,8 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun unfollowArtists(vararg artistIds: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            delete("https://api.spotify.com/v1/me/following?type=artist&ids=${artistIds.joinToString(",")}")
+            delete(EndpointBuilder("/me/following").with("type", "artist")
+                    .with("ids", artistIds.joinToString(",") { it.encode() }).build())
             Unit
         })
     }
@@ -204,7 +210,7 @@ class ClientFollowAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun unfollowPlaylist(ownerId: String, playlistId: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            delete("https://api.spotify.com/v1/users/$ownerId/playlists/$playlistId/followers")
+            delete(EndpointBuilder("/users/$ownerId/playlists/$playlistId/followers").build())
             Unit
         })
     }

.idea/modules/SpotifyKotlinWrapper_test.iml

@@ -2,7 +2,6 @@ package com.adamratzman.spotify.endpoints.priv.library
 
 import com.adamratzman.spotify.main.SpotifyAPI
 import com.adamratzman.spotify.utils.*
-import com.sun.org.apache.xpath.internal.operations.Bool
 import java.util.function.Supplier
 
 /**
@@ -14,9 +13,10 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      *
      * @return Paging Object of [SavedTrack] ordered by position in library
      */
-    fun getSavedTracks(): SpotifyRestAction<PagingObject<SavedTrack>> {
+    fun getSavedTracks(limit: Int? = null, offset: Int? = null, market: Market? = null): SpotifyRestAction<PagingObject<SavedTrack>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/tracks").toPagingObject<SavedTrack>(api = api)
+            get(EndpointBuilder("/me/tracks").with("limit", limit).with("offset", offset).with("market", market?.code)
+                    .build()).toPagingObject<SavedTrack>(endpoint = this)
         })
     }
 
@@ -27,7 +27,7 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun getSavedAlbums(): SpotifyRestAction<PagingObject<SavedAlbum>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/albums").toPagingObject<SavedAlbum>(api = api)
+            get(EndpointBuilder("/me/albums").build()).toPagingObject<SavedAlbum>(endpoint = this)
         })
     }
 
@@ -49,7 +49,8 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun doesLibraryContainTracks(vararg ids: String): SpotifyRestAction<List<Boolean>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/tracks/contains?ids=${ids.joinToString(",") { it.encode() }}").toObject<List<Boolean>>(api)
+            get(EndpointBuilder("/me/tracks/contains").with("ids", ids.joinToString(",") { it.encode() })
+                    .build()).toObject<List<Boolean>>(api)
         })
     }
 
@@ -71,7 +72,8 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun doesLibraryContainAlbums(vararg ids: String): SpotifyRestAction<List<Boolean>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/albums/contains?ids=${ids.joinToString(",") { it.encode() }}").toObject<List<Boolean>>(api)
+            get(EndpointBuilder("/me/albums/contains").with("ids", ids.joinToString(",") { it.encode() })
+                    .build()).toObject<List<Boolean>>(api)
         })
     }
 
@@ -93,7 +95,7 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun addTracksToLibrary(vararg ids: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            put("https://api.spotify.com/v1/me/tracks?ids=${ids.joinToString(",") { it.encode() }}")
+            put(EndpointBuilder("/me/tracks").with("ids", ids.joinToString(",") { it.encode() }).build())
             Unit
         })
     }
@@ -116,7 +118,7 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun addAlbumsToLibrary(vararg ids: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            put("https://api.spotify.com/v1/me/albums?ids=${ids.joinToString(",") { it.encode() }}")
+            put(EndpointBuilder("/me/albums").with("ids", ids.joinToString(",") { it.encode() }).build())
             Unit
         })
     }
@@ -139,7 +141,7 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun removeTracksFromLibrary(vararg ids: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            delete("https://api.spotify.com/v1/me/tracks?ids=${ids.joinToString(",") { it.encode() }}")
+            delete(EndpointBuilder("/me/tracks").with("ids", ids.joinToString(",") { it.encode() }).build())
             Unit
         })
     }
@@ -162,7 +164,7 @@ class ClientLibraryAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      */
     fun removeAlbumsFromLibrary(vararg ids: String): SpotifyRestAction<Unit> {
         return toAction(Supplier {
-            delete("https://api.spotify.com/v1/me/albums?ids=${ids.joinToString(",") { it.encode() }}")
+            delete(EndpointBuilder("/me/albums").with("ids", ids.joinToString(",") { it.encode() }).build())
             Unit
         })
     }

build.gradle

@@ -8,6 +8,11 @@ import java.util.function.Supplier
  * Endpoints for retrieving information about the user’s listening habits.
  */
 class PersonalizationAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
+    enum class TimeRange(val id: String) {
+        LONG_TERM("long_term"), MEDIUM_TERM("medium_term"), SHORT_TERM("short_term");
+        override fun toString() = id
+    }
+
     /**
      * Get the current user’s top artists based on calculated affinity.
      * Affinity is a measure of the expected preference a user has for a particular track or artist.  It is based on user
@@ -20,9 +25,10 @@ class PersonalizationAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      *
      * @return [PagingObject] of full [Artist] objects sorted by affinity
      */
-    fun getTopArtists(): SpotifyRestAction<PagingObject<Artist>> {
+    fun getTopArtists(limit: Int? = null, offset: Int? = null, timeRange: TimeRange? = null): SpotifyRestAction<PagingObject<Artist>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/top/artists").toPagingObject<Artist>(api = api)
+            get(EndpointBuilder("/me/top/artists").with("limit", limit).with("offset", offset)
+                    .with("time_range", timeRange).build()).toPagingObject<Artist>(endpoint = this)
         })
     }
 
@@ -38,9 +44,10 @@ class PersonalizationAPI(api: SpotifyAPI) : SpotifyEndpoint(api) {
      *
      * @return [PagingObject] of full [Track] objects sorted by affinity
      */
-    fun getTopTracks(): SpotifyRestAction<PagingObject<Track>> {
+    fun getTopTracks(limit: Int? = null, offset: Int? = null, timeRange: TimeRange? = null): SpotifyRestAction<PagingObject<Track>> {
         return toAction(Supplier {
-            get("https://api.spotify.com/v1/me/top/tracks").toPagingObject<Track>(api = api)
+            get(EndpointBuilder("/me/top/tracks").with("limit", limit).with("offset", offset)
+                    .with("time_range", timeRange).build()).toPagingObject<Track>(endpoint = this)
         })
     }