DatatransHandler::getMoney() - Code Metrics - Inspection of "Give web temp access when validating order #8468" - Ecodev/artisans - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 28ec5a...07f855 )

by Adrien

created 2021-10-04 07:30 UTC

DatatransHandler::getMoney() A

↳ Parent: DatatransHandler

Complexity

Conditions	4
Paths	4

Size

Total Lines	18
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4.016

Importance

Changes

Metric	Value
eloc	9
dl	0
loc	18
ccs	9
cts	10
cp	0.9
rs	9.9666
c	0
b	0
f	0
cc	4
nc	4
nop	1
crap	4.016

<?php

declare(strict_types=1);

namespace Application\Handler;

use Application\Model\Order;
use Application\Model\User;
use Application\Repository\LogRepository;
use Application\Repository\OrderRepository;
use Application\Repository\UserRepository;
use Application\Service\MessageQueuer;
use Doctrine\ORM\EntityManager;
use Ecodev\Felix\Format;
use Ecodev\Felix\Handler\AbstractHandler;
use Ecodev\Felix\Service\Mailer;
use Exception;
use Laminas\Diactoros\Response\HtmlResponse;
use Mezzio\Template\TemplateRendererInterface;
use Money\Money;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Throwable;

class DatatransHandler extends AbstractHandler
{
    /**
     * @var TemplateRendererInterface
     */
    private $template;

    /**
     * @var EntityManager
     */
    private $entityManager;

    /**
     * @var array
     */
    private $config;

    /**
     * @var Mailer
     */
    private $mailer;

    /**
     * @var MessageQueuer
     */
    private $messageQueuer;

    public function __construct(EntityManager $entityManager, TemplateRendererInterface $template, array $config, Mailer $mailer, MessageQueuer $messageQueuer)
    {
        $this->entityManager = $entityManager;
        $this->template = $template;
        $this->config = $config;
        $this->mailer = $mailer;
        $this->messageQueuer = $messageQueuer;
    }

    /**
     * Webhook called by datatrans when a payment was made
     *
     * See documentation: https://api-reference.datatrans.ch/#failed-unsuccessful-authorization-response
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $body = $request->getParsedBody();
        $extraToLog = is_array($body) ? $body : ['rawBody' => $request->getBody()->getContents()];

        _log()->info(LogRepository::DATATRANS_WEBHOOK_BEGIN, $extraToLog);

        try {
            if (!is_array($body)) {
                throw new Exception('Parsed body is expected to be an array but got: ' . gettype($body));
            }

            if (isset($this->config['key'])) {
                $this->checkSignature($body, $this->config['key']);
            }
            $status = $body['status'] ?? '';

            $message = $this->dispatch($status, $body);
        } catch (Throwable $exception) {
            $message = $this->createMessage('error', $exception->getMessage(), is_array($body) ? $body : []);
        }

        $viewModel = [
            'message' => $message,
        ];

        _log()->info(LogRepository::DATATRANS_WEBHOOK_END, $message);

        return new HtmlResponse($this->template->render('app::datatrans', $viewModel));
    }

    /**
     * Make sure the signature protecting important body fields is valid
     *
     * @param string $key HMAC-SHA256 signing key in hexadecimal format
     */
    private function checkSignature(array $body, string $key): void
    {
        if (!isset($body['sign'])) {
            throw new Exception('Missing HMAC signature');
        }

        $aliasCC = $body['aliasCC'] ?? '';
        $valueToSign = $aliasCC . @$body['merchantId'] . @$body['amount'] . @$body['currency'] . @$body['refno'];
        $expectedSign = hash_hmac('sha256', trim($valueToSign), hex2bin(trim($key)));
        if ($expectedSign !== $body['sign']) {
            throw new Exception('Invalid HMAC signature');
        }
    }

    /**
     * Create a message in a coherent way
     */
    private function createMessage(string $status, string $message, array $detail): array
    {
        return [
            'status' => $status,
            'message' => $message,
            'detail' => $detail,
        ];
    }

    /**
     * Dispatch the data received from Datatrans to take appropriate actions
     */
    private function dispatch(string $status, array $body): array
    {
        switch ($status) {
            case 'success':
                $this->validateOrder($body);
                $message = $this->createMessage($status, $body['responseMessage'], $body);

                break;
            case 'error':
                $message = $this->createMessage($status, $body['errorMessage'], $body);

                break;
            case 'cancel':
                $message = $this->createMessage($status, 'Cancelled', $body);

                break;
            default:
                throw new Exception('Unsupported status in Datatrans data: ' . $status);
        }

        return $message;
    }

    private function validateOrder(array $body): void
    {
        $orderId = $body['refno'] ?? null;

        /** @var OrderRepository $orderRepository */
        $orderRepository = $this->entityManager->getRepository(Order::class);

        /** @var null|Order $order */
        $order = $orderRepository->getAclFilter()->runWithoutAcl(function () use ($orderRepository, $orderId) {
            return $orderRepository->findOneById($orderId);
        });

        if (!$order) {
            throw new Exception('Cannot validate an order without a valid order ID');
        }

        if ($order->getPaymentMethod() !== \Application\DBAL\Types\PaymentMethodType::DATATRANS) {
            throw new Exception('Cannot validate an order whose payment method is: ' . $order->getPaymentMethod());
        }

        if ($order->getStatus() === Order::STATUS_VALIDATED) {
            throw new Exception('Cannot validate an order which is already validated');
        }

        $money = $this->getMoney($body);

        if (!$order->getBalanceCHF()->equals($money) && !$order->getBalanceEUR()->equals($money)) {
            $expectedCHF = $this->formatMoney($order->getBalanceCHF());
            $expectedEUR = $this->formatMoney($order->getBalanceEUR());
            $actual = $this->formatMoney($money);

            throw new Exception("Cannot validate an order with incorrect balance. Expected $expectedCHF, or $expectedEUR, but got: " . $actual);
        }

        // Actually validate
        $orderRepository->getAclFilter()->runWithoutAcl(function () use ($order, $body): void {
            $order->setStatus(Order::STATUS_VALIDATED);
            $order->setInternalRemarks(json_encode($body, JSON_PRETTY_PRINT));
        });

        $this->entityManager->flush();

        $this->notify($order);
    }

    private function formatMoney(Money $money): string
    {
        return Format::money($money) . ' ' . $money->getCurrency()->getCode();
    }

    private function getMoney(array $body): Money
    {
        if (!array_key_exists('amount', $body)) {
            // Do not support "registrations"
            throw new Exception('Cannot validate an order without an amount');
        }
        $amount = $body['amount'];

        $currency = $body['currency'] ?? '';
        if ($currency === 'CHF') {
            return Money::CHF($amount);
        }

        if ($currency === 'EUR') {
            return Money::EUR($amount);
        }

        throw new Exception('Can only accept payment in CHF or EUR, but got: ' . $currency);
    }

    /**
     * Notify the user and the admins
     */
    private function notify(Order $order): void
    {
        /** @var UserRepository $repository */
        $repository = $this->entityManager->getRepository(User::class);

        $user = $order->getOwner();

        if ($user) {
            $message = $repository->getAclFilter()->runWithoutAcl(function () use ($user, $order) {
                return $this->messageQueuer->queueUserValidatedOrder($user, $order);
            });
            $this->mailer->sendMessageAsync($message);
        }

        foreach ($this->messageQueuer->getAllEmailsToNotify() as $adminEmail) {
            $message = $this->messageQueuer->queueAdminValidatedOrder($adminEmail, $order);
            $this->mailer->sendMessageAsync($message);
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Application\Handler;
6
7		use Application\Model\Order;
8		use Application\Model\User;
9		use Application\Repository\LogRepository;
10		use Application\Repository\OrderRepository;
11		use Application\Repository\UserRepository;
12		use Application\Service\MessageQueuer;
13		use Doctrine\ORM\EntityManager;
14		use Ecodev\Felix\Format;
15		use Ecodev\Felix\Handler\AbstractHandler;
16		use Ecodev\Felix\Service\Mailer;
17		use Exception;
18		use Laminas\Diactoros\Response\HtmlResponse;
19		use Mezzio\Template\TemplateRendererInterface;
20		use Money\Money;
21		use Psr\Http\Message\ResponseInterface;
22		use Psr\Http\Message\ServerRequestInterface;
23		use Throwable;
24
25		class DatatransHandler extends AbstractHandler
26		{
27		/**
28		* @var TemplateRendererInterface
29		*/
30		private $template;
31
32		/**
33		* @var EntityManager
34		*/
35		private $entityManager;
36
37		/**
38		* @var array
39		*/
40		private $config;
41
42		/**
43		* @var Mailer
44		*/
45		private $mailer;
46
47		/**
48		* @var MessageQueuer
49		*/
50		private $messageQueuer;
51
52	15	public function __construct(EntityManager $entityManager, TemplateRendererInterface $template, array $config, Mailer $mailer, MessageQueuer $messageQueuer)
53		{
54	15	$this->entityManager = $entityManager;
55	15	$this->template = $template;
56	15	$this->config = $config;
57	15	$this->mailer = $mailer;
58	15	$this->messageQueuer = $messageQueuer;
59	15	}
60
61		/**
62		* Webhook called by datatrans when a payment was made
63		*
64		* See documentation: https://api-reference.datatrans.ch/#failed-unsuccessful-authorization-response
65		*/
66	15	public function handle(ServerRequestInterface $request): ResponseInterface
67		{
68	15	$body = $request->getParsedBody();
69	15	$extraToLog = is_array($body) ? $body : ['rawBody' => $request->getBody()->getContents()];
70
71	15	_log()->info(LogRepository::DATATRANS_WEBHOOK_BEGIN, $extraToLog);
72
73		try {
74	15	if (!is_array($body)) {
75	1	throw new Exception('Parsed body is expected to be an array but got: ' . gettype($body));
76		}
77
78	14	if (isset($this->config['key'])) {
79	13	$this->checkSignature($body, $this->config['key']);
80		}
81	12	$status = $body['status'] ?? '';
82
83	12	$message = $this->dispatch($status, $body);
84	10	} catch (Throwable $exception) {
85	10	$message = $this->createMessage('error', $exception->getMessage(), is_array($body) ? $body : []);
86		}
87
88		$viewModel = [
89	15	'message' => $message,
90		];
91
92	15	_log()->info(LogRepository::DATATRANS_WEBHOOK_END, $message);
93
94	15	return new HtmlResponse($this->template->render('app::datatrans', $viewModel));
95		}
96
97		/**
98		* Make sure the signature protecting important body fields is valid
99		*
100		* @param string $key HMAC-SHA256 signing key in hexadecimal format
101		*/
102	13	private function checkSignature(array $body, string $key): void
103		{
104	13	if (!isset($body['sign'])) {
105	1	throw new Exception('Missing HMAC signature');
106		}
107
108	12	$aliasCC = $body['aliasCC'] ?? '';
109	12	$valueToSign = $aliasCC . @$body['merchantId'] . @$body['amount'] . @$body['currency'] . @$body['refno'];
110	12	$expectedSign = hash_hmac('sha256', trim($valueToSign), hex2bin(trim($key)));
111	12	if ($expectedSign !== $body['sign']) {
112	1	throw new Exception('Invalid HMAC signature');
113		}
114	11	}
115
116		/**
117		* Create a message in a coherent way
118		*/
119	15	private function createMessage(string $status, string $message, array $detail): array
120		{
121		return [
122	15	'status' => $status,
123	15	'message' => $message,
124	15	'detail' => $detail,
125		];
126		}
127
128		/**
129		* Dispatch the data received from Datatrans to take appropriate actions
130		*/
131	12	private function dispatch(string $status, array $body): array
132		{
133		switch ($status) {
134	12	case 'success':
135	9	$this->validateOrder($body);
136	3	$message = $this->createMessage($status, $body['responseMessage'], $body);
137
138	3	break;
139	3	case 'error':
140	1	$message = $this->createMessage($status, $body['errorMessage'], $body);
141
142	1	break;
143	2	case 'cancel':
144	1	$message = $this->createMessage($status, 'Cancelled', $body);
145
146	1	break;
147		default:
148	1	throw new Exception('Unsupported status in Datatrans data: ' . $status);
149		}
150
151	5	return $message;
152		}
153
154	9	private function validateOrder(array $body): void
155		{
156	9	$orderId = $body['refno'] ?? null;
157
158		/** @var OrderRepository $orderRepository */
159	9	$orderRepository = $this->entityManager->getRepository(Order::class);
160
161		/** @var null\|Order $order */
162	9	$order = $orderRepository->getAclFilter()->runWithoutAcl(function () use ($orderRepository, $orderId) {
163	9	return $orderRepository->findOneById($orderId);
164	9	});
165
166	9	if (!$order) {
167	1	throw new Exception('Cannot validate an order without a valid order ID');
168		}
169
170	8	if ($order->getPaymentMethod() !== \Application\DBAL\Types\PaymentMethodType::DATATRANS) {
171	1	throw new Exception('Cannot validate an order whose payment method is: ' . $order->getPaymentMethod());
172		}
173
174	7	if ($order->getStatus() === Order::STATUS_VALIDATED) {
175	1	throw new Exception('Cannot validate an order which is already validated');
176		}
177
178	6	$money = $this->getMoney($body);
179
180	4	if (!$order->getBalanceCHF()->equals($money) && !$order->getBalanceEUR()->equals($money)) {
181	1	$expectedCHF = $this->formatMoney($order->getBalanceCHF());
182	1	$expectedEUR = $this->formatMoney($order->getBalanceEUR());
183	1	$actual = $this->formatMoney($money);
184
185	1	throw new Exception("Cannot validate an order with incorrect balance. Expected $expectedCHF, or $expectedEUR, but got: " . $actual);
186		}
187
188		// Actually validate
189	3	$orderRepository->getAclFilter()->runWithoutAcl(function () use ($order, $body): void {
190	3	$order->setStatus(Order::STATUS_VALIDATED);
191	3	$order->setInternalRemarks(json_encode($body, JSON_PRETTY_PRINT));
192	3	});
193
194	3	$this->entityManager->flush();
195
196	3	$this->notify($order);
197	3	}
198
199	1	private function formatMoney(Money $money): string
200		{
201	1	return Format::money($money) . ' ' . $money->getCurrency()->getCode();
202		}
203
204	6	private function getMoney(array $body): Money
205		{
206	6	if (!array_key_exists('amount', $body)) {
207		// Do not support "registrations"
208	1	throw new Exception('Cannot validate an order without an amount');
209		}
210	5	$amount = $body['amount'];
211
212	5	$currency = $body['currency'] ?? '';
213	5	if ($currency === 'CHF') {
214	4	return Money::CHF($amount);
215		}
216
217	1	if ($currency === 'EUR') {
218		return Money::EUR($amount);
219		}
220
221	1	throw new Exception('Can only accept payment in CHF or EUR, but got: ' . $currency);
222		}
223
224		/**
225		* Notify the user and the admins
226		*/
227	3	private function notify(Order $order): void
228		{
229		/** @var UserRepository $repository */
230	3	$repository = $this->entityManager->getRepository(User::class);
231
232	3	$user = $order->getOwner();
233
234	3	if ($user) {
235	3	$message = $repository->getAclFilter()->runWithoutAcl(function () use ($user, $order) {
236	3	return $this->messageQueuer->queueUserValidatedOrder($user, $order);
237	3	});
238	3	$this->mailer->sendMessageAsync($message);
239		}
240
241	3	foreach ($this->messageQueuer->getAllEmailsToNotify() as $adminEmail) {
242	3	$message = $this->messageQueuer->queueAdminValidatedOrder($adminEmail, $order);
243	3	$this->mailer->sendMessageAsync($message);
244		}
245	3	}
246		}
247

Ecodev / artisans

Push — master ( 28ec5a...07f855 )

DatatransHandler::getMoney() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like