Omnipay\Paxum\Message\CompletePurchaseResponse

Complexity

Total Complexity

20

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Test Coverage

Coverage

93.62%

Importance

Changes	5
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getRequest()	0	3	1
A	getTestMode()	0	3	1
A	getHash()	0	3	1
A	getTransactionId()	0	3	1
A	isSuccessful()	0	3	1
A	__construct()	0	16	4
A	calculateHash()	0	32	5
A	getCurrency()	0	3	1
A	getAmount()	0	3	1
A	getPayer()	0	3	1
A	getTime()	0	6	1
A	getTransactionReference()	0	3	1
A	getTransactionStatus()	0	3	1

<?php
/**
 * Paxum driver for PHP merchant library
 *
 * @link      https://github.com/hiqdev/omnipay-paxum
 * @package   omnipay-paxum
 * @license   MIT
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace Omnipay\Paxum\Message;

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

/**
 * Paxum Complete Purchase Response.
 */
class CompletePurchaseResponse extends AbstractResponse
{
    /**
     * @return AbstractRequest|RequestInterface
     */
    public function getRequest()
    {
        return parent::getRequest();
    }

    /**
     * @param RequestInterface $request
     * @param array $data
     * @throws InvalidResponseException when the request validation fails
     */
    public function __construct(RequestInterface $request, $data)
    {
        $this->request = $request;
        $this->data    = $data;

        if ($this->getTransactionStatus() !== 'done') {
            throw new InvalidResponseException('Transaction not done');
        }

        if ($this->getHash() !== $this->calculateHash()) {
            // echo "hashes: '" . $this->getHash() . "' - '" . $this->calculateHash() . "'\n";
            throw new InvalidResponseException('Invalid hash');
        }

        if ($this->request->getTestMode() !== $this->getTestMode()) {
            throw new InvalidResponseException('Invalid test mode');
        }
    }

    /**
     * {@inheritdoc}
     */
    public function isSuccessful()
    {
        return true;
    }

    /**
     * {@inheritdoc}
     * @return string
     */
    public function getTransactionId()
    {
        return $this->data['item_id'];
    }

    /**
     * {@inheritdoc}
     * @return string
     */
    public function getTransactionReference()
    {
        return $this->data['transaction_id'];
    }

    public function getTransactionStatus()
    {
        return $this->data['transaction_status'];
    }

    /**
     * {@inheritdoc}
     * @return string
     */
    public function getAmount()
    {
        return str_replace(',', '', $this->data['transaction_amount']);
    }

    /**
     * Get payment time.
     *
     * @return string
     */
    public function getTime()
    {
        $time = new DateTime($this->data['transaction_date'], new DateTimeZone('EST'));
        $time->setTimezone(new DateTimeZone('UTC'));

        return $time->format('c');
    }

    /**
     * Get payment currency.
     *
     * @return string
     */
    public function getCurrency()
    {
        return $this->data['transaction_currency'];
    }

    /**
     * Get test mode.
     *
     * @return string
     */
    public function getTestMode()
    {
        return $this->data['test'] === '1';

The expression return $this->data['test'] === '1' returns the type boolean which is incompatible with the documented return type string.

    }

    /**
     * Get payer info - name, username and id.
     *
     * @return string
     */
    public function getPayer()
    {
        return $this->data['buyer_name'] . '/' . $this->data['buyer_username'] . '/' . $this->data['buyer_id'];
    }

    /**
     * Get hash from request.
     *
     * @return string
     */
    public function getHash()
    {
        return $this->data['key'];
    }

    /**
     * Calculate hash to validate incoming IPN notifications.
     *
     * @return string
     */
    public function calculateHash()
    {
        // this is the documentation way
        $raw = file_get_contents('php://input');
        $fields = substr($raw, 0, strpos($raw, '&key='));
        $secret = $this->request->getSecret();

The method getSecret() does not exist on Omnipay\Common\Message\RequestInterface. It seems like you code against a sub-type of Omnipay\Common\Message\RequestInterface such as Omnipay\Paxum\Message\AbstractRequest.

        $supposed_hash = md5($fields . $secret);

The assignment to $supposed_hash is dead and can be removed.

        // this is how they actually get it
        $kvs = '';
        foreach ($this->data as $k => $v) {
            if ($k !== 'key' && $k !== 'username') {
                $kvs .= ($kvs ? '&' : '') . "$k=$v";
            }
        }
        $hash = md5($kvs);

The assignment to $hash is dead and can be removed.

        /* Testing facility
        dlog([
            'key'    => $this->getHash(),
            'fields' => $fields,
            'kvs'    => $kvs,
            'secret' => $secret,
            'hash'   => $hash,
            'h2'     => md5($fields),
            'h3'     => md5($fields . $secret),
            'kh3'    => md5($kvs),
            'kh4'    => md5($kvs . $secret),
        ]); */

        /// tmp fix
        return $this->getHash();
        //return $hash;
    }
}