DatatransHandler::handle() - Code Metrics - Inspection of "Renamed actions to handlers #7748" - Ecodev/my-ichtus - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 4dad36...cd91a2 )

by Adrien

created 2020-12-16 08:49 UTC

DatatransHandler::handle() A

↳ Parent: DatatransHandler

Complexity

Conditions	6
Paths	20

Size

Total Lines	30
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	6

Importance

Changes

Metric	Value
eloc	16
c	0
b	0
f	0
dl	0
loc	30
rs	9.1111
ccs	15
cts	15
cp	1
cc	6
nc	20
nop	1
crap	6

<?php

declare(strict_types=1);

namespace Application\Handler;

use Application\Model\Account;
use Application\Model\Transaction;
use Application\Model\TransactionLine;
use Application\Model\User;
use Application\Repository\AccountRepository;
use Application\Repository\LogRepository;
use Application\Repository\UserRepository;
use Cake\Chronos\Chronos;
use Doctrine\ORM\EntityManager;
use Ecodev\Felix\Handler\AbstractHandler;
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 Psr\Http\Server\RequestHandlerInterface;
use Throwable;

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

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

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

    /**
     * DatatransAction constructor.
     */
    public function __construct(EntityManager $entityManager, TemplateRendererInterface $template, array $config)
    {
        $this->entityManager = $entityManager;
        $this->template = $template;
        $this->config = $config;
    }

    /**
     * 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->createTransactions($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 createTransactions(array $body): void
    {
        // Create only if a transaction with the same Datatrans reference doesn't already exist
        $datatransRef = $body['uppTransactionId'];
        $transactionRepository = $this->entityManager->getRepository(Transaction::class);
        $existing = $transactionRepository->count(['datatransRef' => $datatransRef]);

        if ($existing) {
            return;
        }

        $userId = $body['refno'] ?? null;

        /** @var UserRepository $userRepository */
        $userRepository = $this->entityManager->getRepository(User::class);
        $user = $userRepository->getOneById((int) $userId);
        if (!$user) {
            throw new Exception('Cannot create transactions without a user');
        }

        /** @var AccountRepository $accountRepository */
        $accountRepository = $this->entityManager->getRepository(Account::class);
        $userAccount = $accountRepository->getOrCreate($user);
        $bankAccount = $accountRepository->getOneById(AccountRepository::ACCOUNT_ID_FOR_BANK);

        if (!array_key_exists('amount', $body)) {
            // Do not support "registrations"
            throw new Exception('Cannot create transactions without an amount');
        }

        $currency = $body['currency'] ?? '';
        if ($currency !== 'CHF') {
            throw new Exception('Can only create transactions for CHF, but got: ' . $currency);
        }

        $now = Chronos::now();
        $name = 'Versement en ligne';

        $transaction = new Transaction();
        $this->entityManager->persist($transaction);
        $transaction->setName($name);
        $transaction->setTransactionDate($now);
        $transaction->setDatatransRef($datatransRef);

        // This could be removed later on. For now it's mostly for debugging
        $transaction->setInternalRemarks(json_encode($body, JSON_PRETTY_PRINT));

        $line = new TransactionLine();
        $this->entityManager->persist($line);
        $line->setName($name);
        $line->setTransactionDate($now);
        $line->setBalance(Money::CHF($body['amount']));
        $line->setTransaction($transaction);
        $line->setCredit($userAccount);
        $line->setDebit($bankAccount);

        $this->entityManager->flush();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Application\Handler;
6
7		use Application\Model\Account;
8		use Application\Model\Transaction;
9		use Application\Model\TransactionLine;
10		use Application\Model\User;
11		use Application\Repository\AccountRepository;
12		use Application\Repository\LogRepository;
13		use Application\Repository\UserRepository;
14		use Cake\Chronos\Chronos;
15		use Doctrine\ORM\EntityManager;
16		use Ecodev\Felix\Handler\AbstractHandler;
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 Psr\Http\Server\RequestHandlerInterface;
24		use Throwable;
25
26		class DatatransHandler extends AbstractHandler
27		{
28		/**
29		* @var TemplateRendererInterface
30		*/
31		private $template;
32
33		/**
34		* @var EntityManager
35		*/
36		private $entityManager;
37
38		/**
39		* @var array
40		*/
41		private $config;
42
43		/**
44		* DatatransAction constructor.
45		*/
46	12	public function __construct(EntityManager $entityManager, TemplateRendererInterface $template, array $config)
47		{
48	12	$this->entityManager = $entityManager;
49	12	$this->template = $template;
50	12	$this->config = $config;
51	12	}
52
53		/**
54		* Webhook called by datatrans when a payment was made
55		*
56		* See documentation: https://api-reference.datatrans.ch/#failed-unsuccessful-authorization-response
57		*/
58	12	public function handle(ServerRequestInterface $request): ResponseInterface
59		{
60	12	$body = $request->getParsedBody();
61	12	$extraToLog = is_array($body) ? $body : ['rawBody' => $request->getBody()->getContents()];
62
63	12	_log()->info(LogRepository::DATATRANS_WEBHOOK_BEGIN, $extraToLog);
64
65		try {
66	12	if (!is_array($body)) {
67	1	throw new Exception('Parsed body is expected to be an array but got: ' . gettype($body));
68		}
69
70	11	if (isset($this->config['key'])) {
71	11	$this->checkSignature($body, $this->config['key']);
72		}
73
74	9	$status = $body['status'] ?? '';
75
76	9	$message = $this->dispatch($status, $body);
77	7	} catch (Throwable $exception) {
78	7	$message = $this->createMessage('error', $exception->getMessage(), is_array($body) ? $body : []);
79		}
80
81		$viewModel = [
82	12	'message' => $message,
83		];
84
85	12	_log()->info(LogRepository::DATATRANS_WEBHOOK_END, $message);
86
87	12	return new HtmlResponse($this->template->render('app::datatrans', $viewModel));
88		}
89
90		/**
91		* Make sure the signature protecting important body fields is valid
92		*
93		* @param string $key HMAC-SHA256 signing key in hexadecimal format
94		*/
95	11	private function checkSignature(array $body, string $key): void
96		{
97	11	if (!isset($body['sign'])) {
98	1	throw new Exception('Missing HMAC signature');
99		}
100	10	$aliasCC = $body['aliasCC'] ?? '';
101	10	$valueToSign = $aliasCC . @$body['merchantId'] . @$body['amount'] . @$body['currency'] . @$body['refno'];
102	10	$expectedSign = hash_hmac('sha256', trim($valueToSign), hex2bin(trim($key)));
103	10	if ($expectedSign !== $body['sign']) {
104	1	throw new Exception('Invalid HMAC signature');
105		}
106	9	}
107
108		/**
109		* Create a message in a coherent way
110		*/
111	12	private function createMessage(string $status, string $message, array $detail): array
112		{
113		return [
114	12	'status' => $status,
115	12	'message' => $message,
116	12	'detail' => $detail,
117		];
118		}
119
120		/**
121		* Dispatch the data received from Datatrans to take appropriate actions
122		*/
123	9	private function dispatch(string $status, array $body): array
124		{
125		switch ($status) {
126	9	case 'success':
127	6	$this->createTransactions($body);
128	3	$message = $this->createMessage($status, $body['responseMessage'], $body);
129
130	3	break;
131	3	case 'error':
132	1	$message = $this->createMessage($status, $body['errorMessage'], $body);
133
134	1	break;
135	2	case 'cancel':
136	1	$message = $this->createMessage($status, 'Cancelled', $body);
137
138	1	break;
139		default:
140	1	throw new Exception('Unsupported status in Datatrans data: ' . $status);
141		}
142
143	5	return $message;
144		}
145
146	6	private function createTransactions(array $body): void
147		{
148		// Create only if a transaction with the same Datatrans reference doesn't already exist
149	6	$datatransRef = $body['uppTransactionId'];
150	6	$transactionRepository = $this->entityManager->getRepository(Transaction::class);
151	6	$existing = $transactionRepository->count(['datatransRef' => $datatransRef]);
152
153	6	if ($existing) {
154	3	return;
155		}
156
157	6	$userId = $body['refno'] ?? null;
158
159		/** @var UserRepository $userRepository */
160	6	$userRepository = $this->entityManager->getRepository(User::class);
161	6	$user = $userRepository->getOneById((int) $userId);
162	6	if (!$user) {
163	1	throw new Exception('Cannot create transactions without a user');
164		}
165
166		/** @var AccountRepository $accountRepository */
167	5	$accountRepository = $this->entityManager->getRepository(Account::class);
168	5	$userAccount = $accountRepository->getOrCreate($user);
169	5	$bankAccount = $accountRepository->getOneById(AccountRepository::ACCOUNT_ID_FOR_BANK);
170
171	5	if (!array_key_exists('amount', $body)) {
172		// Do not support "registrations"
173	1	throw new Exception('Cannot create transactions without an amount');
174		}
175
176	4	$currency = $body['currency'] ?? '';
177	4	if ($currency !== 'CHF') {
178	1	throw new Exception('Can only create transactions for CHF, but got: ' . $currency);
179		}
180
181	3	$now = Chronos::now();
182	3	$name = 'Versement en ligne';
183
184	3	$transaction = new Transaction();
185	3	$this->entityManager->persist($transaction);
186	3	$transaction->setName($name);
187	3	$transaction->setTransactionDate($now);
188	3	$transaction->setDatatransRef($datatransRef);
189
190		// This could be removed later on. For now it's mostly for debugging
191	3	$transaction->setInternalRemarks(json_encode($body, JSON_PRETTY_PRINT));
192
193	3	$line = new TransactionLine();
194	3	$this->entityManager->persist($line);
195	3	$line->setName($name);
196	3	$line->setTransactionDate($now);
197	3	$line->setBalance(Money::CHF($body['amount']));
198	3	$line->setTransaction($transaction);
199	3	$line->setCredit($userAccount);
200	3	$line->setDebit($bankAccount);
201
202	3	$this->entityManager->flush();
203	3	}
204		}
205

Ecodev / my-ichtus

Push — master ( 4dad36...cd91a2 )

DatatransHandler::handle() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like