HttpApi::hydrateResponse() - Code Metrics - Inspection of "Return null if 204 (#7)" - Happyr/php-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d32c79...658521 )

by Tobias

created 2017-06-08 15:45 UTC

HttpApi::hydrateResponse() B

↳ Parent: HttpApi

Complexity

Conditions	5
Paths	4

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	8
nc	4
nop	2

<?php

namespace Happyr\ApiClient\Api;

use Happyr\ApiClient\Exception\Domain as DomainExceptions;
use Happyr\ApiClient\Exception\DomainException;
use Happyr\ApiClient\Hydrator\Hydrator;
use Happyr\ApiClient\Hydrator\NoopHydrator;
use Http\Client\HttpClient;
use Http\Message\RequestFactory;
use Psr\Http\Message\ResponseInterface;

/**
 * @author Tobias Nyholm <[email protected]>
 */
abstract class HttpApi
{
    /**
     * @var HttpClient
     */
    protected $httpClient;

    /**
     * @var Hydrator
     */
    protected $hydrator;

    /**
     * @var RequestFactory
     */
    protected $requestFactory;

    /**
     * @param HttpClient     $httpClient
     * @param RequestFactory $requestFactory
     * @param Hydrator       $hydrator
     */
    public function __construct(HttpClient $httpClient, Hydrator $hydrator, RequestFactory $requestFactory)
    {
        $this->httpClient = $httpClient;
        $this->requestFactory = $requestFactory;
        if (!$hydrator instanceof NoopHydrator) {
            $this->hydrator = $hydrator;
        }
    }

    /**
     * @param ResponseInterface $response
     * @param string            $class
     *
     * @throws \Exception
     *
     * @return mixed|ResponseInterface
     */
    protected function hydrateResponse(ResponseInterface $response, $class)
    {
        if (!$this->hydrator) {
            return $response;
        }

        if ($response->getStatusCode() === 204) {
            return null;
        }

        if ($response->getStatusCode() !== 200 && $response->getStatusCode() !== 201) {
            $this->handleErrors($response);
        }

        return $this->hydrator->hydrate($response, $class);
    }

    /**
     * Send a GET request with query parameters.
     *
     * @param string $path           Request path
     * @param array  $params         GET parameters
     * @param array  $requestHeaders Request Headers
     *
     * @return ResponseInterface
     */
    protected function httpGet($path, array $params = [], array $requestHeaders = [])

    {
        if (count($params) > 0) {
            $path .= '?'.http_build_query($params);
        }

        return $this->httpClient->sendRequest(
            $this->requestFactory->createRequest('GET', $path, $requestHeaders)
        );
    }

    /**
     * Send a POST request with JSON-encoded parameters.
     *
     * @param string $path           Request path
     * @param array  $params         POST parameters to be JSON encoded
     * @param array  $requestHeaders Request headers
     *
     * @return ResponseInterface
     */
    protected function httpPost($path, array $params = [], array $requestHeaders = [])
    {
        $requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';

        return $this->httpPostRaw($path, http_build_query($params), $requestHeaders);
    }

    /**
     * Send a POST request with raw data.
     *
     * @param string       $path           Request path
     * @param array|string $body           Request body
     * @param array        $requestHeaders Request headers
     *
     * @return ResponseInterface
     */
    protected function httpPostRaw($path, $body, array $requestHeaders = [])
    {
        return $response = $this->httpClient->sendRequest(
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $this->requestFactory->createRequest('POST', $path, $requestHeaders, $body)

        );
    }

    /**
     * Send a PUT request with JSON-encoded parameters.
     *
     * @param string $path           Request path
     * @param array  $params         POST parameters to be JSON encoded
     * @param array  $requestHeaders Request headers
     *
     * @return ResponseInterface
     */
    protected function httpPut($path, array $params = [], array $requestHeaders = [])

    {
        $requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';

        return $this->httpClient->sendRequest(
            $this->requestFactory->createRequest('PUT', $path, $requestHeaders, http_build_query($params))
        );
    }

    /**
     * Send a DELETE request with JSON-encoded parameters.
     *
     * @param string $path           Request path
     * @param array  $params         POST parameters to be JSON encoded
     * @param array  $requestHeaders Request headers
     *
     * @return ResponseInterface
     */
    protected function httpDelete($path, array $params = [], array $requestHeaders = [])

    {
        $requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';

        return $this->httpClient->sendRequest(
            $this->requestFactory->createRequest('DELETE', $path, $requestHeaders, http_build_query($params))
        );
    }

    /**
     * Handle HTTP errors.
     *
     * Call is controlled by the specific API methods.
     *
     * @param ResponseInterface $response
     *
     * @throws DomainException
     */
    protected function handleErrors(ResponseInterface $response)
    {
        $statusCode = $response->getStatusCode();
        switch ($statusCode) {
            case 400:
                throw DomainExceptions\HttpClientException::badRequest($response);
            case 401:
                throw DomainExceptions\HttpClientException::unauthorized($response);
            case 402:
                throw DomainExceptions\HttpClientException::requestFailed($response);
            case 404:
                throw DomainExceptions\HttpClientException::notFound($response);
            case 404 < $statusCode && $statusCode < 500:
                throw new DomainExceptions\HttpClientException('Client error', $statusCode, $response);
            case 500 <= $statusCode:
                throw DomainExceptions\HttpServerException::serverError($statusCode);
            default:
                throw new DomainExceptions\UnknownErrorException('Failed to hydrate response from API.', $statusCode);
        }
    }
}


1		<?php
2
3		namespace Happyr\ApiClient\Api;
4
5		use Happyr\ApiClient\Exception\Domain as DomainExceptions;
6		use Happyr\ApiClient\Exception\DomainException;
7		use Happyr\ApiClient\Hydrator\Hydrator;
8		use Happyr\ApiClient\Hydrator\NoopHydrator;
9		use Http\Client\HttpClient;
10		use Http\Message\RequestFactory;
11		use Psr\Http\Message\ResponseInterface;
12
13		/**
14		* @author Tobias Nyholm <[email protected]>
15		*/
16		abstract class HttpApi
17		{
18		/**
19		* @var HttpClient
20		*/
21		protected $httpClient;
22
23		/**
24		* @var Hydrator
25		*/
26		protected $hydrator;
27
28		/**
29		* @var RequestFactory
30		*/
31		protected $requestFactory;
32
33		/**
34		* @param HttpClient $httpClient
35		* @param RequestFactory $requestFactory
36		* @param Hydrator $hydrator
37		*/
38		public function __construct(HttpClient $httpClient, Hydrator $hydrator, RequestFactory $requestFactory)
39		{
40		$this->httpClient = $httpClient;
41		$this->requestFactory = $requestFactory;
42		if (!$hydrator instanceof NoopHydrator) {
43		$this->hydrator = $hydrator;
44		}
45		}
46
47		/**
48		* @param ResponseInterface $response
49		* @param string $class
50		*
51		* @throws \Exception
52		*
53		* @return mixed\|ResponseInterface
54		*/
55		protected function hydrateResponse(ResponseInterface $response, $class)
56		{
57		if (!$this->hydrator) {
58		return $response;
59		}
60
61		if ($response->getStatusCode() === 204) {
62		return null;
63		}
64
65		if ($response->getStatusCode() !== 200 && $response->getStatusCode() !== 201) {
66		$this->handleErrors($response);
67		}
68
69		return $this->hydrator->hydrate($response, $class);
70		}
71
72		/**
73		* Send a GET request with query parameters.
74		*
75		* @param string $path Request path
76		* @param array $params GET parameters
77		* @param array $requestHeaders Request Headers
78		*
79		* @return ResponseInterface
80		*/
81	View Code Duplication	protected function httpGet($path, array $params = [], array $requestHeaders = [])
		0 ignored issues – show Duplication introduced 2017-03-27 10:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
82		{
83		if (count($params) > 0) {
84		$path .= '?'.http_build_query($params);
85		}
86
87		return $this->httpClient->sendRequest(
88		$this->requestFactory->createRequest('GET', $path, $requestHeaders)
89		);
90		}
91
92		/**
93		* Send a POST request with JSON-encoded parameters.
94		*
95		* @param string $path Request path
96		* @param array $params POST parameters to be JSON encoded
97		* @param array $requestHeaders Request headers
98		*
99		* @return ResponseInterface
100		*/
101		protected function httpPost($path, array $params = [], array $requestHeaders = [])
102		{
103		$requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';
104
105		return $this->httpPostRaw($path, http_build_query($params), $requestHeaders);
106		}
107
108		/**
109		* Send a POST request with raw data.
110		*
111		* @param string $path Request path
112		* @param array\|string $body Request body
113		* @param array $requestHeaders Request headers
114		*
115		* @return ResponseInterface
116		*/
117		protected function httpPostRaw($path, $body, array $requestHeaders = [])
118		{
119		return $response = $this->httpClient->sendRequest(
		0 ignored issues – show Unused Code introduced 2017-03-27 10:19 UTC by Report Bug Copy Issue Report `$response` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
120		$this->requestFactory->createRequest('POST', $path, $requestHeaders, $body)
		0 ignored issues – show Bug introduced 2017-03-27 10:19 UTC by Report Bug Copy Issue Report It seems like `$body` defined by parameter `$body` on line 117 can also be of type `array`; however, `Http\Message\RequestFactory::createRequest()` does only seem to accept `resource\|string\|object<P...e\StreamInterface>\|null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
121		);
122		}
123
124		/**
125		* Send a PUT request with JSON-encoded parameters.
126		*
127		* @param string $path Request path
128		* @param array $params POST parameters to be JSON encoded
129		* @param array $requestHeaders Request headers
130		*
131		* @return ResponseInterface
132		*/
133	View Code Duplication	protected function httpPut($path, array $params = [], array $requestHeaders = [])
		0 ignored issues – show Duplication introduced 2017-03-27 10:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
134		{
135		$requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';
136
137		return $this->httpClient->sendRequest(
138		$this->requestFactory->createRequest('PUT', $path, $requestHeaders, http_build_query($params))
139		);
140		}
141
142		/**
143		* Send a DELETE request with JSON-encoded parameters.
144		*
145		* @param string $path Request path
146		* @param array $params POST parameters to be JSON encoded
147		* @param array $requestHeaders Request headers
148		*
149		* @return ResponseInterface
150		*/
151	View Code Duplication	protected function httpDelete($path, array $params = [], array $requestHeaders = [])
		0 ignored issues – show Duplication introduced 2017-03-27 10:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
152		{
153		$requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';
154
155		return $this->httpClient->sendRequest(
156		$this->requestFactory->createRequest('DELETE', $path, $requestHeaders, http_build_query($params))
157		);
158		}
159
160		/**
161		* Handle HTTP errors.
162		*
163		* Call is controlled by the specific API methods.
164		*
165		* @param ResponseInterface $response
166		*
167		* @throws DomainException
168		*/
169		protected function handleErrors(ResponseInterface $response)
170		{
171		$statusCode = $response->getStatusCode();
172		switch ($statusCode) {
173		case 400:
174		throw DomainExceptions\HttpClientException::badRequest($response);
175		case 401:
176		throw DomainExceptions\HttpClientException::unauthorized($response);
177		case 402:
178		throw DomainExceptions\HttpClientException::requestFailed($response);
179		case 404:
180		throw DomainExceptions\HttpClientException::notFound($response);
181		case 404 < $statusCode && $statusCode < 500:
182		throw new DomainExceptions\HttpClientException('Client error', $statusCode, $response);
183		case 500 <= $statusCode:
184		throw DomainExceptions\HttpServerException::serverError($statusCode);
185		default:
186		throw new DomainExceptions\UnknownErrorException('Failed to hydrate response from API.', $statusCode);
187		}
188		}
189		}
190

Happyr / php-api-client

Push — master ( d32c79...658521 )

HttpApi::hydrateResponse() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like