Omnipay\IcepayPayments\Message\TransactionStatusRequest

Complexity

Total Complexity

15

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Test Coverage

Coverage

33.33%

Importance

Changes	14
Bugs	1	Features	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getData()	0	7	1
B	getTransactionStatusFromPostBack()	0	39	7
A	sendData()	0	20	2
A	validateSecurityHashMatch()	0	13	3
A	getPossibleValidHashes()	0	18	2

<?php

namespace Omnipay\IcepayPayments\Message;

use Omnipay\Common\Message\ResponseInterface;
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
    {
        $transactionStatusResponse = $this->getTransactionStatusFromPostBack();

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

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

        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|null - Null when the data is is not sent or not correct
     */
    private function getTransactionStatusFromPostBack(): ?TransactionStatusResponse
    {
        if (stripos($this->httpRequest->getContentType(), 'json') === false) {

It seems like $this->httpRequest->getContentType() can also be of type null; however, parameter $haystack of stripos() does only seem to accept string, maybe add an additional type check?

            return null;
        }

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

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

        $this->setContractProfileId($contentAsStdObj->ContractProfileId);

        // Make sure we're updating the correct payment by reference, and not all of them.
        // Note: $contentAsArray['Reference'] is not the same as TransactionReference.
        if ($this->getTransactionReference() !== trim($contentAsArray['TransactionId'])) {
            return null;
        }

        if ($this->validateSecurityHashMatch($this->httpRequest, $contentAsStdObj) === false) {
            return null;
        }

        $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.
     * Needs the POSTed JSON as stdClass.
     *
     * @param Request   $request
     * @param \stdClass $contentAsStdObj
     *
     * @return bool
     */
    private function validateSecurityHashMatch(Request $request, \stdClass $contentAsStdObj): bool
    {
        $sentSecurityHash = $request->headers->get('checksum');

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

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

        return false;
    }

    /**
     * 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 \stdClass $contentAsStdObj
     *
     * @return array
     */
    private function getPossibleValidHashes(Request $request, $contentAsStdObj): array
    {
        $notifyUrls = [
            $request->getSchemeAndHttpHost().$request->getRequestUri(),
            $request->getSchemeAndHttpHost().$request->getRequestUri().'/',
        ];

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

        return $hashes;
    }
}