Client::get() - Code Metrics - Inspection of "Merged in freshleafmedia/bitbucket-api/feature/src..." - gentlero/bitbucket-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 1568c4...251f08 )

by Alexandru

created 2019-07-17 05:49 UTC

Client::get() A

↳ Parent: Client

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	5
cts	5
cp	1
rs	9.9666
c	0
b	0
f	0
cc	4
nc	3
nop	3
crap	4

<?php

/**
 * This file is part of the bitbucket-api package.
 *
 * (c) Alexandru G. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Bitbucket\API\Http;

use Buzz\Client\ClientInterface as BuzzClientInterface;
use Buzz\Client\Curl;
use Buzz\Message\MessageInterface;
use Buzz\Message\RequestInterface;
use Buzz\Message\Request;
use Buzz\Message\Response;
use Bitbucket\API\Http\Listener\ListenerInterface;

/**
 * @author  Alexandru G.    <[email protected]>
 */
class Client extends ClientListener implements ClientInterface
{
    /**
     * @var array
     */
    protected $options = array(
        'base_url'      => 'https://api.bitbucket.org',
        'api_version'   => '1.0',
        'api_versions'  => array('1.0', '2.0'),     // supported versions
        'format'        => 'json',
        'formats'       => array('json', 'xml'),    // supported response formats
        'user_agent'    => 'bitbucket-api-php/1.1.2 (https://bitbucket.org/gentlero/bitbucket-api)',
        'timeout'       => 10,
        'verify_peer'   => true
    );

    /**
     * @var BuzzClientInterface
     */
    protected $client;

    /**
     * @var RequestInterface
     */
    private $lastRequest;

    /**
     * @var MessageInterface
     */
    private $lastResponse;

    /**
     * @var MessageInterface
     */
    protected $responseObj;

    /**
     * @var RequestInterface
     */
    protected $requestObj;

    public function __construct(array $options = array(), BuzzClientInterface $client = null)
    {
        $this->client   = (null === $client) ? new Curl() : $client;
        $this->options  = array_merge($this->options, $options);

        $this->client->setTimeout($this->options['timeout']);
        $this->client->setVerifyPeer($this->options['verify_peer']);
    }

    /**
     * {@inheritdoc}
     */
    public function get($endpoint, $params = array(), $headers = array())
    {
        if (is_array($params) && count($params) > 0) {
            $endpoint   .= (strpos($endpoint, '?') === false ? '?' : '&').http_build_query($params, '', '&');
            $params     = array();
        }

        return $this->request($endpoint, $params, 'GET', $headers);
    }

    /**
     * {@inheritdoc}
     */
    public function post($endpoint, $params = array(), $headers = array())
    {
        return $this->request($endpoint, $params, 'POST', $headers);
    }

    /**
     * {@inheritdoc}
     */
    public function put($endpoint, $params = array(), $headers = array())
    {
        return $this->request($endpoint, $params, 'PUT', $headers);
    }

    /**
     * {@inheritdoc}
     */
    public function delete($endpoint, $params = array(), $headers = array())
    {
        return $this->request($endpoint, $params, 'DELETE', $headers);
    }

    /**
     * {@inheritdoc}
     */
    public function request($endpoint, $params = array(), $method = 'GET', array $headers = array())
    {
        //$request = $this->createRequest($method, $endpoint);
        $request = ($this->requestObj !== null) ? $this->requestObj : $this->createRequest($method, $endpoint);

        // add a default content-type if none was set
        if (empty($headers['Content-Type']) && in_array(strtoupper($method), array('POST', 'PUT'), true)) {
            $headers['Content-Type'] = 'application/x-www-form-urlencoded';
        }

        if (count($headers) > 0) {
            $request->addHeaders($headers);
        }

        $paramsString = null;
        if (is_array($params) && count($params) > 0) {
            $paramsString = http_build_query($params);
        }

        if (is_string($paramsString) && $paramsString !== null) {
            $request->setContent($paramsString);
        }

        if (is_string($params) && $params !== null) {
            $request->setContent($params);
        }

        $response = is_object($this->responseObj) ? $this->responseObj : new Response();

        $this->executeListeners($request, 'preSend');

        $this->client->send($request, $response);

        $this->executeListeners($request, 'postSend', $response);

        $this->lastRequest  = $request;
        $this->lastResponse = $response;

        return $response;
    }

    /**
     * @access public
     * @return BuzzClientInterface
     */
    public function getClient()
    {
        return $this->client;
    }

    /**
     * {@inheritdoc}
     */
    public function getResponseFormat()
    {
        return $this->options['format'];
    }

    /**
     * {@inheritdoc}
     */
    public function setResponseFormat($format)
    {
        if (!in_array($format, $this->options['formats'], true)) {
            throw new \InvalidArgumentException(sprintf('Unsupported response format %s', $format));
        }

        $this->options['format'] = $format;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getApiVersion()
    {
        return $this->options['api_version'];
    }

    /**
     * {@inheritdoc}
     */
    public function setApiVersion($version)
    {
        if (!in_array($version, $this->options['api_versions'], true)) {
            throw new \InvalidArgumentException(sprintf('Unsupported API version %s', $version));
        }

        $this->options['api_version'] = $version;

        return $this;
    }

    /**
     * Check if specified API version is the one currently in use.
     *
     * @access public
     * @param  float $version
     * @return bool
     */
    public function isApiVersion($version)
    {
        return abs($this->options['api_version'] - $version) < 0.00001;
    }

    /**
     * {@inheritdoc}
     */
    public function getApiBaseUrl()
    {
        return $this->options['base_url'].'/'.$this->getApiVersion();
    }

    /**
     * @access public
     * @return MessageInterface
     */
    public function getLastRequest()
    {
        return $this->lastRequest;
    }

    /**
     * @access public
     * @return RequestInterface
     */
    public function getLastResponse()
    {
        return $this->lastResponse;
    }

    /**
     * @access public
     * @param  MessageInterface $response
     * @return void
     */
    public function setResponse(MessageInterface $response)
    {
        $this->responseObj = $response;
    }

    /**
     * @access public
     * @param  RequestInterface $request
     * @return void
     */
    public function setRequest(RequestInterface $request)
    {
        $this->requestObj = $request;
    }

    /**
     * @access protected
     * @param  string           $method
     * @param  string           $url
     * @return RequestInterface
     */
    protected function createRequest($method, $url)
    {
        // do not set base URL if a full one was provided
        if (false === strpos($url, $this->getApiBaseUrl())) {
            $url = $this->getApiBaseUrl().'/'.$url;
        }

        // change the response format
        if ($this->getApiVersion() === '1.0' && strpos($url, 'format=') === false) {
            $url .= (strpos($url, '?') === false ? '?' : '&').'format='.$this->getResponseFormat();
        }

        $request = is_object($this->requestObj) ? $this->requestObj : new Request();
        $request->setMethod($method);
        $request->addHeaders(array(
                'User-Agent' => $this->options['user_agent']
            ));
        $request->setProtocolVersion(1.1);
        $request->fromUrl($url);

        return $request;
    }

    /**
     * Execute all available listeners.
     *
     * $when can be: preSend or postSend
     *
     * @access protected
     * @param RequestInterface $request
     * @param string           $when     When to execute the listener
     * @param MessageInterface $response
     */
    protected function executeListeners(RequestInterface $request, $when = 'preSend', MessageInterface $response = null)
    {
        $haveListeners  = count($this->listeners) > 0;

        if (!$haveListeners) {
            return;
        }

        $params = array($request);

        if (null !== $response) {
            $params[] = $response;
        }

        ksort($this->listeners, SORT_ASC);

        array_walk_recursive(
            $this->listeners,
            function ($class) use ($when, $params) {
                if ($class instanceof ListenerInterface) {
                    call_user_func_array(array($class, $when), $params);
                }
            }
        );
    }
}


1		<?php
2
3		/**
4		* This file is part of the bitbucket-api package.
5		*
6		* (c) Alexandru G. <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11		namespace Bitbucket\API\Http;
12
13		use Buzz\Client\ClientInterface as BuzzClientInterface;
14		use Buzz\Client\Curl;
15		use Buzz\Message\MessageInterface;
16		use Buzz\Message\RequestInterface;
17		use Buzz\Message\Request;
18		use Buzz\Message\Response;
19		use Bitbucket\API\Http\Listener\ListenerInterface;
20
21		/**
22		* @author Alexandru G. <[email protected]>
23		*/
24		class Client extends ClientListener implements ClientInterface
25		{
26		/**
27		* @var array
28		*/
29		protected $options = array(
30		'base_url' => 'https://api.bitbucket.org',
31		'api_version' => '1.0',
32		'api_versions' => array('1.0', '2.0'), // supported versions
33		'format' => 'json',
34		'formats' => array('json', 'xml'), // supported response formats
35		'user_agent' => 'bitbucket-api-php/1.1.2 (https://bitbucket.org/gentlero/bitbucket-api)',
36		'timeout' => 10,
37		'verify_peer' => true
38		);
39
40		/**
41		* @var BuzzClientInterface
42		*/
43		protected $client;
44
45		/**
46		* @var RequestInterface
47		*/
48		private $lastRequest;
49
50		/**
51		* @var MessageInterface
52		*/
53		private $lastResponse;
54
55		/**
56		* @var MessageInterface
57		*/
58		protected $responseObj;
59
60		/**
61		* @var RequestInterface
62		*/
63		protected $requestObj;
64
65	312	public function __construct(array $options = array(), BuzzClientInterface $client = null)
66		{
67	312	$this->client = (null === $client) ? new Curl() : $client;
68	312	$this->options = array_merge($this->options, $options);
69
70	312	$this->client->setTimeout($this->options['timeout']);
71	312	$this->client->setVerifyPeer($this->options['verify_peer']);
72	312	}
73
74		/**
75		* {@inheritdoc}
76		*/
77	8	public function get($endpoint, $params = array(), $headers = array())
78		{
79	8	if (is_array($params) && count($params) > 0) {
80	1	$endpoint .= (strpos($endpoint, '?') === false ? '?' : '&').http_build_query($params, '', '&');
81	1	$params = array();
82		}
83
84	8	return $this->request($endpoint, $params, 'GET', $headers);
85		}
86
87		/**
88		* {@inheritdoc}
89		*/
90	3	public function post($endpoint, $params = array(), $headers = array())
91		{
92	3	return $this->request($endpoint, $params, 'POST', $headers);
93		}
94
95		/**
96		* {@inheritdoc}
97		*/
98	1	public function put($endpoint, $params = array(), $headers = array())
99		{
100	1	return $this->request($endpoint, $params, 'PUT', $headers);
101		}
102
103		/**
104		* {@inheritdoc}
105		*/
106	1	public function delete($endpoint, $params = array(), $headers = array())
107		{
108	1	return $this->request($endpoint, $params, 'DELETE', $headers);
109		}
110
111		/**
112		* {@inheritdoc}
113		*/
114	16	public function request($endpoint, $params = array(), $method = 'GET', array $headers = array())
115		{
116		//$request = $this->createRequest($method, $endpoint);
117	16	$request = ($this->requestObj !== null) ? $this->requestObj : $this->createRequest($method, $endpoint);
118
119		// add a default content-type if none was set
120	16	if (empty($headers['Content-Type']) && in_array(strtoupper($method), array('POST', 'PUT'), true)) {
121	2	$headers['Content-Type'] = 'application/x-www-form-urlencoded';
122		}
123
124	16	if (count($headers) > 0) {
125	10	$request->addHeaders($headers);
126		}
127
128	16	$paramsString = null;
129	16	if (is_array($params) && count($params) > 0) {
130	4	$paramsString = http_build_query($params);
131		}
132
133	16	if (is_string($paramsString) && $paramsString !== null) {
134	4	$request->setContent($paramsString);
135		}
136
137	16	if (is_string($params) && $params !== null) {
138	2	$request->setContent($params);
139		}
140
141	16	$response = is_object($this->responseObj) ? $this->responseObj : new Response();
142
143	16	$this->executeListeners($request, 'preSend');
144
145	14	$this->client->send($request, $response);
146
147	14	$this->executeListeners($request, 'postSend', $response);
148
149	14	$this->lastRequest = $request;
150	14	$this->lastResponse = $response;
151
152	14	return $response;
153		}
154
155		/**
156		* @access public
157		* @return BuzzClientInterface
158		*/
159	1	public function getClient()
160		{
161	1	return $this->client;
162		}
163
164		/**
165		* {@inheritdoc}
166		*/
167	12	public function getResponseFormat()
168		{
169	12	return $this->options['format'];
170		}
171
172		/**
173		* {@inheritdoc}
174		*/
175	4	public function setResponseFormat($format)
176		{
177	4	if (!in_array($format, $this->options['formats'], true)) {
178	2	throw new \InvalidArgumentException(sprintf('Unsupported response format %s', $format));
179		}
180
181	3	$this->options['format'] = $format;
182
183	3	return $this;
184		}
185
186		/**
187		* {@inheritdoc}
188		*/
189	17	public function getApiVersion()
190		{
191	17	return $this->options['api_version'];
192		}
193
194		/**
195		* {@inheritdoc}
196		*/
197	111	public function setApiVersion($version)
198		{
199	111	if (!in_array($version, $this->options['api_versions'], true)) {
200	8	throw new \InvalidArgumentException(sprintf('Unsupported API version %s', $version));
201		}
202
203	103	$this->options['api_version'] = $version;
204
205	103	return $this;
206		}
207
208		/**
209		* Check if specified API version is the one currently in use.
210		*
211		* @access public
212		* @param float $version
213		* @return bool
214		*/
215	1	public function isApiVersion($version)
216		{
217	1	return abs($this->options['api_version'] - $version) < 0.00001;
218		}
219
220		/**
221		* {@inheritdoc}
222		*/
223	16	public function getApiBaseUrl()
224		{
225	16	return $this->options['base_url'].'/'.$this->getApiVersion();
226		}
227
228		/**
229		* @access public
230		* @return MessageInterface
231		*/
232	7	public function getLastRequest()
233		{
234	7	return $this->lastRequest;
235		}
236
237		/**
238		* @access public
239		* @return RequestInterface
240		*/
241	2	public function getLastResponse()
242		{
243	2	return $this->lastResponse;
244		}
245
246		/**
247		* @access public
248		* @param MessageInterface $response
249		* @return void
250		*/
251		public function setResponse(MessageInterface $response)
252		{
253		$this->responseObj = $response;
254		}
255
256		/**
257		* @access public
258		* @param RequestInterface $request
259		* @return void
260		*/
261	1	public function setRequest(RequestInterface $request)
262		{
263	1	$this->requestObj = $request;
264	1	}
265
266		/**
267		* @access protected
268		* @param string $method
269		* @param string $url
270		* @return RequestInterface
271		*/
272	15	protected function createRequest($method, $url)
273		{
274		// do not set base URL if a full one was provided
275	15	if (false === strpos($url, $this->getApiBaseUrl())) {
276	14	$url = $this->getApiBaseUrl().'/'.$url;
277		}
278
279		// change the response format
280	15	if ($this->getApiVersion() === '1.0' && strpos($url, 'format=') === false) {
281	9	$url .= (strpos($url, '?') === false ? '?' : '&').'format='.$this->getResponseFormat();
282		}
283
284	15	$request = is_object($this->requestObj) ? $this->requestObj : new Request();
285	15	$request->setMethod($method);
286	15	$request->addHeaders(array(
287	15	'User-Agent' => $this->options['user_agent']
288		));
289	15	$request->setProtocolVersion(1.1);
290	15	$request->fromUrl($url);
291
292	15	return $request;
293		}
294
295		/**
296		* Execute all available listeners.
297		*
298		* $when can be: preSend or postSend
299		*
300		* @access protected
301		* @param RequestInterface $request
302		* @param string $when When to execute the listener
303		* @param MessageInterface $response
304		*/
305	16	protected function executeListeners(RequestInterface $request, $when = 'preSend', MessageInterface $response = null)
306		{
307	16	$haveListeners = count($this->listeners) > 0;
308
309	16	if (!$haveListeners) {
310	10	return;
311		}
312
313	6	$params = array($request);
314
315	6	if (null !== $response) {
316	4	$params[] = $response;
317		}
318
319	6	ksort($this->listeners, SORT_ASC);
320
321	6	array_walk_recursive(
322	6	$this->listeners,
323	6	function ($class) use ($when, $params) {
324	6	if ($class instanceof ListenerInterface) {
325	6	call_user_func_array(array($class, $when), $params);
326		}
327	6	}
328		);
329	4	}
330		}
331

gentlero / bitbucket-api

Notification Setup Error

Push — develop ( 1568c4...251f08 )

Client::get() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like