api module added

Author: someson

README.md

@@ -68,3 +68,7 @@ if `... did not complete successfully: exit code: 100`
 ```bash
 $ docker image prune -f
 ```
+
+# TODO
+
+* [switch CI to github workflow](https://www.strangebuzz.com/en/blog/setting-a-ci-cd-workflow-for-a-symfony-project-thanks-to-the-github-actions)

src/app/Bootstrap.php

@@ -2,9 +2,10 @@
 
 namespace App;
 
-use DomainException;
+use App\Shared\Listeners\ImplicitViewListener;
 use Phalcon\Di\Di;
 use Phalcon\Di\FactoryDefault;
+use Phalcon\Events\Manager;
 use Phalcon\Support\Registry;
 
 class Bootstrap
@@ -23,6 +24,11 @@ public function __construct(bool $autoDetect = true)
         $this->_app = $isCli ? new CliApplication($container) : new WebApplication($container);
         $this->_app->registerServices($container);
 
+        /** @var Manager $eventsManager */
+        $eventsManager = $container->getShared('eventsManager');
+        $eventsManager->attach('application', new ImplicitViewListener());
+        $this->_app->setEventsManager($eventsManager);
+
         $registry = new Registry();
         $registry->set('modules', $this->_app->getModules());
         $container->set('registry', $registry);
@@ -47,7 +53,7 @@ public function identify(): string
 
         if (is_numeric($tld)) {  // if an IP requested
             return $_SERVER['REQUEST_METHOD'] === 'GET' ?
-                throw new DomainException('Request a domain name instead of IP') : env('DEFAULT_DOMAIN');
+                throw new \DomainException('Request a domain name instead of IP') : env('DEFAULT_DOMAIN');
         }
         return $domain;
     }

src/app/Config/Main.php

@@ -1,7 +1,7 @@
 <?php
 
 return [
-    'debug' => env('APP_DEBUG'),
+    'debug' => (bool) env('APP_DEBUG'),
     'app' => [
         'locale'    => 'de_DE',
         'domain'    => env('APP_DOMAIN'),

src/app/Micro.php

@@ -2,6 +2,7 @@
 
 use App\Shared\ExceptionDto;
 use App\Shared\Micro;
+use App\Shared\Notification;
 use App\Shared\Simple;
 use App\Shared\Volt;
 use Phalcon\Config\Adapter\Php;
@@ -44,19 +45,14 @@
                     'separator' => '_',
                 ]);
                 return $volt;
-            }
+            },
         ]);
         $view->setVar('config', $config);
         $view->setVar('site', $site);
         return $view;
     });
 
-    /**
-     * @param Micro $app
-     * @param array<int, \Throwable> $exceptions
-     * @return string
-     */
-    $output = static function(Micro $app, array $exceptions) {
+    $output = static function(Micro $app, array $exceptions, bool $renderTemplate = true) {
         $code = ResponseStatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR;
         if ($exceptions[0] instanceof \DomainException) {
             $code = ResponseStatusCodeInterface::STATUS_FORBIDDEN;
@@ -68,18 +64,32 @@
         foreach ($exceptions as $exception) {
             $storage->attach(new ExceptionDto($exception::class, $exception->getMessage()));
         }
-        /** @var Simple $view */
-        $view = $app->view;
-        return $view->render('error', [
-            'errCode' => $code,
-            'exceptionData' => $storage,
-        ]);
+        if ($renderTemplate) {
+            /** @var Simple $view */
+            $view = $app->view;
+            return $view->render('error', [
+                'errCode' => $code,
+                'exceptionData' => $storage,
+            ]);
+        }
+        $exceptionMessages = [];
+        /** @var ExceptionDto $dto */
+        foreach ($storage as $dto) {
+            $exceptionMessages[] = Notification::failure($dto->message);
+        }
+        $app->response->setJsonContent(
+            $exceptionMessages,
+            \JSON_NUMERIC_CHECK | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE
+        );
+        return $app->response;
     };
 
     /** @var \Throwable $e from the catch block where this file is included */
-    $app->error(function(\Throwable $appException) use ($output, $app, $e) {
+    $explicitView = $explicitView ?? true;
+
+    $app->error(function(\Throwable $appException) use ($output, $app, $e, $explicitView) {
         $exceptions = $appException->getMessage() === $e->getMessage() ? [$e] : [$appException, $e];
-        echo $output($app, $exceptions);
+        echo $output($app, $exceptions, $explicitView);
     });
     $app->notFound(function() use ($output, $app, $e) { echo $output($app, [$e]); });
 

src/app/Modules/Api/Attributes/ApiAuth.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Modules\Api\Attributes;
+
+#[\Attribute(\Attribute::TARGET_METHOD)]
+class ApiAuth
+{
+    public function __construct(public ?string $type = null) {}
+}

src/app/Modules/Api/Components/ApiAuthFactory.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Modules\Api\Components;
+
+use Phalcon\Http\Request;
+
+class ApiAuthFactory
+{
+    public static function create(string $type = 'bearer'): ApiAuthInterface
+    {
+        $className = match (strtolower($type))
+        {
+            // ...
+            default => Bearer::class,
+        };
+        return new $className;
+    }
+}

src/app/Modules/Api/Components/ApiAuthInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Modules\Api\Components;
+
+use Phalcon\Http\Request;
+
+interface ApiAuthInterface
+{
+    public function from(Request $request): static;
+    public function getToken(): string;
+}

src/app/Modules/Api/Components/ApiHandler.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Modules\Api\Components;
+
+class ApiHandler
+{
+    public function __construct(private ?ApiAuthInterface $tokenHandler = null)
+    {
+        // ...
+    }
+}

src/app/Modules/Api/Components/Bearer.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Modules\Api\Components;
+
+use App\Modules\Api\Exceptions\HttpClientException;
+use Phalcon\Http\Message\ResponseStatusCodeInterface as StatusCode;
+use Phalcon\Http\Request;
+
+class Bearer implements ApiAuthInterface
+{
+    private ?string $token = null;
+
+    /**
+     * @throws HttpClientException
+     */
+    public function from(Request $request): static
+    {
+        $authKey = 'Authorization'; // Authorization: Bearer xjhgjhgkjdgfjdhgfjdgfjdg
+        $authHeader = $request->hasHeader($authKey) ? trim($request->getHeader($authKey)) : null;
+        if (! $authHeader) {
+            throw new HttpClientException(StatusCode::STATUS_UNAUTHORIZED);
+        }
+        [$tokenType, $this->token] = explode(' ', $authHeader);
+        if (strtolower($tokenType) !== 'bearer') {
+            throw new HttpClientException(StatusCode::STATUS_UNAUTHORIZED);
+        }
+    }
+
+    public function getToken(): string
+    {
+        return $this->token;
+    }
+}

src/app/Modules/Api/Components/ErrorContent.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace App\Modules\Api\Components;
+
+use App\Shared\Http\Status;
+
+class ErrorContent implements \JsonSerializable
+{
+    /** @var array<string, mixed> */
+    protected array $_schema = [];
+
+    public function __construct(
+        private int $statusCode,
+        private readonly ?string $message = null
+    ) {
+        $httpStatus = Status::tryFrom($this->statusCode);
+        if (! $httpStatus) {
+            $this->statusCode = Status::INTERNAL_SERVER_ERROR->value;
+            $httpStatus = Status::tryFrom($this->statusCode);
+        }
+        $this->_schema = [
+            'code' => $this->statusCode,
+            'message' => $this->message ?? $httpStatus->message(),
+        ];
+    }
+
+    public function setParam(string $key, mixed $message): self
+    {
+        $this->_schema[$key] = $message;
+        return $this;
+    }
+
+    public function setStatusMessage(string $message): self
+    {
+        return $this->setParam('message', $message);
+    }
+
+    public function setDebugMessage(string $message): self
+    {
+        return $this->setParam('debug', $message);
+    }
+
+    public function get(): array
+    {
+        return $this->_schema;
+    }
+
+    public function jsonSerialize(): array
+    {
+        return $this->get();
+    }
+}