RestClient::__construct() - Code Metrics - Inspection of "Correct remove unused mapping" - Larium/larium-pay - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 60aec0...f632bc )

by Andreas

created 2017-02-17 12:27 UTC

RestClient::__construct() A

↳ Parent: RestClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1.0156

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	6
cts	8
cp	0.75
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	9
nc	1
nop	4
crap	1.0156

<?php

namespace Larium\Pay\Client;

use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Http\Discovery\HttpClientDiscovery;
use Http\Message\Authentication\BasicAuth;
use Http\Discovery\MessageFactoryDiscovery;

class RestClient
{
    private $baseUri;

    private $resource;

    private $username;

    private $pass;

    private $headerAuthentication = [];

    private $headers = [];

    private $options = [];

    private $rawRequest;

    public function __construct(
        $baseUri,
        $resource,
        array $headers = [],
        array $options = []
    ) {
        $this->baseUri = rtrim($baseUri, '/') . '/';
        $this->headers = $headers;
        $this->options = $options;
        $this->resource = $resource;
    }

    public function addHeader($name, $value)
    {
        $this->headers[$name] = $value;
    }

    public function get($id = null, $payload = null)
    {
        $factory = $this->getMessageFactory();
        $uri = $this->getUri($id);
        if ($query = $this->normalizePayload($payload)) {
            $uri = $uri . '?' . ltrim($query, '?');
        }
        $request = $factory->createRequest(
            'GET',
            $uri,
            $this->headers
        );

        $request = $this->authenticate($request);

        return $this->resolveResponse($this->sendRequest($request));
    }

    public function post($payload)

    {
        $factory = $this->getMessageFactory();
        $request = $factory->createRequest(
            'POST',
            $this->getUri(),
            $this->headers,
            $this->normalizePayload($payload)
        );

        $request = $this->authenticate($request);

        return $this->resolveResponse($this->sendRequest($request));
    }

    public function put($id, $payload = null)

    {
        $factory = $this->getMessageFactory();
        $request = $factory->createRequest(
            'PUT',
            $this->getUri($id),
            $this->headers,
            $this->normalizePayload($payload)
        );

        $request = $this->authenticate($request);

        return $this->resolveResponse($this->sendRequest($request));
    }

    public function delete($id)

    {
    }

    public function getUri($id = null)
    {
        $uri = sprintf('%s%s', $this->baseUri, $this->resource);

        if ($id) {
            $uri = sprintf($uri, $id);
        }

        return $uri;
    }

    public function setBasicAuthentication($username, $password)
    {
        $this->username = $username;
        $this->pass = $password;
    }

    public function setHeaderAuthentication($name, $value)
    {
        $this->headerAuthentication = ['name' => $name, 'value' => $value];
    }

    private function authenticate(RequestInterface $request)
    {
        if ($this->username || $this->pass) {
            $authentication = new BasicAuth($this->username, $this->pass);

            return $authentication->authenticate($request);
        }

        if (!empty($this->headerAuthentication)) {
            $request = $request->withHeader(
                $this->headerAuthentication['name'],
                $this->headerAuthentication['value']
            );

            return $request;
        }

        return $request;
    }

    private function normalizePayload($payload)
    {
        if (is_array($payload)) {
            return http_build_query($payload);
        }

        return $payload;
    }

    private function getMessageFactory()
    {
        return MessageFactoryDiscovery::find();
    }

    protected function discoverClient()
    {
        return HttpClientDiscovery::find();
    }

    private function sendRequest(RequestInterface $request)

    {
        $request = $this->authenticate($request);

        $response = $this->discoverClient()->sendRequest($request);

        if ($request->getBody()->isSeekable()) {
            $request->getBody()->rewind();
        }
        $this->rawRequest = $request->getBody()->__toString();

        return $response;
    }

    /**
     * Resolve the response from client.
     *
     * @param ResponseInterface $response
     * @return array An array with following values:
     *              'status': The Http status of response
     *              'headers': An array of response headers
     *              'body': The json decoded body response. (Since we are in
     *              RestClient)
     *              'raw_response': The raw body response for logging purposes.
     *              'raw_request': The raw body request for logging purposes.
     */
    protected function resolveResponse(ResponseInterface $response)
    {
        $body = $response->getBody()->__toString();
        $responseBody = json_decode($body, true) ?: [];

        return array(
            'status' => $response->getStatusCode(),
            'headers' => $response->getHeaders(),
            'body' => $responseBody,
            'raw_response' => $body,
            'raw_request' => $this->rawRequest,
        );
    }
}


1			<?php
2
3			namespace Larium\Pay\Client;
4
5			use Psr\Http\Message\RequestInterface;
6			use Psr\Http\Message\ResponseInterface;
7			use Http\Discovery\HttpClientDiscovery;
8			use Http\Message\Authentication\BasicAuth;
9			use Http\Discovery\MessageFactoryDiscovery;
10
11			class RestClient
12			{
13			private $baseUri;
14
15			private $resource;
16
17			private $username;
18
19			private $pass;
20
21			private $headerAuthentication = [];
22
23			private $headers = [];
24
25			private $options = [];
26
27			private $rawRequest;
28
29	1		public function __construct(
30			$baseUri,
31			$resource,
32	1		array $headers = [],
33	1		array $options = []
34			) {
35			$this->baseUri = rtrim($baseUri, '/') . '/';
36	1		$this->headers = $headers;
37	1		$this->options = $options;
38	1		$this->resource = $resource;
39			}
40
41			public function addHeader($name, $value)
42			{
43			$this->headers[$name] = $value;
44			}
45
46	1		public function get($id = null, $payload = null)
47			{
48			$factory = $this->getMessageFactory();
49			$uri = $this->getUri($id);
50			if ($query = $this->normalizePayload($payload)) {
51			$uri = $uri . '?' . ltrim($query, '?');
52			}
53			$request = $factory->createRequest(
54	1		'GET',
55			$uri,
56	1		$this->headers
57			);
58
59			$request = $this->authenticate($request);
60
61			return $this->resolveResponse($this->sendRequest($request));
62			}
63
64		View Code Duplication	public function post($payload)
			0 ignored issues – show Duplication introduced 2017-02-08 21:09 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...
65			{
66			$factory = $this->getMessageFactory();
67			$request = $factory->createRequest(
68			'POST',
69			$this->getUri(),
70			$this->headers,
71			$this->normalizePayload($payload)
72			);
73
74			$request = $this->authenticate($request);
75
76			return $this->resolveResponse($this->sendRequest($request));
77			}
78
79		View Code Duplication	public function put($id, $payload = null)
			0 ignored issues – show Duplication introduced 2017-02-08 21:09 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...
80			{
81			$factory = $this->getMessageFactory();
82			$request = $factory->createRequest(
83			'PUT',
84			$this->getUri($id),
85			$this->headers,
86			$this->normalizePayload($payload)
87			);
88
89			$request = $this->authenticate($request);
90
91			return $this->resolveResponse($this->sendRequest($request));
92			}
93
94			public function delete($id)
			0 ignored issues – show Unused Code introduced 2017-02-08 21:09 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
95			{
96			}
97
98	2		public function getUri($id = null)
99			{
100			$uri = sprintf('%s%s', $this->baseUri, $this->resource);
101
102	2		if ($id) {
103			$uri = sprintf($uri, $id);
104			}
105
106	2		return $uri;
107	1		}
108
109			public function setBasicAuthentication($username, $password)
110			{
111			$this->username = $username;
112			$this->pass = $password;
113			}
114
115			public function setHeaderAuthentication($name, $value)
116			{
117			$this->headerAuthentication = ['name' => $name, 'value' => $value];
118			}
119
120			private function authenticate(RequestInterface $request)
121			{
122			if ($this->username \|\| $this->pass) {
123			$authentication = new BasicAuth($this->username, $this->pass);
124
125			return $authentication->authenticate($request);
126			}
127
128			if (!empty($this->headerAuthentication)) {
129			$request = $request->withHeader(
130			$this->headerAuthentication['name'],
131			$this->headerAuthentication['value']
132			);
133
134			return $request;
135			}
136
137			return $request;
138			}
139
140			private function normalizePayload($payload)
141			{
142			if (is_array($payload)) {
143			return http_build_query($payload);
144			}
145
146			return $payload;
147			}
148
149			private function getMessageFactory()
150			{
151			return MessageFactoryDiscovery::find();
152			}
153
154			protected function discoverClient()
155			{
156			return HttpClientDiscovery::find();
157			}
158
159	1	View Code Duplication	private function sendRequest(RequestInterface $request)
			0 ignored issues – show Duplication introduced 2017-02-08 21:09 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...
160			{
161			$request = $this->authenticate($request);
162
163			$response = $this->discoverClient()->sendRequest($request);
164
165			if ($request->getBody()->isSeekable()) {
166			$request->getBody()->rewind();
167			}
168			$this->rawRequest = $request->getBody()->__toString();
169
170	1		return $response;
171	1		}
172
173			/**
174			* Resolve the response from client.
175			*
176			* @param ResponseInterface $response
177			* @return array An array with following values:
178			* 'status': The Http status of response
179			* 'headers': An array of response headers
180			* 'body': The json decoded body response. (Since we are in
181			* RestClient)
182			* 'raw_response': The raw body response for logging purposes.
183			* 'raw_request': The raw body request for logging purposes.
184			*/
185			protected function resolveResponse(ResponseInterface $response)
186			{
187			$body = $response->getBody()->__toString();
188			$responseBody = json_decode($body, true) ?: [];
189
190			return array(
191			'status' => $response->getStatusCode(),
192			'headers' => $response->getHeaders(),
193			'body' => $responseBody,
194			'raw_response' => $body,
195			'raw_request' => $this->rawRequest,
196			);
197			}
198			}
199

Larium / larium-pay

Push — master ( 60aec0...f632bc )

RestClient::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like