Add support for getMusicFolders method

README.md

@@ -91,6 +91,7 @@ Please see the official [subsonic api documentation](http://www.subsonic.org/pag
 - getCoverArt.view
 - getGenres.view
 - getLicense.view
+- getMusicFolders.view
 - ping.view
 
 

src/FeatureSet/V1161/Contract/MusicFolderListDataProviderInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\FeatureSet\V1161\Contract;
+
+use Traversable;
+
+interface MusicFolderListDataProviderInterface
+{
+    /**
+     * @return Traversable<array{name: string, id: string}>
+     */
+    public function getMusicFolders(): Traversable;
+}

src/FeatureSet/V1161/FeatureSetFactory.php

@@ -28,6 +28,7 @@ public function getMethods(): array
             'getCoverArt.view' => fn (): Method\V1161MethodInterface => $this->createGetCoverArtMethod(),
             'getArtist.view' => fn (): Method\V1161MethodInterface => $this->createGetArtistMethod(),
             'getGenres.view' => fn (): Method\V1161MethodInterface => $this->createGetGenresMethod(),
+            'getMusicFolders.view' => fn (): Method\V1161MethodInterface => $this->createGetMusicFoldersMethod(),
         ];
     }
 
@@ -72,4 +73,11 @@ public function createGetGenresMethod(): Method\V1161MethodInterface
             new ResponderFactory()
         );
     }
+
+    public function createGetMusicFoldersMethod(): Method\V1161MethodInterface
+    {
+        return new Method\GetMusicFoldersMethod(
+            new ResponderFactory()
+        );
+    }
 }

src/FeatureSet/V1161/FeatureSetFactoryInterface.php

@@ -24,4 +24,6 @@ public function createGetCoverArtMethod(): Method\V1161MethodInterface;
     public function createGetArtistMethod(): Method\V1161MethodInterface;
 
     public function createGetGenresMethod(): Method\V1161MethodInterface;
+
+    public function createGetMusicFoldersMethod(): Method\V1161MethodInterface;
 }

src/FeatureSet/V1161/Method/GetMusicFoldersMethod.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\FeatureSet\V1161\Method;
+
+use Usox\HyperSonic\Exception\SubSonicApiException;
+use Usox\HyperSonic\FeatureSet\V1161\Contract\MusicFolderListDataProviderInterface;
+use Usox\HyperSonic\FeatureSet\V1161\Responder\ResponderFactoryInterface;
+use Usox\HyperSonic\Response\ResponderInterface;
+
+/**
+ * Retrieves the list of available music folders
+ *
+ * This class covers the `getMusicFolders.view` method
+ */
+final class GetMusicFoldersMethod implements V1161MethodInterface
+{
+    public function __construct(
+        private readonly ResponderFactoryInterface $responderFactory,
+    ) {
+    }
+
+    /**
+     * @param array<string, scalar> $queryParams
+     * @param array<string, scalar> $args
+     *
+     * @throws SubSonicApiException
+     */
+    public function __invoke(
+        MusicFolderListDataProviderInterface $dataProvider,
+        array $queryParams,
+        array $args
+    ): ResponderInterface {
+        return $this->responderFactory->createMusicFoldersResponder(
+            $dataProvider->getMusicFolders()
+        );
+    }
+}

src/FeatureSet/V1161/Responder/MusicFoldersResponder.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\FeatureSet\V1161\Responder;
+
+use AaronDDM\XMLBuilder\XMLArray;
+use Traversable;
+use Usox\HyperSonic\Response\FormattedResponderInterface;
+
+final class MusicFoldersResponder implements FormattedResponderInterface
+{
+    /**
+     * @param Traversable<array{
+     *  name: string,
+     *  id: string
+     * }> $musicFolders
+     */
+    public function __construct(
+        private readonly Traversable $musicFolders
+    ) {
+    }
+
+    public function writeXml(XMLArray $XMLArray): void
+    {
+        $XMLArray->startLoop(
+            'musicFolders',
+            [],
+            function (XMLArray $XMLArray): void {
+                foreach ($this->musicFolders as $musicFolder) {
+                    $XMLArray->add(
+                        'musicFolder',
+                        '',
+                        [
+                            'name' => htmlspecialchars($musicFolder['name']),
+                            'id' => $musicFolder['id'],
+                        ]
+                    );
+                }
+            }
+        );
+    }
+
+    public function writeJson(array &$root): void
+    {
+        $root['musicFolders'] = ['musicFolder' => iterator_to_array($this->musicFolders)];
+    }
+
+    public function isBinaryResponder(): bool
+    {
+        return false;
+    }
+}

src/FeatureSet/V1161/Responder/ResponderFactory.php

@@ -4,6 +4,7 @@
 
 namespace Usox\HyperSonic\FeatureSet\V1161\Responder;
 
+use Traversable;
 use Usox\HyperSonic\Response\ResponderInterface;
 
 final class ResponderFactory implements ResponderFactoryInterface
@@ -105,4 +106,18 @@ public function createGenresResponder(
             $genres
         );
     }
+
+    /**
+     * @param Traversable<array{
+     *  name: string,
+     *  id: string
+     * }> $musicFolders
+     */
+    public function createMusicFoldersResponder(
+        Traversable $musicFolders
+    ): ResponderInterface {
+        return new MusicFoldersResponder(
+            $musicFolders
+        );
+    }
 }

src/FeatureSet/V1161/Responder/ResponderFactoryInterface.php

@@ -2,6 +2,7 @@
 
 namespace Usox\HyperSonic\FeatureSet\V1161\Responder;
 
+use Traversable;
 use Usox\HyperSonic\Response\ResponderInterface;
 
 interface ResponderFactoryInterface
@@ -81,4 +82,14 @@ public function createArtistResponder(
     public function createGenresResponder(
         array $genres,
     ): ResponderInterface;
+
+    /**
+     * @param Traversable<array{
+     *  name: string,
+     *  id: string
+     * }> $musicFolders
+     */
+    public function createMusicFoldersResponder(
+        Traversable $musicFolders
+    ): ResponderInterface;
 }

tests/FeatureSet/V1161/FeatureSetFactoryTest.php

@@ -32,6 +32,7 @@ public function methodDataProvider(): array
             ['getCoverArt.view', Method\GetCoverArtMethod::class],
             ['getArtist.view', Method\GetArtistMethod::class],
             ['getGenres.view', Method\GetGenresMethod::class],
+            ['getMusicFolders.view', Method\GetMusicFoldersMethod::class],
         ];
     }
 

tests/FeatureSet/V1161/Method/GetMusicFoldersMethodTest.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\FeatureSet\V1161\Method;
+
+use ArrayIterator;
+use Mockery;
+use Mockery\Adapter\Phpunit\MockeryTestCase;
+use Mockery\MockInterface;
+use Usox\HyperSonic\FeatureSet\V1161\Contract\MusicFolderListDataProviderInterface;
+use Usox\HyperSonic\FeatureSet\V1161\Responder\ResponderFactoryInterface;
+use Usox\HyperSonic\Response\ResponderInterface;
+
+class GetMusicFoldersMethodTest extends MockeryTestCase
+{
+    private MockInterface $responder_factory;
+
+    private GetMusicFoldersMethod $subject;
+
+    public function setUp(): void
+    {
+        $this->responder_factory = Mockery::mock(ResponderFactoryInterface::class);
+
+        $this->subject = new GetMusicFoldersMethod(
+            $this->responder_factory,
+        );
+    }
+
+    public function testInvokeReturnsResponder(): void
+    {
+        $dataProvider = Mockery::mock(MusicFolderListDataProviderInterface::class);
+        $responder = Mockery::mock(ResponderInterface::class);
+
+        $value = new ArrayIterator([666]);
+
+        $dataProvider->shouldReceive('getMusicFolders')
+            ->withNoArgs()
+            ->once()
+            ->andReturn($value);
+
+        $this->responder_factory->shouldReceive('createMusicFoldersResponder')
+            ->with($value)
+            ->once()
+            ->andReturn($responder);
+
+        $this->assertSame(
+            $responder,
+            call_user_func($this->subject, $dataProvider, [], [])
+        );
+    }
+}