XmlRpcService::handleFault() - Code Metrics - Inspection of "Reworked the internals of XmlRpcService" - php-api-clients/xml-rpc-service - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2c06af...b1f160 )

by Cees-Jan

created 2018-01-21 21:56 UTC

XmlRpcService::handleFault() A

↳ Parent: XmlRpcService

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php declare(strict_types=1);

namespace ApiClients\Tools\Services\XmlRpc;

use ApiClients\Foundation\Transport\Service\RequestService;
use ApiClients\Middleware\Xml\XmlStream;
use Psr\Http\Message\ResponseInterface;
use React\Promise\PromiseInterface;
use RingCentral\Psr7\Request;
use function React\Promise\reject;
use function React\Promise\resolve;

class XmlRpcService
{
    /**
     * @var RequestService
     */
    private $requestService;

    /**
     * @param RequestService $requestService
     */
    public function __construct(RequestService $requestService)
    {
        $this->requestService = $requestService;
    }

    public function callRaw(string $method, array $arguments = []): PromiseInterface
    {
        $xml = [
            'methodCall' => [
                'methodName' => $method,
            ],
        ];

        if (count($arguments) > 0) {
            $xml['methodCall']['params'] = $arguments;
        }

        return $this->requestService->request(new Request(
            'POST',
            '',
            [],
            new XmlStream($xml)
        ));
    }

    public function call(string $method, array $arguments = []): PromiseInterface
    {
        $params = [];
        foreach ($arguments as $argument) {
            $params[] = [
                'param' => [
                    'value' => [
                        gettype($argument) => $argument,
                    ],
                ],
            ];
        }

        return $this->callRaw($method, $params)->then(function (ResponseInterface $response) {
            $xml = $response->getBody()->getParsedContents();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $xml = $xml['methodResponse'];

            if (isset($xml['fault'])) {
                return $this->handleFault($xml);
            }

            return $this->handleSuccess($xml);
        });
    }

    private function handleFault(array $xml): PromiseInterface
    {
        $fault = XmlRpcPayloadParser::parse($xml['fault']['value']);

        return reject(
            new XmlRpcError(
                $fault['faultString'],
                $fault['faultCode']
            )
        );
    }

    private function handleSuccess(array $xml): PromiseInterface
    {
        return resolve(
            XmlRpcPayloadParser::parse(
                $xml['params']['param']['value']
            )
        );
    }
}


1		<?php declare(strict_types=1);
2
3		namespace ApiClients\Tools\Services\XmlRpc;
4
5		use ApiClients\Foundation\Transport\Service\RequestService;
6		use ApiClients\Middleware\Xml\XmlStream;
7		use Psr\Http\Message\ResponseInterface;
8		use React\Promise\PromiseInterface;
9		use RingCentral\Psr7\Request;
10		use function React\Promise\reject;
11		use function React\Promise\resolve;
12
13		class XmlRpcService
14		{
15		/**
16		* @var RequestService
17		*/
18		private $requestService;
19
20		/**
21		* @param RequestService $requestService
22		*/
23	2	public function __construct(RequestService $requestService)
24		{
25	2	$this->requestService = $requestService;
26	2	}
27
28	2	public function callRaw(string $method, array $arguments = []): PromiseInterface
29		{
30		$xml = [
31		'methodCall' => [
32	2	'methodName' => $method,
33		],
34		];
35
36	2	if (count($arguments) > 0) {
37		$xml['methodCall']['params'] = $arguments;
38		}
39
40	2	return $this->requestService->request(new Request(
41	2	'POST',
42	2	'',
43	2	[],
44	2	new XmlStream($xml)
45		));
46		}
47
48	2	public function call(string $method, array $arguments = []): PromiseInterface
49		{
50	2	$params = [];
51	2	foreach ($arguments as $argument) {
52		$params[] = [
53		'param' => [
54		'value' => [
55		gettype($argument) => $argument,
56		],
57		],
58		];
59		}
60
61	2	return $this->callRaw($method, $params)->then(function (ResponseInterface $response) {
62	2	$xml = $response->getBody()->getParsedContents();
		0 ignored issues – show Bug introduced 2018-01-20 19:25 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Http\Message\StreamInterface` as the method `getParsedContents()` does only exist in the following implementations of said interface: `ApiClients\Middleware\Xml\XmlStream`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
63	2	$xml = $xml['methodResponse'];
64
65	2	if (isset($xml['fault'])) {
66	1	return $this->handleFault($xml);
67		}
68
69	1	return $this->handleSuccess($xml);
70	2	});
71		}
72
73	1	private function handleFault(array $xml): PromiseInterface
74		{
75	1	$fault = XmlRpcPayloadParser::parse($xml['fault']['value']);
76
77	1	return reject(
78	1	new XmlRpcError(
79	1	$fault['faultString'],
80	1	$fault['faultCode']
81		)
82		);
83		}
84
85	1	private function handleSuccess(array $xml): PromiseInterface
86		{
87	1	return resolve(
88	1	XmlRpcPayloadParser::parse(
89	1	$xml['params']['param']['value']
90		)
91		);
92		}
93		}
94

php-api-clients / xml-rpc-service

GitHub Access Token became invalid

Push — master ( 2c06af...b1f160 )

XmlRpcService::handleFault() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like