sgrodzicki/pingdom

A PHP library for dealing with the Pingdom REST API

Pingdom REST API

A PHP module to make use of the Pingdom REST API for you to automate your interaction with the Pingdom system., _(*1)

Installation

The best way to install the library is by using Composer. Add the following to composer.json in the root of your project:, _(*2)

``` javascript { "require": { "sgrodzicki/pingdom": "1.1.*" } }, <sub>(*3)</sub>

Then, on the command line:

``` bash
curl -s http://getcomposer.org/installer | php
php composer.phar install

Use the generated vendor/.composer/autoload.php file to autoload the library classes., <sub>(*4)</sub>

Basic usage

<?php

$username = ''; // Pingdom username
$password = ''; // Pingdom password
$token    = ''; // Pingdom application key (32 characters)

$pingdom = new \Pingdom\Client($username, $password, $token);

// List of probe servers
$probes = $pingdom->getProbes();
foreach ($probes as $probe) {
    echo $probe->getName() . PHP_EOL;
}

// List of checks
$checks  = $pingdom->getChecks();
foreach ($checks as $check) {
    $results = $pingdom->getResults($check['id']);
}

Tests

, <sub>(*5)</sub>

The client is tested with phpunit; you can run the tests, from the repository's root, by doing:, <sub>(*6)</sub>

``` bash phpunit, <sub>(*7)</sub>

Some tests require internet connection (to test against a real API response), so they are disabled by default; to run them add a `credentials.php` file in the root of your project:

```php
<?php

require_once __DIR__ . '/vendor/autoload.php';

$username = '[your username]';
$password = '[your password]';
$token    = '[your token]';

and run the tests, from the repository's root, by doing:, <sub>(*8)</sub>

bash phpunit --bootstrap credentials.php, <sub>(*9)</sub>