Completed
Push — master ( 4b9050...abec28 )
by Dmitry
01:47
created

BitPayMerchant::requestPurchase()   B

Complexity

Conditions 2
Paths 2

Size

Total Lines 24
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 12
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 24
ccs 12
cts 12
cp 1
rs 8.9713
cc 2
eloc 15
nc 2
nop 1
crap 2
1
<?php
2
/**
3
 * Generalization over Omnipay and Payum
4
 *
5
 * @link      https://github.com/hiqdev/php-merchant
6
 * @package   php-merchant
7
 * @license   BSD-3-Clause
8
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9
 */
10
11
namespace hiqdev\php\merchant\merchants\bitpay;
12
13
use hiqdev\php\merchant\InvoiceInterface;
14
use hiqdev\php\merchant\merchants\AbstractMerchant;
15
use hiqdev\php\merchant\response\CompletePurchaseResponse;
16
use hiqdev\php\merchant\response\RedirectPurchaseResponse;
17
use Omnipay\BitPay\Gateway;
18
use hiqdev\php\merchant\exceptions\MerchantException;
19
20
/**
21
 * Class BitPayAdapter.
22
 *
23
 * @author Dmytro Naumenko <[email protected]>
24
 */
25
class BitPayMerchant extends AbstractMerchant
26
{
27
    /**
28
     * @return Gateway
29 3
     */
30
    protected function createGateway()
31 3
    {
32 3
        return $this->gatewayFactory->build('BitPay', [
33 3
            'token' => $this->credentials->getKey1(),
34 3
            'privateKey'  => $this->credentials->getKey2(),
35 3
            'publicKey' => $this->credentials->getKey3(),
36
            'testMode' => $this->getCredentials()->isTestMode(),
37
        ]);
38
    }
39
40
    /**
41
     * @param InvoiceInterface $invoice
42
     * @return RedirectPurchaseResponse
43 1
     */
44
    public function requestPurchase(InvoiceInterface $invoice)
45
    {
46
        /**
47
         * @var \Omnipay\BitPay\Message\PurchaseResponse
48 1
         */
49 1
        $response = $this->gateway->purchase([
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Omnipay\Common\GatewayInterface as the method purchase() does only exist in the following implementations of said interface: Omnipay\BitPay\Gateway, Omnipay\FreeKassa\Gateway, Omnipay\InterKassa\Gateway, Omnipay\OKPAY\Gateway, Omnipay\Paxum\Gateway, Omnipay\PayPal\Gateway, Omnipay\RoboKassa\Gateway, Omnipay\TwoCheckoutPlus\Gateway, Omnipay\TwoCheckoutPlus\TokenGateway, Omnipay\WebMoney\Gateway, Omnipay\YandexMoney\P2pGateway, Omnipay\ePayService\Gateway.

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...
50 1
            'transactionId' => $invoice->getId(),
51 1
            'description' => $invoice->getDescription(),
52 1
            'amount' => $this->moneyFormatter->format($invoice->getAmount()),
53 1
            'currency' => $invoice->getCurrency()->getCode(),
54 1
            'returnUrl' => $invoice->getReturnUrl(),
55 1
            'notifyUrl' => $invoice->getNotifyUrl(),
56 1
            'cancelUrl' => $invoice->getCancelUrl(),
57
        ])->send();
58 1
59 1
        if ($response->getRedirectUrl() === null) {
60
            throw new MerchantException('Failed to request purchase');
61 1
        }
62
63
        $response = new RedirectPurchaseResponse($response->getRedirectUrl(), $response->getRedirectData());
64
        $response->setMethod('GET');
65
66
        return $response;
67
    }
68 1
69
    /**
70
     * @param array $data
71 1
     * @return CompletePurchaseResponse
72
     */
73 1
    public function completePurchase($data)
74 1
    {
75 1
        /** @var \Omnipay\BitPay\Message\CompletePurchaseResponse $response */
76 1
        $response = $this->gateway->completePurchase($data)->send();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Omnipay\Common\GatewayInterface as the method completePurchase() does only exist in the following implementations of said interface: Omnipay\BitPay\Gateway, Omnipay\FreeKassa\Gateway, Omnipay\InterKassa\Gateway, Omnipay\OKPAY\Gateway, Omnipay\Paxum\Gateway, Omnipay\PayPal\Gateway, Omnipay\RoboKassa\Gateway, Omnipay\TwoCheckoutPlus\Gateway, Omnipay\WebMoney\Gateway, Omnipay\YandexMoney\P2pGateway, Omnipay\ePayService\Gateway.

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...
77 1
78 1
        return (new CompletePurchaseResponse())
79 1
            ->setIsSuccessful($response->isSuccessful())
0 ignored issues
show
Documentation introduced by
$response->isSuccessful() is of type boolean, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
80 1
            ->setAmount($this->moneyParser->parse($response->getAmount(), $response->getCurrency()))
81
            ->setFee($this->moneyParser->parse($response->getFee(), $response->getCurrency()))
82
            ->setTransactionReference($response->getTransactionReference())
83
            ->setTransactionId($response->getTransactionId())
84
            ->setPayer($response->getPayer())
85
            ->setTime(new \DateTime($response->getTime()));
86
    }
87
}
88