testmonitor/donedone-client

The TestMonitor DoneDone Client.

v3.2.0 2024-05-14 08:57 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.1
• mockery/mockery: ~1.0
• phpunit/phpunit: ^10.0
• scrutinizer/ocular: ^1.9
• squizlabs/php_codesniffer: ^3.7

MIT

• Thijs Kok
• Stephan Grootveld
• Frank Keulen

• client
• donedone
• testmonitor

README

This package provides a very basic, convenient, and unified wrapper for the DoneDone REST api.

Table of Contents

• Installation
• Usage
• Examples
• Tests
• Changelog
• Contributing
• Credits
• License

Installation

To install the client you need to require the package using composer:

$ composer require testmonitor/donedone-client

Use composer's autoload:

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

You're all set up now!

Usage

You'll have to instantiate the client using your credentials:

$donedone = new \TestMonitor\DoneDone\Client('[e-mail]', 'API token');

Next, you can start interacting with DoneDone.

Examples

Get a list of DoneDone accounts:

$projects = $donedone->accounts();

Or creating a task, for example (using account 123 and project 456):

$task = $donedone->createTask(new \TestMonitor\DoneDone\Resources\Task([
    'title' => 'Some task',
    'description' => 'A better description',
    'status' => 1,
    'priority' => 2,
]), 123, 456);

Tests

The package contains integration tests. You can run them using PHPUnit.

$ vendor/bin/phpunit

Changelog

Refer to CHANGELOG for more information.

Contributing

Refer to CONTRIBUTING for contributing details.

Credits

• Thijs Kok - Lead developer - ThijsKok
• Stephan Grootveld - Developer - Stefanius
• Frank Keulen - Developer - FrankIsGek
• Muriel Nooder - Developer - ThaNoodle

License

The MIT License (MIT). Refer to the License for more information.