testmonitor / asana-client
The TestMonitor Asana Client.
Installs: 8 306
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 3
Open Issues: 0
Requires
- php: ^8.1
- ext-fileinfo: *
- asana/asana: ^1.0.6
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.2
- mockery/mockery: ~1.5
- phpunit/phpunit: ^10.0
- scrutinizer/ocular: ^1.9
- squizlabs/php_codesniffer: ^3.7
README
This package provides a very basic, convenient, and unified wrapper for the Official Asana PHP client library.
Table of Contents
Installation
To install the client you need to require the package using composer:
$ composer require testmonitor/asana-client
Use composer's autoload:
require __DIR__.'/../vendor/autoload.php';
You're all set up now!
Usage
This client only supports oAuth authentication. You'll need an Asana application to proceed. If you haven't done so, please read up with the Asana authentication docs on how to create an application.
When your Asana application is up and running, start with the oAuth authorization:
$oauth = [ 'clientId' => '12345', 'clientSecret' => 'abcdef', 'redirectUrl' => 'https://redirect.myapp.com/', ]; $asana = new \TestMonitor\Asana\Client($oauth); header('Location: ' . $asana->authorizationUrl('state')); exit();
This will redirect the user to a page asking confirmation for your app getting access to Asana. Make sure your redirectUrl points back to your app. This URL should point to the following code:
$oauth = [ 'clientId' => '12345', 'clientSecret' => 'abcdef', 'redirectUrl' => 'https://redirect.myapp.com/', ]; $asana = new \TestMonitor\Asana\Client($oauth); $token = $asana->fetchToken($_REQUEST['code']);
When everything went ok, you should have an access token (available through Token object). It will be valid for one hour. After that, you'll have to refresh the token to regain access:
$oauth = ['clientId' => '12345', 'clientSecret' => 'abcdef', 'redirectUrl' => 'https://redirect.myapp.com/']; $token = new \TestMonitor\Asana\Token('eyJ0...', '0/34ccc...', 1574600877); // the token you got last time $asana = new \TestMonitor\Asana\Client($oauth, $token); if ($token->expired()) { $newToken = $asana->refreshToken(); }
The new token will be valid again for the next hour.
Examples
Get a list of Asana workspaces:
$workspaces = $asana->workspaces();
Or creating a task, for example (using a example project with gid 12345):
$task = $asana->createTask(new \TestMonitor\Asana\Resources\Task([ 'completed' => false, 'name' => 'Name of the task', 'notes' => 'Some notes', ]), '12345');
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.