HttpClient::prepareQueryString() - Code Metrics - Inspection of "Update readme and Scrutinizer" - elmage/textng-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2)

by Samuel

created 2020-08-19 03:55 UTC

HttpClient::prepareQueryString() A

↳ Parent: HttpClient

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.0416

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Elmage\TextNg;

use Elmage\TextNg\Authentication\ApiKeyAuthentication;
use Elmage\TextNg\Enum\Param;
use Elmage\TextNg\Exception\HttpException;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\RequestOptions;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;

class HttpClient
{
    private $apiUrl;
    private $apiVersion;
    private $auth;
    private $transport;

    /** @var string Text Message Sender */
    private $sender;

    /** @var LoggerInterface */
    private $logger;

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

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

    public function __construct(
        string $apiUrl,
        string $apiVersion,
        ApiKeyAuthentication $auth,
        string $sender,
        ClientInterface $transport
    ) {
        $this->apiUrl = rtrim($apiUrl, '/');
        $this->apiVersion = $apiVersion;
        $this->auth = $auth;
        $this->sender = $sender;
        $this->transport = $transport;
    }

    public function getLogger()
    {
        return $this->logger;
    }

    public function setLogger(LoggerInterface $logger = null)
    {
        $this->logger = $logger;
    }

    public function getSender()
    {
        return $this->sender;
    }

    public function setSender(string $sender)
    {
        $this->sender = $sender;
    }

    /** @return ResponseInterface */
    public function get($path, array $params = array()): ResponseInterface
    {
        return $this->request('GET', $path, $params);
    }

    /** @return ResponseInterface */
    public function post($path, array $params = array()): ResponseInterface
    {
        return $this->request('POST', $path, $params);
    }

    /** @return ResponseInterface */
    public function put($path, array $params = array()): ResponseInterface
    {
        return $this->request('PUT', $path, $params);
    }

    /** @return ResponseInterface */
    public function delete($path, array $params = array()): ResponseInterface
    {
        return $this->request('DELETE', $path, $params);
    }

    /**
     * @param string $method http request method
     * @param string $path   url path
     * @param array  $params request parameters
     */
    private function request(string $method, string $path, array $params = array()): ResponseInterface
    {
        $method = strtoupper($method);

        $params[Param::API_KEY] = $this->auth->getApiKey();

        if ($method === 'GET') {
            $path = $this->prepareQueryString($path, $params);
        }

        $request = new Request($method, $this->prepareUrl($path));

        return $this->send($request, $params);
    }

    private function send(RequestInterface $request, array $params = array()): ResponseInterface
    {
        $this->lastRequest = $request;

        $options = $this->prepareOptions(
            $params
        );

        try {
            $this->lastResponse = $response = $this->transport->send($request, $options);
        } catch (RequestException $e) {
            throw HttpException::wrap($e);
        }

        if ($this->logger) {
            //$this->logWarnings($response); TODO LOG warnings
        }

        return $response;
    }

    /**
     * @param $path //request path

     * @param array $params pointer to an array of parameters
     *
     * @return string
     */
    private function prepareQueryString(string $path, array &$params = array()): string
    {
        if (count($params) < 1) {
            return $path;
        }

        $path .= false === strpos($path, '?') ? '?' : '&';
        $path .= http_build_query($params, '', '&');

        return $path;
    }

    private function prepareOptions(array $params = array())
    {
        $options = array();

        if (count($params) > 0) {
            $options[RequestOptions::JSON] = $params;
            $body = json_encode($params);

        } else {
            $body = '';
        }

        $defaultHeaders = array(
            'User-Agent' => 'elmage/textng/php/'.Client::VERSION,
            'Content-Type' => 'application/json',
            'Accept' => 'text/plain, application/json',
        );

        $options[RequestOptions::HEADERS] = $defaultHeaders;

        return $options;
    }

    private function prepareUrl(string $path): string
    {
        return $this->apiUrl.'/'.ltrim($path, '/');
    }
}


1		<?php
2
3		namespace Elmage\TextNg;
4
5		use Elmage\TextNg\Authentication\ApiKeyAuthentication;
6		use Elmage\TextNg\Enum\Param;
7		use Elmage\TextNg\Exception\HttpException;
8		use GuzzleHttp\ClientInterface;
9		use GuzzleHttp\Exception\RequestException;
10		use GuzzleHttp\Psr7\Request;
11		use GuzzleHttp\RequestOptions;
12		use Psr\Http\Message\RequestInterface;
13		use Psr\Http\Message\ResponseInterface;
14		use Psr\Log\LoggerInterface;
15
16		class HttpClient
17		{
18		private $apiUrl;
19		private $apiVersion;
20		private $auth;
21		private $transport;
22
23		/** @var string Text Message Sender */
24		private $sender;
25
26		/** @var LoggerInterface */
27		private $logger;
28
29		/** @var RequestInterface */
30		private $lastRequest;
31
32		/** @var ResponseInterface */
33		private $lastResponse;
34
35	8	public function __construct(
36		string $apiUrl,
37		string $apiVersion,
38		ApiKeyAuthentication $auth,
39		string $sender,
40		ClientInterface $transport
41		) {
42	8	$this->apiUrl = rtrim($apiUrl, '/');
43	8	$this->apiVersion = $apiVersion;
44	8	$this->auth = $auth;
45	8	$this->sender = $sender;
46	8	$this->transport = $transport;
47	8	}
48
49		public function getLogger()
50		{
51		return $this->logger;
52		}
53
54	2	public function setLogger(LoggerInterface $logger = null)
55		{
56	2	$this->logger = $logger;
57	2	}
58
59	1	public function getSender()
60		{
61	1	return $this->sender;
62		}
63
64	1	public function setSender(string $sender)
65		{
66	1	$this->sender = $sender;
67	1	}
68
69		/** @return ResponseInterface */
70	2	public function get($path, array $params = array()): ResponseInterface
71		{
72	2	return $this->request('GET', $path, $params);
73		}
74
75		/** @return ResponseInterface */
76	2	public function post($path, array $params = array()): ResponseInterface
77		{
78	2	return $this->request('POST', $path, $params);
79		}
80
81		/** @return ResponseInterface */
82	1	public function put($path, array $params = array()): ResponseInterface
83		{
84	1	return $this->request('PUT', $path, $params);
85		}
86
87		/** @return ResponseInterface */
88	1	public function delete($path, array $params = array()): ResponseInterface
89		{
90	1	return $this->request('DELETE', $path, $params);
91		}
92
93		/**
94		* @param string $method http request method
95		* @param string $path url path
96		* @param array $params request parameters
97		*/
98	6	private function request(string $method, string $path, array $params = array()): ResponseInterface
99		{
100	6	$method = strtoupper($method);
101
102	6	$params[Param::API_KEY] = $this->auth->getApiKey();
103
104	6	if ($method === 'GET') {
105	2	$path = $this->prepareQueryString($path, $params);
106		}
107
108	6	$request = new Request($method, $this->prepareUrl($path));
109
110	6	return $this->send($request, $params);
111		}
112
113	6	private function send(RequestInterface $request, array $params = array()): ResponseInterface
114		{
115	6	$this->lastRequest = $request;
116
117	6	$options = $this->prepareOptions(
118	6	$params
119		);
120
121		try {
122	6	$this->lastResponse = $response = $this->transport->send($request, $options);
123		} catch (RequestException $e) {
124		throw HttpException::wrap($e);
125		}
126
127	6	if ($this->logger) {
128		//$this->logWarnings($response); TODO LOG warnings
129		}
130
131	6	return $response;
132		}
133
134		/**
135		* @param $path //request path
		0 ignored issues – show Documentation Bug introduced 2020-08-19 02:43 UTC by Report Bug Copy Issue Report The doc comment `//request` at position `0` could not be parsed: Unknown type name '//request' at position 0 in //request. Loading history...
136		* @param array $params pointer to an array of parameters
137		*
138		* @return string
139		*/
140	2	private function prepareQueryString(string $path, array &$params = array()): string
141		{
142	2	if (count($params) < 1) {
143		return $path;
144		}
145
146	2	$path .= false === strpos($path, '?') ? '?' : '&';
147	2	$path .= http_build_query($params, '', '&');
148
149	2	return $path;
150		}
151
152	6	private function prepareOptions(array $params = array())
153		{
154	6	$options = array();
155
156	6	if (count($params) > 0) {
157	6	$options[RequestOptions::JSON] = $params;
158	6	$body = json_encode($params);
		0 ignored issues – show Unused Code introduced 2020-08-19 02:43 UTC by Report Bug Copy Issue Report The assignment to `$body` is dead and can be removed. Loading history...
159		} else {
160		$body = '';
161		}
162
163		$defaultHeaders = array(
164	6	'User-Agent' => 'elmage/textng/php/'.Client::VERSION,
165	6	'Content-Type' => 'application/json',
166	6	'Accept' => 'text/plain, application/json',
167		);
168
169	6	$options[RequestOptions::HEADERS] = $defaultHeaders;
170
171	6	return $options;
172		}
173
174	6	private function prepareUrl(string $path): string
175		{
176	6	return $this->apiUrl.'/'.ltrim($path, '/');
177		}
178		}
179

elmage / textng-php

Pull Request — master (#2)

HttpClient::prepareQueryString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like