XmlRpcService::call() - Code Metrics - Inspection of "Reject call when a fault has been encountered" - php-api-clients/xml-rpc-service - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a2993...76c4f6 )

by Cees-Jan

created 2018-01-20 19:35 UTC

XmlRpcService::call() B

↳ Parent: XmlRpcService

Complexity

Conditions	3
Paths	2

Size

Total Lines	32
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	8.8571
c	0
b	0
f	0
cc	3
eloc	18
nc	2
nop	2

<?php

namespace ApiClients\Tools\Services\XmlRpc;

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

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

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

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

        if (count($arguments) > 0) {
            $xml['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']);
        });
    }
}


GitHub Access Token became invalid

Push — master ( 4a2993...76c4f6 )

XmlRpcService::call() B

Complexity

Size

Duplication

Importance

Available Fixes

1			<?php
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 function React\Promise\reject;
9			use function React\Promise\resolve;
10			use RingCentral\Psr7\Request;
11
12			class XmlRpcService
13			{
14			/**
15			* @var RequestService
16			*/
17			private $requestService;
18
19			/**
20			* @param RequestService $requestService
21			*/
22			public function __construct(RequestService $requestService)
23			{
24			$this->requestService = $requestService;
25			}
26
27			public function call(string $method, array $arguments = [])
28			{
29			$xml = [
30			'methodCall' => [
31			'methodName' => $method,
32			],
33			];
34
35			if (count($arguments) > 0) {
36			$xml['params'] = $arguments;
37			}
38
39			return $this->requestService->request(new Request(
40			'POST',
41			'',
42			[],
43			new XmlStream($xml)
44			))->then(function (ResponseInterface $response) {
45			$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...
46
47			if (isset($xml['methodResponse']['fault'])) {
48			return reject(
49			new XmlRpcError(
50			$xml['methodResponse']['fault']['value']['struct']['member'][1]['value']['string'],
51			(int)$xml['methodResponse']['fault']['value']['struct']['member'][0]['value']['int']
52			)
53			);
54			}
55
56			return resolve($xml['methodResponse']['params']['param']);
57			});
58			}
59			}
60

php-api-clients / xml-rpc-service

GitHub Access Token became invalid

Push — master ( 4a2993...76c4f6 )

XmlRpcService::call() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like