Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/php-api-clients/travis
:construction_worker: Async first TravisCI PHP API Client
https://github.com/php-api-clients/travis
api api-client async async-php hacktoberfest php php-api-clients php7 reactphp travis travis-ci
Last synced: about 1 month ago
JSON representation
:construction_worker: Async first TravisCI PHP API Client
- Host: GitHub
- URL: https://github.com/php-api-clients/travis
- Owner: php-api-clients
- License: mit
- Created: 2016-10-24T20:45:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T17:45:06.000Z (about 1 year ago)
- Last Synced: 2024-11-09T22:41:16.528Z (about 1 month ago)
- Topics: api, api-client, async, async-php, hacktoberfest, php, php-api-clients, php7, reactphp, travis, travis-ci
- Language: PHP
- Homepage: https://php-api-clients.org/clients/travis/
- Size: 640 KB
- Stars: 6
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Async first TravisCI API Client for PHP 7
[](https://travis-ci.org/php-api-clients/travis)
[](https://packagist.org/packages/api-clients/travis)
[](https://packagist.org/packages/api-clients/travis)
[](https://scrutinizer-ci.com/g/php-api-clients/travis/?branch=master)
[](https://packagist.org/packages/api-clients/travis)
[](https://travis-ci.org/php-api-clients/travis)
# Install
To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.
```
composer require api-clients/travis
```
# Usage
The client needs two things, the ReactPHP event loop, and optionally an authentication token. Once you created the client you can call the `user` method to show the currently authenticated user.
```php
use React\EventLoop\Factory;
use ApiClients\Client\Travis\AsyncClient;
use ApiClients\Client\Travis\Resource\UserInterface;
use function ApiClients\Foundation\resource_pretty_print;
$loop = Factory::create();
$client = AsyncClient::create(
$loop,
'your travis key from https://blog.travis-ci.com/2013-01-28-token-token-token/'
);
$client->user()->then(function (UserInterface $user) {
resource_pretty_print($user);
});
$loop->run();
```
## Results stream
The above example used a promise, when there is more then one result an observabe is returned instead. [`RxPHP`](https://github.com/reactivex/rxphp) is used for the observables. This means you can apply a huge list of methods to the stream of results
```php
use React\EventLoop\Factory;
use ApiClients\Client\Travis\AsyncClient;
use ApiClients\Client\Travis\Resource\BroadcastInterface;
use function ApiClients\Foundation\resource_pretty_print;
$loop = Factory::create();
$client = AsyncClient::create($loop, 'your key');
$client->broadcasts()->subscribe(function (BroadcastInterface $broadcast) {
resource_pretty_print($broadcast);
});
$loop->run();
```
# Synchronous usage
The synchronous client works nearly the same as the asynchronous, infact it wraps the asynchronous client to do all the work. This examples does the same as the asynchronous usage example.
```php
use ApiClients\Client\Travis\Client;
use function ApiClients\Foundation\resource_pretty_print;
$client = Client::create('your travis key');
resource_pretty_print($client->user());
```
## Synchronous results stream
Synchronous results streams are returned as an array.
```php
use ApiClients\Client\Travis\Client;
use function ApiClients\Foundation\resource_pretty_print;
$client = Client::create('your travis key');
foreach ($client->broadcasts() as $broadcast) {
resource_pretty_print($broadcast);
};
```
# Examples
The [`examples`](https://github.com/php-api-clients/travis/tree/master/examples) directory is filled with all kinds of examples for this package.
# License
The MIT License (MIT)
Copyright (c) 2017 Cees-Jan Kiewiet
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.