bluestatedigital/tools-api-client

Client library for the BSD Tools API

v3.3.0 2018-02-01 09:56 UTC

Requires

• php: >=5.6
• guzzlehttp/guzzle: ~6.3
• nesbot/carbon: ~1.3
• psr/log: ~1.0

Requires (Dev)

• mockery/mockery: ~0.9
• phpunit/phpunit: ~3.7

Apache-2.0

README

This library provides an interface to the BSD Tools.

Example usage:

use Blue\Tools\Api\Client;

$client = new Client('user_id', 'secret', 'https://baseurl.com');

/** @var ResponseInterface $response */
$response = $client->get('api/list_things', ['param' => 'value']);

The BSD Tools API will sometimes return a deferred result, which means that the results of the call are not immediately available. The above call, however, will poll for updates to this API call, and will block until the result has been resolved. The manner in which the client polls for updates can be configured as follows:

// Set the client to wait 30 seconds between updates
$client->setDeferredResultInterval(30);

// Set the client to give up after 10 updates (a RuntimeException will be thrown)
$client->setDeferredResultMaxAttempts(10);

Installation

Update composer.json:

"require": {
    "bluestatedigital/tools-api-client": "~2.0"
}

Handling Responses

By default the API client uses Guzzle's RequestException for any responses above HTTP 300. To use your own handler you may either create your own Guzzle error plugin or emitter (see Guzzle 5 documentation), or disable Guzzle's handler entirely by using the following code:

// Prevent Exceptions on non-actionable HTTP response (400 and 500 range)
$client->setRequestOption('exceptions', false);