Source: lib/playlist.js

  1. var Queue = require('./queue')
  2. var SpotifyRequestHandler = require('./spotify')
  3. var Track = require('./track')
  5. /**
  6.  * Create playlist entry.
  7.  * @constructor
  8.  * @param {SpotifyRequestHandler} spotify - Spotify request handler.
  9.  * @param {string} entry - The playlist to search for.
  10.  * @param {string} [id] - The Spotify ID, if known.
  11.  * @param {string} [limit] - The number of tracks to fetch.
  12.  */
  13. function Playlist (spotify, entry, id, owner, limit) {
  14.   /**
  15.    * Entry string.
  16.    */
  17.   this.entry = ''
  19.   /**
  20.    * The ID of the playlist.
  21.    */
  22.   this.id = ''
  24.   /**
  25.    * Playlist tracks.
  26.    */
  27.   this.items = []
  29.   /**
  30.    * Number of tracks to fetch.
  31.    */
  32.   this.limit = null
  34.   /**
  35.    * Spotify request handler.
  36.    */
  37.   this.spotify = null
  39.   /**
  40.    * The user who owns the playlist.
  41.    */
  42.   this.owner = {}
  44.   /**
  45.    * Spotify URI
  46.    * (a string on the form `spotify:user:xxxxxxxx:playlist:xxxxxxxxxxxxxxxxxxxxxx`).
  47.    */
  48.   this.uri = ''
  50.   this.entry = entry.trim()
  51.   this.id = id || this.id
  52.   this.limit = limit
  53.   this.owner.id = owner || this.owner.id
  54.   this.spotify = spotify || new SpotifyRequestHandler()
  55.   this.uri = (this.owner.id && this.id) ? ('spotify:user:' + this.owner.id + ':playlist:' + this.id) : this.uri
  56. }
  58. /**
  59.  * Clone a JSON response.
  60.  * @param {Object} response - The response.
  61.  */
  62. Playlist.prototype.clone = function (response) {
  63.   for (var prop in response) {
  64.     if (response.hasOwnProperty(prop) &&
  65.         prop !== 'limit') {
  66.       this[prop] = response[prop] || this[prop]
  67.     }
  68.   }
  69. }
  71. /**
  72.  * Create a queue of tracks.
  73.  * @param {JSON} response - A JSON response object.
  74.  * @return {Promise | Queue} A queue of tracks.
  75.  */
  76. Playlist.prototype.createQueue = function () {
  77.   var self = this
  78.   var tracks = this.items.map(function (item) {
  79.     var track = new Track(self.spotify, self.entry)
  80.     track.clone(item.track)
  81.     return track
  82.   })
  83.   var queue = new Queue(tracks)
  84.   if (self.limit) {
  85.     queue = queue.slice(0, self.limit)
  86.   }
  87.   return queue
  88. }
  90. /**
  91.  * Dispatch entry.
  92.  * @return {Promise | Queue} A queue of tracks.
  93.  */
  94. Playlist.prototype.dispatch = function () {
  95.   var self = this
  96.   return this.searchForPlaylist().then(function () {
  97.     return self.fetchPlaylist()
  98.   }).then(function () {
  99.     return self.createQueue()
  100.   })
  101. }
  103. /**
  104.  * Fetch playlist tracks.
  105.  * @return {Promise | JSON} A JSON response.
  106.  */
  107. Playlist.prototype.fetchPlaylist = function (id, owner) {
  108.   id = id || this.id
  109.   owner = owner || (this.owner && this.owner.id)
  110.   var self = this
  111.   return this.spotify.getPlaylist(id, owner).then(function (response) {
  112.     self.clone(response)
  113.     return self
  114.   })
  115. }
  117. /**
  118.  * Search for playlist.
  119.  * @return {Promise | JSON} A JSON response, or `null` if not found.
  120.  */
  121. Playlist.prototype.searchForPlaylist = function () {
  122.   var self = this
  123.   if (this.id && this.owner && this.owner.id) {
  124.     return Promise.resolve(this)
  125.   } else {
  126.     return this.spotify.searchForPlaylist(this.entry).then(function (response) {
  127.       if (response &&
  128.           response.playlists &&
  129.           response.playlists.items &&
  130.           response.playlists.items[0]) {
  131.         response = response.playlists.items[0]
  132.         self.clone(response)
  133.         return Promise.resolve(self)
  134.       } else {
  135.         return Promise.reject(response)
  136.       }
  137.     }).catch(function () {
  138.       // console.log('COULD NOT FIND ' + self.entry)
  139.       return Promise.reject(null)
  140.     })
  141.   }
  142. }
  144. module.exports = Playlist