Add binary responder, including getCovertArt method

usox · Apr 23, 2022 · 7dea13b · 7dea13b
1 parent 833371e
commit 7dea13b
Show file tree

Hide file tree

Showing 20 changed files with 182 additions and 23 deletions.
diff --git a/src/FeatureSet/V1161/Contract/GetCoverArtDataProviderInterface.php b/src/FeatureSet/V1161/Contract/GetCoverArtDataProviderInterface.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\FeatureSet\V1161\Contract;
+
+interface GetCoverArtDataProviderInterface extends V1161DataProviderInterface
+{
+    /**
+     * @return array{
+     *  contentType: string,
+     *  art: string
+     * }
+     */
+    public function getArt(string $coverArtId): array;
+}
diff --git a/src/FeatureSet/V1161/FeatureSetFactory.php b/src/FeatureSet/V1161/FeatureSetFactory.php
@@ -22,6 +22,7 @@ public function getMethods(): array
             'ping.view' => fn (): Method\V1161MethodInterface => $this->createPingMethod(),
             'getLicense.view' => fn (): Method\V1161MethodInterface => $this->createGetLicense(),
             'getArtists.view' => fn (): Method\V1161MethodInterface => $this->createGetArtistsMethod(),
+            'getCoverArt.view' => fn (): Method\V1161MethodInterface => $this->createGetCoverArtMethod(),
         ];
     }
 
@@ -45,4 +46,11 @@ public function createGetLicense(): Method\V1161MethodInterface
             new ResponderFactory(),
         );
     }
+
+    public function createGetCoverArtMethod(): Method\V1161MethodInterface
+    {
+        return new Method\GetCoverArtMethod(
+            new ResponderFactory()
+        );
+    }
 }
diff --git a/src/FeatureSet/V1161/FeatureSetFactoryInterface.php b/src/FeatureSet/V1161/FeatureSetFactoryInterface.php
@@ -18,4 +18,6 @@ public function createPingMethod(): Method\V1161MethodInterface;
     public function createGetArtistsMethod(): Method\V1161MethodInterface;
 
     public function createGetLicense(): Method\V1161MethodInterface;
+
+    public function createGetCoverArtMethod(): Method\V1161MethodInterface;
 }
diff --git a/src/FeatureSet/V1161/Method/GetArtistsMethod.php b/src/FeatureSet/V1161/Method/GetArtistsMethod.php
@@ -17,12 +17,14 @@ public function __construct(
     }
 
     /**
+     * @param array<string, scalar> $queryParams
      * @param array<string, scalar> $args
      */
     public function __invoke(
         ResponseWriterInterface $responseWriter,
         ArtistListDataProviderInterface $artistListDataProvider,
-        array $args
+        array $queryParams,
+        array $args,
     ): ResponderInterface {
         $data = [];
         $currentIndex = null;

diff --git a/src/FeatureSet/V1161/Method/GetCoverArtMethod.php b/src/FeatureSet/V1161/Method/GetCoverArtMethod.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\FeatureSet\V1161\Method;
+
+use Usox\HyperSonic\FeatureSet\V1161\Contract\GetCoverArtDataProviderInterface;
+use Usox\HyperSonic\FeatureSet\V1161\Responder\ResponderFactoryInterface;
+use Usox\HyperSonic\Response\ResponderInterface;
+use Usox\HyperSonic\Response\ResponseWriterInterface;
+
+final class GetCoverArtMethod implements V1161MethodInterface
+{
+    public function __construct(
+        private readonly ResponderFactoryInterface $responderFactory,
+    ) {
+    }
+
+    /**
+     * @param array<string, scalar> $queryParams
+     * @param array<string, scalar> $args
+     */
+    public function __invoke(
+        ResponseWriterInterface $responseWriter,
+        GetCoverArtDataProviderInterface $getCoverArtDataProvider,
+        array $queryParams,
+        array $args
+    ): ResponderInterface {
+        $art = $getCoverArtDataProvider->getArt(
+            (string) ($queryParams['id'] ?? '')
+        );
+
+        return $this->responderFactory->createCoverArtResponder(
+            $art['art'],
+            $art['contentType'],
+        );
+    }
+}
diff --git a/src/FeatureSet/V1161/Method/GetLicenseMethod.php b/src/FeatureSet/V1161/Method/GetLicenseMethod.php
@@ -17,11 +17,13 @@ public function __construct(
     }
 
     /**
+     * @param array<string, scalar> $queryParams
      * @param array<string, scalar> $args
      */
     public function __invoke(
         ResponseWriterInterface $responseWriter,
         LicenseDataProviderInterface $licenseDataProvider,
+        array $queryParams,
         array $args
     ): ResponderInterface {
         return $this->responderFactory->createLicenseResponder([

diff --git a/src/FeatureSet/V1161/Method/PingMethod.php b/src/FeatureSet/V1161/Method/PingMethod.php
@@ -18,11 +18,13 @@ public function __construct(
     }
 
     /**
+     * @param array<string, scalar> $queryParams
      * @param array<string, scalar> $args
      */
     public function __invoke(
         ResponseWriterInterface $responseWriter,
         PingDataProviderInterface $dataProvider,
+        array $queryParams,
         array $args
     ): ResponderInterface {
         if (!$dataProvider->isOk()) {

diff --git a/src/FeatureSet/V1161/Responder/ArtistsResponder.php b/src/FeatureSet/V1161/Responder/ArtistsResponder.php
@@ -5,9 +5,9 @@
 namespace Usox\HyperSonic\FeatureSet\V1161\Responder;
 
 use AaronDDM\XMLBuilder\XMLArray;
-use Usox\HyperSonic\Response\ResponderInterface;
+use Usox\HyperSonic\Response\FormattedResponderInterface;
 
-final class ArtistsResponder implements ResponderInterface
+final class ArtistsResponder implements FormattedResponderInterface
 {
     /**
      * @param array{
@@ -59,4 +59,9 @@ public function writeJson(array &$root): void
     {
         $root['artists'] = $this->artistList;
     }
+
+    public function isBinaryResponder(): bool
+    {
+        return false;
+    }
 }
diff --git a/src/FeatureSet/V1161/Responder/CoverArtResponder.php b/src/FeatureSet/V1161/Responder/CoverArtResponder.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\FeatureSet\V1161\Responder;
+
+use Psr\Http\Message\ResponseInterface;
+use Usox\HyperSonic\Response\BinaryResponderInterface;
+
+final class CoverArtResponder implements BinaryResponderInterface
+{
+    public function __construct(
+        private readonly string $covertArt,
+        private readonly string $contentType,
+    ) {
+    }
+
+    public function isBinaryResponder(): bool
+    {
+        return true;
+    }
+
+    public function writeResponse(ResponseInterface $response): ResponseInterface
+    {
+        $response->getBody()->write($this->covertArt);
+
+        return $response->withHeader('Content-Type', $this->contentType);
+    }
+}
diff --git a/src/FeatureSet/V1161/Responder/LicenseResponder.php b/src/FeatureSet/V1161/Responder/LicenseResponder.php
@@ -5,9 +5,9 @@
 namespace Usox\HyperSonic\FeatureSet\V1161\Responder;
 
 use AaronDDM\XMLBuilder\XMLArray;
-use Usox\HyperSonic\Response\ResponderInterface;
+use Usox\HyperSonic\Response\FormattedResponderInterface;
 
-final class LicenseResponder implements ResponderInterface
+final class LicenseResponder implements FormattedResponderInterface
 {
     /**
      * @param array{
@@ -34,4 +34,9 @@ public function writeJson(array &$root): void
     {
         $root['license'] = $this->licenseData;
     }
+
+    public function isBinaryResponder(): bool
+    {
+        return false;
+    }
 }
diff --git a/src/FeatureSet/V1161/Responder/PingResponder.php b/src/FeatureSet/V1161/Responder/PingResponder.php
@@ -5,9 +5,9 @@
 namespace Usox\HyperSonic\FeatureSet\V1161\Responder;
 
 use AaronDDM\XMLBuilder\XMLArray;
-use Usox\HyperSonic\Response\ResponderInterface;
+use Usox\HyperSonic\Response\FormattedResponderInterface;
 
-final class PingResponder implements ResponderInterface
+final class PingResponder implements FormattedResponderInterface
 {
     public function writeXml(XMLArray $XMLArray): void
     {
@@ -16,4 +16,9 @@ public function writeXml(XMLArray $XMLArray): void
     public function writeJson(array &$root): void
     {
     }
+
+    public function isBinaryResponder(): bool
+    {
+        return false;
+    }
 }
diff --git a/src/FeatureSet/V1161/Responder/ResponderFactory.php b/src/FeatureSet/V1161/Responder/ResponderFactory.php
@@ -51,4 +51,14 @@ public function createPingResponder(): ResponderInterface
     {
         return new PingResponder();
     }
+
+    public function createCoverArtResponder(
+        string $coverArt,
+        string $contentType,
+    ): ResponderInterface {
+        return new CoverArtResponder(
+            $coverArt,
+            $contentType,
+        );
+    }
 }
diff --git a/src/FeatureSet/V1161/Responder/ResponderFactoryInterface.php b/src/FeatureSet/V1161/Responder/ResponderFactoryInterface.php
@@ -2,7 +2,6 @@
 
 namespace Usox\HyperSonic\FeatureSet\V1161\Responder;
 
-use DateTimeInterface;
 use Usox\HyperSonic\Response\ResponderInterface;
 
 interface ResponderFactoryInterface
@@ -39,4 +38,9 @@ public function createLicenseResponder(
     ): ResponderInterface;
 
     public function createPingResponder(): ResponderInterface;
+
+    public function createCoverArtResponder(
+        string $coverArt,
+        string $contentType,
+    ): ResponderInterface;
 }
diff --git a/src/HyperSonic.php b/src/HyperSonic.php
@@ -12,6 +12,8 @@
 use Usox\HyperSonic\Authentication\Exception\AbstractAuthenticationException;
 use Usox\HyperSonic\Exception\ErrorCodeEnum;
 use Usox\HyperSonic\FeatureSet\V1161\FeatureSetFactoryInterface;
+use Usox\HyperSonic\Response\BinaryResponderInterface;
+use Usox\HyperSonic\Response\FormattedResponderInterface;
 use Usox\HyperSonic\Response\ResponderInterface;
 use Usox\HyperSonic\Response\ResponseWriterFactory;
 use Usox\HyperSonic\Response\ResponseWriterFactoryInterface;
@@ -48,8 +50,10 @@ public function run(
         ResponseInterface $response,
         array $args
     ): ResponseInterface {
+        $queryParams = $request->getQueryParams();
+
         // subsonic response format
-        $responseFormat = $request->getQueryParams()['f'] ?? 'xml';
+        $responseFormat = $queryParams['f'] ?? 'xml';
 
         if ($responseFormat === 'xml') {
             $responseWriter = $this->responseWriterFactory->createXmlResponseWriter(
@@ -93,9 +97,14 @@ public function run(
 
             // execute handler method
             /** @var ResponderInterface $responder */
-            $responder = call_user_func($method, $responseWriter, $dataProvider, $args);
-
-            $response = $responseWriter->write($response, $responder);
+            $responder = call_user_func($method, $responseWriter, $dataProvider, $queryParams, $args);
+            if ($responder->isBinaryResponder()) {
+                /** @var BinaryResponderInterface $responder */
+                $response = $responder->writeResponse($response);
+            } else {
+                /** @var FormattedResponderInterface $responder */
+                $response = $responseWriter->write($response, $responder);
+            }
         } else {
             $response = $responseWriter->writeError($response, ErrorCodeEnum::SERVER_VERSION_INCOMPATIBLE);
         }

diff --git a/src/Response/BinaryResponderInterface.php b/src/Response/BinaryResponderInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\Response;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface BinaryResponderInterface extends ResponderInterface
+{
+    public function writeResponse(ResponseInterface $response): ResponseInterface;
+}
diff --git a/src/Response/FormattedResponderInterface.php b/src/Response/FormattedResponderInterface.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\HyperSonic\Response;
+
+use AaronDDM\XMLBuilder\XMLArray;
+
+interface FormattedResponderInterface extends ResponderInterface
+{
+    public function writeXml(XMLArray $XMLArray): void;
+
+    /**
+     * @param array<mixed, mixed> $root
+     */
+    public function writeJson(array &$root): void;
+}
diff --git a/src/Response/JsonResponseWriter.php b/src/Response/JsonResponseWriter.php
@@ -16,7 +16,7 @@ public function __construct(
 
     public function write(
         ResponseInterface $response,
-        ResponderInterface $responder
+        FormattedResponderInterface $responder
     ): ResponseInterface {
         $root = [
             'status' => 'ok',

diff --git a/src/Response/ResponderInterface.php b/src/Response/ResponderInterface.php
@@ -2,14 +2,7 @@
 
 namespace Usox\HyperSonic\Response;
 
-use AaronDDM\XMLBuilder\XMLArray;
-
 interface ResponderInterface
 {
-    public function writeXml(XMLArray $XMLArray): void;
-
-    /**
-     * @param array<mixed, mixed> $root
-     */
-    public function writeJson(array &$root): void;
+    public function isBinaryResponder(): bool;
 }
diff --git a/src/Response/ResponseWriterInterface.php b/src/Response/ResponseWriterInterface.php
@@ -11,7 +11,7 @@ interface ResponseWriterInterface
 {
     public function write(
         ResponseInterface $response,
-        ResponderInterface $responder,
+        FormattedResponderInterface $responder,
     ): ResponseInterface;
 
     public function writeError(

diff --git a/src/Response/XmlResponseWriter.php b/src/Response/XmlResponseWriter.php
@@ -25,7 +25,7 @@ public function __construct(
 
     public function write(
         ResponseInterface $response,
-        ResponderInterface $responder,
+        FormattedResponderInterface $responder,
     ): ResponseInterface {
         $rootNode = $this->getRootNode();