Add support for Spotify playlists

src/Helper.php

@@ -12,6 +12,7 @@ class Helper
 {
     const TRACK_HASH = "00032020";
     const ALBUM_HASH = "0004206c";
+    const PLAYLIST_HASH = "0006006c";
 
     /**
      * Create a mode array from the mode text value.

src/Queue.php

@@ -228,7 +228,7 @@ protected function addUris(array $tracks, int $position = null)
 
             $position += $numberOfTracks;
 
-            if ($data["NumTracksAdded"] != $numberOfTracks) {
+            if ($data["NumTracksAdded"] < $numberOfTracks) {
                 throw new SonosException("Failed to add all the tracks");
             }
         }

src/Tracks/Factory.php

@@ -40,6 +40,7 @@ private function guessTrackClass(string $uri): string
     {
         $classes = [
             Spotify::class,
+            SpotifyPlaylist::class,
             Google::class,
             GoogleUnlimited::class,
             Deezer::class,

src/Tracks/SpotifyPlaylist.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace duncan3dc\Sonos\Tracks;
+
+use duncan3dc\Sonos\Helper;
+
+/**
+ * Representation of a Spotify playlist.
+ */
+class SpotifyPlaylist extends Track
+{
+    const PREFIX = "x-rincon-cpcontainer:" . Helper::PLAYLIST_HASH;
+    const REGION_EU = "2311";
+    const REGION_US = "3079";
+
+    /**
+     * @var string $region The region code for the Spotify service (the default is EU).
+     */
+    public static $region = self::REGION_EU;
+
+
+    /**
+     * Create a Spotify playlist object.
+     *
+     * @param string $uri The URI of the playlist or the full Spotify ID of the playlist
+     */
+    public function __construct(string $uri)
+    {
+        # If this is a spotify playlist ID and not a URI then convert it to a URI now
+        if (substr($uri, 0, strlen(self::PREFIX)) !== self::PREFIX) {
+            $uri = self::PREFIX . urlencode($uri);
+        }
+
+        parent::__construct($uri);
+    }
+
+    /**
+     * Get the metadata xml for this playlist.
+     *
+     * @return string
+     */
+    public function getMetaData(): string
+    {
+        $uri = substr($this->getUri(), strlen(self::PREFIX));
+
+        return Helper::createMetaDataXml(Helper::PLAYLIST_HASH . "{$uri}", "-1", [
+            "dc:title"      =>  "",
+            "upnp:class"    =>  "object.container.playlistContainer",
+        ], static::$region);
+    }
+}

tests/Tracks/FactoryTest.php

@@ -9,6 +9,7 @@
 use duncan3dc\Sonos\Tracks\Google;
 use duncan3dc\Sonos\Tracks\GoogleUnlimited;
 use duncan3dc\Sonos\Tracks\Spotify;
+use duncan3dc\Sonos\Tracks\SpotifyPlaylist;
 use duncan3dc\Sonos\Tracks\Stream;
 use duncan3dc\Sonos\Tracks\Track;
 use duncan3dc\SonosTests\MockTest;
@@ -44,6 +45,13 @@ public function testSpotifyTrackUri()
     }
 
 
+    public function testSpotifyPlaylistUri()
+    {
+        $uri = "x-rincon-cpcontainer:0006006cspotify:user:123sdfd6:playlist:123sdfd6";
+        $track = $this->factory->createFromUri($uri);
+        $this->assertInstanceOf(SpotifyPlaylist::class, $track);
+    }
+
     public function testDeezerTrackUri()
     {
         $uri = "x-sonos-http:tr:123sdfd6";
@@ -106,6 +114,14 @@ public function testSpotifyTrackXml()
     }
 
 
+    public function testSpotifyPlaylistTrackXml()
+    {
+        $xml = $this->getXml("x-rincon-cpcontainer:0006006cspotify:user:123sdfd6:playlist:123sdfd6");
+        $track = $this->factory->createFromXml($xml);
+        $this->assertInstanceOf(SpotifyPlaylist::class, $track);
+    }
+
+
     public function testDeezerTrackXml()
     {
         $xml = $this->getXml("x-sonos-http:tr:123sdfd6");