Asanpardakht::reverse() - Code Metrics - Inspection of "Improvement AsanPardakht rest api" - shetabit/multipay - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#89)

unknown

created 2021-07-11 12:19 UTC

Asanpardakht::reverse() A

↳ Parent: Asanpardakht

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	3	Features	1

Metric	Value
cc	1
eloc	3
c	4
b	3
f	1
nc	1
nop	0
dl	0
loc	5
rs	10

<?php

namespace Shetabit\Multipay\Drivers\Asanpardakht;

use GuzzleHttp\Client;
use Shetabit\Multipay\Abstracts\Driver;
use Shetabit\Multipay\Exceptions\PurchaseFailedException;
use Shetabit\Multipay\Contracts\ReceiptInterface;
use Shetabit\Multipay\Invoice;
use Shetabit\Multipay\Receipt;
use Shetabit\Multipay\RedirectionForm;

class Asanpardakht extends Driver
{
    const TokenURL = 'Token';
    const TimeURL = 'Time';
    const TranResultURL = 'TranResult';
    const CardHashURL = 'CardHash';
    const SettlementURL = 'Settlement';
    const VerifyURL = 'Verify';
    const CancelURL = 'Cancel';
    const ReverseURL = 'Reverse';

    /**
     * Invoice
     *
     * @var Invoice
     */
    protected $invoice;

    /**
     * Response
     *
     * @var object
     */
    protected $response;

    /**
     * PayGateTransactionId
     *
     */
    protected $payGateTransactionId;

    /**
     * Driver settings
     *
     * @var object
     */
    protected $settings;

    /**
     * Asanpardakht constructor.
     * Construct the class with the relevant settings.
     *
     * @param Invoice $invoice
     * @param $settings
     */
    public function __construct(Invoice $invoice, $settings)
    {
        $this->invoice($invoice);
        $this->settings = (object)$settings;

        //convert to rial
        $this->invoice->amount($this->invoice->getAmount() * 10);
    }

    /**
     * Purchase Invoice.
     *
     * @return string
     *
     * @throws PurchaseFailedException
     */
    public function purchase()
    {
        $this->invoice->uuid(crc32($this->invoice->getUuid()));

        $result = $this->token();

        if (!isset($result['status_code']) or $result['status_code'] != 200) {
            $this->purchaseFailed($result['status_code']);
        }

        $this->invoice->transactionId($result['content']);

        // return the transaction's id
        return $this->invoice->getTransactionId();
    }

    /**
     * Pay the Invoice
     *
     * @return RedirectionForm
     */
    public function pay(): RedirectionForm
    {
        $data = [
            'RefID' => $this->invoice->getTransactionId()
        ];

        //set mobileap for get user cards
        if (!empty($this->invoice->getDetails()['mobile'])) {
            $data['mobileap'] = $this->invoice->getDetails()['mobile'];
        }

        return $this->redirectWithForm($this->settings->apiPaymentUrl, $data, 'POST');
    }

    /**
     * Verify payment
     *
     * @return mixed|Receipt
     *
     * @throws PurchaseFailedException
     */
    public function verify(): ReceiptInterface
    {
        $result = $this->transactionResult();

        if (!isset($result['status_code']) or $result['status_code'] != 200) {
            $this->purchaseFailed($result['status_code']);
        }

        $this->payGateTransactionId = $result['content']['payGateTranID'];

        //step1: verify
        $verify_result = $this->verifyTransaction();

        if (!isset($verify_result['status_code']) or $verify_result['status_code'] != 200) {
            $this->purchaseFailed($verify_result['status_code']);
        }

        //step2: settlement
        $this->settlement();

        $receipt = $this->createReceipt($this->payGateTransactionId);
        $receipt->detail([
            'traceNo' => $this->payGateTransactionId,
            'referenceNo' => $result['content']['rrn'],
            'transactionId' => $result['content']['refID'],
            'cardNo' => $result['content']['cardNumber'],
        ]);

        return $receipt;
    }

    /**
     * send request to Asanpardakht
     *
     * @param $method
     * @param $url
     * @param array $data
     * @return array
     */
    protected function callApi($method, $url, $data = []): array
    {
        $client = new Client(['base_uri' => $this->settings->apiRestPaymentUrl]);

        $response = $client->request($method, $url, [
            "json" => $data,
            "headers" => [
                'Content-Type' => 'application/json',
                'usr' => $this->settings->username,
                'pwd' => $this->settings->password
            ],
            "http_errors" => false,
        ]);

        return [
            'status_code' => $response->getStatusCode(),
            'content' => json_decode($response->getBody()->getContents(), true)
        ];
    }

    /**
     * Generate the payment's receipt
     *
     * @param $referenceId
     *
     * @return Receipt
     */
    protected function createReceipt($referenceId): Receipt
    {
        $receipt = new Receipt('asanpardakht', $referenceId);

        return $receipt;
    }

    /**
     * call create token request
     *
     * @return array
     */
    public function token(): array
    {
        return $this->callApi('POST', self::TokenURL, [
            'serviceTypeId' => 1,
            'merchantConfigurationId' => $this->settings->merchantConfigID,
            'localInvoiceId' => $this->invoice->getUuid(),
            'amountInRials' => $this->invoice->getAmount(),
            'localDate' => $this->getTime()['content'],
            'callbackURL' => $this->settings->callbackUrl . "?" . http_build_query(['invoice' => $this->invoice->getUuid()]),
            'paymentId' => "0",
            'additionalData' => '',
        ]);
    }

    /**
     * call reserve request
     *
     * @return array
     */
    public function reverse(): array
    {
        return $this->callApi('POST', self::ReverseURL, [
            'merchantConfigurationId' => (int)$this->settings->merchantConfigID,
            'payGateTranId' => (int)$this->invoice->getUuid()
        ]);
    }

    /**
     * send cancel request
     *
     * @return array
     */
    public function cancel(): array
    {
        return $this->callApi('POST', self::CancelURL, [
            'merchantConfigurationId' => (int)$this->settings->merchantConfigID,
            'payGateTranId' => (int)$this->payGateTransactionId
        ]);
    }

    /**
     * send verify request
     *
     * @return array
     */
    public function verifyTransaction(): array
    {
        return $this->callApi('POST', self::VerifyURL, [
            'merchantConfigurationId' => (int)$this->settings->merchantConfigID,
            'payGateTranId' => (int)$this->payGateTransactionId
        ]);
    }

    /**
     * send settlement request
     *
     * @return array
     */
    public function settlement(): array
    {
        return $this->callApi('POST', self::SettlementURL, [
            'merchantConfigurationId' => (int)$this->settings->merchantConfigID,
            'payGateTranId' => (int)$this->payGateTransactionId
        ]);
    }

    /**
     * get card hash request
     *
     * @return array
     */
    public function cardHash(): array
    {
        return $this->callApi('GET', self::CardHashURL . '?merchantConfigurationId=' . $this->settings->merchantConfigID . '&localInvoiceId=' . $this->invoice->getTransactionId(), []);
    }

    /**
     * get transaction result
     *
     * @return array
     */
    public function transactionResult(): array
    {
        return $this->callApi('GET', self::TranResultURL . '?merchantConfigurationId=' . $this->settings->merchantConfigID . '&localInvoiceId=' . $this->invoice->getTransactionId(), []);
    }

    /**
     * get Asanpardakht server time
     *
     * @return array
     */
    public function getTime(): array
    {
        return $this->callApi('GET', self::TimeURL);
    }

    /**
     * Trigger an exception
     *
     * @param $status
     *
     * @throws PurchaseFailedException
     */
    protected function purchaseFailed($status)
    {
        $translations = [
            400 => "bad request",
            401 => "unauthorized. probably wrong or unsent header(s)",
            471 => "identity not trusted to proceed",
            472 => "no records found",
            473 => "invalid merchant username or password",
            474 => "invalid incoming request machine ip. check response body to see your actual public IP address",
            475 => "invoice identifier is not a number",
            476 => "request amount is not a number",
            477 => "request local date length is invalid",
            478 => "request local date is not in valid format",
            479 => "invalid service type id",
            480 => "invalid payer id",
            481 => "incorrect settlement description format",
            482 => "settlement slices does not match total amount",
            483 => "unregistered iban",
            484 => "internal error for other reasons",
            485 => "invalid local date",
            486 => "amount not in range",
            487 => "service not found or not available for merchant",
            488 => "invalid default callback",
            489 => "duplicate local invoice id",
            490 => "merchant disabled or misconfigured",
            491 => "too many settlement destinations",
            492 => "unprocessable request",
            493 => "error processing special request for other reasons like business restrictions",
            494 => "invalid payment_id for governmental payment",
            495 => "invalid referenceId in additionalData",
            496 => "invalid json in additionalData",
            497 => "invalid payment_id location",
            571 => "misconfiguration OR not yet processed",
            572 => "misconfiguration OR transaction status undetermined",
            573 => "misconfiguraed valid ips for configuration OR unable to request for verification due to an internal error",
            574 => "internal error in uthorization",
            575 => "no valid ibans found for merchant",
            576 => "internal error",
            577 => "internal error",
            578 => "no default sharing is defined for merchant",
            579 => "cant submit ibans with default sharing endpoint",
            580 => "error processing special request"
        ];

        if (array_key_exists($status, $translations)) {
            throw new PurchaseFailedException($translations[$status]);
        } else {
            throw new PurchaseFailedException('خطای ناشناخته ای رخ داده است.');
        }
    }
}


1			<?php
2
3			namespace Shetabit\Multipay\Drivers\Asanpardakht;
4
5			use GuzzleHttp\Client;
6			use Shetabit\Multipay\Abstracts\Driver;
7			use Shetabit\Multipay\Exceptions\PurchaseFailedException;
8			use Shetabit\Multipay\Contracts\ReceiptInterface;
9			use Shetabit\Multipay\Invoice;
10			use Shetabit\Multipay\Receipt;
11			use Shetabit\Multipay\RedirectionForm;
12
13			class Asanpardakht extends Driver
14			{
15			const TokenURL = 'Token';
16			const TimeURL = 'Time';
17			const TranResultURL = 'TranResult';
18			const CardHashURL = 'CardHash';
19			const SettlementURL = 'Settlement';
20			const VerifyURL = 'Verify';
21			const CancelURL = 'Cancel';
22			const ReverseURL = 'Reverse';
23
24			/**
25			* Invoice
26			*
27			* @var Invoice
28			*/
29			protected $invoice;
30
31			/**
32			* Response
33			*
34			* @var object
35			*/
36			protected $response;
37
38			/**
39			* PayGateTransactionId
40			*
41			*/
42			protected $payGateTransactionId;
43
44			/**
45			* Driver settings
46			*
47			* @var object
48			*/
49			protected $settings;
50
51			/**
52			* Asanpardakht constructor.
53			* Construct the class with the relevant settings.
54			*
55			* @param Invoice $invoice
56			* @param $settings
57			*/
58			public function __construct(Invoice $invoice, $settings)
59			{
60			$this->invoice($invoice);
61			$this->settings = (object)$settings;
62
63			//convert to rial
64			$this->invoice->amount($this->invoice->getAmount() * 10);
65			}
66
67			/**
68			* Purchase Invoice.
69			*
70			* @return string
71			*
72			* @throws PurchaseFailedException
73			*/
74			public function purchase()
75			{
76			$this->invoice->uuid(crc32($this->invoice->getUuid()));
77
78			$result = $this->token();
79
80			if (!isset($result['status_code']) or $result['status_code'] != 200) {
81			$this->purchaseFailed($result['status_code']);
82			}
83
84			$this->invoice->transactionId($result['content']);
85
86			// return the transaction's id
87			return $this->invoice->getTransactionId();
88			}
89
90			/**
91			* Pay the Invoice
92			*
93			* @return RedirectionForm
94			*/
95			public function pay(): RedirectionForm
96			{
97			$data = [
98			'RefID' => $this->invoice->getTransactionId()
99			];
100
101			//set mobileap for get user cards
102			if (!empty($this->invoice->getDetails()['mobile'])) {
103			$data['mobileap'] = $this->invoice->getDetails()['mobile'];
104			}
105
106			return $this->redirectWithForm($this->settings->apiPaymentUrl, $data, 'POST');
107			}
108
109			/**
110			* Verify payment
111			*
112			* @return mixed\|Receipt
113			*
114			* @throws PurchaseFailedException
115			*/
116			public function verify(): ReceiptInterface
117			{
118			$result = $this->transactionResult();
119
120			if (!isset($result['status_code']) or $result['status_code'] != 200) {
121			$this->purchaseFailed($result['status_code']);
122			}
123
124			$this->payGateTransactionId = $result['content']['payGateTranID'];
125
126			//step1: verify
127			$verify_result = $this->verifyTransaction();
128
129			if (!isset($verify_result['status_code']) or $verify_result['status_code'] != 200) {
130			$this->purchaseFailed($verify_result['status_code']);
131			}
132
133			//step2: settlement
134			$this->settlement();
135
136			$receipt = $this->createReceipt($this->payGateTransactionId);
137			$receipt->detail([
138			'traceNo' => $this->payGateTransactionId,
139			'referenceNo' => $result['content']['rrn'],
140			'transactionId' => $result['content']['refID'],
141			'cardNo' => $result['content']['cardNumber'],
142			]);
143
144			return $receipt;
145			}
146
147			/**
148			* send request to Asanpardakht
149			*
150			* @param $method
151			* @param $url
152			* @param array $data
153			* @return array
154			*/
155			protected function callApi($method, $url, $data = []): array
156			{
157			$client = new Client(['base_uri' => $this->settings->apiRestPaymentUrl]);
158
159			$response = $client->request($method, $url, [
160			"json" => $data,
161			"headers" => [
162			'Content-Type' => 'application/json',
163			'usr' => $this->settings->username,
164			'pwd' => $this->settings->password
165			],
166			"http_errors" => false,
167			]);
168
169			return [
170			'status_code' => $response->getStatusCode(),
171			'content' => json_decode($response->getBody()->getContents(), true)
172			];
173			}
174
175			/**
176			* Generate the payment's receipt
177			*
178			* @param $referenceId
179			*
180			* @return Receipt
181			*/
182			protected function createReceipt($referenceId): Receipt
183			{
184			$receipt = new Receipt('asanpardakht', $referenceId);
185
186			return $receipt;
187			}
188
189			/**
190			* call create token request
191			*
192			* @return array
193			*/
194			public function token(): array
195			{
196			return $this->callApi('POST', self::TokenURL, [
197			'serviceTypeId' => 1,
198			'merchantConfigurationId' => $this->settings->merchantConfigID,
199			'localInvoiceId' => $this->invoice->getUuid(),
200			'amountInRials' => $this->invoice->getAmount(),
201			'localDate' => $this->getTime()['content'],
202			'callbackURL' => $this->settings->callbackUrl . "?" . http_build_query(['invoice' => $this->invoice->getUuid()]),
203			'paymentId' => "0",
204			'additionalData' => '',
205			]);
206			}
207
208			/**
209			* call reserve request
210			*
211			* @return array
212			*/
213			public function reverse(): array
214			{
215			return $this->callApi('POST', self::ReverseURL, [
216			'merchantConfigurationId' => (int)$this->settings->merchantConfigID,
217			'payGateTranId' => (int)$this->invoice->getUuid()
218			]);
219			}
220
221			/**
222			* send cancel request
223			*
224			* @return array
225			*/
226			public function cancel(): array
227			{
228			return $this->callApi('POST', self::CancelURL, [
229			'merchantConfigurationId' => (int)$this->settings->merchantConfigID,
230			'payGateTranId' => (int)$this->payGateTransactionId
231			]);
232			}
233
234			/**
235			* send verify request
236			*
237			* @return array
238			*/
239			public function verifyTransaction(): array
240			{
241			return $this->callApi('POST', self::VerifyURL, [
242			'merchantConfigurationId' => (int)$this->settings->merchantConfigID,
243			'payGateTranId' => (int)$this->payGateTransactionId
244			]);
245			}
246
247			/**
248			* send settlement request
249			*
250			* @return array
251			*/
252			public function settlement(): array
253			{
254			return $this->callApi('POST', self::SettlementURL, [
255			'merchantConfigurationId' => (int)$this->settings->merchantConfigID,
256			'payGateTranId' => (int)$this->payGateTransactionId
257			]);
258			}
259
260			/**
261			* get card hash request
262			*
263			* @return array
264			*/
265			public function cardHash(): array
266			{
267			return $this->callApi('GET', self::CardHashURL . '?merchantConfigurationId=' . $this->settings->merchantConfigID . '&localInvoiceId=' . $this->invoice->getTransactionId(), []);
268			}
269
270			/**
271			* get transaction result
272			*
273			* @return array
274			*/
275			public function transactionResult(): array
276			{
277			return $this->callApi('GET', self::TranResultURL . '?merchantConfigurationId=' . $this->settings->merchantConfigID . '&localInvoiceId=' . $this->invoice->getTransactionId(), []);
278			}
279
280			/**
281			* get Asanpardakht server time
282			*
283			* @return array
284			*/
285			public function getTime(): array
286			{
287			return $this->callApi('GET', self::TimeURL);
288			}
289
290			/**
291			* Trigger an exception
292			*
293			* @param $status
294			*
295			* @throws PurchaseFailedException
296			*/
297			protected function purchaseFailed($status)
298			{
299			$translations = [
300			400 => "bad request",
301			401 => "unauthorized. probably wrong or unsent header(s)",
302			471 => "identity not trusted to proceed",
303			472 => "no records found",
304			473 => "invalid merchant username or password",
305			474 => "invalid incoming request machine ip. check response body to see your actual public IP address",
306			475 => "invoice identifier is not a number",
307			476 => "request amount is not a number",
308			477 => "request local date length is invalid",
309			478 => "request local date is not in valid format",
310			479 => "invalid service type id",
311			480 => "invalid payer id",
312			481 => "incorrect settlement description format",
313			482 => "settlement slices does not match total amount",
314			483 => "unregistered iban",
315			484 => "internal error for other reasons",
316			485 => "invalid local date",
317			486 => "amount not in range",
318			487 => "service not found or not available for merchant",
319			488 => "invalid default callback",
320			489 => "duplicate local invoice id",
321			490 => "merchant disabled or misconfigured",
322			491 => "too many settlement destinations",
323			492 => "unprocessable request",
324			493 => "error processing special request for other reasons like business restrictions",
325			494 => "invalid payment_id for governmental payment",
326			495 => "invalid referenceId in additionalData",
327			496 => "invalid json in additionalData",
328			497 => "invalid payment_id location",
329			571 => "misconfiguration OR not yet processed",
330			572 => "misconfiguration OR transaction status undetermined",
331			573 => "misconfiguraed valid ips for configuration OR unable to request for verification due to an internal error",
332			574 => "internal error in uthorization",
333			575 => "no valid ibans found for merchant",
334			576 => "internal error",
335			577 => "internal error",
336			578 => "no default sharing is defined for merchant",
337			579 => "cant submit ibans with default sharing endpoint",
338			580 => "error processing special request"
339			];
340
341			if (array_key_exists($status, $translations)) {
342			throw new PurchaseFailedException($translations[$status]);
343			} else {
344			throw new PurchaseFailedException('خطای ناشناخته ای رخ داده است.');
345			}
346			}
347			}
348

shetabit / multipay

Pull Request — master (#89)

Asanpardakht::reverse() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like