Status-Code Handling

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - [Refactor CTClient:](https://github.com/5pm-HDH/churchtools-api/pull/83) transform inheritance from GuzzleClient to composition-relation
 - [Move generated Doc-Files to `out`-Folder](https://github.com/5pm-HDH/churchtools-api/pull/89)
 - [Create UpdatableMode-Interface for type safety](https://github.com/5pm-HDH/churchtools-api/pull/93)
+- [Status-Code handling and Exception-handling](https://github.com/5pm-HDH/churchtools-api/pull/99)
 
 ### Fixed
 

docs/out/CTLog.md

@@ -2,11 +2,16 @@
 
 By default, there are two log types:
 
-**File-Log:**
+**File-Log (Info):**
 
 - Logs the log-levels: INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
 - Log is stored to the file `churchtools-api.log`
 
+**File-Log (Warning):**
+
+- Logs the log-levels: WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
+- Log is stored to the file `churchtools-api-warning.log`
+
 **Console-Log:**
 
 - Logs by default the log-level: ERROR, CRITICAL, ALERT, EMERGENCY

docs/out/ErrorHandling.md

@@ -2,19 +2,28 @@
 
 The Error-Handling-Concept divides an exception in five different categories:
 
-**CTConnectException**
+## CTConfigException
+
+- wrong Configuration (e.q. no API-Url is set)
+
+## CTModelException
+
+- exception in model (e.q. process wiki-pages return root node)
+
+## CTRequestException
+
+- could not retrieve the models
+
+### CTConnectException extends CTRequestException
+
 - technical Exception the ConnectException from Guzzle
 - error in Connection (timeout, undefined-host, ...)
 
-**CTConfigException**
-- wrong Configuration (e.q. no API-Url is set)
+### CTAuthException extends CTRequestException
 
-**CTAuthException**
 - could not authenticate user
-- unauthorized access to resource
 
-**CTRequestException**
-- could not retrieve the models
+### CTPermissionException extends CTRequestException
 
-**CTModelException**
-- exception in model (e.q. process wiki-pages return root node)
+- unauthorized access to resource (401)
+- forbidden api-call (403)

docs/src/ressources/CTLog.md

@@ -2,11 +2,16 @@
 
 By default, there are two log types:
 
-**File-Log:**
+**File-Log (Info):**
 
 - Logs the log-levels: INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
 - Log is stored to the file `churchtools-api.log`
 
+**File-Log (Warning):**
+
+- Logs the log-levels: WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
+- Log is stored to the file `churchtools-api-warning.log`
+
 **Console-Log:**
 
 - Logs by default the log-level: ERROR, CRITICAL, ALERT, EMERGENCY

docs/src/ressources/ErrorHandling.md

@@ -2,19 +2,28 @@
 
 The Error-Handling-Concept divides an exception in five different categories:
 
-**CTConnectException**
+## CTConfigException
+
+- wrong Configuration (e.q. no API-Url is set)
+
+## CTModelException
+
+- exception in model (e.q. process wiki-pages return root node)
+
+## CTRequestException
+
+- could not retrieve the models
+
+### CTConnectException extends CTRequestException
+
 - technical Exception the ConnectException from Guzzle
 - error in Connection (timeout, undefined-host, ...)
 
-**CTConfigException**
-- wrong Configuration (e.q. no API-Url is set)
+### CTAuthException extends CTRequestException
 
-**CTAuthException**
 - could not authenticate user
-- unauthorized access to resource
 
-**CTRequestException**
-- could not retrieve the models
+### CTPermissionException extends CTRequestException
 
-**CTModelException**
-- exception in model (e.q. process wiki-pages return root node)
+- unauthorized access to resource (401)
+- forbidden api-call (403)

src/CTClient.php

@@ -4,11 +4,13 @@
 namespace CTApi;
 
 
-use CTApi\Exceptions\CTAuthException;
 use CTApi\Exceptions\CTConnectException;
+use CTApi\Exceptions\CTPermissionException;
+use CTApi\Exceptions\CTRequestException;
 use Exception;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ConnectException;
+use GuzzleHttp\Exception\GuzzleException;
 use GuzzleHttp\HandlerStack;
 use Psr\Http\Message\ResponseInterface;
 
@@ -72,17 +74,24 @@ public function delete($uri, array $options = []): ResponseInterface
 
     private function handleResponse(ResponseInterface $response): ResponseInterface
     {
-        switch ($response->getStatusCode()) {
-            case 401:
-                throw new CTAuthException("Unauthorized.", 401);
+        $responseCode = (int)$response->getStatusCode();
+        if ($responseCode == 401 || $responseCode == 403) {
+            throw new CTPermissionException("Unauthorized or Forbidden.", $responseCode);
         }
-        return $response;
+
+        if ($responseCode >= 200 && $responseCode <= 299) {
+            return $response;
+        }
+
+        throw CTRequestException::ofErrorResponse($response);
     }
 
     private function handleException(Exception $exception): ResponseInterface
     {
         if ($exception instanceof ConnectException) {
             throw new CTConnectException($exception->getMessage(), $exception->getCode(), $exception);
+        } else if ($exception instanceof GuzzleException) {
+            throw new CTRequestException($exception->getMessage(), $exception->getCode(), $exception);
         }
         throw $exception;
     }

src/CTConfig.php

@@ -3,6 +3,7 @@
 namespace CTApi;
 
 use CTApi\Exceptions\CTConfigException;
+use CTApi\Exceptions\CTRequestException;
 use CTApi\Middleware\CTCacheMiddleware;
 use CTApi\Requests\AuthRequest;
 use CTApi\Requests\PersonRequest;
@@ -107,7 +108,7 @@ public static function validateApiKey(): bool
             } else {
                 return true;
             }
-        } catch (\Exception $exception) {
+        } catch (CTRequestException $exception) {
             return false;
         }
     }

src/CTLog.php

@@ -10,6 +10,7 @@
 class CTLog
 {
     private const LOG_FILE = __DIR__ . '/../churchtools-api.log';
+    private const LOG_FILE_WARNING = __DIR__ . '/../churchtools-api-warning.log';
 
     private static ?Logger $logger = null;
     private static bool $fileLogEnabled = true;
@@ -35,6 +36,7 @@ private static function createLog(): void
 
         if (self::$fileLogEnabled) {
             self::$logger->pushHandler(new StreamHandler(self::LOG_FILE, Logger::INFO));
+            self::$logger->pushHandler(new StreamHandler(self::LOG_FILE_WARNING, Logger::WARNING));
         }
         if (self::$consoleLogEnabled) {
             self::$logger->pushHandler(new StreamHandler('php://stdout', self::$consoleLogLevel));

src/Exceptions/CTAuthException.php

@@ -4,10 +4,13 @@
 namespace CTApi\Exceptions;
 
 use CTApi\CTLog;
-use RuntimeException;
 use Throwable;
 
-class CTAuthException extends RuntimeException
+/**
+ * Class CTAuthException is a CTRequestException. It Indicates a failed authentification.
+ * @package CTApi\Exceptions
+ */
+class CTAuthException extends CTRequestException
 {
     public function __construct($message = "", $code = 0, Throwable $previous = null)
     {

src/Exceptions/CTConfigException.php

@@ -8,6 +8,10 @@
 use RuntimeException;
 use Throwable;
 
+/**
+ * Class CTConfigException indicates a error in the CTConfig-Settings.
+ * @package CTApi\Exceptions
+ */
 class CTConfigException extends RuntimeException
 {
     public function __construct($message = "", $code = 0, Throwable $previous = null)

src/Exceptions/CTConnectException.php

@@ -5,10 +5,13 @@
 
 
 use CTApi\CTLog;
-use RuntimeException;
 use Throwable;
 
-class CTConnectException extends RuntimeException
+/**
+ * Class CTConnectException is a CRRequestException. Its thrown when ChurchTools server is not available.
+ * @package CTApi\Exceptions
+ */
+class CTConnectException extends CTRequestException
 {
     public function __construct($message = "", $code = 0, Throwable $previous = null)
     {

src/Exceptions/CTModelException.php

@@ -8,6 +8,10 @@
 use RuntimeException;
 use Throwable;
 
+/**
+ * Class CTModelException is thrown when the model data is invalid.
+ * @package CTApi\Exceptions
+ */
 class CTModelException extends RuntimeException
 {
     public function __construct($message = "", $code = 0, Throwable $previous = null)

src/Exceptions/CTPermissionException.php

@@ -0,0 +1,21 @@
+<?php
+
+
+namespace CTApi\Exceptions;
+
+
+use CTApi\CTLog;
+use Throwable;
+
+/**
+ * Class CTPermissionException is a CTRequestException that indicates a permission error.
+ * @package CTApi\Exceptions
+ */
+class CTPermissionException extends CTRequestException
+{
+    public function __construct($message = "", $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+        CTLog::getLog()->warning("CTPermissionException: " . $message);
+    }
+}

src/Exceptions/CTRequestException.php

@@ -8,6 +8,10 @@
 use RuntimeException;
 use Throwable;
 
+/**
+ * Class CTRequestException is thrown when communication with ChurchTools api fails.
+ * @package CTApi\Exceptions
+ */
 class CTRequestException extends RuntimeException
 {
     public function __construct($message = "", $code = 0, Throwable $previous = null)
@@ -27,7 +31,7 @@ public static function ofModelNotFound(?string $modelName = null, ?Throwable $th
 
     public static function ofErrorResponse(ResponseInterface $response): self
     {
-        $contents = \json_decode((string) $response->getBody(), true);
+        $contents = \json_decode((string)$response->getBody(), true);
 
         if (!isset($contents['message'])) {
             return new self($response->getReasonPhrase() ?: 'Unknown API error.');
@@ -41,7 +45,7 @@ public static function ofErrorResponse(ResponseInterface $response): self
             foreach ($contents['errors'] as $error) {
                 $wasValue = '';
 
-                if (array_key_exists('value', $error['args'])) {
+                if (array_key_exists('args', $error) && array_key_exists('value', $error['args'])) {
                     $wasValue = 'Received value was %s.';
 
                     if (is_null($error['args']['value'])) {
@@ -51,12 +55,16 @@ public static function ofErrorResponse(ResponseInterface $response): self
                     }
                 }
 
-                $errorDescriptions[] = sprintf(
-                    'Field "%s": %s %s',
-                    $error['fieldId'],
-                    $error['message'],
-                    $wasValue
-                );
+                if (array_key_exists('fieldId', $error)) {
+                    $errorDescriptions[] = sprintf(
+                        'Field "%s": %s %s',
+                        $error['fieldId'],
+                        $error['message'],
+                        $wasValue
+                    );
+                } else {
+                    $errorDescriptions[] = $error['message'];
+                }
             }
 
             $msg .= '. ' . implode(' ', $errorDescriptions);

src/Models/File.php

@@ -7,6 +7,7 @@
 use CTApi\CTClient;
 use CTApi\CTConfig;
 use CTApi\CTLog;
+use CTApi\Exceptions\CTRequestException;
 use CTApi\Models\Traits\FillWithData;
 use CTApi\Models\Traits\MetaAttribute;
 use GuzzleHttp\Exception\GuzzleException;
@@ -55,16 +56,16 @@ public function requestFileContent(): bool|string
     {
         try {
             $baseUrl = $this->getFileUrlBaseUrl();
-            if(!is_null($baseUrl)){
+            if (!is_null($baseUrl)) {
                 $response = CTClient::getClient()->get($baseUrl, [
                     'headers' => [
                         'Cache-Control' => 'no-cache'
                     ],
                     'query' => $this->getFileUrlQueryParameters()
                 ]);
-                return (string) $response->getBody();
+                return (string)$response->getBody();
             }
-        } catch (GuzzleException $e) {
+        } catch (CTRequestException $e) {
             CTLog::getLog()->error('File: Could not retrieve file-content.');
             // ignore
         }
@@ -87,7 +88,7 @@ public function getFileUrlBaseUrl(): ?string
     {
         $fileUrlBase = null;
 
-        $parsedUrl = parse_url((string) $this->getFileUrl());
+        $parsedUrl = parse_url((string)$this->getFileUrl());
         if (array_key_exists('scheme', $parsedUrl) && array_key_exists('host', $parsedUrl)) {
             $fileUrlBase = $parsedUrl['scheme'] . '://' . $parsedUrl['host'];
 
@@ -101,9 +102,9 @@ public function getFileUrlBaseUrl(): ?string
     public function getFileUrlQueryParameters(): array
     {
         $query = [];
-        $parsedUrl = parse_url((string) $this->getFileUrl());
+        $parsedUrl = parse_url((string)$this->getFileUrl());
         if (array_key_exists('query', $parsedUrl)) {
-            $queryString = (string) $parsedUrl['query'];
+            $queryString = (string)$parsedUrl['query'];
 
             foreach (explode('&', $queryString) as $querySubstring) {
                 $querySubstringArray = explode('=', $querySubstring);

src/Models/Meta.php

@@ -87,7 +87,7 @@ public function requestModifiedPerson(): ?Person
 
     private function requestPerson(?string $id): ?Person
     {
-        if (!is_null($id)) {
+        if (!is_null($id) && $id > 0) {
             return PersonRequest::find((int)$id);
         }
         return null;