kevintweber/gauges

PHP wrapper for the gaug.es API.

v1.0 2017-03-17 01:17 UTC

README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score

[Gauges] (http://get.gaug.es/) is a real-time website analytics service. This small library is designed to make consuming the [Gauges API] (http://get.gaug.es/documentation/) simple using PHP.

Installation

The recommended way to install this library is using [Composer] (http://getcomposer.org).

$ composer require kevintweber/gauges

Usage

Consuming the Gauges API with this library is super simple:

use Kevintweber\Gauges\Factory;

// Create the request object.
$request = Factory::createRequest($your_gauges_api_token);

// Optionally, set a PSR-3 logger.
$request->setLogger($logger);

// Make an API call.
$response = $request->gaugeDetail($gauge_id);

// The response is a Psr7 response.
$content = (string) $response->getContent();
$data = json_decode($content, true);

This library utilizes the Guzzle 6 library to make the API requests. To understand what else you can do with the response object, please refer to the [Guzzle documentation] (http://guzzle.readthedocs.org/en/latest/).

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email kevintweber@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.