runet-id/api-client

RUNET-ID API Client

Thursday, July 26, 2018
by RUVENTS
Repository
6 Watchers
0 Stars
4,262 Installations

PHP
3 Dependents
0 Suggesters
0 Forks
1 Open issues
64 Versions
32 % Grown

The README.md

Официальный API-клиент RUNET-ID для PHP

, _(*1)

Документация по API RUNET-ID., _(*2)

Установка

Выполните установку пакетов., _(*3)

$ composer require runet-id/api-client:^3.0@beta php-http/discovery guzzlehttp/psr7 php-http/guzzle6-adapter, _(*4)

Пакет php-http/discovery необходим для быстрого старта. Позднее Discovery можно заменить явными инъекциями HTTP-клиента и PSR-7 фабрик. Подробнее в разделе Удаление библиотеки Discovery., _(*5)

Вместо guzzlehttp/psr7 вы можете использовать любую имплементацию PSR-7 сообщений, например, zendframework/zend-diactoros., _(*6)

Вместо php-http/guzzle6-adapter вы можете использовать любую имплементацию HTTP-клиента, например, cURL client или Socket client., _(*7)

Использование

<?php

use Http\Discovery\MessageFactoryDiscovery;
use RunetId\Client\RunetIdClientFactory;
use RunetId\Client\Result\SuccessResult;

$factory = new RunetIdClientFactory();
$client = $factory->create('key', 'secret');

// Запрос с использованием встроенных подсказок по endpoint-ам RUNET-ID.
$user = $client->userGet()
    // метод setLanguage доступен во всех endpoint-ах
    ->setLanguage('en')
    ->setRunetId(1)
    ->getResult();

// Метод getResult возвращает размеченный phpDoc-свойствами класс.
$runetId = $user->RunetId;
$company = $user->Work->Company->Name;

// Чтобы получить исходный массив, используйте метод getRawResult.
$arrayUser = $client->userGet()
    ->setRunetId(1)
    ->getRawResult();

// Endpoint-ы можно использовать повторно.
$roleChanger = $client
    ->eventChangeRole()
    ->setRoleId(1);

$success1 = $roleChanger
    ->setRunetId(1)
    ->getResult()
    ->Success;

$success2 = $roleChanger
    ->setRunetId(2)
    ->getResult()
    ->Success;

// Данные можно передавать в свободной форме.
$company = $client
    ->companyGet()
    // Метод setQueryData() перезаписывает все параметры.
    ->setQueryData([
        'CompanyId' => 1,
    ])
    // Метод addQueryData() добавляет параметры, используя array_merge().
    ->addQueryData([
        'Language' => 'en',
    ])
    // Метод setQueryValue() устанавливает значение конкретного параметра,
    // перезаписывая предыдущее значение.
    ->setQueryValue('EventId', 123)
    ->getResult();

// Для POST запросов также доступны аналогичные методы (add|set)FormData() и setFormValue().
$client
    ->userEdit()
    ->setFormData([
        'RunetId' => 1,
        'Email' => '1@mail.ru',
    ])
    ->addFormData([
        'FirstName' => 'Имя',
    ])
    ->setFormValue('LastName', 'Фамилия')
    ->getResult();

// Чтобы сконструировать запрос от начала до конца,
// можно воспользоваться методом custom().

/** @var SuccessResult $result */
$result = $client
    ->custom()
    ->setMethod('PUT')
    ->setEndpoint('/some/put/endpoint')
    ->setLanguage('en')
    ->setQueryValue('param', 'value')
    ->setFormData([
        'FormParam' => 'FormParamValue',
    ])
    ->setClass(SuccessResult::class)
    ->getResult();

// Отправка свободного Psr\Http\Message\RequestInterface осуществляется через метод request().
// Schema, host и заголовки аутентификации будут подставлены автоматически.
$request = MessageFactoryDiscovery::find()
    ->createRequest('GET', '/user/get?RunetId=1');
$resultArray = $client->request($request);

Получение постраничных данных

Поставляемые с библиотекой endpoint-ы автоматически получают постраничные данные., _(*8)

<?php

// При условии наличия 900 регистраций на мероприятии и серверном ограничении в 200 сущностей:

$endpoint = $client->eventUsers();

iterator_count($endpoint->getResult()->Users); // 900 (5 запросов),
iterator_count($endpoint->setMaxResults(340)->getResult()->Users); // 340 (2 запроса).

Для запроса постраничных данных используеся метод RunetIdClient::requestPaginated(RequestInterface $request, string $itemsKey)., _(*9)

Аргумент $itemsKey принимает ключ, по которому можно найти массив постраничных данных. Например, для метода /event/users $itemsKey = 'Users''., _(*10)

В результирующем массиве по ключу $itemsKey будет содержаться генератор, обеспечивающий lazy-loading., _(*11)

Выбрасываемые исключения

Http\Client\Exception будет выброшено при ошибке выполнения запроса. Подробнее о классах исключений HTTPLUG. В частности,, _(*12)
- Http\Client\Common\Exception\ClientErrorException будет выброшено при коде ответа 4xx,
- Http\Client\Common\Exception\ServerErrorException будет выброшено при коде ответа 5xx.
```
<?php

try {
    $client->userGet()
        ->setRunetId(1)
        ->getResult();
} catch (Http\Client\Common\Exception\ServerErrorException $exception) {
    $statusCode = $exception->getResponse()->getStatusCode();
}
```

RunetId\Client\Exception\JsonDecodeException будет выброшено при ошибке парсинга JSON., _(*13)

<?php

try {
    $client->userGet()
        ->setRunetId(1)
        ->getResult();
} catch (RunetId\Client\Exception\JsonDecodeException $exception) {
    $jsonErrorMsg = $exception->getMessage();
    $jsonErrorCode = $exception->getCode();
    $invalidString = $exception->getInvalidString();
}

RunetId\Client\Exception\RunetIdException будет выброшено при ошибке API RUNET-ID., _(*14)

<?php

try {
    $client->userGet()
        ->setRunetId(1)
        ->getResult();
} catch (RunetId\Client\Exception\RunetIdException $exception) {
    $errorMessage = $exception->getMessage();
    $errorCode = $exception->getCode();
    // Метод getData() возвращает полный массив данных из ответа API.
    $data = $exception->getData();
}

RunetId\Client\Exception\ResultFactoryException будет выброшено при ошибке создания объекта результата., _(*15)
RunetId\Client\Exception\UnexpectedPaginatedDataException будет выброшено при неверном формате ответа в методе RunetIdClient::requestPaginated()., _(*16)

Подробнее об объектах Result

<?php

$result = $client
    ->userGet()
    ->setRunetId(1)
    ->getResult();

// Вы можете обращаться к неразмеченным свойствам.
$result->SomeNewProperty;

// Для простоты при запросе несуществующих в исходном массиве данных
// объект не будет генерировать исключения. Вместо этого будет возвращен null.
// Это может быть полезно при обращении к свойствам,
// которые могут быть не включены в выдачу вследствие недостаточных прав.
$result->SomeLimitedAccessProperty; // null

// Чтобы проверить существование свойства в исходном массиве, используйте exists().
$hasStatus = $result->exists('Status');

// Результат является обходимым.
foreach ($result as $key => $value) {
    printf("%s: %s\n", $key, $value);
}

Конфигурация

<?php

use RunetId\Client\RunetIdClientFactory;

// Установка параметров query по умолчанию.
$factory = new RunetIdClientFactory();
$client = $factory->create(
    'key',
    'secret',
    RunetIdClientFactory::API_URI.'?Language=en&EventId=123'
);

// Использование другого базового url.
$factory = new RunetIdClientFactory();
$client = $factory->create(
    'key',
    'secret',
    'http://localhost:8000/endpoint-prefix/?Language=en'
);

Поставляемая с библиотекой фабрика также позволяет использовать любые плагины проекта PHP-HTTP. Для этого передайте массив плагинов 4-ым аргументом., _(*17)

Например, для логгирования запросов при помощи PSR-3 логгера, установите пакет php-http/logger-plugin и подключите плагин к клиенту RUNET-ID (подробнее в документации PHP-HTTP)., _(*18)

<?php

use Http\Client\Common\Plugin\LoggerPlugin;
use RunetId\Client\RunetIdClientFactory;

$loggerPlugin = new LoggerPlugin(
    // Здесь может быть любая имплементация Psr\Log\LoggerInterface.
    new Monolog\Logger('http')
);

$factory = new RunetIdClientFactory();
$client = $factory->create(
    'key',
    'secret',
    null,
    null,
    // Http\Client\Common\Plugin[]
    [$loggerPlugin]
);

5-ым аргументом можно передать специально сконфигурированный для создаваемого клиента экземпляр Http\Client\HttpClient, который будет декорирован фабрикой для работы с RUNET-ID. По умолчанию используется HTTP-клиент, переданный в конструктор фабрики или клиент, найденный Discovery., _(*19)

Удаление библиотеки Discovery

Библиотека php-http/discovery позволяет находить установленные имплементации HTTP-клиента и PSR-7 фабрик и, например, использовать их в качестве инъекций по умолчанию., _(*20)

Зависимость от php-http/discovery мягкая. Чтобы удалить данный пакет из сборки, необходимо явно передать в конструктор фабрики имплементации HTTP-клиента и PSR-7 фабрик., _(*21)

Например, если в проекте используется Guzzle 6, инициализация фабрики будет выглядеть следующим образом:, _(*22)

<?php

$httpClient = new Http\Adapter\Guzzle6\Client();
$uriFactory = new Http\Message\UriFactory\GuzzleUriFactory();
$requestFactory = new Http\Message\MessageFactory\GuzzleMessageFactory();
$streamFactory = new Http\Message\StreamFactory\GuzzleStreamFactory();

$runetIdFactory = new RunetId\Client\RunetIdClientFactory($httpClient, $uriFactory, $requestFactory, $streamFactory);

После этого можно удалить пакет Discovery composer remove php-http/discovery., _(*23)

Тестирование

vendor/bin/simple-phpunit --coverage-text, _(*24)

The Versions

26/07 2018

dev-master

9999999-dev

RUNET-ID API Client

library api-client

RUNET-ID API Client

runet-id/api-client

The README.md

Официальный API-клиент RUNET-ID для PHP

Установка

Использование

Получение постраничных данных

Выбрасываемые исключения

Подробнее об объектах Result

Конфигурация

Удаление библиотеки Discovery

Тестирование

The Versions

dev-master

The Requires

The Development Requires

by Valentin Udaltsov

3.0.0-beta3

The Requires

The Development Requires

by Valentin Udaltsov

v3.0.0-beta2

The Requires

The Development Requires

by Valentin Udaltsov

3.0.0-beta1

The Requires

The Development Requires

by Valentin Udaltsov

dev-3.0-beta-dev

The Requires

The Development Requires

by Valentin Udaltsov

3.0.0-alpha6

The Requires

The Development Requires

by Valentin Udaltsov

3.0.0-alpha5

The Requires

The Development Requires

by Valentin Udaltsov

2.1.x-dev

The Requires

by Valentin Udaltsov

2.1.38

The Requires

by Valentin Udaltsov

3.0.0-alpha4

The Requires

The Development Requires

by Valentin Udaltsov

3.0.0-alpha3

The Requires

The Development Requires

by Valentin Udaltsov

3.0.0-alpha2

The Requires

The Development Requires

by Valentin Udaltsov

3.0.0-alpha1

The Requires

The Development Requires

by Valentin Udaltsov

2.1.37

The Requires

by Valentin Udaltsov

2.1.36

The Requires

by Valentin Udaltsov

dev-meetings

The Requires

by Valentin Udaltsov

2.1.35

The Requires

by Valentin Udaltsov

2.1.34

The Requires

by Valentin Udaltsov

2.1.33