PAT-1866 Migrate sandboxes-service-api-client onto php-api-client-base

libs/sandboxes-service-api-client/README.md

@@ -11,13 +11,12 @@ composer require keboola/sandboxes-service-api-client
 
 ```php
 use Keboola\SandboxesServiceApiClient\Sandboxes\SandboxesApiClient;
-use Keboola\SandboxesServiceApiClient\ApiClientConfiguration;
 
-$client = new SandboxesApiClient(new ApiClientConfiguration(
+$client = new SandboxesApiClient(
     baseUrl: 'https://data-science.keboola.com',
-    storageToken: '{storage-api-token}',
+    token: '{storage-api-token}',
     userAgent: 'My App',
-));
+);
 
 $result = $client->createSandbox([
     'componentId' => 'keboola.data-apps',
@@ -31,13 +30,12 @@ $result = $client->createSandbox([
 
 ```php
 use Keboola\SandboxesServiceApiClient\Apps\AppsApiClient;
-use Keboola\SandboxesServiceApiClient\ApiClientConfiguration;
 
-$client = new AppsApiClient(new ApiClientConfiguration(
+$client = new AppsApiClient(
     baseUrl: 'https://data-apps.keboola.com',
-    storageToken: '{storage-api-token}',
+    token: '{storage-api-token}',
     userAgent: 'My App',
-));
+);
 
 // List all apps
 $apps = $client->listApps();

libs/sandboxes-service-api-client/composer.json

@@ -9,6 +9,12 @@
             "email": "devel@keboola.com"
         }
     ],
+    "repositories": {
+        "libs": {
+            "type": "path",
+            "url": "../../libs/*"
+        }
+    },
     "autoload": {
         "psr-4": {
             "Keboola\\SandboxesServiceApiClient\\": "src/"
@@ -22,6 +28,7 @@
     "require": {
         "php": "^8.2",
         "guzzlehttp/guzzle": "^7.8",
+        "keboola/php-api-client-base": "*@dev",
         "monolog/monolog": "^2.0|^3.0",
         "webmozart/assert": "^1.11"
     },

libs/sandboxes-service-api-client/src/Apps/App.php

@@ -4,9 +4,10 @@
 
 namespace Keboola\SandboxesServiceApiClient\Apps;
 
-use Keboola\SandboxesServiceApiClient\Exception\ClientException;
+use Keboola\ApiClientBase\Exception\ClientException;
+use Keboola\ApiClientBase\ResponseModelInterface;
 
-class App
+final class App implements ResponseModelInterface
 {
     protected const REQUIRED_PROPERTIES = [
         'id',
@@ -72,28 +73,28 @@ class App
     private int $autoSuspendAfterSeconds;
     private string $provisioningStrategy;
 
-    public static function fromArray(array $in): self
+    public static function fromResponseData(array $data): static
     {
         foreach (self::REQUIRED_PROPERTIES as $property) {
-            if (!isset($in[$property])) {
+            if (!isset($data[$property])) {
                 throw new ClientException("Property $property is missing from API response");
             }
         }
 
         $app = new self();
-        $app->setId((string) $in['id']);
-        $app->setProjectId((string) $in['projectId']);
-        $app->setComponentId((string) $in['componentId']);
-        $app->setType(isset($in['type']) ? (string) $in['type'] : null);
-        $app->setBranchId(isset($in['branchId']) ? $in['branchId'] : null);
-        $app->setConfigId((string) $in['configId']);
-        $app->setConfigVersion((string) $in['configVersion']);
-        $app->setState((string) $in['state']);
-        $app->setDesiredState((string) $in['desiredState']);
-        $app->setLastRequestTimestamp($in['lastRequestTimestamp'] ?? null);
-        $app->setUrl($in['url'] ?? null);
-        $app->setAutoSuspendAfterSeconds((int) ($in['autoSuspendAfterSeconds'] ?? 0));
-        $app->setProvisioningStrategy((string) $in['provisioningStrategy']);
+        $app->setId((string) $data['id']);
+        $app->setProjectId((string) $data['projectId']);
+        $app->setComponentId((string) $data['componentId']);
+        $app->setType(isset($data['type']) ? (string) $data['type'] : null);
+        $app->setBranchId(isset($data['branchId']) ? $data['branchId'] : null);
+        $app->setConfigId((string) $data['configId']);
+        $app->setConfigVersion((string) $data['configVersion']);
+        $app->setState((string) $data['state']);
+        $app->setDesiredState((string) $data['desiredState']);
+        $app->setLastRequestTimestamp($data['lastRequestTimestamp'] ?? null);
+        $app->setUrl($data['url'] ?? null);
+        $app->setAutoSuspendAfterSeconds((int) ($data['autoSuspendAfterSeconds'] ?? 0));
+        $app->setProvisioningStrategy((string) $data['provisioningStrategy']);
 
         return $app;
     }

libs/sandboxes-service-api-client/src/Apps/AppsApiClient.php

@@ -4,18 +4,52 @@
 
 namespace Keboola\SandboxesServiceApiClient\Apps;
 
+use Closure;
+use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Psr7\Request;
-use Keboola\SandboxesServiceApiClient\ApiClient;
-use Keboola\SandboxesServiceApiClient\ApiClientConfiguration;
-use Keboola\SandboxesServiceApiClient\Json;
+use Keboola\ApiClientBase\ApiClient;
+use Keboola\ApiClientBase\ApiClientOptions;
+use Keboola\ApiClientBase\Auth\StorageApiTokenAuthenticator;
+use Keboola\ApiClientBase\Json;
+use Keboola\SandboxesServiceApiClient\Exception\SandboxesServiceClientException;
+use Keboola\SandboxesServiceApiClient\SandboxesErrorMessageResolver;
+use Psr\Log\LoggerInterface;
 
 class AppsApiClient
 {
+    private const FALLBACK_USER_AGENT = 'Keboola Sandboxes Service API PHP Client';
+
     private ApiClient $apiClient;
 
-    public function __construct(ApiClientConfiguration $configuration)
-    {
-        $this->apiClient = new ApiClient($configuration);
+    /**
+     * @param non-empty-string $baseUrl
+     * @param non-empty-string $storageToken
+     * @param int<0, max> $backoffMaxTries
+     */
+    public function __construct(
+        string $baseUrl,
+        string $storageToken,
+        ?LoggerInterface $logger = null,
+        int $backoffMaxTries = ApiClientOptions::DEFAULT_BACKOFF_MAX_TRIES,
+        int $connectTimeout = ApiClientOptions::DEFAULT_CONNECT_TIMEOUT,
+        int $requestTimeout = ApiClientOptions::DEFAULT_REQUEST_TIMEOUT,
+        string $userAgent = self::FALLBACK_USER_AGENT,
+        null|Closure|HandlerStack $requestHandler = null,
+    ) {
+        $this->apiClient = new ApiClient(
+            $baseUrl,
+            new StorageApiTokenAuthenticator($storageToken),
+            new ApiClientOptions(
+                userAgent: $userAgent,
+                backoffMaxTries: $backoffMaxTries,
+                connectTimeout: $connectTimeout,
+                requestTimeout: $requestTimeout,
+                requestHandler: $requestHandler,
+                logger: $logger,
+            ),
+            errorMessageResolver: new SandboxesErrorMessageResolver(),
+            exceptionClass: SandboxesServiceClientException::class,
+        );
     }
 
     /**
@@ -45,23 +79,22 @@ public function listApps(
             $uri .= '?' . http_build_query($queryParams);
         }
 
-        $responseData = $this->apiClient->sendRequestAndDecodeResponse(
+        return $this->apiClient->sendRequestAndMapResponse(
             new Request('GET', $uri),
+            App::class,
+            isList: true,
         );
-
-        return array_map(fn(array $appData) => App::fromArray($appData), $responseData);
     }
 
     public function getApp(string $appId): App
     {
-        $responseData = $this->apiClient->sendRequestAndDecodeResponse(
+        return $this->apiClient->sendRequestAndMapResponse(
             new Request(
                 'GET',
                 sprintf('/apps/%s', $appId),
             ),
+            App::class,
         );
-
-        return App::fromArray($responseData);
     }
 
     /**
@@ -87,7 +120,7 @@ public function patchApp(string $appId, array $payload): void
      */
     public function createApp(array $payload): App
     {
-        $responseData = $this->apiClient->sendRequestAndDecodeResponse(
+        return $this->apiClient->sendRequestAndMapResponse(
             new Request(
                 'POST',
                 '/apps',
@@ -96,9 +129,8 @@ public function createApp(array $payload): App
                 ],
                 Json::encodeArray($payload),
             ),
+            App::class,
         );
-
-        return App::fromArray($responseData);
     }
 
     public function deleteApp(string $appId): void