https://github.com/testmonitor/donedone-client

The TestMonitor DoneDone Client.
https://github.com/testmonitor/donedone-client

Last synced: about 1 year ago
JSON representation

The TestMonitor DoneDone Client.

• Host: GitHub
• URL: https://github.com/testmonitor/donedone-client
• Owner: testmonitor
• License: mit
• Created: 2019-12-04T10:14:25.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-15T07:18:27.000Z (over 1 year ago)
• Last Synced: 2024-09-15T09:09:33.553Z (over 1 year ago)
• Language: PHP
• Homepage:
• Size: 69.3 KB
• Stars: 2
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# TestMonitor DoneDone Client

[![Latest Stable Version](https://poser.pugx.org/testmonitor/donedone-client/v/stable)](https://packagist.org/packages/testmonitor/donedone-client)

[![CircleCI](https://img.shields.io/circleci/project/github/testmonitor/donedone-client.svg)](https://circleci.com/gh/testmonitor/donedone-client)

[![StyleCI](https://styleci.io/repos/223800227/shield)](https://styleci.io/repos/225837714)

[![codecov](https://codecov.io/gh/testmonitor/donedone-client/graph/badge.svg?token=86DQPB0421)](https://codecov.io/gh/testmonitor/donedone-client)

[![License](https://poser.pugx.org/testmonitor/donedone-client/license)](https://packagist.org/packages/testmonitor/donedone-client)

This package provides a very basic, convenient, and unified wrapper for the [DoneDone REST api](https://www.donedone.com/api).

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Examples](#examples)

- [Tests](#tests)

- [Changelog](#changelog)

- [Contributing](#contributing)

- [Credits](#credits)

- [License](#license)

## Installation

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

	$ composer require testmonitor/donedone-client

Use composer's autoload:

```php

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

```

You're all set up now!

## Usage

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

```php

$donedone = new \TestMonitor\DoneDone\Client('email@server.com', 'API token');

```

Next, you can start interacting with DoneDone.

## Examples

Get a list of DoneDone accounts:

```php

$projects = $donedone->accounts();

```

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

```php

$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](CHANGELOG.md) for more information.

## Contributing

Refer to [CONTRIBUTING](CONTRIBUTING.md) for contributing details.

## Credits

* **Thijs Kok** - *Lead developer* - [ThijsKok](https://github.com/thijskok)

* **Stephan Grootveld** - *Developer* - [Stefanius](https://github.com/stefanius)

* **Frank Keulen** - *Developer* - [FrankIsGek](https://github.com/frankisgek)

* **Muriel Nooder** - *Developer* - [ThaNoodle](https://github.com/thanoodle)

## License

The MIT License (MIT). Refer to the [License](LICENSE.md) for more information.