HttpApi::createRequestBody() - Code Metrics - Inspection of "Do not use json request body (#313)" - mailgun/mailgun-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9e19f1...122210 )

by Tobias

created 2017-03-26 14:13 UTC

HttpApi::createRequestBody() A

↳ Parent: HttpApi

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	2
eloc	2
nc	2
nop	1
crap	6

<?php

/*
 * Copyright (C) 2013-2016 Mailgun
 *
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

namespace Mailgun\Api;

use Http\Client\Exception as HttplugException;
use Http\Client\HttpClient;
use Mailgun\Exception\UnknownErrorException;
use Mailgun\Hydrator\Hydrator;
use Mailgun\Hydrator\NoopHydrator;
use Mailgun\Exception\HttpClientException;
use Mailgun\Exception\HttpServerException;
use Mailgun\RequestBuilder;
use Psr\Http\Message\ResponseInterface;

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

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

    /**
     * @var RequestBuilder
     */
    protected $requestBuilder;

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

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

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

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

    /**
     * Throw the correct exception for this error.
     *
     * @param ResponseInterface $response
     *
     * @throws \Exception
     */
    protected function handleErrors(ResponseInterface $response)
    {
        $statusCode = $response->getStatusCode();
        switch ($statusCode) {
            case 400:
                throw HttpClientException::badRequest($response);
            case 401:
                throw HttpClientException::unauthorized($response);
            case 402:
                throw HttpClientException::requestFailed($response);
            case 404:
                throw HttpClientException::notFound($response);
            case 500 <= $statusCode:
                throw HttpServerException::serverError($statusCode);
            default:
                throw new UnknownErrorException();
        }
    }

    /**
     * Send a GET request with query parameters.
     *
     * @param string $path           Request path
     * @param array  $parameters     GET parameters
     * @param array  $requestHeaders Request Headers
     *
     * @return ResponseInterface
     */
    protected function httpGet($path, array $parameters = [], array $requestHeaders = [])
    {
        if (count($parameters) > 0) {
            $path .= '?'.http_build_query($parameters);
        }

        try {
            $response = $this->httpClient->sendRequest(
                $this->requestBuilder->create('GET', $path, $requestHeaders)
            );
        } catch (HttplugException\NetworkException $e) {
            throw HttpServerException::networkError($e);
        }

        return $response;
    }

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

        return $this->httpPostRaw($path, $this->createRequestBody($parameters), $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 = [])
    {
        try {
            $response = $this->httpClient->sendRequest(
                $this->requestBuilder->create('POST', $path, $requestHeaders, $body)
            );
        } catch (HttplugException\NetworkException $e) {
            throw HttpServerException::networkError($e);
        }

        return $response;
    }

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

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

        try {
            $response = $this->httpClient->sendRequest(
                $this->requestBuilder->create('PUT', $path, $requestHeaders, $this->createRequestBody($parameters))
            );
        } catch (HttplugException\NetworkException $e) {
            throw HttpServerException::networkError($e);
        }

        return $response;
    }

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

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

        try {
            $response = $this->httpClient->sendRequest(
                $this->requestBuilder->create('DELETE', $path, $requestHeaders, $this->createRequestBody($parameters))
            );
        } catch (HttplugException\NetworkException $e) {
            throw HttpServerException::networkError($e);
        }

        return $response;
    }

    /**
     * Create a JSON encoded version of an array of parameters.
     *
     * @param array $parameters Request parameters
     *
     * @return null|string
     */
    protected function createRequestBody(array $parameters)
    {
        return (count($parameters) === 0) ? null : http_build_query($parameters);
    }
}


1			<?php
2
3			/*
4			* Copyright (C) 2013-2016 Mailgun
5			*
6			* This software may be modified and distributed under the terms
7			* of the MIT license. See the LICENSE file for details.
8			*/
9
10			namespace Mailgun\Api;
11
12			use Http\Client\Exception as HttplugException;
13			use Http\Client\HttpClient;
14			use Mailgun\Exception\UnknownErrorException;
15			use Mailgun\Hydrator\Hydrator;
16			use Mailgun\Hydrator\NoopHydrator;
17			use Mailgun\Exception\HttpClientException;
18			use Mailgun\Exception\HttpServerException;
19			use Mailgun\RequestBuilder;
20			use Psr\Http\Message\ResponseInterface;
21
22			/**
23			* @author Tobias Nyholm <[email protected]>
24			*/
25			abstract class HttpApi
26			{
27			/**
28			* The HTTP client.
29			*
30			* @var HttpClient
31			*/
32			private $httpClient;
33
34			/**
35			* @var Hydrator
36			*/
37			protected $hydrator;
38
39			/**
40			* @var RequestBuilder
41			*/
42			protected $requestBuilder;
43
44			/**
45			* @param HttpClient $httpClient
46			* @param RequestBuilder $requestBuilder
47			* @param Hydrator $hydrator
48			*/
49	9		public function __construct(HttpClient $httpClient, RequestBuilder $requestBuilder, Hydrator $hydrator)
50			{
51	9		$this->httpClient = $httpClient;
52	9		$this->requestBuilder = $requestBuilder;
53	9		if (!$hydrator instanceof NoopHydrator) {
54	9		$this->hydrator = $hydrator;
55	9		}
56	9		}
57
58			/**
59			* @param ResponseInterface $response
60			* @param string $class
61			*
62			* @return mixed\|ResponseInterface
63			*
64			* @throws \Exception
65			*/
66	7		protected function hydrateResponse(ResponseInterface $response, $class)
67			{
68	7		if (!$this->hydrator) {
69			return $response;
70			}
71
72	7		if ($response->getStatusCode() !== 200 && $response->getStatusCode() !== 201) {
73			$this->handleErrors($response);
74			}
75
76	7		return $this->hydrator->hydrate($response, $class);
77			}
78
79			/**
80			* Throw the correct exception for this error.
81			*
82			* @param ResponseInterface $response
83			*
84			* @throws \Exception
85			*/
86			protected function handleErrors(ResponseInterface $response)
87			{
88			$statusCode = $response->getStatusCode();
89			switch ($statusCode) {
90			case 400:
91			throw HttpClientException::badRequest($response);
92			case 401:
93			throw HttpClientException::unauthorized($response);
94			case 402:
95			throw HttpClientException::requestFailed($response);
96			case 404:
97			throw HttpClientException::notFound($response);
98			case 500 <= $statusCode:
99			throw HttpServerException::serverError($statusCode);
100			default:
101			throw new UnknownErrorException();
102			}
103			}
104
105			/**
106			* Send a GET request with query parameters.
107			*
108			* @param string $path Request path
109			* @param array $parameters GET parameters
110			* @param array $requestHeaders Request Headers
111			*
112			* @return ResponseInterface
113			*/
114			protected function httpGet($path, array $parameters = [], array $requestHeaders = [])
115			{
116			if (count($parameters) > 0) {
117			$path .= '?'.http_build_query($parameters);
118			}
119
120			try {
121			$response = $this->httpClient->sendRequest(
122			$this->requestBuilder->create('GET', $path, $requestHeaders)
123			);
124			} catch (HttplugException\NetworkException $e) {
125			throw HttpServerException::networkError($e);
126			}
127
128			return $response;
129			}
130
131			/**
132			* Send a POST request with JSON-encoded parameters.
133			*
134			* @param string $path Request path
135			* @param array $parameters POST parameters to be JSON encoded
136			* @param array $requestHeaders Request headers
137			*
138			* @return ResponseInterface
139			*/
140			protected function httpPost($path, array $parameters = [], array $requestHeaders = [])
141			{
142			$requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';
143
144			return $this->httpPostRaw($path, $this->createRequestBody($parameters), $requestHeaders);
145			}
146
147			/**
148			* Send a POST request with raw data.
149			*
150			* @param string $path Request path
151			* @param array\|string $body Request body
152			* @param array $requestHeaders Request headers
153			*
154			* @return ResponseInterface
155			*/
156			protected function httpPostRaw($path, $body, array $requestHeaders = [])
157			{
158			try {
159			$response = $this->httpClient->sendRequest(
160			$this->requestBuilder->create('POST', $path, $requestHeaders, $body)
161			);
162			} catch (HttplugException\NetworkException $e) {
163			throw HttpServerException::networkError($e);
164			}
165
166			return $response;
167			}
168
169			/**
170			* Send a PUT request with JSON-encoded parameters.
171			*
172			* @param string $path Request path
173			* @param array $parameters POST parameters to be JSON encoded
174			* @param array $requestHeaders Request headers
175			*
176			* @return ResponseInterface
177			*/
178		View Code Duplication	protected function httpPut($path, array $parameters = [], array $requestHeaders = [])
			0 ignored issues – show Duplication introduced 2016-11-24 17:22 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...
179			{
180			$requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';
181
182			try {
183			$response = $this->httpClient->sendRequest(
184			$this->requestBuilder->create('PUT', $path, $requestHeaders, $this->createRequestBody($parameters))
185			);
186			} catch (HttplugException\NetworkException $e) {
187			throw HttpServerException::networkError($e);
188			}
189
190			return $response;
191			}
192
193			/**
194			* Send a DELETE request with JSON-encoded parameters.
195			*
196			* @param string $path Request path
197			* @param array $parameters POST parameters to be JSON encoded
198			* @param array $requestHeaders Request headers
199			*
200			* @return ResponseInterface
201			*/
202		View Code Duplication	protected function httpDelete($path, array $parameters = [], array $requestHeaders = [])
			0 ignored issues – show Duplication introduced 2016-11-24 17:22 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...
203			{
204			$requestHeaders['Content-Type'] = 'application/x-www-form-urlencoded';
205
206			try {
207			$response = $this->httpClient->sendRequest(
208			$this->requestBuilder->create('DELETE', $path, $requestHeaders, $this->createRequestBody($parameters))
209			);
210			} catch (HttplugException\NetworkException $e) {
211			throw HttpServerException::networkError($e);
212			}
213
214			return $response;
215			}
216
217			/**
218			* Create a JSON encoded version of an array of parameters.
219			*
220			* @param array $parameters Request parameters
221			*
222			* @return null\|string
223			*/
224			protected function createRequestBody(array $parameters)
225			{
226			return (count($parameters) === 0) ? null : http_build_query($parameters);
227			}
228			}
229

mailgun / mailgun-php

Push — master ( 9e19f1...122210 )

HttpApi::createRequestBody() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like