From 5f044ebf1bc6f45acec2e79dc05185acd0405f42 Mon Sep 17 00:00:00 2001 From: Lukas Reschke Date: Mon, 16 Mar 2015 11:28:23 +0100 Subject: Add wrapper for Guzzle --- lib/public/http/client/iclient.php | 181 ++++++++++++++++++++++++++++++ lib/public/http/client/iclientservice.php | 21 ++++ lib/public/http/client/iresponse.php | 37 ++++++ lib/public/iservercontainer.php | 8 ++ 4 files changed, 247 insertions(+) create mode 100644 lib/public/http/client/iclient.php create mode 100644 lib/public/http/client/iclientservice.php create mode 100644 lib/public/http/client/iresponse.php (limited to 'lib/public') diff --git a/lib/public/http/client/iclient.php b/lib/public/http/client/iclient.php new file mode 100644 index 00000000000..2946bcfa18d --- /dev/null +++ b/lib/public/http/client/iclient.php @@ -0,0 +1,181 @@ + + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OCP\Http\Client; + +/** + * Interface IClient + * + * @package OCP\Http + */ +interface IClient { + + /** + * Sends a GET request + * @param string $uri + * @param array $options Array such as + * 'query' => [ + * 'field' => 'abc', + * 'other_field' => '123', + * 'file_name' => fopen('/path/to/file', 'r'), + * ], + * 'headers' => [ + * 'foo' => 'bar', + * ], + * 'cookies' => [' + * 'foo' => 'bar', + * ], + * 'allow_redirects' => [ + * 'max' => 10, // allow at most 10 redirects. + * 'strict' => true, // use "strict" RFC compliant redirects. + * 'referer' => true, // add a Referer header + * 'protocols' => ['https'] // only allow https URLs + * ], + * 'save_to' => '/path/to/file', // save to a file or a stream + * 'verify' => true, // bool or string to CA file + * 'debug' => true, + * @return IResponse + * @throws \Exception If the request could not get completed + */ + public function get($uri, array $options = []); + + /** + * Sends a HEAD request + * @param string $uri + * @param array $options Array such as + * 'headers' => [ + * 'foo' => 'bar', + * ], + * 'cookies' => [' + * 'foo' => 'bar', + * ], + * 'allow_redirects' => [ + * 'max' => 10, // allow at most 10 redirects. + * 'strict' => true, // use "strict" RFC compliant redirects. + * 'referer' => true, // add a Referer header + * 'protocols' => ['https'] // only allow https URLs + * ], + * 'save_to' => '/path/to/file', // save to a file or a stream + * 'verify' => true, // bool or string to CA file + * 'debug' => true, + * @return IResponse + */ + public function head($uri, $options = []); + + /** + * Sends a POST request + * @param string $uri + * @param array $options Array such as + * 'body' => [ + * 'field' => 'abc', + * 'other_field' => '123', + * 'file_name' => fopen('/path/to/file', 'r'), + * ], + * 'headers' => [ + * 'foo' => 'bar', + * ], + * 'cookies' => [' + * 'foo' => 'bar', + * ], + * 'allow_redirects' => [ + * 'max' => 10, // allow at most 10 redirects. + * 'strict' => true, // use "strict" RFC compliant redirects. + * 'referer' => true, // add a Referer header + * 'protocols' => ['https'] // only allow https URLs + * ], + * 'save_to' => '/path/to/file', // save to a file or a stream + * 'verify' => true, // bool or string to CA file + * 'debug' => true, + * @return IResponse + */ + public function post($uri, array $options = []); + + /** + * Sends a PUT request + * @param string $uri + * @param array $options Array such as + * 'body' => [ + * 'field' => 'abc', + * 'other_field' => '123', + * 'file_name' => fopen('/path/to/file', 'r'), + * ], + * 'headers' => [ + * 'foo' => 'bar', + * ], + * 'cookies' => [' + * 'foo' => 'bar', + * ], + * 'allow_redirects' => [ + * 'max' => 10, // allow at most 10 redirects. + * 'strict' => true, // use "strict" RFC compliant redirects. + * 'referer' => true, // add a Referer header + * 'protocols' => ['https'] // only allow https URLs + * ], + * 'save_to' => '/path/to/file', // save to a file or a stream + * 'verify' => true, // bool or string to CA file + * 'debug' => true, + * @return IResponse + */ + public function put($uri, array $options = []); + + /** + * Sends a DELETE request + * @param string $uri + * @param array $options Array such as + * 'body' => [ + * 'field' => 'abc', + * 'other_field' => '123', + * 'file_name' => fopen('/path/to/file', 'r'), + * ], + * 'headers' => [ + * 'foo' => 'bar', + * ], + * 'cookies' => [' + * 'foo' => 'bar', + * ], + * 'allow_redirects' => [ + * 'max' => 10, // allow at most 10 redirects. + * 'strict' => true, // use "strict" RFC compliant redirects. + * 'referer' => true, // add a Referer header + * 'protocols' => ['https'] // only allow https URLs + * ], + * 'save_to' => '/path/to/file', // save to a file or a stream + * 'verify' => true, // bool or string to CA file + * 'debug' => true, + * @return IResponse + */ + public function delete($uri, array $options = []); + + /** + * Sends a options request + * @param string $uri + * @param array $options Array such as + * 'body' => [ + * 'field' => 'abc', + * 'other_field' => '123', + * 'file_name' => fopen('/path/to/file', 'r'), + * ], + * 'headers' => [ + * 'foo' => 'bar', + * ], + * 'cookies' => [' + * 'foo' => 'bar', + * ], + * 'allow_redirects' => [ + * 'max' => 10, // allow at most 10 redirects. + * 'strict' => true, // use "strict" RFC compliant redirects. + * 'referer' => true, // add a Referer header + * 'protocols' => ['https'] // only allow https URLs + * ], + * 'save_to' => '/path/to/file', // save to a file or a stream + * 'verify' => true, // bool or string to CA file + * 'debug' => true, + * @return IResponse + */ + public function options($uri, array $options = []); +} diff --git a/lib/public/http/client/iclientservice.php b/lib/public/http/client/iclientservice.php new file mode 100644 index 00000000000..4dc65f1721e --- /dev/null +++ b/lib/public/http/client/iclientservice.php @@ -0,0 +1,21 @@ + + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OCP\Http\Client; + +/** + * Interface IClientService + * + * @package OCP\Http + */ +interface IClientService { + /** + * @return IClient + */ + public function newClient(); +} diff --git a/lib/public/http/client/iresponse.php b/lib/public/http/client/iresponse.php new file mode 100644 index 00000000000..5355046a2a7 --- /dev/null +++ b/lib/public/http/client/iresponse.php @@ -0,0 +1,37 @@ + + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OCP\Http\Client; + +/** + * Interface IResponse + * + * @package OCP\Http + */ +interface IResponse { + /** + * @return string + */ + public function getBody(); + + /** + * @return int + */ + public function getStatusCode(); + + /** + * @param $key + * @return string + */ + public function getHeader($key); + + /** + * @return array + */ + public function getHeaders(); +} diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php index 20345e61212..a01ae5e200d 100644 --- a/lib/public/iservercontainer.php +++ b/lib/public/iservercontainer.php @@ -267,9 +267,17 @@ interface IServerContainer { /** * Returns an instance of the HTTP helper class * @return \OC\HTTPHelper + * @deprecated Use \OCP\Http\Client\IClientService */ function getHTTPHelper(); + /** + * Returns an instance of the HTTP client service + * + * @return \OCP\Http\Client\IClientService + */ + function getHTTPClientService(); + /** * Get the active event logger * -- cgit v1.2.3