keboola/storage-api-php-client-branch-wrapper

Wrapper for Storage API clients for Dev/Prod mode

6.0.0 2024-07-24 09:11 UTC

Requires

• php: >=8.2
• ext-json: *
• keboola/storage-api-client: ^15.0
• symfony/http-foundation: ^5.2|^6.0
• symfony/validator: ^5.2|^6.0

Requires (Dev)

• infection/infection: ^0.27
• keboola/coding-standard: >=13.0
• phpstan/phpstan: ^1.5
• phpstan/phpstan-phpunit: ^1.1
• phpunit/phpunit: ^9.5
• symfony/dotenv: ^6.1

MIT

• Keboola

• client
• branch
• keboola
• storage api

README

This is a wrapper for encapsulating Client and BranchAwareClient of Storage API PHP Client.

Installation

composer require keboola/storage-api-php-client-branch-wrapper

Usage

Create client instance and use it in wrapper instance:

$clientOptions = ClientOptions('http://xxx.com', '1234-XXXX', '123');
$clientWrapper = new ClientWrapper($clientOptions);
$branchClient = $clietnWrapper->getBranchClient();

Client options refer to the options of the Storage API Client constructor. Except for the runIdGenerator option which defines a callback used to generate runId when none is provided in request (applicable for StorageClientRequestFactory).

Development

Create a test Keboola Connection project and set TEST_STORAGE_API_URL and TEST_STORAGE_API_TOKEN environment variables. Use the .env.dist file to create .env file.

Run tests with:

docker-compose run --rm dev

License

MIT licensed, see LICENSE file.