PAT-1866 Migrate vault-api-client onto php-api-client-base

libs/configuration-variables-resolver/composer.json

@@ -38,6 +38,7 @@
         "php": "^8.2",
         "ext-json": "*",
         "keboola/common-exceptions": "^1.1",
+        "keboola/php-api-client-base": "*@dev",
         "keboola/service-client": "*@dev",
         "keboola/storage-api-client": "^17.0|^18.0",
         "keboola/storage-api-php-client-branch-wrapper": "^6.0",

libs/configuration-variables-resolver/src/UnifiedConfigurationResolverFactory.php

@@ -6,7 +6,6 @@
 
 use Keboola\ServiceClient\ServiceClient;
 use Keboola\StorageApiBranch\ClientWrapper;
-use Keboola\VaultApiClient\ApiClientConfiguration as VaultVariablesApiClientConfiguration;
 use Keboola\VaultApiClient\Variables\VariablesApiClient;
 use Psr\Log\LoggerInterface;
 
@@ -30,10 +29,13 @@ public function createResolver(
         $token = $clientWrapper->getToken()->getTokenValue();
         assert($token !== '');
 
+        $config = $this->vaultVariablesApiClientConfiguration;
         $vaultVariablesApiClient = new VariablesApiClient(
             baseUrl: $this->serviceClient->getVaultUrl(),
             token: $token,
-            configuration: $this->vaultVariablesApiClientConfiguration,
+            logger: $this->logger,
+            backoffMaxTries: $config->backoffMaxTries,
+            userAgent: 'Keboola Vault PHP Client' . ($config->userAgent !== null ? ' - ' . $config->userAgent : ''),
         );
 
         $sharedCodeResolver = new SharedCodeResolver($clientWrapper, $this->logger);

libs/configuration-variables-resolver/src/VaultVariablesApiClientConfiguration.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\ConfigurationVariablesResolver;
+
+/**
+ * Configuration for the vault VariablesApiClient.
+ *
+ * Re-introduced locally after vault-api-client dropped its own ApiClientConfiguration
+ * (flattened into individual constructor arguments). Keeps this lib's previous default
+ * of 10 retries and preserves the factory's config-object API for its consumers.
+ */
+class VaultVariablesApiClientConfiguration
+{
+    private const DEFAULT_BACKOFF_RETRIES = 10;
+
+    /**
+     * @param int<0, max> $backoffMaxTries
+     */
+    public function __construct(
+        public readonly ?string $userAgent = null,
+        public readonly int $backoffMaxTries = self::DEFAULT_BACKOFF_RETRIES,
+    ) {
+    }
+}

libs/configuration-variables-resolver/tests/UnifiedConfigurationResolverFactoryTest.php

@@ -5,11 +5,11 @@
 namespace Keboola\ConfigurationVariablesResolver\Tests;
 
 use Keboola\ConfigurationVariablesResolver\UnifiedConfigurationResolverFactory;
+use Keboola\ConfigurationVariablesResolver\VaultVariablesApiClientConfiguration;
 use Keboola\ServiceClient\ServiceClient;
 use Keboola\StorageApi\BranchAwareClient;
 use Keboola\StorageApiBranch\ClientWrapper;
 use Keboola\StorageApiBranch\StorageApiToken;
-use Keboola\VaultApiClient\ApiClientConfiguration as VaultVariablesApiClientConfiguration;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\NullLogger;
 
@@ -235,11 +235,9 @@ private function getFactory(): UnifiedConfigurationResolverFactory
         $serviceClient = $this->createMock(ServiceClient::class);
         $serviceClient->method('getVaultUrl')->willReturn($this->variablesApiMock->getServerUrl());
 
-        $vaultVariablesApiClientConfiguration = new VaultVariablesApiClientConfiguration();
-
         return new UnifiedConfigurationResolverFactory(
             $serviceClient,
-            $vaultVariablesApiClientConfiguration,
+            new VaultVariablesApiClientConfiguration(),
             new NullLogger,
         );
     }

libs/vault-api-client/README.md

@@ -1,10 +1,58 @@
 # Vault API Client
 
+PHP client for the Keboola Vault API, built on top of `keboola/php-api-client-base`.
+
 ## Installation
+
 ```bash
 composer require keboola/vault-api-client
 ```
 
+## Usage
+
+```php
+use Keboola\VaultApiClient\Variables\Model\ListOptions;
+use Keboola\VaultApiClient\Variables\Model\Variable;
+use Keboola\VaultApiClient\Variables\VariablesApiClient;
+
+$client = new VariablesApiClient(
+    baseUrl: 'https://vault.keboola.com',
+    token: 'your-storage-api-token',
+);
+
+// Create a variable
+$variable = $client->createVariable(
+    key: 'MY_SECRET',
+    value: 'secret-value',
+    flags: [Variable::FLAG_ENCRYPTED],
+    attributes: ['branchId' => '123'],
+);
+
+// List variables
+$variables = $client->listVariables(new ListOptions(offset: 0, limit: 50));
+
+// List scoped variables for a branch
+$branchVariables = $client->listScopedVariablesForBranch(branchId: '123');
+
+// Delete a variable
+$client->deleteVariable(hash: $variable->hash);
+```
+
+### Custom configuration
+
+Pass retry, timeout, and logging options directly as constructor parameters:
+
+```php
+use Monolog\Logger;
+
+$client = new VariablesApiClient(
+    baseUrl: 'https://vault.keboola.com',
+    token: 'your-storage-api-token',
+    backoffMaxTries: 3,
+    logger: new Logger('vault'),
+);
+```
+
 ## License
 
 MIT licensed, see [LICENSE](./LICENSE) file.

libs/vault-api-client/composer.json

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

libs/vault-api-client/src/Exception/VaultClientException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\VaultApiClient\Exception;
+
+use Keboola\ApiClientBase\Exception\ClientException;
+
+final class VaultClientException extends ClientException
+{
+}