keboola / orchestrator-php-client

1.2.4 2023-10-02 07:15 UTC

Requires

• php: >=5.6
• guzzle/guzzle: 3.8.*

Requires (Dev)

• keboola/storage-api-client: 6.1.*
• phpunit/phpunit: 3.7.*

Unknown License

Published on Packagist.org on 2023-10-02 08:33 UTC

README

Simple PHP wrapper library for Keboola Orchestrator REST API

Installation

Library is available as composer package. To start using composer in your project follow these steps:

Install composer

curl -s http://getcomposer.org/installer | php
mv ./composer.phar ~/bin/composer # or /usr/local/bin/composer

Create composer.json file in your project root folder:

{
    "require": {
        "php" : ">=5.6",
        "keboola/orchestrator-php-client": "1.3.*"
    }
}

Install package:

composer install

Add autoloader in your bootstrap script:

require 'vendor/autoload.php';

Read more in Composer documentation

Usage

Execute all orchestrations in KBC project example:

use Keboola\Orchestrator\Client;

$client = Client::factory(array(
    'token' => 'YOUR_TOKEN',
));

// retrieve all orchestrations in KBC project
$orchestrations = $client->getOrchestrations();

foreach ($orchestrations AS $orchestration) {
    // manually execute orchestration
    $client->createJob($orchestration['id']);
}

Tests

To run tests you need Storage API token to an empty project in Keboola Connection. The project must be in US region.

Create .env file with environment variables:

ORCHESTRATOR_API_URL=https://syrup.keboola.com/orchestrator/
ORCHESTRATOR_API_TOKEN=your_token
ERROR_NOTIFICATION_EMAIL={your_email}

• ORCHESTRATOR_API_URL - Url of Orchestrator Rest API endpoint
• ORCHESTRATOR_API_TOKEN - Valid Storage API token. Token must have canManageTokens permissions.
• ERROR_NOTIFICATION_EMAIL - Your email address. It will be used in orchestrator notification settings.

Build image and run tests

docker network create orchestrator-router_api-tests
docker-compose build tests
docker-compose run --rm tests ./vendor/bin/phpunit

License

MIT licensed, see LICENSE file.