feat(MPDZBS-877): zmscitizenapi cleanup (#740)

* feat(MPDZB-877): Work on thinnedprocess typing * feat(MPDZB): Refactor part 1 * feat(MPDZB): Refactor part 1 * feat(MPDZB-877): revert to processId in parameter * feat(MPDZBS-877): refactor thinned process to object * feat(MPDZB-877): refactor thinned process and rename controllers * feat(MPDZBs-877): clean up more junk --------- Co-authored-by: Tom Fink <thomasafink@Toms-MacBook-Air.local> Co-authored-by: DDEV User <nobody@example.com> Co-authored-by: Thomas Fink <thomasafink@Thomass-MacBook-Air.local>
it-at-m · Dec 16, 2024 · f98d01f · f98d01f
1 parent cc0ad02
commit f98d01f
Show file tree

Hide file tree

Showing 21 changed files with 74 additions and 150 deletions.
diff --git a/zmscitizenapi/package.json b/zmscitizenapi/package.json
@@ -2,7 +2,6 @@
   "name": "zmscitizenapi",
   "version": "1.0.0",
   "description": "This application offers a REST-like interface for ZMS functions and database access.",
-  "main": "index.js",
   "private": true,
   "scripts": {
     "preinstall": "",

diff --git a/zmscitizenapi/src/Zmscitizenapi/AppointmentReserve.php b/zmscitizenapi/src/Zmscitizenapi/AppointmentReserve.php
@@ -56,12 +56,12 @@ public function readResponse(RequestInterface $request, ResponseInterface $respo
             }
 
             $freeAppointments = new ProcessList();
-            $freeAppointments = ZmsApiFacadeService::getFreeAppointments([
-                'officeId' => $officeId,
-                'serviceIds' => $serviceIds,
-                'serviceCounts' => $serviceCounts,
-                'date' => UtilityHelper::getInternalDateFromTimestamp($timestamp)
-            ]);
+            $freeAppointments = ZmsApiFacadeService::getFreeAppointments(
+                $officeId,
+                $serviceIds,
+                $serviceCounts,
+                UtilityHelper::getInternalDateFromTimestamp($timestamp)
+            );
 
             $processArray = json_decode(json_encode($freeAppointments), true);
 
@@ -106,17 +106,17 @@ public function readResponse(RequestInterface $request, ResponseInterface $respo
                 }
             }
 
-            $appointment = new ThinnedProcess();
-            $appointment = UtilityHelper::processToThinnedProcess($reservedProcess);
+            $thinnedProcess = new ThinnedProcess();
+            $thinnedProcess = UtilityHelper::processToThinnedProcess($reservedProcess);
 
-            $appointment = array_merge($appointment->toArray(), ['officeId' => $officeId]);
+            $thinnedProcess = array_merge($thinnedProcess->toArray(), ['officeId' => $officeId]);
 
-            return $this->createJsonResponse($response, $appointment, 200);
+            return $this->createJsonResponse($response, $thinnedProcess, 200);
 
         } catch (\Exception $e) {
             return $this->createJsonResponse($response, [
                 'errorCode' => 'internalServerError',
-                'errorMessage' => $e->getMessage()
+                'errorMessage' => 'An internal server error occurred'
             ], 500);
         }
     }

diff --git a/zmscitizenapi/src/Zmscitizenapi/Helper/UtilityHelper.php b/zmscitizenapi/src/Zmscitizenapi/Helper/UtilityHelper.php
@@ -51,16 +51,27 @@ public static function uniqueElementsFilter($value, $index, $self): bool
         return array_search($value, $self) === $index;
     }
 
+    public static function getClientIp(): string
+    {
+        $headers = ['HTTP_CLIENT_IP', 'HTTP_X_FORWARDED_FOR', 'HTTP_X_FORWARDED', 'HTTP_X_CLUSTER_CLIENT_IP', 'HTTP_FORWARDED_FOR', 'HTTP_FORWARDED', 'REMOTE_ADDR'];
+        foreach ($headers as $header) {
+            if (isset($_SERVER[$header]) && filter_var($_SERVER[$header], FILTER_VALIDATE_IP)) {
+                return $_SERVER[$header];
+            }
+        }
+        return '127.0.0.1';
+    }
+
     public static function processToThinnedProcess(Process $myProcess): ThinnedProcess
     {
         if (!$myProcess || !isset($myProcess->id)) {
             return null;
         }
-    
+
         $subRequestCounts = [];
         $mainServiceId = null;
         $mainServiceCount = 0;
-    
+
         $requests = $myProcess->requests ?? [];
         if ($requests) {
             $requests = is_array($requests) ? $requests : iterator_to_array($requests);
@@ -96,7 +107,7 @@ public static function processToThinnedProcess(Process $myProcess): ThinnedProce
         $thinnedProcess->subRequestCounts = array_values($subRequestCounts);
         $thinnedProcess->serviceId = $mainServiceId;
         $thinnedProcess->serviceCount = $mainServiceCount;
-    
+
         return $thinnedProcess;
     }
 
@@ -105,23 +116,23 @@ public static function thinnedProcessToProcess(ThinnedProcess $thinnedProcess):
         if (!$thinnedProcess || !isset($thinnedProcess->processId)) {
             return null;
         }
-    
+
         $processEntity = new Process();
         $processEntity->id = $thinnedProcess->processId;
         $processEntity->authKey = $thinnedProcess->authKey ?? null;
-    
+
         $client = new Client();
         $client->familyName = $thinnedProcess->familyName ?? null;
         $client->email = $thinnedProcess->email ?? null;
         $client->telephone = $thinnedProcess->telephone ?? null;
         $client->customTextfield = $thinnedProcess->customTextfield ?? null;
-    
+
         $processEntity->clients = [$client];
-    
+
         $thinnedProcess = new Appointment();
         $thinnedProcess->date = $thinnedProcess->timestamp ?? null;
         $processEntity->appointments = [$thinnedProcess];
-    
+
         $scope = new Scope();
         if (isset($thinnedProcess->officeName)) {
             $scope->contact = new Contact();
@@ -133,11 +144,11 @@ public static function thinnedProcessToProcess(ThinnedProcess $thinnedProcess):
             $scope->provider->source = \App::$source_name;
         }
         $processEntity->scope = $scope;
-    
+
         $mainServiceId = $thinnedProcess->serviceId ?? null;
         $mainServiceCount = $thinnedProcess->serviceCount ?? 0;
         $subRequestCounts = $thinnedProcess->subRequestCounts ?? [];
-    
+
         $requests = [];
         for ($i = 0; $i < $mainServiceCount; $i++) {
             $request = new Request();
@@ -154,13 +165,13 @@ public static function thinnedProcessToProcess(ThinnedProcess $thinnedProcess):
             }
         }
         $processEntity->requests = $requests;
-    
+
         $processEntity->lastChange = time();
-        $processEntity->createIP = $_SERVER['REMOTE_ADDR'] ?? '127.0.0.1';
+        $processEntity->createIP = self::getClientIp();
         $processEntity->createTimestamp = time();
-    
+
         return $processEntity;
     }
-      
+
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentCancel.php b/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentCancel.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class AppointmentCancel extends Entity
 {
 
-    public static $schema = "citizenapi/appointmentCancel.json";
+    public static $schema = "zmsentities/schema/citizenapi/appointmentCancel.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentConfirm.php b/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentConfirm.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class AppointmentConfirm extends Entity
 {
 
-    public static $schema = "citizenapi/appointmentConfirm.json";
+    public static $schema = "zmsentities/schema/citizenapi/appointmentConfirm.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentPreConfirm.php b/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentPreConfirm.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class AppointmentPreConfirm extends Entity
 {
 
-    public static $schema = "citizenapi/appointmentPreConfirm.json";
+    public static $schema = "zmsentities/schema/citizenapi/appointmentPreConfirm.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentReserve.php b/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentReserve.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class AppointmentReserve extends Entity
 {
 
-    public static $schema = "citizenapi/appointmentReserve.json";
+    public static $schema = "zmsentities/schema/citizenapi/appointmentReserve.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentUpdate.php b/zmscitizenapi/src/Zmscitizenapi/Models/AppointmentUpdate.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class AppointmentUpdate extends Entity
 {
 
-    public static $schema = "citizenapi/appointmentUpdate.json";
+    public static $schema = "zmsentities/schema/citizenapi/appointmentUpdate.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/AvailableAppointments.php b/zmscitizenapi/src/Zmscitizenapi/Models/AvailableAppointments.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class AvailableAppointments extends Entity
 {
 
-    public static $schema = "citizenapi/availableAppointments.json";
+    public static $schema = "zmsentities/schema/citizenapi/availableAppointments.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/AvailableDays.php b/zmscitizenapi/src/Zmscitizenapi/Models/AvailableDays.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class AvailableDays extends Entity
 {
 
-    public static $schema = "citizenapi/availableDays.json";
+    public static $schema = "zmsentities/schema/citizenapi/availableDays.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/CaptchaDetails.php b/zmscitizenapi/src/Zmscitizenapi/Models/CaptchaDetails.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class CaptchaDetails extends Entity
 {
 
-    public static $schema = "citizenapi/captchaDetails.json";
+    public static $schema = "zmsentities/schema/citizenapi/captchaDetails.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/Offices.php b/zmscitizenapi/src/Zmscitizenapi/Models/Offices.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class Offices extends Entity
 {
 
-    public static $schema = "citizenapi/offices.json";
+    public static $schema = "zmsentities/schema/citizenapi/offices.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/OfficesAndServices.php b/zmscitizenapi/src/Zmscitizenapi/Models/OfficesAndServices.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class OfficesAndServices extends Entity
 {
 
-    public static $schema = "citizenapi/officesAndServices.json";
+    public static $schema = "zmsentities/schema/citizenapi/officesAndServices.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/OfficesByService.php b/zmscitizenapi/src/Zmscitizenapi/Models/OfficesByService.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class OfficesByService extends Entity
 {
 
-    public static $schema = "citizenapi/officesByService.json";
+    public static $schema = "zmsentities/schema/citizenapi/officesByService.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/Scope.php b/zmscitizenapi/src/Zmscitizenapi/Models/Scope.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class Scope extends Entity
 {
 
-    public static $schema = "citizenapi/scope.json";
+    public static $schema = "zmsentities/schema/citizenapi/scope.json";
 
 }
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/Scopes.php b/zmscitizenapi/src/Zmscitizenapi/Models/Scopes.php
@@ -5,15 +5,9 @@
 use \BO\Zmsentities\Helper\Property;
 use \BO\Zmsentities\Schema\Entity;
 
-/**
- * @SuppressWarnings(Complexity)
- * @SuppressWarnings(Coupling)
- * @SuppressWarnings(Public)
- *
- */
 class Scopes extends Entity
 {
 
-    public static $schema = "citizenapi/scopes.json";
+    public static $schema = "zmsentities/schema/citizenapi/scopes.json";
 
 }