BaseClient::doRequest() - Code Metrics - Inspection of "Tracking section." - tricae-br/iris - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

unknown

created 2015-11-30 18:15 UTC

BaseClient::doRequest() A

↳ Parent: BaseClient

Complexity

Conditions	2
Paths	2

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	21
ccs	13
cts	13
cp	1
rs	9.3143
cc	2
eloc	12
nc	2
nop	3
crap	2

<?php

namespace Iris\Api;

use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\Exception\RequestException;

abstract class BaseClient
{
    const RESPONSE_OK = 200;

    const RESPONSE_OK_NO_BODY = 204;

    /**
     * @var \GuzzleHttp\Client
     */
    protected $client;

    /**
     * @var string
     */
    protected $version;

    /**
     * @var string
     */
    protected $partner;

    /**
     * @var string
     */
    protected $accessToken;

    /**
     * @var string
     */
    protected $venture;

    /**
     * @var string
     */
    protected $uniqueId;

    /**
     * @var \Psr\Log\LoggerInterface
     */
    protected $logger;

    /**
     * @param \Iris\Interfaces\Configuration $configuration
     * @param \Psr\Log\LoggerInterface $logger
     */
    public function __construct(
        \Iris\Interfaces\Configuration $configuration,
        \Psr\Log\LoggerInterface $logger
    ) {
        $this->partner      = $configuration->getVenture();
        $this->venture      = $configuration->getVenture();
        $this->uniqueId     = uniqid();
        $this->logger       = $logger;

        $this->loadClient($configuration->getConnection());
    }

    /**
     * @param \Iris\Interfaces\Connection $connection
     */
    protected function loadClient(\Iris\Interfaces\Connection $connection)
    {
        $this->version      = $connection->getVersion();
        $this->accessToken  = $connection->getAccessToken();

        $this->loadGuzzle($connection->getBaseUrl());
    }

    /**
     * @param string $baseUrl
     */
    protected function loadGuzzle($baseUrl)
    {
        $this->client = new HttpClient(array(
            'base_url' => $baseUrl,
            'defaults' => array(
                'headers' => array(
                    'Accept' => 'application/json',
                    'Content-Type' => 'application/json'
                )
            )
        ));
    }

    /**
     * @return string
     */
    public function getUniqueId()
    {
        return $this->uniqueId;
    }

    /**
     * @return string
     */
    public function getVersion()
    {
        return $this->version;
    }

    /**
     * @return string
     */
    public function getVenture()
    {
        return $this->venture;
    }

    /**
     * @return string
     */
    public function getPartner()
    {
        return $this->partner;
    }

    /**
     * @return string
     */
    public function getAccessToken()
    {
        return $this->accessToken;
    }

    /**
     * @return \GuzzleHttp\Client
     */
    public function getClient()
    {
        return $this->client;
    }

    /**TODO generalize this method to be used by Bob as venture
     * Builds path to call api.
     * @param string $callPath Suffix path, the action.
     * @param string $venture Venture code.
     * @return string
     */
    protected function buildRequestUrl($callPath, $venture)
    {
        $requestUrl = sprintf(
            'api/%s/gfg/%s/%s',
            $this->getVersion(),
            $this->getPartner(),
            $venture
        );
        return $requestUrl . $callPath;
    }

    /**
     * @param \Exception $exception
     * @param string $message
     * @param array $context
     * @throw \Iris\Exceptions\RetryMessage
     */
    public function throwException(\Exception $exception, $message, array $context = [])
    {
        $message = $message . ' ( Exception message: ' . $exception->getMessage() . ')';
        $this->logger->error($message, $context);

        $retryMessage = 'Try Again';
        $code = 500;

        if ($exception instanceof RequestException) {
            $this->logResponse($exception->getResponse());

            $retryMessage = $exception->getResponse()->getBody();
            $code         = $exception->getResponse()->getStatusCode();
        }

        throw new \Iris\Exceptions\RetryMessage($retryMessage, $code);
    }

    /**
     * @param string $url
     * @param $body
     * @return \GuzzleHttp\Message\Response
     */
    protected function create($url, $body)
    {
        return $this->doRequest(
            'post',
            $url,
            array(
                'body' => json_encode($body),
                'headers' => ['venture-access-token' => $this->getAccessToken(), 'venture-key' => $this->getVenture()],
                'exceptions' => false
            )
        );
    }

    /**
     * @param string $url
     * @param $body
     * @return \GuzzleHttp\Message\Response
     */
    protected function update($url, $body)
    {
        return $this->doRequest(
            'put',
            $url,
            array(
                'body' => json_encode($body),
                'headers' => ['venture-access-token' => $this->getAccessToken(), 'venture-key' => $this->getVenture()],
                'exceptions' => false
            )
        );
    }

    /**
     * @param string $method
     * @param string $url
     * @param array $options
     * @return \GuzzleHttp\Message\Response
     */
    protected function doRequest($method, $url, $options = array())
    {
        $message = sprintf(
            '%s REQUEST TO: %s -- OPTIONS %s',
            $this->getUniqueId(),
            $url,
            json_encode($options)
        );

        $this->logger->info($message);

        $response = $this->getClient()->$method($url, $options);

        $this->logResponse($response);

        if (!$this->isResponseOk($response)) {
            throw new \Iris\Exceptions\RetryMessage($response->getBody(), $response->getStatusCode());
        }

        return $response;
    }

    /**
     * @param \GuzzleHttp\Message\ResponseInterface $response
     * @return void
     */
    protected function logResponse(\GuzzleHttp\Message\ResponseInterface $response)
    {
        $message = sprintf(
            '%s RESPONSE: %s -- HTTP CODE %s -- BODY %s',
            $this->getUniqueId(),
            $response->getEffectiveUrl(),
            $response->getStatusCode(),
            $response->getBody()
        );

        $this->logger->info($message);
    }

    /**
     * @param \GuzzleHttp\Message\ResponseInterface $response
     * @return bool
     */
    protected function isResponseOk(\GuzzleHttp\Message\ResponseInterface $response)
    {
        return in_array($response->getStatusCode(), array(static::RESPONSE_OK, static::RESPONSE_OK_NO_BODY));
    }
}


1		<?php
2
3		namespace Iris\Api;
4
5		use GuzzleHttp\Client as HttpClient;
6		use GuzzleHttp\Exception\RequestException;
7
8		abstract class BaseClient
9		{
10		const RESPONSE_OK = 200;
11
12		const RESPONSE_OK_NO_BODY = 204;
13
14		/**
15		* @var \GuzzleHttp\Client
16		*/
17		protected $client;
18
19		/**
20		* @var string
21		*/
22		protected $version;
23
24		/**
25		* @var string
26		*/
27		protected $partner;
28
29		/**
30		* @var string
31		*/
32		protected $accessToken;
33
34		/**
35		* @var string
36		*/
37		protected $venture;
38
39		/**
40		* @var string
41		*/
42		protected $uniqueId;
43
44		/**
45		* @var \Psr\Log\LoggerInterface
46		*/
47		protected $logger;
48
49		/**
50		* @param \Iris\Interfaces\Configuration $configuration
51		* @param \Psr\Log\LoggerInterface $logger
52		*/
53	32	public function __construct(
54		\Iris\Interfaces\Configuration $configuration,
55		\Psr\Log\LoggerInterface $logger
56		) {
57	32	$this->partner = $configuration->getVenture();
58	32	$this->venture = $configuration->getVenture();
59	32	$this->uniqueId = uniqid();
60	32	$this->logger = $logger;
61
62	32	$this->loadClient($configuration->getConnection());
63	32	}
64
65		/**
66		* @param \Iris\Interfaces\Connection $connection
67		*/
68	32	protected function loadClient(\Iris\Interfaces\Connection $connection)
69		{
70	32	$this->version = $connection->getVersion();
71	32	$this->accessToken = $connection->getAccessToken();
72
73	32	$this->loadGuzzle($connection->getBaseUrl());
74	32	}
75
76		/**
77		* @param string $baseUrl
78		*/
79		protected function loadGuzzle($baseUrl)
80		{
81		$this->client = new HttpClient(array(
82		'base_url' => $baseUrl,
83		'defaults' => array(
84		'headers' => array(
85		'Accept' => 'application/json',
86		'Content-Type' => 'application/json'
87		)
88		)
89		));
90		}
91
92		/**
93		* @return string
94		*/
95	27	public function getUniqueId()
96		{
97	27	return $this->uniqueId;
98		}
99
100		/**
101		* @return string
102		*/
103	26	public function getVersion()
104		{
105	26	return $this->version;
106		}
107
108		/**
109		* @return string
110		*/
111	20	public function getVenture()
112		{
113	20	return $this->venture;
114		}
115
116		/**
117		* @return string
118		*/
119	7	public function getPartner()
120		{
121	7	return $this->partner;
122		}
123
124		/**
125		* @return string
126		*/
127	20	public function getAccessToken()
128		{
129	20	return $this->accessToken;
130		}
131
132		/**
133		* @return \GuzzleHttp\Client
134		*/
135		public function getClient()
136		{
137		return $this->client;
138		}
139
140		/**TODO generalize this method to be used by Bob as venture
141		* Builds path to call api.
142		* @param string $callPath Suffix path, the action.
143		* @param string $venture Venture code.
144		* @return string
145		*/
146	6	protected function buildRequestUrl($callPath, $venture)
147		{
148	6	$requestUrl = sprintf(
149	6	'api/%s/gfg/%s/%s',
150	6	$this->getVersion(),
151	6	$this->getPartner(),
152		$venture
153	6	);
154	6	return $requestUrl . $callPath;
155		}
156
157		/**
158		* @param \Exception $exception
159		* @param string $message
160		* @param array $context
161		* @throw \Iris\Exceptions\RetryMessage
162		*/
163	2	public function throwException(\Exception $exception, $message, array $context = [])
164		{
165	2	$message = $message . ' ( Exception message: ' . $exception->getMessage() . ')';
166	2	$this->logger->error($message, $context);
167
168	2	$retryMessage = 'Try Again';
169	2	$code = 500;
170
171	2	if ($exception instanceof RequestException) {
172	1	$this->logResponse($exception->getResponse());
173
174	1	$retryMessage = $exception->getResponse()->getBody();
175	1	$code = $exception->getResponse()->getStatusCode();
176	1	}
177
178	2	throw new \Iris\Exceptions\RetryMessage($retryMessage, $code);
179		}
180
181		/**
182		* @param string $url
183		* @param $body
184		* @return \GuzzleHttp\Message\Response
185		*/
186	2	protected function create($url, $body)
187		{
188	2	return $this->doRequest(
189	2	'post',
190	2	$url,
191		array(
192	2	'body' => json_encode($body),
193	2	'headers' => ['venture-access-token' => $this->getAccessToken(), 'venture-key' => $this->getVenture()],
194		'exceptions' => false
195	2	)
196	2	);
197		}
198
199		/**
200		* @param string $url
201		* @param $body
202		* @return \GuzzleHttp\Message\Response
203		*/
204	17	protected function update($url, $body)
205		{
206	17	return $this->doRequest(
207	17	'put',
208	17	$url,
209		array(
210	17	'body' => json_encode($body),
211	17	'headers' => ['venture-access-token' => $this->getAccessToken(), 'venture-key' => $this->getVenture()],
212		'exceptions' => false
213	17	)
214	17	);
215		}
216
217		/**
218		* @param string $method
219		* @param string $url
220		* @param array $options
221		* @return \GuzzleHttp\Message\Response
222		*/
223	25	protected function doRequest($method, $url, $options = array())
224		{
225	25	$message = sprintf(
226	25	'%s REQUEST TO: %s -- OPTIONS %s',
227	25	$this->getUniqueId(),
228	25	$url,
229	25	json_encode($options)
230	25	);
231
232	25	$this->logger->info($message);
233
234	25	$response = $this->getClient()->$method($url, $options);
235
236	14	$this->logResponse($response);
237
238	14	if (!$this->isResponseOk($response)) {
239	3	throw new \Iris\Exceptions\RetryMessage($response->getBody(), $response->getStatusCode());
240		}
241
242	11	return $response;
243		}
244
245		/**
246		* @param \GuzzleHttp\Message\ResponseInterface $response
247		* @return void
248		*/
249	15	protected function logResponse(\GuzzleHttp\Message\ResponseInterface $response)
250		{
251	15	$message = sprintf(
252	15	'%s RESPONSE: %s -- HTTP CODE %s -- BODY %s',
253	15	$this->getUniqueId(),
254	15	$response->getEffectiveUrl(),
255	15	$response->getStatusCode(),
256	15	$response->getBody()
257	15	);
258
259	15	$this->logger->info($message);
260	15	}
261
262		/**
263		* @param \GuzzleHttp\Message\ResponseInterface $response
264		* @return bool
265		*/
266	14	protected function isResponseOk(\GuzzleHttp\Message\ResponseInterface $response)
267		{
268	14	return in_array($response->getStatusCode(), array(static::RESPONSE_OK, static::RESPONSE_OK_NO_BODY));
269		}
270		}
271

tricae-br / iris

Pull Request — master (#2)

BaseClient::doRequest() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like