'createPlaylist' request changed: Path and arguments (#281)

* New request path to createPlaylist

* Update README.md

* Fixed create playlist request

* Update package.json

* Revert "Update package.json"

This reverts commit 5718272.

* Add tests and make some changes

Co-authored-by: thelinmichael <[email protected]>

Author: marinacrachi

README.md

@@ -418,7 +418,7 @@ spotifyApi.getUserPlaylists('thelinmichael')
   });
 
 // Create a private playlist
-spotifyApi.createPlaylist('thelinmichael', 'My Cool Playlist', { 'public' : false })
+spotifyApi.createPlaylist('My playlist', { 'description': 'My description', 'public': true })
   .then(function(data) {
     console.log('Created playlist!');
   }, function(err) {

__tests__/spotify-web-api.js

@@ -1512,14 +1512,36 @@ describe('Spotify Web API', () => {
     });
   });
 
-  test.skip('should create a playlist', function(done) {
+  test('should create a playlist', function(done) {
+    sinon.stub(HttpManager, '_makeRequest', function(
+      method,
+      options,
+      uri,
+      callback
+    ) {
+      expect(method).toBe(superagent.post);
+      expect(uri).toBe(
+        'https://api.spotify.com/v1/me/playlists'
+      );
+      expect(JSON.parse(options.data)).toEqual({
+        name: 'My Cool Playlist'
+      });
+      expect(options.query).toBeFalsy();
+      callback(null, {
+        body: { name: 'My Cool Playlist' },
+        statusCode: 200
+      });
+    });
+
     var api = new SpotifyWebApi();
     api.setAccessToken('long-access-token');
 
     api
-      .createPlaylist('thelinmichael', 'My Cool Playlist', { public: true })
+      .createPlaylist('My Cool Playlist')
       .then(
         function(data) {
+          expect(data.body.name).toBe('My Cool Playlist');
+          expect(data.statusCode).toBe(200);
           done();
         },
         function(err) {
@@ -1538,55 +1560,58 @@ describe('Spotify Web API', () => {
     ) {
       expect(method).toBe(superagent.post);
       expect(uri).toBe(
-        'https://api.spotify.com/v1/users/thelinmichael/playlists'
+        'https://api.spotify.com/v1/me/playlists'
       );
       expect(JSON.parse(options.data)).toEqual({
         name: 'My Cool Playlist',
+        description: 'It\'s really cool',
         public: false
       });
       expect(options.query).toBeFalsy();
       callback(null, {
-        body: { name: 'My Cool Playlist', public: false },
+        body: { name: 'My Cool Playlist', description: 'It\s really cool', public: false },
         statusCode: 200
       });
     });
 
     var api = new SpotifyWebApi();
 
     api.createPlaylist(
-      'thelinmichael',
       'My Cool Playlist',
+      { description: 'It\'s really cool' },
       { public: false },
       function(err, data) {
         expect(data.body.name).toBe('My Cool Playlist');
+        expect(data.body.description).toBe('It\s really cool');
+        expect(data.body.public).toBe(false);
         expect(data.statusCode).toBe(200);
         done();
       }
     );
   });
 
-  test('should create a playlist using callback without options', done => {
-    sinon.stub(HttpManager, '_makeRequest').callsFake(function(
+  test('should create a playlist using callback with user id', done => {
+    sinon.stub(HttpManager, '_makeRequest', function(
       method,
       options,
       uri,
       callback
     ) {
       expect(method).toBe(superagent.post);
       expect(uri).toBe(
-        'https://api.spotify.com/v1/users/thelinmichael/playlists'
+        'https://api.spotify.com/v1/me/playlists'
       );
       expect(JSON.parse(options.data)).toEqual({ name: 'My Cool Playlist' });
-      callback(null, { body: { name: 'My Cool Playlist' } });
+      callback(null, { body: { name: 'My Cool Playlist' }, statusCode: 200 });
       expect(options.query).toBeFalsy();
     });
 
     var api = new SpotifyWebApi();
 
-    api.createPlaylist('thelinmichael', 'My Cool Playlist', function(
-      err,
-      data
-    ) {
+    api.createPlaylist('thelinmichael', 'My Cool Playlist', {}, 
+    function(err, data) {
+      expect(data.body.name).toBe('My Cool Playlist');
+      expect(data.statusCode).toBe(200);
       done();
     });
   });

package-lock.json

@@ -508,34 +508,25 @@ SpotifyWebApi.prototype = {
 
   /**
    * Create a playlist.
-   * @param {string} userId The playlist's owner's user ID.
-   * @param {string} playlistName The name of the playlist.
-   * @param {Object} [options] The possible options, currently only public.
+   * @param {string} [name] The name of the playlist.
+   * @param {Object} [options] The possible options, being description, collaborative and public.
    * @param {requestCallback} [callback] Optional callback method to be called instead of the promise.
-   * @example createPlaylist('thelinmichael', 'My cool playlist!', { public : false }).then(...)
+   * @example createPlaylist('My playlist', {''description': 'My description', 'collaborative' : false, 'public': true}).then(...)
    * @returns {Promise|undefined} A promise that if successful, resolves to an object containing information about the
    *          created playlist. If rejected, it contains an error object. Not returned if a callback is given.
    */
-  createPlaylist: function(userId, playlistName, options, callback) {
-    // In case someone is using a version where options parameter did not exist.
-    var actualCallback;
-    if (typeof options === 'function' && !callback) {
-      actualCallback = options;
-    } else {
-      actualCallback = callback;
-    }
-
-    var actualOptions = { name: playlistName };
-    if (typeof options === 'object') {
-      Object.keys(options).forEach(function(key) {
-        actualOptions[key] = options[key];
-      });
+  createPlaylist: function(name, options, callback) {
+    // In case someone is using a version where user id was required
+    if (typeof options === 'string') {
+      options = callback;
+      callback = arguments[3];
     }
+    options.name = name;
 
     return WebApiRequest.builder(this.getAccessToken())
-      .withPath('/v1/users/' + encodeURIComponent(userId) + '/playlists')
+      .withPath('/v1/me/playlists')
       .withHeaders({ 'Content-Type': 'application/json' })
-      .withBodyParameters(actualOptions)
+      .withBodyParameters(options)
       .build()
       .execute(HttpManager.post, actualCallback);
   },