Guzzle — PHP HTTP-клиент

Чтобы монолог был доступен в вашем проекте, вам нужно изменить файл composer.json и запустить команду обновления composer. Ваш файл composer.json должен выглядеть следующим образом:

  { "name": "jd/guzzle demo", "authors": [ { "name": "John Doe", "email": "john@doe.tst" } ], "require": { "guzzle/guzzle": "~3.7", "monolog/monolog": "1.6.0" } } 

Чтобы заставить Guzzle использовать монолог и писать все запросы и ответы, которые мы отправляем и получаем, нам нужно внести некоторые изменения в наш код:

  <?php chdir(dirname(__DIR__)); require_once 'vendor/autoload.php'; //... use Guzzle\Log\MessageFormatter; use Guzzle\Log\MonologLogAdapter; use Guzzle\Plugin\Log\LogPlugin; use Monolog\Handler\StreamHandler; use Monolog\Logger; $logger = new Logger('client'); $logger->pushHandler(new StreamHandler('guzzle.log')); $logAdapter = new MonologLogAdapter($logger); $logPlugin = new LogPlugin($logAdapter, MessageFormatter::DEBUG_FORMAT); /** @var $client Client */ $client = new Client("https://qrng.anu.edu.au"); $client->addSubscriber($logPlugin); 

Сначала мы создаем экземпляр монолога с помощью $logger = new Logger('client'); , Monolog обладает несколькими обработчиками, в этом случае мы будем использовать StreamHandler для записи в файл с именем guzzle.log . Затем мы создаем монологический адаптер жадности, создавая экземпляр объекта MonologLogAdapter. Затем мы создаем объект подключаемого модуля журнала, используя менеджер подключаемых модулей журнала Guzzle LogPlugin. Обратите внимание на константу MessageFormatter::DEBUG_FORMAT которая указывает Guzzle регистрировать полные сообщения с запросами и ответами. Пожалуйста, обратитесь к документации Guzzle, чтобы увидеть, какие форматы сообщений доступны. Наконец, мы добавляем плагин log-файла в клиент $client->addSubscriber($logPlugin); вызывая $client->addSubscriber($logPlugin);

Взаимодействие с Github API

Давайте посмотрим на этот код, а затем я объясню его построчно

  <?php chdir(dirname(__DIR__)); require_once 'vendor/autoload.php'; use Guzzle\http\Client; use Guzzle\Log\MonologLogAdapter; use Guzzle\Plugin\Log\LogPlugin; use Guzzle\Log\MessageFormatter; use Monolog\Logger; use Monolog\Handler\StreamHandler; $client = new Client('https://api.github.com'); $log = new Logger('log'); $log->pushHandler(new StreamHandler('requests.log')); $adapter = new MonologLogAdapter($log); $logPlugin = new LogPlugin($adapter, MessageFormatter::DEBUG_FORMAT); $client->addSubscriber($logPlugin); $request = $client->post('authorizations', array(), json_encode( array( 'scopes' => array( 'public_repo', 'user', 'repo', 'gist' ), 'note' => 'auto client' . uniqid() ))); $request->setAuth('john@doe.tst', 'yourpasswordhere'); $request->getCurlOptions()->set(CURLOPT_SSL_VERIFYPEER, false); $response = $request->send(); $body = json_decode($response->getBody(true)); $oauthToken = $body->token; $request = $client->get('user/keys'); $query = $request->getQuery(); $query->add('access_token', $oauthToken); $request->getCurlOptions()->set(CURLOPT_SSL_VERIFYPEER, false); try { $response = $request->send(); $body = $response->getBody(true); echo $body; } catch (Exception $e) { echo $request->getResponse()->getRawHeaders(); } 

Подробное объяснение приведено ниже.

 $client = new Client('https://api.github.com'); 

Мы создаем клиента, который будет использовать базовый URL Github API.

  $log = new Logger('log'); $log->pushHandler(new StreamHandler('requests.log')); $adapter = new MonologLogAdapter($log); $logPlugin = new LogPlugin($adapter, MessageFormatter::DEBUG_FORMAT); $client->addSubscriber($logPlugin); 

Как мы уже видели, мы настроили возможности ведения журналов, чтобы мы могли отлаживать проблемы связи.

  $request = $client->post('authorizations', array(), json_encode( array( 'scopes' => array( 'public_repo', 'user', 'repo', 'gist' ), 'note' => 'auto client' . uniqid() ))); 

Сначала мы хотим запросить авторизацию для использования API Github ( http://developer.github.com/v3/oauth/ ) без необходимости каждый раз использовать имя пользователя и пароль, поэтому нам нужно выполнить HTTP-глагол POST для https://api.github.com/authorizations . Помните, что мы создали базовый URL при создании нашего клиента, поэтому нам нужно только указать путь. Чтобы увидеть список возможных параметров, которые можно отправить в API Github, обратитесь к их документации.

  $request->setAuth('john@doe.tst', 'yourpasswordhere'); $request->getCurlOptions()->set(CURLOPT_SSL_VERIFYPEER, false); 

В этот раз мы будем использовать HTTP Basic Authentication. Помните, что единственным механизмом, препятствующим отправке ваших учетных данных в виде простого текста, является HTTPS (как показано в URL-адресе API) — выполнение запроса через что-то настолько небезопасное, что HTTP может привести к тому, что кто-то перехватит ваши данные. Во второй строке мы настраиваем cURL, чтобы не проверять сертификат SSL, так как это может решить несколько проблем связи.

  $response = $request->send(); $body = json_decode($response->getBody(true)); 

Наконец мы отправляем запрос. Ответ получен через метод getBody (), флаг TRUE используется для настройки Guzzle на возврат простой строки. Помните, что API Github является RESTful, поэтому все будет закодировано в JSON, и, таким образом, мы будем декодировать его в объект с помощью json_decode ().

  $oauthToken = $body->token; 

Токен Oauth будет находиться внутри атрибута ‘token’. Пожалуйста, обратитесь к документации Github API для подробного объяснения формата ответа.

  $request = $client->get('user/keys'); $query = $request->getQuery(); $query->add('access_token', $oauthToken); 

Мы будем выполнять новый запрос. На этот раз мы хотим перечислить наши авторизованные ключи, которые настроены в нашей учетной записи, в основном для доступа к нашим репозиториям через SSH. На этот раз необходимо отправить HTTP-запрос GET, но вместо использования наших учетных данных в виде простого текста мы будем использовать выданный нам токен Oauth; этот токен должен быть добавлен в качестве параметра запроса к URL-адресу, который мы запрашиваем.

  $response = $request->send(); $body = $response->getBody(true); echo $body; 

Наконец, мы отправляем запрос и получаем тело ответа, готовое для анализа и использования в любых целях.

Вывод

Эта небольшая демонстрация — лишь вершина айсберга того, на что способен Guzzle. С хорошо структурированной системой плагинов, механизмом обработки запросов и ответов вы можете, наконец, приручить большое количество API, которые может предложить Интернет.

Если у вас есть конкретный пример использования Guzzle, который вы хотели бы продемонстрировать, или просто общие замечания, дайте нам знать!