Merge pull request #10 from JMPerez/add-follow-unfollow-playlists

Add methods to follow and unfollow playlists

Author: JMPerez

src/spotify-web-api.js

@@ -274,6 +274,31 @@ var SpotifyWebApi = (function() {
     return _checkParamsAndPerformRequest(requestData, callback);
   };
 
+  /**
+   * Add the current user as a follower of one playlist.
+   * See [Follow a Playlist](https://developer.spotify.com/web-api/follow-playlist/) on
+   * the Spotify Developer site for more information about the endpoint.
+   * @param {string} ownerId The id of the playlist owner. If you know the Spotify URI of
+   * the playlist, it is easy to find the owner's user id
+   * (e.g. spotify:user:<here_is_the_owner_id>:playlist:xxxx)
+   * @param {string} playlistId The id of the playlist. If you know the Spotify URI it is easy
+   * to find the playlist id (e.g. spotify:user:xxxx:playlist:<here_is_the_playlist_id>)
+   * @param {Object} options A JSON object with options that can be passed. For instance,
+   * whether you want the playlist to be followed privately ({public: false})
+   * @param {function(Object, Object)} callback An optional callback that receives 2 parameters. The first
+   * one is the error object (null if no error), and the second is an empty value if the request succeeded.
+   * @return {Object} Null if a callback is provided, a `Promise` object otherwise
+   */
+  Constr.prototype.followPlaylist = function(ownerId, playlistId, options, callback) {
+    var requestData = {
+      url: _baseUri + '/users/' + ownerId + '/playlists/' + playlistId + '/followers',
+      type: 'PUT',
+      postData: {}
+    };
+
+    return _checkParamsAndPerformRequest(requestData, options, callback);
+  };
+
   /**
    * Removes the current user as a follower of one or more other Spotify users.
    * See [Unfollow Artists or Users](https://developer.spotify.com/web-api/unfollow-artists-users/) on
@@ -318,6 +343,27 @@ var SpotifyWebApi = (function() {
     return _checkParamsAndPerformRequest(requestData, callback);
   };
 
+  /**
+   * Remove the current user as a follower of one playlist.
+   * See [Unfollow a Playlist](https://developer.spotify.com/web-api/unfollow-playlist/) on
+   * the Spotify Developer site for more information about the endpoint.
+   * @param {string} ownerId The id of the playlist owner. If you know the Spotify URI of
+   * the playlist, it is easy to find the owner's user id
+   * (e.g. spotify:user:<here_is_the_owner_id>:playlist:xxxx)
+   * @param {string} playlistId The id of the playlist. If you know the Spotify URI it is easy
+   * to find the playlist id (e.g. spotify:user:xxxx:playlist:<here_is_the_playlist_id>)
+   * @param {function(Object, Object)} callback An optional callback that receives 2 parameters. The first
+   * one is the error object (null if no error), and the second is an empty value if the request succeeded.
+   * @return {Object} Null if a callback is provided, a `Promise` object otherwise
+   */
+  Constr.prototype.unfollowPlaylist = function(ownerId, playlistId, callback) {
+    var requestData = {
+      url: _baseUri + '/users/' + ownerId + '/playlists/' + playlistId + '/followers',
+      type: 'DELETE'
+    };
+    return _checkParamsAndPerformRequest(requestData, callback);
+  };
+
   /**
    * Checks to see if the current user is following one or more other Spotify users.
    * See [Check if Current User Follows](https://developer.spotify.com/web-api/check-current-user-follows/) on

tests/js/spec/test.js

@@ -685,6 +685,39 @@
         expect(that.requests).to.have.length(1);
         expect(that.requests[0].url).to.equal('https://api.spotify.com/v1/me/following/?ids=artistid01%2Cartistid02&type=artist');
       });
+
+      it('should follow a playlist publicly', function() {
+        var callback = sinon.spy();
+        var api = new SpotifyWebApi();
+        api.followPlaylist('spotify', '2ujjMpFriZ2nayLmrD1Jgl', callback);
+        that.requests[0].respond(200);
+        expect(that.requests[0].method).to.equal('PUT');
+        expect(callback.calledWith(null, '')).to.be.ok;
+        expect(that.requests).to.have.length(1);
+        expect(that.requests[0].url).to.equal('https://api.spotify.com/v1/users/spotify/playlists/2ujjMpFriZ2nayLmrD1Jgl/followers');
+      });
+
+      it('should follow a playlist privately', function() {
+        var callback = sinon.spy();
+        var api = new SpotifyWebApi();
+        api.followPlaylist('spotify', '2ujjMpFriZ2nayLmrD1Jgl', {"public": false}, callback);
+        that.requests[0].respond(200);
+        expect(that.requests[0].method).to.equal('PUT');
+        expect(callback.calledWith(null, '')).to.be.ok;
+        expect(that.requests).to.have.length(1);
+        expect(that.requests[0].url).to.equal('https://api.spotify.com/v1/users/spotify/playlists/2ujjMpFriZ2nayLmrD1Jgl/followers');
+      });
+
+      it('should unfollow a playlist', function() {
+        var callback = sinon.spy();
+        var api = new SpotifyWebApi();
+        api.unfollowPlaylist('spotify', '2ujjMpFriZ2nayLmrD1Jgl', callback);
+        that.requests[0].respond(200);
+        expect(that.requests[0].method).to.equal('DELETE');
+        expect(callback.calledWith(null, '')).to.be.ok;
+        expect(that.requests).to.have.length(1);
+        expect(that.requests[0].url).to.equal('https://api.spotify.com/v1/users/spotify/playlists/2ujjMpFriZ2nayLmrD1Jgl/followers');
+      });
     });
 
     describe('Using Promises/A+ through Q.js', function() {