gamez/mite

Interact with mite (https://mite.yo.lk) from your PHP application.

1.0.1 2019-01-23 15:17 UTC

README

Interact with mite from your PHP application.

Current version Supported PHP version Build Status

Requirements

  • An account name (The first part of your mite account's domain, e.g. in https://xxx.mite.yo.lk)
  • An API key (You can find your API key on https://xxx.mite.yo.lk/myself)

Please note that the capabilities of the library are limited by the permissions of the used credentials. As an example, a user with the role "Time Tracker" can only access data that has been made available to them and is not allowed to create new customers.

If you want to see and do anything, use an account with administrative permissions.

Installation

composer require gamez/mite

Setup

Creating an API client based on Guzzle

composer require guzzlehttp/guzzle:^6.3
<?php
// a file in the same directory in which you perfomed the composer command(s)
require 'vendor/autoload.php';

use Gamez\Mite\Api\GuzzleApiClient;

$accountName = 'xxx';
$apiKey = 'xxx';

$apiClient = GuzzleApiClient::with($accountName, $apiKey);

Creating an API client based on a PSR-18 HTTP Client

The following example uses kriswallsmith/buzz as the client and nyholm/psr7 as the Request Factory, but you can use any library that implements PSR-17 and PSR-18.

composer require kriswallsmith/buzz:^1.0 nyholm/psr7:^1.0
<?php
// a file in the same directory in which you perfomed the composer command(s)
require 'vendor/autoload.php';

use Buzz\Client\FileGetContents;
use Gamez\Mite\Api\HttpApiClient;
use Nyholm\Psr7\Factory\Psr17Factory;

$accountName = 'xxx';
$apiKey = 'xxx';

$psr17Factory = new Psr17Factory();
$httpClient = new FileGetContents($psr17Factory);

$apiClient = HttpApiClient::with($account, $apiKey, $httpClient, $psr17Factory);

Creating your own API client

If you want to create your own API client, implement the \Gamez\Mite\Api\ApiClient interface and use your implementation.

Caching HTTP requests

To cache HTTP requests to the API, you can add a caching middleware/plugin to the HTTP client before injecting it into the API client instance. See the documentation of the respective component for instructions on how to do that.

Usage

Simple API

Gamez\Mite\SimpleApi is the easiest and fastest way to access the data in your mite account. Its methods are named after the available REST API endpoints and always return arrays of data. You can inspect the available methods by looking at the source code of the Gamez\Mite\SimpleApi class or by using the autocompletion features of your IDE.

The Simple API doesn't get in your way when accessing the mite API, but it doesn't provide additional features either. It will, for example, not tell you if you used a wrong query parameter or invalid field value, so you will have to rely on the returned API responses.

For information on which query parameters and field values are allowed, see official mite API documentation

Example

<?php

use Gamez\Mite\SimpleApi;

/** @var \Gamez\Mite\Api\ApiClient $apiClient */
$api = SimpleApi::withApiClient($apiClient);

$customer = $api->createCustomer([
    'name' => 'My new customer',
    'note' => 'He pays better than the old one',
]);

echo 'Customer: '.print_r($customer, true);

$project = $api->createProject([
    'name' => 'My new customer project',
    'customer_id' => $customer['id'],
    'budget_type' => 'minutes_per_month',
    'budget' => 6000,
    'hourly_rate' => 10000,
    'active_hourly_rate' => 'hourly_rate',
]);

echo 'Project: '.print_r($project, true);

$service = $api->createService([
    'name' => 'Customer Support',
]);

echo 'Service: '.print_r($service, true);

$user = current($api->getActiveUsers()); // For the sake of this example, we use the first available user

echo 'User: '.print_r($user, true);

$timeEntry = $api->createTimeEntry([
    'date_at' => 'today',
    'minutes' => 60,
    'user_id' => $user['id'], // Would we omit this, the authenticated user would be used
    'project_id' => $project['id'],
    'service_id' => $service['id'],
    'note' => 'We had some work to do, and we did some work.'
]);

echo 'Time Entry: '.print_r($timeEntry, true);

// $api->delete($newTimeEntry['id'];

$workdaysPerMonthAndUser = $api->getGroupedTimeEntries($groupBy = ['user'], ['at' => 'this_month']);

echo 'Workdays per month and user: '.print_r($workdaysPerMonthAndUser, true);

Simple Tracker

Gamez\Mite\SimpleTracker allows you to work with mite's time tracker.

Note: You can only access the tracker of the currently authenticated user (identified by the used API key). It is not possible to modify trackers of other users.

Each action on the tracker returns an array with information about the tracked time entry, but you don't have to inspect the result to know if the action has been successful or not - if an action does not throw an error, it has been successful.

<?php

use Gamez\Mite\SimpleApi;
use Gamez\Mite\SimpleTracker;

/** @var \Gamez\Mite\Api\ApiClient $apiClient */
$api = SimpleApi::withApiClient($apiClient);
$tracker = SimpleTracker::withApiClient($apiClient);

$sleeping = $api->createTimeEntry(['note' => 'I am sleeping']);
$working = $api->createTimeEntry(['note' => 'I switch to this now and then']);

$tracker->start($sleeping['id']);
sleep(1); // You don't need this sleep, but the example makes more sense this way
$tracker->start($working['id']); // This will automatically stop the "sleeping" tracker
// No sleep this time, we'll just work for zero seconds 
$tracker->stop($working['id']); // We stopped working!

print_r($tracker->status()); // Sad

Catching errors

All exceptions thrown by this library implement the \Gamez\Mite\Exception\MiteException interface. Exceptions thrown while using an API Client will throw a \Gamez\Mite\Exception\ApiClientError.

<?php 

use Gamez\Mite\Exception\ApiClientError;
use Gamez\Mite\Exception\MiteException;

try {
    /** @var \Gamez\Mite\Api\ApiClient $apiClient */
    $result = $apiClient->get('nice-try');
} catch (ApiClientError $e) {
    $message = "Something went wrong while accessing {$e->getRequest()->getUri()}";

    if ($response = $e->getResponse()) {
        $message .= " ({$response->getStatusCode()})";
    }

    $message .= ' : '.$e->getMessage();

    exit($message);
} catch (MiteException $e) {
    exit('Something not API related went really wrong: '.$e->getMessage());
}

// Something went wrong while accessing https://xxx.mite.yo.lk/nice-try (404) :
// The URI /nice-try could not be found.

Roadmap

  • Tests
  • Interfaces and value objects
  • CLI tool
  • Better documentation
  • Using mite XML Backup files as a data backend