Add NotFoundJsonHandler

Author: devanych

src/Handler/NotFoundJsonHandler.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HttpSoft\Basis\Handler;
+
+use HttpSoft\Basis\Response\ExtractErrorDataTrait;
+use HttpSoft\Basis\Response\PrepareJsonDataTrait;
+use HttpSoft\ErrorHandler\ErrorResponseGeneratorInterface;
+use HttpSoft\Response\JsonResponse;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+
+final class NotFoundJsonHandler implements RequestHandlerInterface
+{
+    use ExtractErrorDataTrait;
+    use PrepareJsonDataTrait;
+
+    /**
+     * @var bool
+     */
+    private bool $debug;
+
+    /**
+     * @param bool $debug
+     */
+    public function __construct(bool $debug = false)
+    {
+        $this->debug = $debug;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function handle(ServerRequestInterface $request): ResponseInterface
+    {
+        $code = ErrorResponseGeneratorInterface::STATUS_NOT_FOUND;
+        $message = ErrorResponseGeneratorInterface::ERROR_PHRASES[$code];
+        $data = ['name' => 'Error', 'code' => $code, 'message' => $message];
+
+        if ($this->debug) {
+            $data['request'] = $this->extractRequestData($request);
+        }
+
+        return new JsonResponse($this->prepareJsonData($data), $code);
+    }
+}

tests/Handler/NotFoundJsonHandlerTest.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HttpSoft\Tests\Basis\Handler;
+
+use HttpSoft\Basis\Handler\NotFoundJsonHandler;
+use HttpSoft\ErrorHandler\ErrorResponseGeneratorInterface;
+use HttpSoft\Message\ServerRequestFactory;
+use HttpSoft\Tests\Basis\TestAsset\TraitMethodsWrapper;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ServerRequestInterface;
+
+class NotFoundJsonHandlerTest extends TestCase
+{
+    /**
+     * @var ServerRequestInterface
+     */
+    private ServerRequestInterface $request;
+
+    /**
+     * @var TraitMethodsWrapper
+     */
+    private TraitMethodsWrapper $traits;
+
+    /**
+     * @var int
+     */
+    private int $statusCode = ErrorResponseGeneratorInterface::STATUS_NOT_FOUND;
+
+    public function setUp(): void
+    {
+        $this->request = (new ServerRequestFactory())->createServerRequest(
+            'POST',
+            'http://example.com',
+            ['name' => 'value']
+        );
+        $this->traits = new TraitMethodsWrapper();
+    }
+
+    public function testHandleWithoutDebugMode(): void
+    {
+        $handler = new NotFoundJsonHandler(false);
+        $response = $handler->handle($this->request);
+
+        $expectedContent = $this->encode([
+            'name' => 'Error',
+            'code' => $this->statusCode,
+            'message' => ErrorResponseGeneratorInterface::ERROR_PHRASES[$this->statusCode],
+        ]);
+        $this->assertSame($expectedContent, (string) $response->getBody());
+    }
+
+    public function testHandleWithDebugMode(): void
+    {
+        $handler = new NotFoundJsonHandler(true);
+        $response = $handler->handle($this->request);
+
+        $expectedContent = $this->encode([
+            'name' => 'Error',
+            'code' => $this->statusCode,
+            'message' => ErrorResponseGeneratorInterface::ERROR_PHRASES[$this->statusCode],
+            'request' => $this->traits->extractRequestData($this->request),
+        ]);
+        $this->assertSame($expectedContent, (string) $response->getBody());
+    }
+
+    /**
+     * @param mixed $data
+     * @return string
+     */
+    private function encode($data): string
+    {
+        return json_encode($this->traits->prepareJsonData($data), JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
+    }
+}