From 47d3cd2ed79de2798b32f32e80cefab55effe92b Mon Sep 17 00:00:00 2001 From: Thierry Goettelmann Date: Thu, 6 Aug 2015 15:15:10 +0200 Subject: [PATCH] Update Guzzle to 6.0 Rewrite API for to support new Guzzle 6.0 --- composer.json | 2 +- src/Api.php | 200 ++++++++++++++++++++++++++++---------------------- 2 files changed, 113 insertions(+), 89 deletions(-) diff --git a/composer.json b/composer.json index dc36127..7ace00a 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "description": "Wrapper for OVH APIs", "license": "BSD-3-Clause", "require": { - "guzzlehttp/guzzle": ">=4.0,<6.0" + "guzzlehttp/guzzle": "^6.0" }, "authors": [ { diff --git a/src/Api.php b/src/Api.php index ba28784..ef3de42 100644 --- a/src/Api.php +++ b/src/Api.php @@ -30,8 +30,9 @@ namespace Ovh; -use GuzzleHttp\Client as GClient; -use GuzzleHttp\Stream\Stream; +use GuzzleHttp\Client; +use GuzzleHttp\Psr7\Request; +use GuzzleHttp\Psr7\Response; /** * Wrapper to manage login and exchanges with simpliest Ovh API @@ -41,74 +42,90 @@ use GuzzleHttp\Stream\Stream; * Http connections use guzzle http client api and result of request are * object from this http wrapper * - * @package Ovh + * @package Ovh * @category Ovh - * @author Vincent Cassé + * @author Vincent Cassé + * @author Thierry Goettelmann */ class Api { - /** * Url to communicate with Ovh API + * + * @var array */ - private $endpoints = array( - 'ovh-eu' => 'https://api.ovh.com/1.0', - 'ovh-ca' => 'https://ca.api.ovh.com/1.0', - 'kimsufi-eu' => 'https://eu.api.kimsufi.com/1.0', - 'kimsufi-ca' => 'https://ca.api.kimsufi.com/1.0', + private $endpoints = [ + 'ovh-eu' => 'https://api.ovh.com/1.0', + 'ovh-ca' => 'https://ca.api.ovh.com/1.0', + 'kimsufi-eu' => 'https://eu.api.kimsufi.com/1.0', + 'kimsufi-ca' => 'https://ca.api.kimsufi.com/1.0', 'soyoustart-eu' => 'https://eu.api.soyoustart.com/1.0', 'soyoustart-ca' => 'https://ca.api.soyoustart.com/1.0', - 'runabove-ca' => 'https://api.runabove.com/1.0'); + 'runabove-ca' => 'https://api.runabove.com/1.0', + ]; /** * Contain endpoint selected to choose API + * + * @var string */ private $endpoint = null; /** * Contain key of the current application + * + * @var string */ private $application_key = null; /** * Contain secret of the current application + * + * @var string */ private $application_secret = null; /** * Contain consumer key of the current application + * + * @var string */ private $consumer_key = null; /** * Contain delta between local timestamp and api server timestamp + * + * @var string */ private $time_delta = null; /** * Contain http client connection + * + * @var Client */ private $http_client = null; /** * Construct a new wrapper instance * - * @param $application_key key of your application. - * For OVH APIs, you can create a application's credentials on https://api.ovh.com/createApp/ - * @param $application_secret secret of your application. - * @param $api_endpoint name of api selected - * @param $consumer_key If you have already a consumer key, this parameter prevent to do a - * new authentication - * @param $http_client instance of http client + * @param string $application_key key of your application. + * For OVH APIs, you can create a application's credentials on + * https://api.ovh.com/createApp/ + * @param string $application_secret secret of your application. + * @param string $api_endpoint name of api selected + * @param string $consumer_key If you have already a consumer key, this parameter prevent to do a + * new authentication + * @param Client $http_client instance of http client * - * @throws InvalidParameterException if one parameter is missing or with bad value + * @throws Exceptions\InvalidParameterException if one parameter is missing or with bad value */ public function __construct( $application_key, $application_secret, $api_endpoint, $consumer_key = null, - GClient $http_client = null + Client $http_client = null ) { if (!isset($application_key)) { throw new Exceptions\InvalidParameterException("Application key parameter is empty"); @@ -127,29 +144,31 @@ class Api } if (!isset($http_client)) { - $http_client = new GClient(); + $http_client = new Client(); } - $this->application_key = $application_key; - $this->endpoint = $this->endpoints[$api_endpoint]; + $this->application_key = $application_key; + $this->endpoint = $this->endpoints[$api_endpoint]; $this->application_secret = $application_secret; - $this->http_client = $http_client; - $this->consumer_key = $consumer_key; - $this->time_delta = null; + $this->http_client = $http_client; + $this->consumer_key = $consumer_key; + $this->time_delta = null; } /** * Calculate time delta between local machine and API's server * * @throws \GuzzleHttp\Exception\ClientException if http request is an error + * @return int */ private function calculateTimeDelta() { if (!isset($this->time_delta)) { - $response = $this->http_client->get($this->endpoint . "/auth/time"); - $serverTimestamp = (int) (String) $response->getBody(); - $this->time_delta = $serverTimestamp - (int) \time(); + $response = $this->http_client->get($this->endpoint . "/auth/time"); + $serverTimestamp = (int)(String)$response->getBody(); + $this->time_delta = $serverTimestamp - (int)\time(); } + return $this->time_delta; } @@ -157,16 +176,17 @@ class Api * Request a consumer key from the API and the validation link to * authorize user to validate this consumer key * - * @param $accessRules list of rules your application need. - * @param $redirection url to redirect on your website after authentication + * @param array $accessRules list of rules your application need. + * @param string $redirection url to redirect on your website after authentication * + * @return mixed * @throws \GuzzleHttp\Exception\ClientException if http request is an error */ public function requestCredentials( - $accessRules, + array $accessRules, $redirection = null ) { - $parameters = new \StdClass(); + $parameters = new \StdClass(); $parameters->accessRules = $accessRules; $parameters->redirection = $redirection; @@ -179,6 +199,7 @@ class Api ); $this->consumer_key = $response["consumerKey"]; + return $response; } @@ -186,42 +207,44 @@ class Api * This is the main method of this wrapper. It will * sign a given query and return its result. * - * @param $method HTTP method of request (GET,POST,PUT,DELETE) - * @param $path relative url of API request - * @param $content body of the request - * @param $is_authenticated if the request use authentication + * @param string $method HTTP method of request (GET,POST,PUT,DELETE) + * @param string $path relative url of API request + * @param \stdClass|array|null $content body of the request + * @param bool $is_authenticated if the request use authentication * + * @return array * @throws \GuzzleHttp\Exception\ClientException if http request is an error */ - private function rawCall( - $method, - $path, - $content = null, - $is_authenticated = true - ) { - $url = $this->endpoint . $path; - - $request = $this->http_client->createRequest( - $method, - $url - ); + private function rawCall($method, $path, $content = null, $is_authenticated = true) + { + $url = $this->endpoint . $path; + $request = new Request($method, $url); if (isset($content) && $method == 'GET') { - $query = $request->getQuery(); - foreach ($content as $key => $value) { - $query->set($key, $value); - } - $url .= '?'.$query; - $body = ""; + + $queryString = $request->getUri()->getQuery(); + + $query = false !== strpos($queryString, '&') + ? explode('&', $queryString) + : []; + + $query = array_merge($query, (array)$content); + $query = \GuzzleHttp\Psr7\build_query($query); + + $request = $request->withUri($request->getUri()->withQuery($query)); + $body = ""; } elseif (isset($content)) { $body = json_encode($content); - $request->setBody(Stream::factory($body)); + + $request->getBody()->write($body); } else { $body = ""; } - $request->setHeader('Content-Type', 'application/json; charset=utf-8'); - $request->setHeader('X-Ovh-Application', $this->application_key); + $headers = [ + 'Content-Type' => 'application/json; charset=utf-8', + 'X-Ovh-Application' => $this->application_key, + ]; if ($is_authenticated) { if (!isset($this->time_delta)) { @@ -229,75 +252,76 @@ class Api } $now = time() + $this->time_delta; - $request->setHeader('X-Ovh-Timestamp', $now); + $headers['X-Ovh-Timestamp'] = $now; if (isset($this->consumer_key)) { - $toSign = $this->application_secret.'+'.$this->consumer_key.'+'.$method.'+'.$url.'+'.$body.'+'.$now; - $signature = '$1$' . sha1($toSign); - $request->setHeader('X-Ovh-Consumer', $this->consumer_key); - $request->setHeader('X-Ovh-Signature', $signature); + $toSign = $this->application_secret . '+' . $this->consumer_key . '+' . $method + . '+' . $url . '+' . $body . '+' . $now; + $signature = '$1$' . sha1($toSign); + $headers['X-Ovh-Consumer'] = $this->consumer_key; + $headers['X-Ovh-Signature'] = $signature; } } - return $this->http_client->send($request)->json(); + + /** @var Response $response */ + $response = $this->http_client->send($request, ['headers' => $headers]); + + return json_decode($response->getBody(), true); } /** * Wrap call to Ovh APIs for GET requests * - * @param $path path ask inside api - * @param $content content to send inside body of request + * @param string $path path ask inside api + * @param array $content content to send inside body of request * + * @return array * @throws \GuzzleHttp\Exception\ClientException if http request is an error */ - public function get( - $path, - $content = null - ) { + public function get($path, $content = null) + { return $this->rawCall("GET", $path, $content); } /** * Wrap call to Ovh APIs for POST requests * - * @param $path path ask inside api - * @param $content content to send inside body of request + * @param string $path path ask inside api + * @param array $content content to send inside body of request * + * @return array * @throws \GuzzleHttp\Exception\ClientException if http request is an error */ - public function post( - $path, - $content = null - ) { + public function post($path, $content = null) + { return $this->rawCall("POST", $path, $content); } /** * Wrap call to Ovh APIs for PUT requests * - * @param $path path ask inside api - * @param $content content to send inside body of request + * @param string $path path ask inside api + * @param array $content content to send inside body of request * + * @return array * @throws \GuzzleHttp\Exception\ClientException if http request is an error */ - public function put( - $path, - $content - ) { + public function put($path, $content) + { return $this->rawCall("PUT", $path, $content); } /** * Wrap call to Ovh APIs for DELETE requests * - * @param $path path ask inside api - * @param $content content to send inside body of request + * @param string $path path ask inside api + * @param array $content content to send inside body of request * + * @return array * @throws \GuzzleHttp\Exception\ClientException if http request is an error */ - public function delete( - $path, - $content = null - ) { + public function delete($path, $content = null) + { return $this->rawCall("DELETE", $path, $content); }