Omnipay\IcepayPayments\Message\TransactionStatusRequest

Complexity

Total Complexity

15

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Test Coverage

Coverage

6.25%

Importance

Changes	8
Bugs	0	Features	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getData()	0	7	1
A	sendData()	0	29	4
A	getTransactionStatusFromPostBack()	0	27	5
A	validateSecurityHashMatch()	0	23	3
A	getPossibleValidHashes()	0	18	2

<?php

namespace Omnipay\IcepayPayments\Message;

use Omnipay\Common\Message\ResponseInterface;
use Omnipay\IcepayPayments\Exception\PostBackException;
use Symfony\Component\HttpFoundation\Request;

/**
 * The request for getting the transaction status at Icepay.
 */
class TransactionStatusRequest extends AbstractRequest
{
    /**
     * {@inheritdoc}
     */
    public function getData(): array
    {
        $data = parent::getData();

        $data['ContractProfileId'] = $this->getContractProfileId();

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function sendData($data): ResponseInterface
    {
        try {
            $transactionStatusResponse = $this->getTransactionStatusFromPostBack();
        } catch (PostBackException $exception) {
            // Optional parameter to throw the error instead of fallback.
            if (isset($data['throwOnPostBackError'])) {
                throw $exception;
            }
            $transactionStatusResponse = false;
        }

        if ($transactionStatusResponse !== false) {
            return $transactionStatusResponse;
        }

        $this->sendRequest(
            Request::METHOD_POST,
            sprintf(
                '/transaction/%s',
                $this->getTransactionReference()
            ),
            $data
        );

        return new TransactionStatusResponse(
            $this,
            $this->getResponseBody(),
            $this->getResponse()->getStatusCode()

The method getStatusCode() does not exist on Omnipay\Common\Message\ResponseInterface.

        );
    }

    /**
     * Use the data sent by Icepay in the post back to check the status.
     * This is necessary because Icepay has a delay in their backend if you request the status immediately after the signal.
     *
     * @see http://docs2.icepay.com/payment-process/handling-the-postback/postback-sample/
     *
     * @return TransactionStatusResponse|bool False when the data is is not sent or not correct.
     *
     * @throws PostBackException by call to self::validateSecurityHashMatch()
     */
    private function getTransactionStatusFromPostBack(): ?TransactionStatusResponse
    {
        if (stripos($this->httpRequest->getContentType(), 'json') === false) {
            return false;

The expression return false returns the type false which is incompatible with the type-hinted return Omnipay\IcepayPayments\Message\TransactionStatusResponse|null.

        }

        try {
            $contentAsArray = json_decode($this->httpRequest->getContent(), true);
        } catch(\LogicException $exception) {
            return false;

The expression return false returns the type false which is incompatible with the type-hinted return Omnipay\IcepayPayments\Message\TransactionStatusResponse|null.

        }

        if (is_array($contentAsArray) === false || isset($contentAsArray['StatusCode']) === false) {
            return false;

The expression return false returns the type false which is incompatible with the type-hinted return Omnipay\IcepayPayments\Message\TransactionStatusResponse|null.

        }

        $this->validateSecurityHashMatch($this->httpRequest, $contentAsArray);

        $camelCasedKeysContent = array_combine(
            array_map('lcfirst', array_keys($contentAsArray)),
            array_values($contentAsArray)
        );

        return new TransactionStatusResponse(
            $this,
            $camelCasedKeysContent,
            200
        );
    }

    /**
     * Get the security hash from the request and match it against a generated hash from the sent values.
     * Will throw an exception if it does not match.
     * Needs the POSTed Json as a php array.
     *
     * @param Request         $request
     * @param $contentAsArray
     *
     * @return bool
     *
     * @throws PostBackException
     */
    private function validateSecurityHashMatch(Request $request, $contentAsArray): bool
    {
        $generatedSecurityHash = $this->getSecurityHash(
            Request::METHOD_POST,
            $request->getPathInfo(),
            $contentAsArray
        );

        $sentSecurityHash = $request->headers->get('checksum');

        $possibleHashes = $this->getPossibleValidHashes($request, $contentAsArray);

        foreach ($possibleHashes as $generatedHash) {
            if ($generatedHash === $sentSecurityHash) {
                return true;
            }
        }

        throw new PostBackException(
            sprintf(
                'Sent security hash %s did not match generated hash %s',
                $sentSecurityHash,
                $generatedSecurityHash
            )
        );
    }

    /**
     * They way Icepay generates the hash is by using our notification url.
     * Though, they might add a trailing slash. Unsure of this at this point, so check both.
     *
     * @param Request $request
     * @param $contentAsArray
     *
     * @return array
     */
    private function getPossibleValidHashes(Request $request, $contentAsArray): array
    {
        $notifyUrls = [
            $request->getSchemeAndHttpHost() . $request->getRequestUri(),
            $request->getSchemeAndHttpHost() . $request->getRequestUri() . '/',
        ];

        $hashes = [];
        foreach ($notifyUrls as $notifyUrl) {
            $hashes[] = $this->getSecurityHash(
                $request->getMethod(),
                $notifyUrl,
                $contentAsArray,
                true
            );
        }

        return $hashes;
    }
}