Omnipay\Paxum\Message\CompletePurchaseResponse

Complexity

Total Complexity

18

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	1	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	4
A	isSuccessful()	0	4	1
A	getTransactionId()	0	4	1
A	getTransactionReference()	0	4	1
A	getTransactionStatus()	0	4	1
A	getAmount()	0	4	1
A	getTime()	0	4	1
A	getTestMode()	0	4	1
A	getPayer()	0	4	1
A	getHash()	0	4	1
B	calculateHash()	0	35	5

<?php

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

namespace Omnipay\Paxum\Message;

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

/**
 * Paxum Complete Purchase Response.
 */
class CompletePurchaseResponse extends AbstractResponse
{
    /**
     * @param RequestInterface $request
     * @param array $data
     */
    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";

45% of this comment could be valid code. Did you maybe forget this after debugging?

            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 $this->data['transaction_amount'];
    }

    /**
     * Get payment time.
     *
     * @return string
     */
    public function getTime()
    {
        return date('c', strtotime($this->data['transaction_date'] . ' EST'));
    }

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

    /**
     * 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()
    {
        // raw POST request
        $raw = file_get_contents('php://input');
        // removing trailing '&key=...'
        $fields = substr($raw, 0, strpos($raw, '&key='));
        // this is the documentation way
        $supposed_hash = md5($fields . $this->request->getSecret());

It seems like you code against a concrete implementation and not the interface Omnipay\Common\Message\RequestInterface as the method getSecret() does only exist in the following implementations of said interface: Omnipay\Paxum\Message\AbstractRequest, Omnipay\Paxum\Message\CompletePurchaseRequest, Omnipay\Paxum\Message\PurchaseRequest.

$supposed_hash is not used, you could remove the assignment.

        // 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);

        /* Testing facility

56% of this comment could be valid code. Did you maybe forget this after debugging?

        throw new \Exception(
            var_export([
                'key'    => $this->getHash(),
                'fields' => $fields,
                'secret' => $this->request->getSecret(),
                'hash'   => $hash,
                'h2'     => md5($fields),
                'h3'     => md5($fields . $this->request->getSecret()),
                'kvs'    => $kvs,
                'kh3'    => md5($kvs),
                'kh4'    => md5($kvs . $this->request->getSecret()),
            ], true)
        );*/

        return $hash;
    }
}