GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Completed
Push — master ( b4b8f1...d387ef )
by Lanre
10s
created

GetBVN::getPluginAccessor()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
crap 1
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 GetBVN extends AbstractPlugin
12
{
13
    use VerifyHttpStatusResponseCode;
14
15
    protected $baseUrl;
16
17
    const GET_BVN_ENDPOINT = "/bank/resolve_bvn/:bvn";
18
19
    const VALID_BVN_LENGTH = 11;
20
21 3
    public function __construct(string $baseUrl)
22
    {
23 3
        $this->baseUrl = $baseUrl;
24 3
    }
25
26 3
    public function getPluginAccessor(): string
27
    {
28 3
        return "getBVN";
29
    }
30
31 3
    public function handle(string $bvn)
32
    {
33 3
        if (mb_strlen($bvn) !== self::VALID_BVN_LENGTH) {
34 1
            throw new Exception(
35 1
                "Invalid BVN.. A valid BVN should contain only 11 digits"
36
            );
37
            
38
        }
39
40 2
        $link = $this->baseUrl. str_replace(":bvn", $bvn, self::GET_BVN_ENDPOINT);
41
42 2
        $response = $this->adapter->getHttpClient()
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
43 2
            ->get($link);
44
45 2
        $this->verifyResponse($response);
46
47
        //return both the data and meta keys from the array
48 1
        return array_slice(
49 1
            json_decode($response->getBody(), true),
50 1
            2
51
        );
52
    }
53
}
54