DatatransAction::notify() - Code Metrics - Inspection of "Fix DatatransAction: queue messages with elevated..." - Ecodev/artisans - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a59cba...d7e91e )

by Sylvain

created 2020-12-08 16:54 UTC

DatatransAction::notify() A

↳ Parent: DatatransAction

Complexity

Conditions	3
Paths	4

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	10
c	1
b	0
f	0
nc	4
nop	1
dl	0
loc	18
ccs	12
cts	12
cp	1
crap	3
rs	9.9332

<?php

declare(strict_types=1);

namespace Application\Action;

use Application\Model\Order;
use Application\Model\User;
use Application\Repository\OrderRepository;
use Application\Repository\UserRepository;
use Application\Service\MessageQueuer;
use Doctrine\ORM\EntityManager;
use Ecodev\Felix\Service\Mailer;
use Exception;
use Laminas\Diactoros\Response\HtmlResponse;
use Mezzio\Template\TemplateRendererInterface;
use Money\Currencies\ISOCurrencies;
use Money\Formatter\DecimalMoneyFormatter;
use Money\Money;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Throwable;

class DatatransAction extends AbstractAction
{
    /**
     * @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 process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $request->getMethod();
        $body = $request->getParsedBody();

        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,
        ];

        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
        $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
    {
        $currencies = new ISOCurrencies();
        $moneyFormatter = new DecimalMoneyFormatter($currencies);

        return $moneyFormatter->format($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);
        }

        $admins = $repository->getAllAdministratorsToNotify();
        foreach ($admins as $admin) {
            $message = $this->messageQueuer->queueAdminValidatedOrder($admin, $order);
            $this->mailer->sendMessageAsync($message);
        }
    }
}


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

Ecodev / artisans

Push — master ( a59cba...d7e91e )

DatatransAction::notify() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like