Beeminder API

A PHP interface to the Beeminder API. Handles everything in v1, although it still needs much better error handling.

Usage

First you'll need to include the autoloader using the following snippet:

require_once '/path/to/lib/Beeminder/Autoloader.php';
Beeminder_Autoloader::register();

Just replace /path/to/ with the actual path the API is stored in.

Once the autoloader is included and setup, it's time to create an instance of Beeminder_Client. After that, simply login using authorisation tokens (either OAuth or the private API token) and then call whatever method(s) you want. Here's an example:

// Include the autoloader
require_once dirname(__FILE__) . '/vendor/beeminder-api/lib/Beeminder/Autoloader.php';
Beeminder_Autoloader::register();

// Create new client
$api = new Beeminder_Client();

// Setup auth (private token)
$api->login('username', 'secret_token', Beeminder_Client::AUTH_PRIVATE_TOKEN);

// Fetch a list of goals for the user
$goals = $api->getGoalApi()->getGoals();

// Output some happy info
foreach ($goals as $goal) {
    echo "{$goal->title}\n";
    echo "{$goal->goal_type}\n";
}

Questions

How do I check which version I have?

echo Beeminder_Client::VERSION

If this gives an error like PHP Fatal error: Undefined class constant 'VERSION', then you are using an older obsolete release and it's best to download the lastest version.

Development

beeminder-php-api uses the PHPUnit testing framework and has 100% test coverage.

###Running the tests

phpunit -c test/phpunit.xml --coverage-text

Projects that use this library

• beeminder-ping -- A WordPress plugin to ping Beeminder when a post is made.

Credits

• Beeminder is pretty neat. You should use it :)
• API library design based on php-github-api.