GetAccountDetails - Code Metrics - Inspection of "Add plugins to access the "Banks" API" - adelowo/gbowo-paystack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

by Lanre

created 2017-07-16 15:00 UTC

GetAccountDetails A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	6
lcom	1
cbo	2
dl	0
loc	43
ccs	16
cts	16
cp	1
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getPluginAccessor()	4	1
A	handle()	18	2
A	isValid()	5	2

<?php

namespace Paystack\Bank;

use Exception;
use Gbowo\Adapter\Paystack\Traits\VerifyHttpStatusResponseCode;
use function GuzzleHttp\json_decode;
use function Gbowo\toQueryParams;
use Gbowo\Plugin\AbstractPlugin;

class GetAccountDetails extends AbstractPlugin
{
    use VerifyHttpStatusResponseCode;

    protected $baseUrl;

    const GET_ACCOUNT_DETAILS_ENDPOINT = "/bank/resolve";

    public function __construct(string $baseUrl)
    {
        $this->baseUrl = $baseUrl;
    }

    public function getPluginAccessor(): string
    {
        return "getAccountDetails";
    }

    public function handle(array $params)
    {
        if (!$this->isValid($params)) {
            throw new Exception(
                "Invalid params.. The params should contain an 'account_number' key and 'bank_code' key"
            );
            
        }

        $link = $this->baseUrl. self::GET_ACCOUNT_DETAILS_ENDPOINT . toQueryParams($params);

        $response = $this->adapter->getHttpClient()
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.
    }
}
            ->get($link);

        $this->verifyResponse($response);

        return json_decode($response->getBody(), true)["data"];
    }

    protected function isValid(array $params): bool
    {
	//TODO(adelowo) Make use of `isset` here to prevent null values ?
        return array_key_exists("account_number", $params) && array_key_exists("bank_code", $params);
    }
}


1		<?php
2
3		namespace Paystack\Bank;
4
5		use Exception;
6		use Gbowo\Adapter\Paystack\Traits\VerifyHttpStatusResponseCode;
7		use function GuzzleHttp\json_decode;
8		use function Gbowo\toQueryParams;
9		use Gbowo\Plugin\AbstractPlugin;
10
11		class GetAccountDetails extends AbstractPlugin
12		{
13		use VerifyHttpStatusResponseCode;
14
15		protected $baseUrl;
16
17		const GET_ACCOUNT_DETAILS_ENDPOINT = "/bank/resolve";
18
19	3	public function __construct(string $baseUrl)
20		{
21	3	$this->baseUrl = $baseUrl;
22	3	}
23
24	3	public function getPluginAccessor(): string
25		{
26	3	return "getAccountDetails";
27		}
28
29	3	public function handle(array $params)
30		{
31	3	if (!$this->isValid($params)) {
32	1	throw new Exception(
33	1	"Invalid params.. The params should contain an 'account_number' key and 'bank_code' key"
34		);
35
36		}
37
38	2	$link = $this->baseUrl. self::GET_ACCOUNT_DETAILS_ENDPOINT . toQueryParams($params);
39
40	2	$response = $this->adapter->getHttpClient()
		0 ignored issues – show Bug introduced 2017-03-03 20:45 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Gbowo\Contract\Adapter\AdapterInterface` as the method `getHttpClient()` does only exist in the following implementations of said interface: `Gbowo\Adapter\Amplifypay\AmplifypayAdapter`, `Gbowo\Adapter\Paystack\PaystackAdapter`. 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...
41	2	->get($link);
42
43	2	$this->verifyResponse($response);
44
45	1	return json_decode($response->getBody(), true)["data"];
46		}
47
48	3	protected function isValid(array $params): bool
49		{
50		//TODO(adelowo) Make use of `isset` here to prevent null values ?
51	3	return array_key_exists("account_number", $params) && array_key_exists("bank_code", $params);
52		}
53		}
54

adelowo / gbowo-paystack

GitHub Access Token became invalid

Pull Request — master (#3)

GetAccountDetails A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like