Client::put() - Code Metrics - Inspection of "Merge pull request #21473 from owncloud/fix-unit-t..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c77917...12b0e9 )

by Jörn Friedrich

created 2016-01-06 12:43 UTC

Client::put() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	3
nc	1
nop	2
crap	1

<?php
/**
 * @author Lukas Reschke <[email protected]>
 * @author Robin Appelman <[email protected]>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\Http\Client;

use GuzzleHttp\Client as GuzzleClient;
use OCP\Http\Client\IClient;
use OCP\ICertificateManager;
use OCP\IConfig;

/**
 * Class Client
 *
 * @package OC\Http
 */
class Client implements IClient {
	/** @var GuzzleClient */
	private $client;
	/** @var IConfig */
	private $config;
	/** @var ICertificateManager */
	private $certificateManager;

	/**
	 * @param IConfig $config
	 * @param ICertificateManager $certificateManager
	 * @param GuzzleClient $client
	 */
	public function __construct(IConfig $config,
								ICertificateManager $certificateManager,
								GuzzleClient $client) {
		$this->config = $config;
		$this->client = $client;
		$this->certificateManager = $certificateManager;
		$this->setDefaultOptions();
	}

	/**
	 * Sets the default options to the client
	 */
	private function setDefaultOptions() {
		// Either use default bundle or the user bundle if nothing is specified
		if($this->certificateManager->listCertificates() !== []) {
			$dataDir = $this->config->getSystemValue('datadirectory');
			$this->client->setDefaultOption('verify', $dataDir.'/'.$this->certificateManager->getCertificateBundle());
		} else {
			$this->client->setDefaultOption('verify', \OC::$SERVERROOT . '/resources/config/ca-bundle.crt');
		}

		$this->client->setDefaultOption('headers/User-Agent', 'ownCloud Server Crawler');
		if($this->getProxyUri() !== '') {
			$this->client->setDefaultOption('proxy', $this->getProxyUri());
		}
	}

	/**
	 * Get the proxy URI
	 * @return string
	 */
	private function getProxyUri() {
		$proxyHost = $this->config->getSystemValue('proxy', null);
		$proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', null);
		$proxyUri = '';

		if(!is_null($proxyUserPwd)) {
			$proxyUri .= $proxyUserPwd.'@';
		}
		if(!is_null($proxyHost)) {
			$proxyUri .= $proxyHost;
		}

		return $proxyUri;
	}

	/**
	 * 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,
	 *              'timeout' => 5,
	 * @return Response
	 * @throws \Exception If the request could not get completed
	 */
	public function get($uri, array $options = []) {
		$response = $this->client->get($uri, $options);
		$isStream = isset($options['stream']) && $options['stream'];
		return new Response($response, $isStream);
	}

	/**
	 * 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,
	 *              'timeout' => 5,
	 * @return Response
	 * @throws \Exception If the request could not get completed
	 */
	public function head($uri, $options = []) {
		$response = $this->client->head($uri, $options);
		return new Response($response);
	}

	/**
	 * 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,
	 *              'timeout' => 5,
	 * @return Response
	 * @throws \Exception If the request could not get completed
	 */
	public function post($uri, array $options = []) {
		$response = $this->client->post($uri, $options);
		return new Response($response);
	}

	/**
	 * 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,
	 *              'timeout' => 5,
	 * @return Response
	 * @throws \Exception If the request could not get completed
	 */
	public function put($uri, array $options = []) {
		$response = $this->client->put($uri, $options);
		return new Response($response);
	}

	/**
	 * 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,
	 *              'timeout' => 5,
	 * @return Response
	 * @throws \Exception If the request could not get completed
	 */
	public function delete($uri, array $options = []) {
		$response = $this->client->delete($uri, $options);
		return new Response($response);
	}


	/**
	 * 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,
	 *              'timeout' => 5,
	 * @return Response
	 * @throws \Exception If the request could not get completed
	 */
	public function options($uri, array $options = []) {
		$response = $this->client->options($uri, $options);
		return new Response($response);
	}
}


1		<?php
2		/**
3		* @author Lukas Reschke <[email protected]>
4		* @author Robin Appelman <[email protected]>
5		*
6		* @copyright Copyright (c) 2015, ownCloud, Inc.
7		* @license AGPL-3.0
8		*
9		* This code is free software: you can redistribute it and/or modify
10		* it under the terms of the GNU Affero General Public License, version 3,
11		* as published by the Free Software Foundation.
12		*
13		* This program is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		* GNU Affero General Public License for more details.
17		*
18		* You should have received a copy of the GNU Affero General Public License, version 3,
19		* along with this program. If not, see <http://www.gnu.org/licenses/>
20		*
21		*/
22
23		namespace OC\Http\Client;
24
25		use GuzzleHttp\Client as GuzzleClient;
26		use OCP\Http\Client\IClient;
27		use OCP\ICertificateManager;
28		use OCP\IConfig;
29
30		/**
31		* Class Client
32		*
33		* @package OC\Http
34		*/
35		class Client implements IClient {
36		/** @var GuzzleClient */
37		private $client;
38		/** @var IConfig */
39		private $config;
40		/** @var ICertificateManager */
41		private $certificateManager;
42
43		/**
44		* @param IConfig $config
45		* @param ICertificateManager $certificateManager
46		* @param GuzzleClient $client
47		*/
48	9	public function __construct(IConfig $config,
49		ICertificateManager $certificateManager,
50		GuzzleClient $client) {
51	9	$this->config = $config;
52	9	$this->client = $client;
53	9	$this->certificateManager = $certificateManager;
54	9	$this->setDefaultOptions();
55	9	}
56
57		/**
58		* Sets the default options to the client
59		*/
60	9	private function setDefaultOptions() {
61		// Either use default bundle or the user bundle if nothing is specified
62	9	if($this->certificateManager->listCertificates() !== []) {
63	9	$dataDir = $this->config->getSystemValue('datadirectory');
64	9	$this->client->setDefaultOption('verify', $dataDir.'/'.$this->certificateManager->getCertificateBundle());
65	9	} else {
66		$this->client->setDefaultOption('verify', \OC::$SERVERROOT . '/resources/config/ca-bundle.crt');
67		}
68
69	9	$this->client->setDefaultOption('headers/User-Agent', 'ownCloud Server Crawler');
70	9	if($this->getProxyUri() !== '') {
71		$this->client->setDefaultOption('proxy', $this->getProxyUri());
72		}
73	9	}
74
75		/**
76		* Get the proxy URI
77		* @return string
78		*/
79	9	private function getProxyUri() {
80	9	$proxyHost = $this->config->getSystemValue('proxy', null);
81	9	$proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', null);
82	9	$proxyUri = '';
83
84	9	if(!is_null($proxyUserPwd)) {
85	1	$proxyUri .= $proxyUserPwd.'@';
86	1	}
87	9	if(!is_null($proxyHost)) {
88	2	$proxyUri .= $proxyHost;
89	2	}
90
91	9	return $proxyUri;
92		}
93
94		/**
95		* Sends a GET request
96		* @param string $uri
97		* @param array $options Array such as
98		* 'query' => [
99		* 'field' => 'abc',
100		* 'other_field' => '123',
101		* 'file_name' => fopen('/path/to/file', 'r'),
102		* ],
103		* 'headers' => [
104		* 'foo' => 'bar',
105		* ],
106		* 'cookies' => ['
107		* 'foo' => 'bar',
108		* ],
109		* 'allow_redirects' => [
110		* 'max' => 10, // allow at most 10 redirects.
111		* 'strict' => true, // use "strict" RFC compliant redirects.
112		* 'referer' => true, // add a Referer header
113		* 'protocols' => ['https'] // only allow https URLs
114		* ],
115		* 'save_to' => '/path/to/file', // save to a file or a stream
116		* 'verify' => true, // bool or string to CA file
117		* 'debug' => true,
118		* 'timeout' => 5,
119		* @return Response
120		* @throws \Exception If the request could not get completed
121		*/
122	1	public function get($uri, array $options = []) {
123	1	$response = $this->client->get($uri, $options);
124	1	$isStream = isset($options['stream']) && $options['stream'];
125	1	return new Response($response, $isStream);
126		}
127
128		/**
129		* Sends a HEAD request
130		* @param string $uri
131		* @param array $options Array such as
132		* 'headers' => [
133		* 'foo' => 'bar',
134		* ],
135		* 'cookies' => ['
136		* 'foo' => 'bar',
137		* ],
138		* 'allow_redirects' => [
139		* 'max' => 10, // allow at most 10 redirects.
140		* 'strict' => true, // use "strict" RFC compliant redirects.
141		* 'referer' => true, // add a Referer header
142		* 'protocols' => ['https'] // only allow https URLs
143		* ],
144		* 'save_to' => '/path/to/file', // save to a file or a stream
145		* 'verify' => true, // bool or string to CA file
146		* 'debug' => true,
147		* 'timeout' => 5,
148		* @return Response
149		* @throws \Exception If the request could not get completed
150		*/
151		public function head($uri, $options = []) {
152		$response = $this->client->head($uri, $options);
153		return new Response($response);
154		}
155
156		/**
157		* Sends a POST request
158		* @param string $uri
159		* @param array $options Array such as
160		* 'body' => [
161		* 'field' => 'abc',
162		* 'other_field' => '123',
163		* 'file_name' => fopen('/path/to/file', 'r'),
164		* ],
165		* 'headers' => [
166		* 'foo' => 'bar',
167		* ],
168		* 'cookies' => ['
169		* 'foo' => 'bar',
170		* ],
171		* 'allow_redirects' => [
172		* 'max' => 10, // allow at most 10 redirects.
173		* 'strict' => true, // use "strict" RFC compliant redirects.
174		* 'referer' => true, // add a Referer header
175		* 'protocols' => ['https'] // only allow https URLs
176		* ],
177		* 'save_to' => '/path/to/file', // save to a file or a stream
178		* 'verify' => true, // bool or string to CA file
179		* 'debug' => true,
180		* 'timeout' => 5,
181		* @return Response
182		* @throws \Exception If the request could not get completed
183		*/
184	1	public function post($uri, array $options = []) {
185	1	$response = $this->client->post($uri, $options);
186	1	return new Response($response);
187		}
188
189		/**
190		* Sends a PUT request
191		* @param string $uri
192		* @param array $options Array such as
193		* 'body' => [
194		* 'field' => 'abc',
195		* 'other_field' => '123',
196		* 'file_name' => fopen('/path/to/file', 'r'),
197		* ],
198		* 'headers' => [
199		* 'foo' => 'bar',
200		* ],
201		* 'cookies' => ['
202		* 'foo' => 'bar',
203		* ],
204		* 'allow_redirects' => [
205		* 'max' => 10, // allow at most 10 redirects.
206		* 'strict' => true, // use "strict" RFC compliant redirects.
207		* 'referer' => true, // add a Referer header
208		* 'protocols' => ['https'] // only allow https URLs
209		* ],
210		* 'save_to' => '/path/to/file', // save to a file or a stream
211		* 'verify' => true, // bool or string to CA file
212		* 'debug' => true,
213		* 'timeout' => 5,
214		* @return Response
215		* @throws \Exception If the request could not get completed
216		*/
217	1	public function put($uri, array $options = []) {
218	1	$response = $this->client->put($uri, $options);
219	1	return new Response($response);
220		}
221
222		/**
223		* Sends a DELETE request
224		* @param string $uri
225		* @param array $options Array such as
226		* 'body' => [
227		* 'field' => 'abc',
228		* 'other_field' => '123',
229		* 'file_name' => fopen('/path/to/file', 'r'),
230		* ],
231		* 'headers' => [
232		* 'foo' => 'bar',
233		* ],
234		* 'cookies' => ['
235		* 'foo' => 'bar',
236		* ],
237		* 'allow_redirects' => [
238		* 'max' => 10, // allow at most 10 redirects.
239		* 'strict' => true, // use "strict" RFC compliant redirects.
240		* 'referer' => true, // add a Referer header
241		* 'protocols' => ['https'] // only allow https URLs
242		* ],
243		* 'save_to' => '/path/to/file', // save to a file or a stream
244		* 'verify' => true, // bool or string to CA file
245		* 'debug' => true,
246		* 'timeout' => 5,
247		* @return Response
248		* @throws \Exception If the request could not get completed
249		*/
250	1	public function delete($uri, array $options = []) {
251	1	$response = $this->client->delete($uri, $options);
252	1	return new Response($response);
253		}
254
255
256		/**
257		* Sends a options request
258		* @param string $uri
259		* @param array $options Array such as
260		* 'body' => [
261		* 'field' => 'abc',
262		* 'other_field' => '123',
263		* 'file_name' => fopen('/path/to/file', 'r'),
264		* ],
265		* 'headers' => [
266		* 'foo' => 'bar',
267		* ],
268		* 'cookies' => ['
269		* 'foo' => 'bar',
270		* ],
271		* 'allow_redirects' => [
272		* 'max' => 10, // allow at most 10 redirects.
273		* 'strict' => true, // use "strict" RFC compliant redirects.
274		* 'referer' => true, // add a Referer header
275		* 'protocols' => ['https'] // only allow https URLs
276		* ],
277		* 'save_to' => '/path/to/file', // save to a file or a stream
278		* 'verify' => true, // bool or string to CA file
279		* 'debug' => true,
280		* 'timeout' => 5,
281		* @return Response
282		* @throws \Exception If the request could not get completed
283		*/
284	1	public function options($uri, array $options = []) {
285	1	$response = $this->client->options($uri, $options);
286	1	return new Response($response);
287		}
288		}
289

owncloud / core

Push — master ( c77917...12b0e9 )

Client::put() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like