Minor refactoring for improving code quality

pH-7 · Jul 13, 2023 · 4043c89 · 4043c89
1 parent 530188b
commit 4043c89
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 26 deletions.
diff --git a/src/Dal/TokenKeyDal.php b/src/Dal/TokenKeyDal.php
@@ -8,7 +8,7 @@ final class TokenKeyDal
 {
     public const TABLE_NAME = 'secretkeys';
 
-    public static function saveSecretKey(string $jwtKey)
+    public static function saveSecretKey(string $jwtKey): void
     {
         $tokenBean = R::dispense(self::TABLE_NAME);
         $tokenBean->secretKey = $jwtKey;

diff --git a/src/Dal/UserDal.php b/src/Dal/UserDal.php
@@ -89,6 +89,9 @@ public static function getByEmail(string $email): UserEntity
         return (new UserEntity())->unserialize($userBean?->export());
     }
 
+    /**
+     * @throws \RedBeanPHP\RedException\SQL
+     */
     public static function setToken(string $jwtToken, string $userUuid): void
     {
         $bindings = ['userUuid' => $userUuid];

diff --git a/src/Route/food-item.routes.php b/src/Route/food-item.routes.php
@@ -2,10 +2,6 @@
 namespace PH7\ApiSimpleMenu\Route;
 
 use PH7\ApiSimpleMenu\Service\FoodItem;
-use PH7\ApiSimpleMenu\Validation\Exception\InvalidValidationException;
-
-use PH7\JustHttp\StatusCode;
-use PH7\PhpHttpResponseHeader\Http;
 
 enum FoodItemAction: string
 {
@@ -21,22 +17,10 @@ public function getResponse(): string
         $itemId = $_REQUEST['id'] ?? ''; // using the null coalescing operator
 
         $item = new FoodItem();
-        try {
-            $response = match ($this) {
-                self::RETRIEVE_ALL => $item->retrieveAll(),
-                self::RETRIEVE => $item->retrieve($itemId),
-            };
-        } catch (InvalidValidationException $e) {
-            // Send 400 http status code
-            Http::setHeadersByCode(StatusCode::BAD_REQUEST);
-
-            $response = [
-                'errors' => [
-                    'message' => $e->getMessage(),
-                    'code' => $e->getCode()
-                ]
-            ];
-        }
+        $response = match ($this) {
+            self::RETRIEVE_ALL => $item->retrieveAll(),
+            self::RETRIEVE => $item->retrieve($itemId),
+        };
 
         return json_encode($response);
     }

diff --git a/src/Route/not-found.routes.php b/src/Route/not-found.routes.php
@@ -4,6 +4,7 @@
 use PH7\JustHttp\StatusCode;
 use PH7\PhpHttpResponseHeader\Http;
 
+// PHP 7.4 anonymous arrow function
 $getResponse = fn(): string => json_encode(['error' => 'Request not found']);
 
 // Send HTTP 404 Not Found

diff --git a/src/Route/routes.php b/src/Route/routes.php
@@ -3,6 +3,9 @@
 
 use PH7\ApiSimpleMenu\Route\Exception\NotFoundException;
 use PH7\ApiSimpleMenu\Service\Exception\CredentialsInvalidException;
+use PH7\ApiSimpleMenu\Validation\Exception\InvalidValidationException;
+use PH7\JustHttp\StatusCode;
+use PH7\PhpHttpResponseHeader\Http as HttpResponse;
 
 $resource = $_REQUEST['resource'] ?? null;
 
@@ -14,7 +17,19 @@
     };
 } catch (CredentialsInvalidException $e) {
     response([
-        'message' => $e->getMessage()
+        'errors' => [
+            'message' => $e->getMessage()
+        ]
+    ]);
+} catch (InvalidValidationException $e) {
+    // Send 400 http status code
+    HttpResponse::setHeadersByCode(StatusCode::BAD_REQUEST);
+
+    response([
+        'errors' => [
+            'message' => $e->getMessage(),
+            'code' => $e->getCode()
+        ]
     ]);
 } catch (NotFoundException $e) {
     // FYI, not-found.Route already sends a 404 Not Found HTTP code

diff --git a/src/Route/user.routes.php b/src/Route/user.routes.php
@@ -2,10 +2,10 @@
 namespace PH7\ApiSimpleMenu\Route;
 
 use PH7\ApiSimpleMenu\Route\Exception\NotFoundException;
+use PH7\ApiSimpleMenu\Service\Exception\CannotLoginUserException;
 use PH7\ApiSimpleMenu\Service\Exception\EmailExistsException;
 use PH7\ApiSimpleMenu\Service\SecretKey;
 use PH7\ApiSimpleMenu\Service\User;
-use PH7\ApiSimpleMenu\Validation\Exception\InvalidValidationException;
 
 use PH7\JustHttp\StatusCode;
 use PH7\PhpHttpResponseHeader\Http as HttpResponse;
@@ -57,14 +57,13 @@ public function getResponse(): string
                 self::RETRIEVE => $user->retrieve($userId),
                 self::REMOVE => $user->remove($postBody),
             };
-        } catch (InvalidValidationException $e) {
+        } catch (CannotLoginUserException $e) {
             // Send 400 http status code
             HttpResponse::setHeadersByCode(StatusCode::BAD_REQUEST);
 
             $response = [
                 'errors' => [
                     'message' => $e->getMessage(),
-                    'code' => $e->getCode()
                 ]
             ];
         } catch (EmailExistsException $e) {

diff --git a/src/Service/Exception/CannotLoginUserException.php b/src/Service/Exception/CannotLoginUserException.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace PH7\ApiSimpleMenu\Service\Exception;
+
+use RuntimeException;
+
+class CannotLoginUserException extends RuntimeException
+{
+}
diff --git a/src/Service/User.php b/src/Service/User.php
@@ -1,8 +1,10 @@
 <?php
 namespace PH7\ApiSimpleMenu\Service;
 
+use Exception;
 use Firebase\JWT\JWT;
 use PH7\ApiSimpleMenu\Dal\UserDal;
+use PH7\ApiSimpleMenu\Service\Exception\CannotLoginUserException;
 use PH7\ApiSimpleMenu\Service\Exception\EmailExistsException;
 use PH7\ApiSimpleMenu\Service\Exception\CredentialsInvalidException;
 use PH7\ApiSimpleMenu\Validation\Exception\InvalidValidationException;
@@ -47,7 +49,11 @@ public function login(mixed $data): array
                         $_ENV['JWT_ALGO_ENCRYPTION']
                     );
 
-                    UserDal::setToken($jwtToken, $user->getUserUuid());
+                    try {
+                        UserDal::setToken($jwtToken, $user->getUserUuid());
+                    } catch (Exception $e) {
+                        throw new CannotLoginUserException('Cannot set token to user');
+                    }
 
                     return [
                         'message' => sprintf('%s successfully logged in', $userName),