Add more tests for shows endpoints

Author: thelinmichael

__tests__/spotify-web-api.js

@@ -4189,7 +4189,7 @@ describe('Spotify Web API', () => {
    * Shows
    */
 
-   /* Get a Show */
+  /* Get a Show */
   test('should get a show', done => {
     sinon.stub(HttpManager, '_makeRequest').callsFake(function(
       method,
@@ -4204,19 +4204,6 @@ describe('Spotify Web API', () => {
       expect(options.query.market).toBe('SE');
 
       callback(null, {
-        body: {
-          total_episodes : 3,
-          type : "show",
-          name : "The API show",
-          episodes : [{
-            items : [
-              {
-                "audio_preview_url" : "https://p.scdn.co/mp3-preview/7a785904a33e34b0b2bd382c82fca16be7060c36",
-                "duration_ms" : 2677448
-              }
-            ]
-          }]
-        },
         statusCode: 200
       })
     });
@@ -4225,13 +4212,142 @@ describe('Spotify Web API', () => {
 
     api.getShow('123', { market: 'SE' }).then(
       function(data) {
-        expect(data.body.total_episodes).toBe(3);
-        expect(data.body.episodes[0].items[0].duration_ms).toBe(2677448);
         done();
       },
       function(err) {
         done(err);
       }
     );
   });
+
+  /* Look up several shows */
+  test('should get several shows', done => {
+    sinon.stub(HttpManager, '_makeRequest').callsFake(function(
+      method,
+      options,
+      uri,
+      callback
+    ) {
+      expect(method).toBe(superagent.get);
+      expect(uri).toBe(
+        'https://api.spotify.com/v1/shows'
+      );
+      expect(options.query.market).toBe('SE');
+      expect(options.query.ids).toBe('1,2,3');
+      callback(null, {
+        statusCode: 200
+      })
+    });
+
+    var api = new SpotifyWebApi();
+
+    api.getShows(['1', '2', '3'], { market: 'SE' }).then(
+      function(data) {
+        done();
+      },
+      function(err) {
+        done(err);
+      }
+    );
+  });
+
+  /* Check if one or more shows is already saved in the current Spotify user’s “Your Music” library. */
+  test('should see that show is already saved by user', done => {
+    sinon.stub(HttpManager, '_makeRequest').callsFake(function(
+      method,
+      options,
+      uri,
+      callback
+    ) {
+      expect(method).toBe(superagent.get);
+      expect(uri).toBe(
+        'https://api.spotify.com/v1/me/shows/contains'
+      );
+      expect(options.query.ids).toBe('1,2,3');
+      callback(null, {
+        body: [ true, false, false ],
+        statusCode: 200
+      })
+    });
+
+    var api = new SpotifyWebApi();
+
+    api.containsMySavedShows(['1', '2', '3']).then(
+      function(data) {
+        done();
+      },
+      function(err) {
+        done(err);
+      }
+    );
+  });
+
+  /* Get the episodes of an show. */
+  test('should retrieve the episodes of a show', done => {
+    sinon.stub(HttpManager, '_makeRequest').callsFake(function(
+      method,
+      options,
+      uri,
+      callback
+    ) {
+      expect(method).toBe(superagent.get);
+      expect(uri).toBe(
+        'https://api.spotify.com/v1/shows/123/episodes'
+      );
+      expect(options.query.market).toBe('SE');
+      expect(options.query.limit).toBe(1);
+      expect(options.query.offset).toBe(2);
+      callback(null, {
+        body: {},
+        statusCode: 200
+      })
+    });
+
+    var api = new SpotifyWebApi();
+
+    api.getShowEpisodes('123', { 'market' : 'SE', 'limit' : 1, 'offset': 2}).then(
+      function(data) {
+        done();
+      },
+      function(err) {
+        done(err);
+      }
+    );
+  });
+
+  /* Search for a show. */
+  test('should search for a show', done => {
+    sinon.stub(HttpManager, '_makeRequest').callsFake(function(
+      method,
+      options,
+      uri,
+      callback
+    ) {
+      expect(method).toBe(superagent.get);
+      expect(uri).toBe(
+        'https://api.spotify.com/v1/search/'
+      );
+      expect(options.query.q).toBe('kvartal');
+      expect(options.query.type).toBe('show');
+      expect(options.query.market).toBe('SE');
+      expect(options.query.limit).toBe(3);
+      expect(options.query.offset).toBe(1);
+      callback(null, {
+        body: {},
+        statusCode: 200
+      })
+    });
+
+    var api = new SpotifyWebApi();
+
+    api.searchShows('kvartal', { 'market' : 'SE', 'limit' : 3, 'offset': 1}).then(
+      function(data) {
+        done();
+      },
+      function(err) {
+        done(err);
+      }
+    );
+  });
+
 });

src/spotify-web-api.js

@@ -261,7 +261,7 @@ SpotifyWebApi.prototype = {
    * Search for music entities of certain types.
    * @param {string} query The search query.
    * @param {string[]} types An array of item types to search across.
-   * Valid types are: 'album', 'artist', 'playlist', and 'track'.
+   * Valid types are: 'album', 'artist', 'playlist', 'track', 'show', and 'episode'.
    * @param {Object} [options] The possible options, e.g. limit, offset.
    * @param {requestCallback} [callback] Optional callback method to be called instead of the promise.
    * @example search('Abba', ['track', 'playlist'], { limit : 5, offset : 1 }).then(...)
@@ -1567,25 +1567,16 @@ SpotifyWebApi.prototype = {
    *          about the shows. Not returned if a callback is given.
    */
   getShows: function(showIds, options, callback) {
-    // In case someone is using a version where options parameter did not exist.
-    var actualCallback, actualOptions;
-    if (typeof options === 'function' && !callback) {
-      actualCallback = options;
-      actualOptions = {};
-    } else {
-      actualCallback = callback;
-      actualOptions = options;
-    }
     return WebApiRequest.builder(this.getAccessToken())
       .withPath('/v1/shows')
       .withQueryParameters(
         {
           ids: showIds.join(',')
         },
-        actualOptions
+        options
       )
       .build()
-      .execute(HttpManager.get, actualCallback);
+      .execute(HttpManager.get, callback);
   },
 
   /**
@@ -1656,7 +1647,7 @@ SpotifyWebApi.prototype = {
   /**
    * Get the episodes of an show.
    * @param showId the show's ID.
-   * @options {Object} [options] The possible options, e.g. limit.
+   * @options {Object} [options] The possible options, being limit, offset, and market.
    * @param {requestCallback} [callback] Optional callback method to be called instead of the promise.
    * @example getShowEpisodes('41MnTivkwTO3UUJ8DrqEJJ', { limit : 5, offset : 1 }).then(...)
    * @returns {Promise|undefined} A promise that if successful, returns an object containing the