BitPayMerchant - Code Metrics - Inspection of "[WIP] Completely refactored" - hiqdev/php-merchant - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by Dmitry

created 2017-10-24 14:25 UTC

BitPayMerchant A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	8

Test Coverage

Coverage

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	3
c	1
b	0
f	0
lcom	2
cbo	8
dl	0
loc	60
ccs	0
cts	24
cp	0
rs	10

3 Methods

Rating	Name	Size	Complexity
A	createGateway()	9	1
A	completePurchase()	14	1
A	requestPurchase()	20	1

<?php

namespace hiqdev\php\merchant\merchants\bitpay;

use hiqdev\php\merchant\InvoiceInterface;
use hiqdev\php\merchant\merchants\AbstractMerchant;
use hiqdev\php\merchant\response\CompletePurchaseResponse;
use hiqdev\php\merchant\response\RedirectPurchaseResponse;
use Omnipay\BitPay\Gateway;

/**
 * Class BitPayAdapter
 *
 * @author Dmytro Naumenko <[email protected]>
 */
class BitPayMerchant extends AbstractMerchant
{
    /**
     * @return Gateway
     */
    protected function createGateway()
    {
        return $this->gatewayFactory->build('BitPay', [
            'token' => $this->credentials->getKey1(),
            'privateKey'  => $this->credentials->getKey2(),
            'publicKey' => $this->credentials->getKey3(),
            'testMode' => $this->getCredentials()->isTestMode()
        ]);
    }

    /**
     * @param InvoiceInterface $invoice
     * @return RedirectPurchaseResponse
     */
    public function requestPurchase(InvoiceInterface $invoice)
    {
        /**
         * @var \Omnipay\BitPay\Message\PurchaseResponse $response
         */
        $response = $this->gateway->purchase([
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.
    }
}
            'transactionId' => $invoice->getId(),
            'description' => $invoice->getDescription(),
            'amount' => $this->moneyFormatter->format($invoice->getAmount()),
            'currency' => $invoice->getCurrency()->getCode(),
            'returnUrl' => $invoice->getReturnUrl(),
            'notifyUrl' => $invoice->getNotifyUrl(),
            'cancelUrl' => $invoice->getCancelUrl(),
        ])->send();

        $response = new RedirectPurchaseResponse($response->getRedirectUrl(), $response->getRedirectData());
        $response->setMethod('GET');

        return $response;
    }

    /**
     * @param array $data
     * @return CompletePurchaseResponse
     */
    public function completePurchase($data)
    {
        /** @var \Omnipay\BitPay\Message\CompletePurchaseResponse $response */
        $response = $this->gateway->completePurchase($data)->send();
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.
    }
}

        return (new CompletePurchaseResponse())
            ->setIsSuccessful($response->isSuccessful())
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->setAmount($this->moneyParser->parse($response->getAmount(), $response->getCurrency()))
            ->setFee($this->moneyParser->parse($response->getFee(), $response->getCurrency()))
            ->setTransactionReference($response->getTransactionReference())
            ->setTransactionId($response->getTransactionId())
            ->setPayer($response->getPayer())
            ->setTime(new \DateTime($response->getTime()));
    }

}


Pull Request — master (#1)

BitPayMerchant A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Available Fixes

Available Fixes

1			<?php
2
3			namespace hiqdev\php\merchant\merchants\bitpay;
4
5			use hiqdev\php\merchant\InvoiceInterface;
6			use hiqdev\php\merchant\merchants\AbstractMerchant;
7			use hiqdev\php\merchant\response\CompletePurchaseResponse;
8			use hiqdev\php\merchant\response\RedirectPurchaseResponse;
9			use Omnipay\BitPay\Gateway;
10
11			/**
12			* Class BitPayAdapter
13			*
14			* @author Dmytro Naumenko <[email protected]>
15			*/
16			class BitPayMerchant extends AbstractMerchant
17			{
18			/**
19			* @return Gateway
20			*/
21			protected function createGateway()
22			{
23			return $this->gatewayFactory->build('BitPay', [
24			'token' => $this->credentials->getKey1(),
25			'privateKey' => $this->credentials->getKey2(),
26			'publicKey' => $this->credentials->getKey3(),
27			'testMode' => $this->getCredentials()->isTestMode()
28			]);
29			}
30
31			/**
32			* @param InvoiceInterface $invoice
33			* @return RedirectPurchaseResponse
34			*/
35			public function requestPurchase(InvoiceInterface $invoice)
36			{
37			/**
38			* @var \Omnipay\BitPay\Message\PurchaseResponse $response
39			*/
40			$response = $this->gateway->purchase([
			0 ignored issues – show Bug introduced 2017-10-20 09:54 UTC by Report Bug Copy Issue Report 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\InterKassa\Gateway`, `Omnipay\OKPAY\Gateway`, `Omnipay\Paxum\Gateway`, `Omnipay\PayPal\Gateway`, `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 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			'transactionId' => $invoice->getId(),
42			'description' => $invoice->getDescription(),
43			'amount' => $this->moneyFormatter->format($invoice->getAmount()),
44			'currency' => $invoice->getCurrency()->getCode(),
45			'returnUrl' => $invoice->getReturnUrl(),
46			'notifyUrl' => $invoice->getNotifyUrl(),
47			'cancelUrl' => $invoice->getCancelUrl(),
48			])->send();
49
50			$response = new RedirectPurchaseResponse($response->getRedirectUrl(), $response->getRedirectData());
51			$response->setMethod('GET');
52
53			return $response;
54			}
55
56			/**
57			* @param array $data
58			* @return CompletePurchaseResponse
59			*/
60			public function completePurchase($data)
61			{
62			/** @var \Omnipay\BitPay\Message\CompletePurchaseResponse $response */
63			$response = $this->gateway->completePurchase($data)->send();
			0 ignored issues – show Bug introduced 2017-10-20 09:54 UTC by Report Bug Copy Issue Report 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\InterKassa\Gateway`, `Omnipay\OKPAY\Gateway`, `Omnipay\Paxum\Gateway`, `Omnipay\PayPal\Gateway`, `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 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...
64
65			return (new CompletePurchaseResponse())
66			->setIsSuccessful($response->isSuccessful())
			0 ignored issues – show Documentation introduced 2017-10-20 09:54 UTC by Report Bug Copy Issue Report `$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...
67			->setAmount($this->moneyParser->parse($response->getAmount(), $response->getCurrency()))
68			->setFee($this->moneyParser->parse($response->getFee(), $response->getCurrency()))
69			->setTransactionReference($response->getTransactionReference())
70			->setTransactionId($response->getTransactionId())
71			->setPayer($response->getPayer())
72			->setTime(new \DateTime($response->getTime()));
73			}
74
75			}
76

hiqdev / php-merchant

Pull Request — master (#1)

BitPayMerchant A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like