response DTO classes

Author: SniperSister

app/Enum/WebserviceEndpoint.php

@@ -4,5 +4,8 @@
 
 enum WebserviceEndpoint: string
 {
-    case HEALTH_CHECK = "health.json";
+    case HEALTH_CHECK = "/api/index.php/v1/updates/health";
+    case FETCH_UPDATES = "/api/index.php/v1/updates/fetch";
+    case PREPARE_UPDATE = "/api/index.php/v1/updates/prepare";
+    case FINALIZE_UPDATE = "/api/index.php/v1/updates/finalize";
 }

app/Jobs/CheckSiteHealth.php

@@ -5,7 +5,7 @@
 namespace App\Jobs;
 
 use App\Models\Site;
-use App\Services\SiteConnectionService;
+use app\Remotesite\Connection;
 use Carbon\Carbon;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Queue\Queueable;
@@ -26,7 +26,7 @@ public function __construct(protected readonly Site $site)
      */
     public function handle(): void
     {
-        /** @var SiteConnectionService $connection */
+        /** @var Connection $connection */
         $connection = $this->site->connection;
 
         $response = $connection->checkHealth();

app/Jobs/UpdateSite.php

@@ -4,6 +4,8 @@
 
 namespace App\Jobs;
 
+use App\Models\Site;
+use app\Remotesite\Connection;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Queue\Queueable;
 
@@ -14,16 +16,19 @@ class UpdateSite implements ShouldQueue
     /**
      * Create a new job instance.
      */
-    public function __construct()
+    public function __construct(protected readonly Site $site, protected string $targetVersion)
     {
-        //
     }
 
     /**
      * Execute the job.
      */
     public function handle(): void
     {
-        //
+        /** @var Connection $connection */
+        $connection = $this->site->connection;
+
+        // Test connection and get current version
+        $healthResult = $connection->checkHealth();
     }
 }

app/Models/Site.php

@@ -4,7 +4,7 @@
 
 namespace App\Models;
 
-use App\Services\SiteConnectionService;
+use App\Remotesite\Connection;
 use Illuminate\Database\Eloquent\Model;
 
 class Site extends Model
@@ -38,11 +38,11 @@ protected function casts(): array
 
     public function getUrlAttribute(string $value): string
     {
-        return rtrim($value, "/") . "/";
+        return rtrim($value, "/");
     }
 
-    public function getConnectionAttribute(): SiteConnectionService
+    public function getConnectionAttribute(): Connection
     {
-        return new SiteConnectionService($this->url, $this->key);
+        return new Connection($this->url, $this->key);
     }
 }

app/Services/SiteConnectionService.php renamed to app/RemoteSite/Connection.php

@@ -2,36 +2,33 @@
 
 declare(strict_types=1);
 
-namespace App\Services;
+namespace App\RemoteSite;
 
 use App\Enum\HttpMethod;
 use App\Enum\WebserviceEndpoint;
+use App\RemoteSite\Responses\HealthCheck;
+use App\RemoteSite\Responses\HealthCheck as HealthCheckResponse;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use Illuminate\Support\Facades\App;
 use Psr\Http\Message\RequestInterface;
 
-class SiteConnectionService
+class Connection
 {
     public function __construct(protected readonly string $baseUrl, protected readonly string $key)
     {
     }
 
-    public function checkHealth(): array
+    public function checkHealth(): HealthCheck
     {
         $healthData = $this->performWebserviceRequest(
             HttpMethod::GET,
             WebserviceEndpoint::HEALTH_CHECK
         );
 
-        // Perform a sanity check
-        if (empty($healthData['cms_version'])) {
-            throw new \Exception("Invalid health response content");
-        }
-
-        return $healthData;
+        return HealthCheckResponse::from($healthData);
     }
 
     public function performExtractionRequest(array $data): array

app/RemoteSite/Responses/BaseResponse.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\RemoteSite\Responses;
+
+abstract class BaseResponse
+{
+    public static function from(array $data): self
+    {
+        $reflect = new \ReflectionClass(static::class);
+        $properties = $reflect->getProperties(\ReflectionProperty::IS_PUBLIC);
+
+        $arguments = [];
+
+        foreach ($properties as $property) {
+            if (!array_key_exists($property->name, $data)) {
+                continue;
+            }
+
+            $arguments[$property->name] = $data[$property->name];
+        }
+
+        return $reflect->newInstanceArgs($arguments);
+    }
+}

app/RemoteSite/Responses/HealthCheck.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\RemoteSite\Responses;
+
+class HealthCheck extends BaseResponse
+{
+    public function __construct(
+        public string $php_version,
+        public string $db_type,
+        public string $db_version,
+        public string $cms_version,
+        public string $server_os
+    ) {
+    }
+}