CompletePurchaseResponse::getReasonCode() - Code Metrics - Inspection of "Add support for getting the reason code from the r..." - PatronBase/omnipay-cybersource-hosted - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a20d58...66381e )

by Leith

created 2019-08-27 06:34 UTC

CompletePurchaseResponse::getReasonCode() A

↳ Parent: CompletePurchaseResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php

namespace Omnipay\CyberSource\Message;

use Omnipay\Common\Message\AbstractResponse;
use Omnipay\Common\Message\RequestInterface;
use Omnipay\Common\Exception\InvalidResponseException;

/**
 * CyberSource Complete Purchase Response
 */
class CompletePurchaseResponse extends AbstractResponse
{
    /**
     * Constructor
     *
     * @param RequestInterface $request the initiating request.
     * @param mixed $data
     *
     * @throws InvalidResponseException If merchant data or order number is missing, or signature does not match
     */
    public function __construct(RequestInterface $request, $data)
    {
        parent::__construct($request, $data);

        foreach (array('decision', 'signed_field_names', 'signature') as $key) {
            if (empty($data[$key])) {
                throw new InvalidResponseException('Invalid response from payment gateway (no data)');
            }
        }

        $security = new Security();

        $returnSignature = $security->createSignature(
            $data,
            explode(',', $data['signed_field_names']),
            $this->request->getSecretKey()
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 ($returnSignature != $data['signature']) {
            throw new InvalidResponseException('Invalid response from payment gateway (signature mismatch)');
        }
    }

    /**
     * Is the response successful?
     * 
     * Possible values: 'ACCEPT', 'DECLINE', 'REVIEW', 'ERROR', 'CANCEL'
     *
     * @return boolean
     */
    public function isSuccessful()
    {
        return $this->getKey('decision') === 'ACCEPT';
    }

    /**
     * Get the transaction identifier if available.
     *
     * @return null|string
     */
    public function getTransactionReference()
    {
        return $this->getKey('transaction_id');
    }

    /**
     * Get the authorisation code if available.
     *
     * @return null|string
     */
    public function getAuthCode()
    {
        return $this->getKey('auth_code');
    }

    /**
     * Get the reason code if available.
     *
     * @return null|string
     */
    public function getReasonCode()
    {
        return $this->getKey('reason_code');
    }

    /**
     * Get the merchant response message if available.
     *
     * @return null|string
     */
    public function getMessage()
    {
        return $this->getKey('message');
    }

    /**
     * Get the card number if available.
     *
     * @return null|string
     */
    public function getCardNumber()
    {
        return $this->getKey('req_card_number');
    }

    /**
     * Get the card type if available.
     *
     * @return null|string  3-digit number that maps to CyberSource-specific list of card types
     */
    public function getCardType()
    {
        return $this->getKey('req_card_type');
    }

    /**
     * Get the card expiry if available.
     *
     * @return null|string  Format 'mm-yyyy'
     */
    public function getCardExpiry()
    {
        return $this->getKey('req_card_expiry_date');
    }

    /**
     * Helper method to get a specific response parameter if available.
     *
     * @param string $key The key to look up
     *
     * @return null|mixed
     */
    protected function getKey($key)
    {
        return isset($this->data[$key]) ? $this->data[$key] : null;
    }
}


1		<?php
2
3		namespace Omnipay\CyberSource\Message;
4
5		use Omnipay\Common\Message\AbstractResponse;
6		use Omnipay\Common\Message\RequestInterface;
7		use Omnipay\Common\Exception\InvalidResponseException;
8
9		/**
10		* CyberSource Complete Purchase Response
11		*/
12		class CompletePurchaseResponse extends AbstractResponse
13		{
14		/**
15		* Constructor
16		*
17		* @param RequestInterface $request the initiating request.
18		* @param mixed $data
19		*
20		* @throws InvalidResponseException If merchant data or order number is missing, or signature does not match
21		*/
22	13	public function __construct(RequestInterface $request, $data)
23		{
24	13	parent::__construct($request, $data);
25
26	13	foreach (array('decision', 'signed_field_names', 'signature') as $key) {
27	13	if (empty($data[$key])) {
28	13	throw new InvalidResponseException('Invalid response from payment gateway (no data)');
29		}
30		}
31
32	8	$security = new Security();
33
34	8	$returnSignature = $security->createSignature(
35	8	$data,
36	8	explode(',', $data['signed_field_names']),
37	8	$this->request->getSecretKey()
		0 ignored issues – show Bug introduced 2019-06-26 06:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Omnipay\Common\Message\RequestInterface` as the method `getSecretKey()` does only exist in the following implementations of said interface: `Omnipay\CyberSource\Mess...CompletePurchaseRequest`, `Omnipay\CyberSource\Message\PurchaseRequest`. 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...
38		);
39
40	8	if ($returnSignature != $data['signature']) {
41	1	throw new InvalidResponseException('Invalid response from payment gateway (signature mismatch)');
42		}
43	7	}
44
45		/**
46		* Is the response successful?
47		*
48		* Possible values: 'ACCEPT', 'DECLINE', 'REVIEW', 'ERROR', 'CANCEL'
49		*
50		* @return boolean
51		*/
52	7	public function isSuccessful()
53		{
54	7	return $this->getKey('decision') === 'ACCEPT';
55		}
56
57		/**
58		* Get the transaction identifier if available.
59		*
60		* @return null\|string
61		*/
62	4	public function getTransactionReference()
63		{
64	4	return $this->getKey('transaction_id');
65		}
66
67		/**
68		* Get the authorisation code if available.
69		*
70		* @return null\|string
71		*/
72	3	public function getAuthCode()
73		{
74	3	return $this->getKey('auth_code');
75		}
76
77		/**
78		* Get the reason code if available.
79		*
80		* @return null\|string
81		*/
82	3	public function getReasonCode()
83		{
84	3	return $this->getKey('reason_code');
85		}
86
87		/**
88		* Get the merchant response message if available.
89		*
90		* @return null\|string
91		*/
92	4	public function getMessage()
93		{
94	4	return $this->getKey('message');
95		}
96
97		/**
98		* Get the card number if available.
99		*
100		* @return null\|string
101		*/
102	3	public function getCardNumber()
103		{
104	3	return $this->getKey('req_card_number');
105		}
106
107		/**
108		* Get the card type if available.
109		*
110		* @return null\|string 3-digit number that maps to CyberSource-specific list of card types
111		*/
112	3	public function getCardType()
113		{
114	3	return $this->getKey('req_card_type');
115		}
116
117		/**
118		* Get the card expiry if available.
119		*
120		* @return null\|string Format 'mm-yyyy'
121		*/
122	3	public function getCardExpiry()
123		{
124	3	return $this->getKey('req_card_expiry_date');
125		}
126
127		/**
128		* Helper method to get a specific response parameter if available.
129		*
130		* @param string $key The key to look up
131		*
132		* @return null\|mixed
133		*/
134	7	protected function getKey($key)
135		{
136	7	return isset($this->data[$key]) ? $this->data[$key] : null;
137		}
138		}
139

PatronBase / omnipay-cybersource-hosted

Push — master ( a20d58...66381e )

CompletePurchaseResponse::getReasonCode() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like