Initial commit

src/Controllers/Controller.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Siteworxpro\App\Controllers;
+
+use League\Route\Http\Exception\NotFoundException;
+use Nyholm\Psr7\ServerRequest;
+use OpenApi\Attributes as OA;
+use Psr\Http\Message\ResponseInterface;
+use Siteworxpro\App\Helpers\Version;
+
+/**
+ * Class Controller
+ *
+ * An abstract base controller providing default implementations for HTTP methods.
+ *
+ * @package Siteworxpro\App\Controllers
+ */
+#[OA\Info(
+    version: Version::VERSION,
+    description: "This is a template API built using Siteworxpro framework.",
+    title: "Siteworxpro Template API",
+    contact: new OA\Contact(
+        name: "Siteworxpro",
+        url: "https://www.siteworxpro.com",
+        email: "support@siteworxpro.com"
+    ),
+    license: new OA\License('MIT', 'https://opensource.org/licenses/MIT')
+)]
+#[OA\Server(url: "https://localhost", description: "Local Server")]
+abstract class Controller implements ControllerInterface
+{
+    /**
+     * @param ServerRequest $request
+     * @return ResponseInterface
+     * @throws NotFoundException
+     */
+    public function get(ServerRequest $request): ResponseInterface
+    {
+        throw new NotFoundException("not found");
+    }
+
+    /**
+     * @throws NotFoundException
+     */
+    public function post(ServerRequest $request): ResponseInterface
+    {
+        throw new NotFoundException("not found");
+    }
+
+    /**
+     * @throws NotFoundException
+     */
+    public function put(ServerRequest $request): ResponseInterface
+    {
+        throw new NotFoundException("not found");
+    }
+
+    /**
+     * @throws NotFoundException
+     */
+    public function delete(ServerRequest $request): ResponseInterface
+    {
+        throw new NotFoundException("not found");
+    }
+
+    /**
+     * @throws NotFoundException
+     */
+    public function patch(ServerRequest $request): ResponseInterface
+    {
+        throw new NotFoundException("not found");
+    }
+}

src/Controllers/ControllerInterface.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Siteworxpro\App\Controllers;
+
+use Nyholm\Psr7\ServerRequest;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Interface ControllerInterface
+ *
+ * Defines the contract for handling HTTP requests in a controller.
+ */
+interface ControllerInterface
+{
+    /**
+     * Handle the request and return a response.
+     *
+     * @param ServerRequest $request The request data.
+     * @return ResponseInterface The response data.
+     */
+    public function get(ServerRequest $request): ResponseInterface;
+
+    /**
+     * Handle the request and return a response.
+     *
+     * @param ServerRequest $request The request data.
+     * @return ResponseInterface The response data.
+     */
+    public function post(ServerRequest $request): ResponseInterface;
+
+    /**
+     * Handle the request and return a response.
+     *
+     * @param ServerRequest $request The request data.
+     * @return ResponseInterface The response data.
+     */
+    public function put(ServerRequest $request): ResponseInterface;
+
+    /**
+     * Handle the request and return a response.
+     *
+     * @param ServerRequest $request The request data.
+     * @return ResponseInterface The response data.
+     */
+    public function delete(ServerRequest $request): ResponseInterface;
+
+    /**
+     * Handle the request and return a response.
+     *
+     * @param ServerRequest $request The request data.
+     * @return ResponseInterface The response data.
+     */
+    public function patch(ServerRequest $request): ResponseInterface;
+}

src/Controllers/HealthcheckController.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Siteworxpro\App\Controllers;
+
+use Illuminate\Database\PostgresConnection;
+use Nyholm\Psr7\ServerRequest;
+use Psr\Http\Message\ResponseInterface;
+use Siteworxpro\App\Http\JsonResponseFactory;
+use Siteworxpro\App\Http\Responses\GenericResponse;
+use Siteworxpro\App\Http\Responses\ServerErrorResponse;
+use Siteworxpro\App\Models\Model;
+use Siteworxpro\App\Services\Facades\Logger;
+use Siteworxpro\App\Services\Facades\Redis;
+use Siteworxpro\HttpStatus\CodesEnum;
+use OpenApi\Attributes as OA;
+
+/**
+ * Class HealthcheckController
+ *
+ * Handles health check requests to verify database and cache connectivity.
+ *
+ * @package Siteworxpro\App\Controllers
+ */
+class HealthcheckController extends Controller
+{
+    /**
+     * Handles the GET request for health check.
+     *
+     * @throws \JsonException
+     */
+    #[OA\Get(path: '/healthz', tags: ['Healthcheck'])]
+    #[OA\Response(response: '200', description: 'Healthcheck OK')]
+    #[OA\Response(response: '503', description: 'Healthcheck Failed')]
+    public function get(ServerRequest $request): ResponseInterface
+    {
+        try {
+            /** @var PostgresConnection $conn */
+            $conn = Model::getConnectionResolver()->connection();
+            $conn->getPdo()->exec('SELECT 1');
+
+            $response = Redis::ping();
+            if ($response->getPayload() !== 'PONG') {
+                throw new \Exception('Redis ping failed');
+            }
+        } catch (\Exception $e) {
+            Logger::emergency(
+                'Healthcheck failed: ' . $e->getMessage(),
+                ['exception' => $e]
+            );
+
+            return JsonResponseFactory::createJsonResponse(
+                new ServerErrorResponse($e),
+                CodesEnum::SERVICE_UNAVAILABLE
+            );
+        }
+
+        return JsonResponseFactory::createJsonResponse(
+            new GenericResponse('Healthcheck OK')
+        );
+    }
+}

src/Controllers/IndexController.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Siteworxpro\App\Controllers;
+
+use Nyholm\Psr7\ServerRequest;
+use Psr\Http\Message\ResponseInterface;
+use Siteworxpro\App\Attributes\Guards;
+use Siteworxpro\App\CommandBus\Commands\ExampleCommand;
+use Siteworxpro\App\Docs\TokenSecurity;
+use Siteworxpro\App\Docs\UnauthorizedResponse;
+use Siteworxpro\App\Http\JsonResponseFactory;
+use OpenApi\Attributes as OA;
+use Siteworxpro\App\Http\Responses\GenericResponse;
+use Siteworxpro\App\Services\Facades\CommandBus;
+
+/**
+ * Class IndexController
+ *
+ * This class handles the index route of the application.
+ */
+class IndexController extends Controller
+{
+    /**
+     * Handles the GET request for the index route.
+     *
+     * @throws \JsonException
+     */
+    #[Guards\Jwt]
+    #[Guards\Scope(['get.index', 'status.check'])]
+    #[Guards\RequireAllScopes]
+    #[OA\Get(path: '/', security: [new TokenSecurity()], tags: ['Examples'])]
+    #[OA\Response(
+        response: '200',
+        description: 'An Example Response',
+        content: new OA\JsonContent(ref: '#/components/schemas/GenericResponse')
+    )]
+    #[UnauthorizedResponse]
+    public function get(ServerRequest $request): ResponseInterface
+    {
+        $command = new ExampleCommand($request->getQueryParams()['name'] ?? 'Guest');
+        $greeting = CommandBus::handle($command);
+
+        return JsonResponseFactory::createJsonResponse(new GenericResponse('Server is running. ' . $greeting));
+    }
+
+    /**
+     * Handles the POST request for the index route.
+     *
+     * @throws \JsonException
+     */
+    #[Guards\Jwt]
+    #[Guards\Scope(['post.index'])]
+    #[OA\Post(path: '/', security: [new TokenSecurity()], tags: ['Examples'])]
+    #[OA\Response(
+        response: '200',
+        description: 'An Example Response',
+        content: new OA\JsonContent(ref: '#/components/schemas/GenericResponse')
+    )]
+    #[UnauthorizedResponse]
+    public function post(ServerRequest $request): ResponseInterface
+    {
+        return JsonResponseFactory::createJsonResponse(new GenericResponse('POST request received'));
+    }
+}

src/Controllers/OpenApiController.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Siteworxpro\App\Controllers;
+
+use Nyholm\Psr7\Response;
+use Nyholm\Psr7\ServerRequest;
+use OpenApi\Generator;
+use Psr\Http\Message\ResponseInterface;
+
+class OpenApiController extends Controller
+{
+    /**
+     * Handles the GET request to generate and return the OpenAPI specification.
+     *
+     * @param ServerRequest $request
+     * @return ResponseInterface
+     */
+    public function get(ServerRequest $request): ResponseInterface
+    {
+        $openapi = new Generator()->generate([
+            __DIR__ . '/../Controllers',
+            __DIR__ . '/../Models',
+            __DIR__ . '/../Http/Responses',
+        ]);
+
+        $response = new Response();
+
+        if (
+            $request->getHeaderLine('Accept') === 'application/json' ||
+            str_contains($request->getUri()->getPath(), '.json')
+        ) {
+            $response->getBody()->write($openapi->toJson());
+            return $response->withHeader('Content-Type', 'application/json');
+        }
+
+        $response->getBody()->write($openapi->toYaml());
+        return $response->withHeader('Content-Type', 'application/x-yaml');
+    }
+}