Vandar::verify() - Code Metrics - Inspection of "Add additional info to Vandar & Payping" - shetabit/multipay - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#156)

unknown

created 2022-08-17 06:45 UTC

Vandar::verify() B

↳ Parent: Vandar

Complexity

Conditions	7
Paths	14

Size

Total Lines	51
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	7
eloc	30
c	2
b	0
f	0
nc	14
nop	0
dl	0
loc	51
rs	8.5066

How to fix Long Method

<?php

namespace Shetabit\Multipay\Drivers\Vandar;

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

class Vandar extends Driver
{
    /**
     * Vandar Client.
     *
     * @var object
     */
    protected $client;

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

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

    const PAYMENT_STATUS_FAILED = 'FAILED';
    const PAYMENT_STATUS_OK = 'OK';

    public function __construct(Invoice $invoice, $settings)
    {
        $this->invoice($invoice);
        $this->settings = (object) $settings;
        $this->client = new Client();
    }

    /**
     * Retrieve data from details using its name.
     *
     * @return string
     */
    private function extractDetails($name)
    {
        return empty($this->invoice->getDetails()[$name]) ? null : $this->invoice->getDetails()[$name];
    }

    /**
     * @return string
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Shetabit\Multipay\Exceptions\PurchaseFailedException
     */
    public function purchase()
    {


        $mobile = $this->extractDetails('mobile');
        $description = $this->extractDetails('description');
        $nationalCode = $this->extractDetails('national_code');
        $validCard = $this->extractDetails('valid_card_number');
        $factorNumber = $this->extractDetails('factorNumber');

        $data = [
            'api_key' => $this->settings->merchantId,
            'amount' => $this->invoice->getAmount(),
            'callback_url' => $this->settings->callbackUrl,
            'description' => $description,
            'mobile_number' => $mobile,
            'national_code' => $nationalCode,
            'valid_card_number' => $validCard,
            'factorNumber' => $factorNumber,
        ];

        $response = $this->client
            ->request(
                'POST',
                $this->settings->apiPurchaseUrl,
                [
                    'json' => $data,
                    'headers' => [
                        "Accept" => "application/json",
                    ],
                    'http_errors' => false,
                ]
            );

        $responseBody = json_decode($response->getBody()->getContents(), true);
        $statusCode = (int) $responseBody['status'];

        if ($statusCode !== 1) {
            $errors = array_pop($responseBody['errors']);

            throw new PurchaseFailedException($errors);
        }

        $this->invoice->transactionId($responseBody['token']);

        return $this->invoice->getTransactionId();
    }

    /**
     * @return \Shetabit\Multipay\RedirectionForm
     */
    public function pay(): RedirectionForm
    {
        $url = $this->settings->apiPaymentUrl . $this->invoice->getTransactionId();

        return $this->redirectWithForm($url, [], 'GET');
    }

    /**
     * @return ReceiptInterface
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Shetabit\Multipay\Exceptions\InvalidPaymentException
     */
    public function verify(): ReceiptInterface
    {
        $token = Request::get('token');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $paymentStatus = Request::get('payment_status');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $data = [
            'api_key' => $this->settings->merchantId,
            'token' => $token
        ];

        if ($paymentStatus == self::PAYMENT_STATUS_FAILED) {

            $this->notVerified('پرداخت با شکست مواجه شد.');
        }

        $response = $this->client
            ->request(
                'POST',
                $this->settings->apiVerificationUrl,
                [
                    'json' => $data,
                    'headers' => [
                        "Accept" => "application/json",
                    ],
                    'http_errors' => false,
                ]
            );

        $responseBody = json_decode($response->getBody()->getContents(), true);
        $statusCode = (int) $responseBody['status'];

        if ($statusCode !== 1) {
            if (isset($responseBody['error'])) {
                $message = is_array($responseBody['error']) ? array_pop($responseBody['error']) : $responseBody['error'];
            }

            if (isset($responseBody['errors']) and is_array($responseBody['errors'])) {
                $message = array_pop($responseBody['errors']);
            }

            $this->notVerified($message ?? '');
        }

        $receipt = $this->createReceipt($token);

        $receipt->detail([
            "amount" => $responseBody['amount'],
            "realAmount" => $responseBody['realAmount'],
            "wage" => $responseBody['wage'],
            "cardNumber" => $responseBody['cardNumber'],
        ]);

        return $receipt;
    }

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

        return $receipt;
    }

    /**
     * @param $message
     * @throws \Shetabit\Multipay\Exceptions\InvalidPaymentException
     */
    protected function notVerified($message)
    {
        if (empty($message)) {
            throw new InvalidPaymentException('خطای ناشناخته ای رخ داده است.');
        } else {
            throw new InvalidPaymentException($message);
        }
    }
}


1			<?php
2
3			namespace Shetabit\Multipay\Drivers\Vandar;
4
5			use GuzzleHttp\Client;
6			use Shetabit\Multipay\Abstracts\Driver;
7			use Shetabit\Multipay\Contracts\ReceiptInterface;
8			use Shetabit\Multipay\Exceptions\InvalidPaymentException;
9			use Shetabit\Multipay\Exceptions\PurchaseFailedException;
10			use Shetabit\Multipay\Invoice;
11			use Shetabit\Multipay\Receipt;
12			use Shetabit\Multipay\RedirectionForm;
13			use Shetabit\Multipay\Request;
14
15			class Vandar extends Driver
16			{
17			/**
18			* Vandar Client.
19			*
20			* @var object
21			*/
22			protected $client;
23
24			/**
25			* Invoice
26			*
27			* @var Invoice
28			*/
29			protected $invoice;
30
31			/**
32			* Driver settings
33			*
34			* @var object
35			*/
36			protected $settings;
37
38			const PAYMENT_STATUS_FAILED = 'FAILED';
39			const PAYMENT_STATUS_OK = 'OK';
40
41			public function __construct(Invoice $invoice, $settings)
42			{
43			$this->invoice($invoice);
44			$this->settings = (object) $settings;
45			$this->client = new Client();
46			}
47
48			/**
49			* Retrieve data from details using its name.
50			*
51			* @return string
52			*/
53			private function extractDetails($name)
54			{
55			return empty($this->invoice->getDetails()[$name]) ? null : $this->invoice->getDetails()[$name];
56			}
57
58			/**
59			* @return string
60			* @throws \GuzzleHttp\Exception\GuzzleException
61			* @throws \Shetabit\Multipay\Exceptions\PurchaseFailedException
62			*/
63			public function purchase()
64			{
65
66
67			$mobile = $this->extractDetails('mobile');
68			$description = $this->extractDetails('description');
69			$nationalCode = $this->extractDetails('national_code');
70			$validCard = $this->extractDetails('valid_card_number');
71			$factorNumber = $this->extractDetails('factorNumber');
72
73			$data = [
74			'api_key' => $this->settings->merchantId,
75			'amount' => $this->invoice->getAmount(),
76			'callback_url' => $this->settings->callbackUrl,
77			'description' => $description,
78			'mobile_number' => $mobile,
79			'national_code' => $nationalCode,
80			'valid_card_number' => $validCard,
81			'factorNumber' => $factorNumber,
82			];
83
84			$response = $this->client
85			->request(
86			'POST',
87			$this->settings->apiPurchaseUrl,
88			[
89			'json' => $data,
90			'headers' => [
91			"Accept" => "application/json",
92			],
93			'http_errors' => false,
94			]
95			);
96
97			$responseBody = json_decode($response->getBody()->getContents(), true);
98			$statusCode = (int) $responseBody['status'];
99
100			if ($statusCode !== 1) {
101			$errors = array_pop($responseBody['errors']);
102
103			throw new PurchaseFailedException($errors);
104			}
105
106			$this->invoice->transactionId($responseBody['token']);
107
108			return $this->invoice->getTransactionId();
109			}
110
111			/**
112			* @return \Shetabit\Multipay\RedirectionForm
113			*/
114			public function pay(): RedirectionForm
115			{
116			$url = $this->settings->apiPaymentUrl . $this->invoice->getTransactionId();
117
118			return $this->redirectWithForm($url, [], 'GET');
119			}
120
121			/**
122			* @return ReceiptInterface
123			*
124			* @throws \GuzzleHttp\Exception\GuzzleException
125			* @throws \Shetabit\Multipay\Exceptions\InvalidPaymentException
126			*/
127			public function verify(): ReceiptInterface
128			{
129			$token = Request::get('token');
			0 ignored issues – show Bug introduced 2022-04-28 10:08 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$token` is correct as `Shetabit\Multipay\Request::get('token')` targeting `Shetabit\Multipay\Request::get()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
130			$paymentStatus = Request::get('payment_status');
			0 ignored issues – show Bug introduced 2022-04-28 10:08 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$paymentStatus` is correct as `Shetabit\Multipay\Request::get('payment_status')` targeting `Shetabit\Multipay\Request::get()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
131			$data = [
132			'api_key' => $this->settings->merchantId,
133			'token' => $token
134			];
135
136			if ($paymentStatus == self::PAYMENT_STATUS_FAILED) {
			0 ignored issues – show introduced 2022-04-28 10:08 UTC by Report Bug Copy Issue Report The condition `$paymentStatus == self::PAYMENT_STATUS_FAILED` is always `false`. Loading history...
137			$this->notVerified('پرداخت با شکست مواجه شد.');
138			}
139
140			$response = $this->client
141			->request(
142			'POST',
143			$this->settings->apiVerificationUrl,
144			[
145			'json' => $data,
146			'headers' => [
147			"Accept" => "application/json",
148			],
149			'http_errors' => false,
150			]
151			);
152
153			$responseBody = json_decode($response->getBody()->getContents(), true);
154			$statusCode = (int) $responseBody['status'];
155
156			if ($statusCode !== 1) {
157			if (isset($responseBody['error'])) {
158			$message = is_array($responseBody['error']) ? array_pop($responseBody['error']) : $responseBody['error'];
159			}
160
161			if (isset($responseBody['errors']) and is_array($responseBody['errors'])) {
162			$message = array_pop($responseBody['errors']);
163			}
164
165			$this->notVerified($message ?? '');
166			}
167
168			$receipt = $this->createReceipt($token);
169
170			$receipt->detail([
171			"amount" => $responseBody['amount'],
172			"realAmount" => $responseBody['realAmount'],
173			"wage" => $responseBody['wage'],
174			"cardNumber" => $responseBody['cardNumber'],
175			]);
176
177			return $receipt;
178			}
179
180			/**
181			* Generate the payment's receipt
182			*
183			* @param $referenceId
184			*
185			* @return Receipt
186			*/
187			protected function createReceipt($referenceId)
188			{
189			$receipt = new Receipt('vandar', $referenceId);
190
191			return $receipt;
192			}
193
194			/**
195			* @param $message
196			* @throws \Shetabit\Multipay\Exceptions\InvalidPaymentException
197			*/
198			protected function notVerified($message)
199			{
200			if (empty($message)) {
201			throw new InvalidPaymentException('خطای ناشناخته ای رخ داده است.');
202			} else {
203			throw new InvalidPaymentException($message);
204			}
205			}
206			}
207

shetabit / multipay

Pull Request — master (#156)

Vandar::verify() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like