keboola/job-queue-internal-api-php-client

Client for internal job queue API

23.5.0 2024-10-21 13:48 UTC

Requires

• php: ^8.2
• ext-json: *
• guzzlehttp/guzzle: ^6.3|^7.0
• keboola/artifacts: ^3.0
• keboola/kbc-manage-api-php-client: ^5.2|^6.0|^7.0
• keboola/object-encryptor: ^2.8
• keboola/permission-checker: ^2.0
• keboola/storage-api-client: ^15.2
• keboola/storage-api-php-client-branch-wrapper: ^6.0
• monolog/monolog: ^2.6
• psr/log: ^1.1|^2.0|^3.0
• symfony/config: ^5.4|^6.0
• symfony/uid: ^5.4|^6.2
• symfony/validator: ^5.4|^6.0

Requires (Dev)

• infection/infection: ^0.27
• keboola/coding-standard: >=14.0
• phpstan/phpstan: ^1.0
• phpstan/phpstan-phpunit: ^1.3
• phpunit/phpunit: ^9.5
• sempro/phpunit-pretty-print: ^1.4
• symfony/dotenv: ^6.3

MIT

• Keboola

• queue
• client
• job
• keboola

README

PHP client for the Internal Job Queue API (API docs).

Usage

composer require keboola/job-queue-internal-api-php-client

use Keboola\JobQueueInternalClient\Client;

$storageClientFactory = new JobFactory\StorageClientFactory('http://connetion.keboola.com/');
$objectEncryptorFactory = new ObjectEncryptorFactory('key-id', 'us-east-1', '', '');
$jobFactory = new JobFactory($storageClientFactory, $objectEncryptorFactory);
$client = new Client(
    new NullLogger(),
    $jobFactory,
    'http://internal.queue.api/',
    'testQueueToken'
);
$client->getJobData('123');
$client->postJobResult('123', 'success', ['images' => ['digests' => []]]);

Development

Prerequisites:

• configured az and aws CLI tools (run az login and aws configure --profile keboola-dev-platform-services)
• installed GCP CLI gcloud (and run gcloud auth login or gcloud auth application-default login)
• installed terraform (https://www.terraform.io) and jq (https://stedolan.github.io/jq) to setup local env
• intalled docker and docker compose to run & develop the app

TL;DR:

export NAME_PREFIX= # your name/nickname to make your resource unique & recognizable

cat <<EOF > ./provisioning/local/terraform.tfvars
name_prefix = "${NAME_PREFIX}"
EOF

cat <<EOF > .env.local
TEST_STORAGE_API_URL=https://connection.keboola.com
TEST_STORAGE_API_TOKEN=
TEST_STORAGE_API_TOKEN_MASTER=
EOF

terraform -chdir=./provisioning/local init -backend-config="key=job-queue-internal-api-php-client/${NAME_PREFIX}.tfstate"
terraform -chdir=./provisioning/local apply
./provisioning/local/update-env.sh azure # or aws

License

MIT licensed, see LICENSE file.