expose endpoint-specific connectoinhelper method

Author: SniperSister

app/Enum/WebserviceEndpoints.php renamed to app/Enum/WebserviceEndpoint.php

@@ -2,7 +2,7 @@
 
 namespace App\Enum;
 
-enum WebserviceEndpoints: string
+enum WebserviceEndpoint: string
 {
     case HEALTH_CHECK = "health.json";
 }

app/Jobs/CheckSiteHealth.php

@@ -29,18 +29,10 @@ public function handle(): void
         /** @var SiteConnectionService $connection */
         $connection = $this->site->connection;
 
-        $response = $connection->performWebserviceRequest(
-            HttpMethod::GET,
-            WebserviceEndpoints::HEALTH_CHECK->value
-        );
+        $response = $connection->checkHealth();
 
         $healthData = collect($response);
 
-        // Perform a sanity check
-        if (!$healthData->has('cms_version')) {
-            throw new \Exception("Invalid health response content");
-        }
-
         // Write updated data to DB
         $this->site->update(
             $healthData->only([

app/Services/SiteConnectionService.php

@@ -3,6 +3,7 @@
 namespace App\Services;
 
 use App\Enum\HttpMethod;
+use App\Enum\WebserviceEndpoint;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\Psr7\Request;
@@ -16,35 +17,19 @@ public function __construct(protected readonly string $baseUrl, protected readon
     {
     }
 
-    protected function performRequest(
-        RequestInterface $request,
-        array $options = []
-    ): array {
-        /** @var Client $httpClient */
-        $httpClient = App::make(Client::class);
-
-        /** @var Response $response */
-        $response = $httpClient->send(
-            $request,
-            $options
+    public function checkHealth(): array
+    {
+        $healthData = $this->performWebserviceRequest(
+            HttpMethod::GET,
+            WebserviceEndpoint::HEALTH_CHECK
         );
 
-        // Validate response
-        if (!json_validate((string) $response->getBody())) {
-            throw new RequestException(
-                "Invalid JSON body",
-                $request,
-                $response
-            );
+        // Perform a sanity check
+        if (empty($healthData['cms_version'])) {
+            throw new \Exception("Invalid health response content");
         }
 
-        // Return decoded body
-        return json_decode(
-            (string) $response->getBody(),
-            true,
-            512,
-            JSON_THROW_ON_ERROR
-        );
+        return $healthData;
     }
 
     public function performExtractionRequest(array $data): array
@@ -56,7 +41,7 @@ public function performExtractionRequest(array $data): array
 
         $data['password'] = $this->key;
 
-        return $this->performRequest(
+        return $this->performHttpRequest(
             $request,
             [
                 'form_params' => $data,
@@ -65,21 +50,55 @@ public function performExtractionRequest(array $data): array
         );
     }
 
-    public function performWebserviceRequest(HttpMethod $method, string $endpoint, array $data = []): array
-    {
+    protected function performWebserviceRequest(
+        HttpMethod $method,
+        WebserviceEndpoint $endpoint,
+        array $data = []
+    ): array {
         $request = new Request(
             $method->name,
-            $this->baseUrl . $endpoint,
+            $this->baseUrl . $endpoint->value,
             [
                 'Authorization' => 'JUpdate-Token ' . $this->key
             ]
         );
 
-        return $this->performRequest(
+        return $this->performHttpRequest(
             $request,
             [
                 "json" => $data
             ]
         );
     }
+
+    protected function performHttpRequest(
+        RequestInterface $request,
+        array $options = []
+    ): array {
+        /** @var Client $httpClient */
+        $httpClient = App::make(Client::class);
+
+        /** @var Response $response */
+        $response = $httpClient->send(
+            $request,
+            $options
+        );
+
+        // Validate response
+        if (!json_validate((string) $response->getBody())) {
+            throw new RequestException(
+                "Invalid JSON body",
+                $request,
+                $response
+            );
+        }
+
+        // Return decoded body
+        return json_decode(
+            (string) $response->getBody(),
+            true,
+            512,
+            JSON_THROW_ON_ERROR
+        );
+    }
 }