Merge pull request 'api-erstellen' (#1) from api-erstellen into master

Reviewed-on: #1

.gitignore

@@ -105,3 +105,4 @@ Temporary Items
 /api/vendor/
 /api/tests/_*
 /api/tests/*.suite.yml
+/api/.env

api/.env

@@ -1,5 +0,0 @@
-## Datenbank-Einstellungen
-DATABASES_HOST=psql.torsten-hettstedt.net
-DATABASES_NAME=torsten
-DATABASES_USER=web_user
-DATABASES_PASS=V6ZGhtdXEbxH8oWD

api/.env.example

@@ -0,0 +1,5 @@
+## Datenbank-Einstellungen
+DATABASES_HOST=psql.domain.tld
+DATABASES_NAME=db
+DATABASES_USER=user
+DATABASES_PASS=1234

api/Dockerfile

@@ -1,6 +1,5 @@
 FROM php:8.0-apache
 
-#RUN apt update && apt install -y postgresql postgresql-client
 RUN apt update && apt install -y libpq-dev
 RUN docker-php-ext-install -j$(nproc) pdo pdo_pgsql
 

api/src/Controller/AbstractController.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace TorstenHettstedt\TimekeepingApi\Controller;
+
+use JsonSerializable;
+use PDO;
+use Psr\Container\ContainerInterface;
+use Slim\Psr7\Response;
+
+abstract class AbstractController
+{
+
+    protected PDO $databases;
+
+    /**
+     * WorkingHoursController constructor.
+     *
+     * @param ContainerInterface $container
+     *
+     * @throws NotDatabasesException
+     */
+    public function __construct(ContainerInterface $container)
+    {
+        if ($container->has('databases') === false) {
+            throw new NotDatabasesException('Datenbank ist nicht Vorhanden');
+        }
+        $this->databases = $container->get('databases');
+    }
+
+    /**
+     * @param Response                            $response
+     * @param JsonSerializable|JsonSerializable[] $data
+     * @param int                                 $status_code
+     *
+     * @return Response
+     */
+    protected function printResponse(Response $response, mixed $data, int $status_code): Response {
+        $payload = json_encode($data);
+
+        $response->getBody()->write($payload);
+
+        return $response
+            ->withHeader('Content-Type', 'application/json')
+            ->withStatus($status_code);
+    }
+
+}

api/src/Controller/HttpConflictRequestException.php

@@ -6,16 +6,15 @@ use Slim\Exception\HttpSpecializedException;
 
 class HttpConflictRequestException extends HttpSpecializedException
 {
-    /**
+    /** @var int */
-     * @var int
-     */
     protected $code = 409;
 
-    /**
+    /** @var string */
-     * @var string
-     */
     protected $message = 'Conflict.';
 
+    /** @var string  */
     protected $title = '409 Conflict';
+
+    /** @var string  */
     protected $description = 'The 409 (Conflict) status code indicates that the request could not be completed due to a conflict with the current state of the target resource.';
 }

api/src/Controller/WorkingHoursController.php

@@ -2,45 +2,23 @@
 
 namespace TorstenHettstedt\TimekeepingApi\Controller;
 
-
 use DateInterval;
 use DateTime;
 use Exception;
 use Fig\Http\Message\StatusCodeInterface;
-use PDO;
-use Psr\Container\ContainerInterface;
 use Slim\Exception\HttpBadRequestException;
 use Slim\Exception\HttpInternalServerErrorException;
 use Slim\Exception\HttpNotFoundException;
 use Slim\Psr7\Request;
 use Slim\Psr7\Response;
 use TorstenHettstedt\TimekeepingApi\Models\WorkingHours;
-use TorstenHettstedt\TimekeepingApi\Repositories\RepositoryModelAlreadyExists;
+use TorstenHettstedt\TimekeepingApi\Repositories\RepositoryRecordAlreadyExistException;
 use TorstenHettstedt\TimekeepingApi\Repositories\RepositoryRecordNotFoundException;
 use TorstenHettstedt\TimekeepingApi\Repositories\WorkingHoursRepository;
 
-class WorkingHoursController
+class WorkingHoursController extends AbstractController
 {
 
-    protected PDO                $databases;
-    protected ContainerInterface $container;
-
-    /**
-     * WorkingHoursController constructor.
-     *
-     * @param ContainerInterface $container
-     *
-     * @throws NotDatabasesException
-     */
-    public function __construct(ContainerInterface $container)
-    {
-        $this->container = $container;
-        if ($this->container->has('databases') === false) {
-            throw new NotDatabasesException('Datenbank ist nicht Vorhanden');
-        }
-        $this->databases = $this->container->get('databases');
-    }
-
     /**
      * @param Request  $request
      * @param Response $response
@@ -71,13 +49,17 @@ class WorkingHoursController
      *
      * @return Response
      *
-     * @throws Exception
+     * @throws HttpInternalServerErrorException
      * @noinspection PhpUnusedParameterInspection
      */
     public function browse(Request $request, Response $response, array $args): Response
     {
         $repository = new WorkingHoursRepository($this->databases);
-        return $this->printResponse($response, $repository->findAll(), StatusCodeInterface::STATUS_OK);
+        try {
+            return $this->printResponse($response, $repository->findAll(), StatusCodeInterface::STATUS_OK);
+        } catch (Exception $exception) {
+            throw new HttpInternalServerErrorException($request, 'Der Wert für das Datum oder die Zeit ist falsch in der Datenbank', $exception);
+        }
     }
 
     /**
@@ -121,7 +103,7 @@ class WorkingHoursController
         $model = $this->buildModel($request, $body['workingDay'], $body['workingTime']);
         try {
             $repository->insert($model);
-        } catch (RepositoryModelAlreadyExists $exception) {
+        } catch (RepositoryRecordAlreadyExistException $exception) {
             throw new HttpConflictRequestException($request, 'Der Eintrag ist schon vorhanden.', $exception);
         } catch (Exception $exception) {
             throw new HttpInternalServerErrorException($request, 'Der Wert für das Datum oder die Zeit ist falsch in der Datenbank', $exception);
@@ -129,24 +111,6 @@ class WorkingHoursController
         return $this->printResponse($response, $model, StatusCodeInterface::STATUS_CREATED);
     }
 
-    /**
-     * @param Response $response
-     * @param mixed    $data
-     * @param int      $status_code
-     *
-     * @return Response
-     */
-    protected function printResponse(Response $response, mixed $data, int $status_code): Response
-    {
-        $payload = json_encode($data);
-
-        $response->getBody()->write($payload);
-
-        return $response
-            ->withHeader('Content-Type', 'application/json')
-            ->withStatus($status_code);
-    }
-
     /**
      * @param Request $request
      * @param string  $date

api/src/Controller/WorkingHoursViewController.php

@@ -4,25 +4,16 @@ namespace TorstenHettstedt\TimekeepingApi\Controller;
 
 
 use Exception;
-use Psr\Container\ContainerInterface;
+use Fig\Http\Message\StatusCodeInterface;
+use Slim\Exception\HttpInternalServerErrorException;
 use Slim\Psr7\Request;
 use Slim\Psr7\Response;
-use TorstenHettstedt\TimekeepingApi\Models\WorkingHoursView;
 use TorstenHettstedt\TimekeepingApi\Repositories\WorkingHoursMonthlyViewRepository;
 use TorstenHettstedt\TimekeepingApi\Repositories\WorkingHoursWeeklyViewRepository;
 use TorstenHettstedt\TimekeepingApi\Repositories\WorkingHoursYearlyViewRepository;
 
-class WorkingHoursViewController
+class WorkingHoursViewController extends AbstractController
 {
-    /**
-     * @var ContainerInterface
-     */
-    protected ContainerInterface $container;
-
-    public function __construct(ContainerInterface $container) {
-        $this->container = $container;
-    }
-
     /**
      * @param Request  $request
      * @param Response $response
@@ -30,17 +21,18 @@ class WorkingHoursViewController
      *
      * @return Response
      *
+     * @throws HttpInternalServerErrorException
      * @noinspection PhpUnusedParameterInspection
-     * @throws NotDatabasesException
-     * @throws Exception
      */
     public function browseWeekly(Request $request, Response $response, array $args): Response
     {
-        if ($this->container->has('databases') === false) {
+        $repository = new WorkingHoursWeeklyViewRepository($this->databases);
-            throw new NotDatabasesException('Datenbank ist nicht Vorhanden');
+        try {
+            return $this->printResponse($response, $repository->findAll(), StatusCodeInterface::STATUS_OK);
+        } catch (Exception $exception) {
+            throw new HttpInternalServerErrorException($request,
+                'Der Wert für das Datum oder die Zeit ist falsch in der Datenbank', $exception);
         }
-        $repository = new WorkingHoursWeeklyViewRepository($this->container->get('databases'));
-        return $this->printResponse($response, $repository->findAll());
     }
 
     /**
@@ -50,16 +42,18 @@ class WorkingHoursViewController
      *
      * @return Response
      *
+     * @throws HttpInternalServerErrorException
      * @noinspection PhpUnusedParameterInspection
-     * @throws Exception
      */
     public function browseMonthly(Request $request, Response $response, array $args): Response
     {
-        if ($this->container->has('databases') === false) {
+        $repository = new WorkingHoursMonthlyViewRepository($this->databases);
-            throw new NotDatabasesException('Datenbank ist nicht Vorhanden');
+        try {
+            return $this->printResponse($response, $repository->findAll(), StatusCodeInterface::STATUS_OK);
+        } catch (Exception $exception) {
+            throw new HttpInternalServerErrorException($request,
+                'Der Wert für das Datum oder die Zeit ist falsch in der Datenbank', $exception);
         }
-        $repository = new WorkingHoursMonthlyViewRepository($this->container->get('databases'));
-        return $this->printResponse($response, $repository->findAll());
     }
 
     /**
@@ -69,33 +63,18 @@ class WorkingHoursViewController
      *
      * @return Response
      *
+     * @throws HttpInternalServerErrorException
      * @noinspection PhpUnusedParameterInspection
-     * @throws Exception
      */
     public function browseYearly(Request $request, Response $response, array $args): Response
     {
-        if ($this->container->has('databases') === false) {
+        $repository = new WorkingHoursYearlyViewRepository($this->databases);
-            throw new NotDatabasesException('Datenbank ist nicht Vorhanden');
+        try {
+            return $this->printResponse($response, $repository->findAll(), StatusCodeInterface::STATUS_OK);
+        } catch (Exception $exception) {
+            throw new HttpInternalServerErrorException($request,
+                'Der Wert für das Datum oder die Zeit ist falsch in der Datenbank', $exception);
         }
-        $repository = new WorkingHoursYearlyViewRepository($this->container->get('databases'));
-        return $this->printResponse($response, $repository->findAll());
-    }
-
-    /**
-     * @param Response $response
-     * @param WorkingHoursView[]    $data
-     *
-     * @return Response
-     */
-    protected function printResponse( Response $response, array $data): Response
-    {
-        $payload = json_encode($data);
-
-        $response->getBody()->write($payload);
-
-        return $response
-            ->withHeader('Content-Type', 'application/json')
-            ->withStatus(200);
     }
 
 }

api/src/Repositories/RepositoryModelAlreadyExists.php

@@ -1,10 +0,0 @@
-<?php
-
-
-namespace TorstenHettstedt\TimekeepingApi\Repositories;
-
-
-class RepositoryModelAlreadyExists extends RepositoryException
-{
-
-}

api/src/Repositories/RepositoryRecordAlreadyExistException.php

@@ -0,0 +1,10 @@
+<?php
+
+
+namespace TorstenHettstedt\TimekeepingApi\Repositories;
+
+
+class RepositoryRecordAlreadyExistException extends RepositoryException
+{
+
+}

api/src/Repositories/RepositoryWriterInterface.php

@@ -11,7 +11,7 @@ interface RepositoryWriterInterface
     /**
      * @param T $model
      *
-     * @throws RepositoryModelAlreadyExists
+     * @throws RepositoryRecordAlreadyExistException
      */
     public function insert(mixed $model): void;
 

api/src/Repositories/WorkingHoursRepository.php

@@ -85,7 +85,7 @@ class WorkingHoursRepository implements RepositoryReaderInterface, RepositoryWri
     /**
      * @param WorkingHours|ModelInterface $model
      *
-     * @throws RepositoryModelAlreadyExists
+     * @throws RepositoryRecordAlreadyExistException
      * @throws Exception
      */
     public function insert(mixed $model): void
@@ -99,7 +99,7 @@ class WorkingHoursRepository implements RepositoryReaderInterface, RepositoryWri
 
         try {
             $this->findByKey($workingDay);
-            throw new RepositoryModelAlreadyExists();
+            throw new RepositoryRecordAlreadyExistException();
         } /** @noinspection PhpUnusedLocalVariableInspection */
         catch (RepositoryRecordNotFoundException $exception) {
             $stmt = $this->database->prepare('insert into  public."Arbeitszeiten" ("Datum", "Arbeitszeit") values (?, ?) on conflict do nothing');

api/tests/unit/Controller/WorkingHoursViewControllerTest.php

@@ -44,16 +44,16 @@ class WorkingHoursViewControllerTest extends Unit
     }
 
     /**
+     * @throws NotDatabasesException
      * @throws Exception
      */
-    public function testBrowseMonthlyWithNonDatabase(): void
+    public function testConstructWithNonDatabase(): void
     {
         $this->container = $this->makeEmpty(ContainerInterface::class, [
             'has' => false
         ]);
-        $controller = new WorkingHoursViewController($this->container);
         $this->expectException(NotDatabasesException::class);
-        $controller->browseMonthly($this->request, $this->response, []);
+        new WorkingHoursViewController($this->container);
     }
 
     /**
@@ -66,19 +66,6 @@ class WorkingHoursViewControllerTest extends Unit
         $this->assertInstanceOf(Response::class, $response);
     }
 
-    /**
-     * @throws Exception
-     */
-    public function testBrowseYearlyWithNonDatabase(): void
-    {
-        $this->container = $this->makeEmpty(ContainerInterface::class, [
-            'has' => false
-        ]);
-        $controller = new WorkingHoursViewController($this->container);
-        $this->expectException(NotDatabasesException::class);
-        $controller->browseYearly($this->request, $this->response, []);
-    }
-
     /**
      * @throws Exception
      */
@@ -89,19 +76,6 @@ class WorkingHoursViewControllerTest extends Unit
         $this->assertInstanceOf(Response::class, $response);
     }
 
-    /**
-     * @throws Exception
-     */
-    public function testBrowseWeeklyWithNonDatabase(): void
-    {
-        $this->container = $this->makeEmpty(ContainerInterface::class, [
-            'has' => false
-        ]);
-        $controller = new WorkingHoursViewController($this->container);
-        $this->expectException(NotDatabasesException::class);
-        $controller->browseWeekly($this->request, $this->response, []);
-    }
-
     /**
      * @throws Exception
      */

api/tests/unit/Middleware/ErrorHandlerTest.php

@@ -72,9 +72,7 @@ class ErrorHandlerTest extends Unit
             'file'    => '/path(to/file',
             'getTitle'   => Expected::once('The Title'),
         ]);
-        $this->logger = $this->makeEmpty(LoggerInterface::class, [
+        $this->logger = $this->makeEmpty(LoggerInterface::class, []);
-            'error' => Expected::once(),
-        ]);
 
         $middleWare = new ErrorHandler($this->app);
         $middleWare($this->request, $this->exception, true, true, true, $this->logger);
@@ -91,9 +89,7 @@ class ErrorHandlerTest extends Unit
             'code'    => 400,
             'file'    => '/path(to/file',
         ]);
-        $this->logger = $this->makeEmpty(LoggerInterface::class, [
+        $this->logger = $this->makeEmpty(LoggerInterface::class, []);
-            'error' => Expected::once(),
-        ]);
 
         $middleWare = new ErrorHandler($this->app);
         $middleWare($this->request, $this->exception, true, true, true, $this->logger);

api/tests/unit/Repositories/WorkingHoursRepositoryTest.php

@@ -8,10 +8,9 @@ use DateTime;
 use Exception;
 use InvalidArgumentException;
 use PDO;
-use PDOStatement;
 use TorstenHettstedt\TimekeepingApi\Models\ModelInterface;
 use TorstenHettstedt\TimekeepingApi\Models\WorkingHours;
-use TorstenHettstedt\TimekeepingApi\Repositories\RepositoryModelAlreadyExists;
+use TorstenHettstedt\TimekeepingApi\Repositories\RepositoryRecordAlreadyExistException;
 use TorstenHettstedt\TimekeepingApi\Repositories\RepositoryRecordNotFoundException;
 use TorstenHettstedt\TimekeepingApi\Repositories\WorkingHoursRepository;
 
@@ -24,7 +23,6 @@ class WorkingHoursRepositoryTest extends Unit
     const RECORDS_COUNT     = 61;
 
     protected PDO          $pdoObject;
-    protected PDOStatement $pdoStatement;
 
     protected function _before(): void
     {
@@ -104,7 +102,7 @@ class WorkingHoursRepositoryTest extends Unit
             'workingDay'  => new DateTime(self::EXISTING_DATE),
             'workingTime' => new DateInterval(self::NEW_INTERVAL),
         ]);
-        $this->expectException(RepositoryModelAlreadyExists::class);
+        $this->expectException(RepositoryRecordAlreadyExistException::class);
         $repository->insert($model);
     }