XmlRpcService - Code Metrics - Inspection of "Unit tests for the service" - php-api-clients/xml-rpc-service - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 262efd...7f68f8 )

by Cees-Jan

created 2018-01-21 20:24 UTC

XmlRpcService A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	13
lcom	1
cbo	6
dl	0
loc	95
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	call()	17	2
B	callRaw()	32	3
C	parseMessage()	28	7

<?php declare(strict_types=1);

namespace ApiClients\Tools\Services\XmlRpc;

use ApiClients\Foundation\Transport\Service\RequestService;
use ApiClients\Middleware\Xml\XmlStream;
use DateTimeImmutable;
use Psr\Http\Message\ResponseInterface;
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 call(string $method, array $arguments = [])
    {
        $params = [];
        foreach ($arguments as $argument) {
            $params[] = [
                'param' => [
                    'value' => [
                        gettype($argument) => $argument,
                    ],
                ],
            ];
        }

        return $this->callRaw($method, $params)->then(function (array $xml) {
            return $this->parseMessage($xml);
        });
    }

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

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

        return $this->requestService->request(new Request(
            'POST',
            '',
            [],
            new XmlStream($xml)
        ))->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.
    }
}

            if (isset($xml['methodResponse']['fault'])) {
                return reject(
                    new XmlRpcError(
                        $xml['methodResponse']['fault']['value']['struct']['member'][1]['value']['string'],
                        (int)$xml['methodResponse']['fault']['value']['struct']['member'][0]['value']['int']
                    )
                );
            }

            return resolve($xml['methodResponse']['params']['param']['value']);
        });
    }

    private function parseMessage(array $xml)
    {
        if (isset($xml['string'])) {
            return $xml['string'];
        }

        if (isset($xml['i4'])) {
            return (int)$xml['i4'];
        }

        if (isset($xml['int'])) {
            return (int)$xml['int'];
        }

        if (isset($xml['double'])) {
            return (float)$xml['double'];
        }

        if (isset($xml['boolean'])) {
            return (bool)$xml['boolean'];
        }

        if (isset($xml['dateTime.iso8601'])) {
            return new DateTimeImmutable($xml['dateTime.iso8601']);
        }

        return $xml;
    }
}


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 DateTimeImmutable;
8			use Psr\Http\Message\ResponseInterface;
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			public function __construct(RequestService $requestService)
24			{
25			$this->requestService = $requestService;
26			}
27
28			public function call(string $method, array $arguments = [])
29			{
30			$params = [];
31			foreach ($arguments as $argument) {
32			$params[] = [
33			'param' => [
34			'value' => [
35			gettype($argument) => $argument,
36			],
37			],
38			];
39			}
40
41			return $this->callRaw($method, $params)->then(function (array $xml) {
42			return $this->parseMessage($xml);
43			});
44			}
45
46			public function callRaw(string $method, array $arguments = [])
47			{
48			$xml = [
49			'methodCall' => [
50			'methodName' => $method,
51			],
52			];
53
54			if (count($arguments) > 0) {
55			$xml['methodCall']['params'] = $arguments;
56			}
57
58			return $this->requestService->request(new Request(
59			'POST',
60			'',
61			[],
62			new XmlStream($xml)
63			))->then(function (ResponseInterface $response) {
64			$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...
65
66			if (isset($xml['methodResponse']['fault'])) {
67			return reject(
68			new XmlRpcError(
69			$xml['methodResponse']['fault']['value']['struct']['member'][1]['value']['string'],
70			(int)$xml['methodResponse']['fault']['value']['struct']['member'][0]['value']['int']
71			)
72			);
73			}
74
75			return resolve($xml['methodResponse']['params']['param']['value']);
76			});
77			}
78
79			private function parseMessage(array $xml)
80			{
81			if (isset($xml['string'])) {
82			return $xml['string'];
83			}
84
85			if (isset($xml['i4'])) {
86			return (int)$xml['i4'];
87			}
88
89			if (isset($xml['int'])) {
90			return (int)$xml['int'];
91			}
92
93			if (isset($xml['double'])) {
94			return (float)$xml['double'];
95			}
96
97			if (isset($xml['boolean'])) {
98			return (bool)$xml['boolean'];
99			}
100
101			if (isset($xml['dateTime.iso8601'])) {
102			return new DateTimeImmutable($xml['dateTime.iso8601']);
103			}
104
105			return $xml;
106			}
107			}
108

php-api-clients / xml-rpc-service

GitHub Access Token became invalid

Push — master ( 262efd...7f68f8 )

XmlRpcService A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like