yiiviet / yii2-payment

src/nganluong/PaymentGateway.php

<?php
/**
 * @link https://github.com/yiiviet/yii2-payment
 * @copyright Copyright (c) 2017 Yii Viet
 * @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
 */

namespace yiiviet\payment\nganluong;

use GatewayClients\DataInterface;

use yii\base\NotSupportedException;

use yiiviet\payment\BasePaymentGateway;

use vxm\gatewayclients\RequestEvent;

/**
 * Lớp PaymentGateway hổ trợ việc kết nối đến Ngân Lượng.
 * Hiện tại nó hỗ trợ 100% tính năng của Ngân Lượng v3.1, v3.2
 *
 * @method ResponseData purchase(array $data, $clientId = null)
 * @method ResponseData queryDR(array $data, $clientId = null)
 * @method VerifiedData verifyRequestPurchaseSuccess(\yii\web\Request $request = null, $clientId = null)
 * @method PaymentClient getClient($id = null)
 * @method PaymentClient getDefaultClient()
 *
 * @property PaymentClient $client
 * @property PaymentClient $defaultClient
 * @property bool $seamless
 *
 * @author Vuong Minh <vuongxuongminh@gmail.com>
 * @since 1.0
 */
class PaymentGateway extends BasePaymentGateway
{
    /**
     * Lệnh `authenticate` yêu cầu Ngân Lượng xác minh OTP của khách có hợp lệ hay không.
     * Nó được sử dụng ở version 3.2 phương thức seamless checkout.
     */
    const RC_AUTHENTICATE = 'authenticate';

    /**
     * @event RequestEvent được gọi trước khi thực hiện yêu cầu Ngân Lượng xác minh OTP của khách.
     */
    const EVENT_BEFORE_AUTHENTICATE = 'beforeAuthenticate';

    /**
     * @event RequestEvent được gọi sau khi thực hiện yêu cầu Ngân Lượng xác minh OTP của khách.
     */
    const EVENT_AFTER_AUTHENTICATE = 'afterAuthenticate';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là Ngân Lượng,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_METHOD_NL = 'NL';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là QR Code,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_METHOD_QR_CODE = 'QRCODE';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là tại ngân hàng,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_METHOD_BANK_OFFLINE = 'NH_OFFLINE';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là thẻ tín dụng trả trước,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_METHOD_CREDIT_CARD_PREPAID = 'CREDIT_CARD_PREPAID';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là thẻ VISA,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_METHOD_VISA = 'VISA';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là ATM Online,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_METHOD_ATM_ONLINE = 'ATM_ONLINE';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là ATM Offline,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_METHOD_ATM_OFFLINE = 'ATM_OFFLINE';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là Internet Banking,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_METHOD_INTERNET_BANKING = 'IB_ONLINE';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức thanh toán là thanh toán tại shop,
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     * @since 1.0.3
     */
    const PAYMENT_METHOD_CASH_IN_SHOP = 'CASH_IN_SHOP';

    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức giao dịch là trực tiếp (trực tiếp nhận tiền),
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_TYPE_REDIRECT = 1;
    /**
     * Hằng khai báo giúp Ngân Lượng xác định phương thức giao dịch là tạm giữ (tạm giữ tiền),
     * khi khởi tạo lệnh [[RC_PURCHASE]] tại phương thức [[request()]].
     */
    const PAYMENT_TYPE_SAFE = 2;

    /**
     * Hằng khai báo giúp bạn xác định trạng thái giao dịch thành công,
     * khi khởi tạo lệnh [[VRC_PURCHASE_SUCCESS]] hoặc [[RC_QUERY_DR]] tại phương thức [[request()]] hoặc [[verifyRequest()]].
     */
    const TRANSACTION_STATUS_SUCCESS = '00';

    /**
     * Hằng khai báo giúp bạn xác định trạng thái giao dịch thàng công nhưng Ngân Lượng tạm giữ,
     * khi khởi tạo lệnh [[VRC_PURCHASE_SUCCESS]] hoặc [[RC_QUERY_DR]] tại phương thức [[request()]] hoặc [[verifyRequest()]].
     */
    const TRANSACTION_STATUS_PENDING = '01';

    /**
     * Hằng khai báo giúp bạn xác định trạng thái giao dịch thất bại khách hàng không thanh toán hoặc lỗi,
     * khi khởi tạo lệnh [[VRC_PURCHASE_SUCCESS]] hoặc [[RC_QUERY_DR]] tại phương thức [[request()]] hoặc [[verifyRequest()]].
     */
    const TRANSACTION_STATUS_ERROR = '02';

    /**
     * Hằng khai báo giúp xác nhận thuộc tính `auth_site` trong kết quả nhận được từ `purchase` version 3.2 là xác nhận OTP thông qua
     * phương thức [[authenticate()]].
     */
    const AUTH_NL = 'NL';

    /**
     * Hằng khai báo giúp xác nhận thuộc tính `auth_site` trong kết quả nhận được từ `purchase` version 3.2 là xác nhận OTP thông qua
     * ngân hàng, bạn phải `redirect` khách đến trang `auth_url` để xác minh `OTP`.
     */
    const AUTH_BANK = 'BANK';

    /**
     * Hằng cho biết gateway ở version 3.1
     */
    const VERSION_3_1 = '3.1';

    /**
     * Hằng cho biết gateway ở version 3.2
     */
    const VERSION_3_2 = '3.2';

    /**
     * @inheritdoc
     */
    public $clientConfig = ['class' => PaymentClient::class];

    /**
     * @inheritdoc
     */
    public $requestDataConfig = ['class' => RequestData::class];

    /**
     * @inheritdoc
     */
    public $responseDataConfig = ['class' => ResponseData::class];

    /**
     * @inheritdoc
     */
    public $verifiedDataConfig = ['class' => VerifiedData::class];

    /**
     * @inheritdoc
     */
    public function getBaseUrl(): string
    {
        return ($this->sandbox ? 'https://sandbox.nganluong.vn:8088/nl30' : 'https://www.nganluong.vn') . '/checkout.api.nganluong.post.php';
    }

    /**
     * @inheritdoc
     * @since 1.0.3
     */
    public function requestCommands(): array
    {
        return [self::RC_PURCHASE, self::RC_QUERY_DR, self::RC_AUTHENTICATE];
    }

    /**
     * @inheritdoc
     */
    public function getSupportedVersions(): array
    {
        return [self::VERSION_3_1, self::VERSION_3_2];
    }

    /**
     * Phương thức yêu cầu Ngân Lượng xác minh OTP.
     * Đây là phương thức ánh xạ của [[request()]] sử dụng lệnh [[RC_AUTHENTICATE]]. Nó chỉ được hổ trợ ở version 3.2.
     *
     * @param array $data Dữ liệu yêu cầu xác minh.
     * @param null $clientId Client id sử dụng để tạo yêu. Nếu không thiết lập [[getDefaultClient()]] sẽ được gọi để xác định client.
     * @return ResponseData|DataInterface Trả về [[ResponseData]] là dữ liệu từ Ngân Lượng phản hồi.
     * @throws \yii\base\InvalidConfigException|NotSupportedException|\ReflectionException
     */
    public function authenticate(array $data, $clientId = null)
    {
        return $this->request(self::RC_AUTHENTICATE, $data, $clientId);
    }

    /**
     * Phương thức dùng để nhận biết gateway có phải đang sử dụng chế độ `seamless checkout` hay không (version 3.2).
     *
     * @return bool Return TRUE if current mode is seamless.
     */
    public function getSeamless(): bool
    {
        return $this->getVersion() === self::VERSION_3_2;
    }

    /**
     * Phương thức dùng để thiết lập `seamless checkout` (version 3.2).
     *
     * @param bool $seamless Mode seamless or not.
     * @return bool Return TRUE if seamless mode is turn on.
     * @throws NotSupportedException
     */
    public function setSeamless(bool $seamless): bool
    {
        return $this->setVersion($seamless ? self::VERSION_3_2 : self::VERSION_3_1);
    }

    /**
     * @inheritdoc
     * @throws NotSupportedException
     */
    public function request($command, array $data, $clientId = null): DataInterface
    {
        if ($command === self::RC_AUTHENTICATE && !$this->getSeamless()) {

This code seems to be duplicated across your project.

            throw new NotSupportedException('Authenticate command only support in `seamless` mode!');
        } else {
            return parent::request($command, $data, $clientId);
        }
    }

    /**
     * @inheritdoc
     * @throws NotSupportedException
     */
    public function verifyRequest($command, \yii\web\Request $request = null, $clientId = null)
    {
        if ($command === self::VRC_IPN) {

This code seems to be duplicated across your project.

            throw new NotSupportedException('IPN is not supported in Ngan Luong gateway!');
        } else {
            return parent::verifyRequest($command, $request, $clientId);
        }
    }

    /**
     * @inheritdoc
     */
    protected function defaultVersion(): string
    {
        return self::VERSION_3_1;
    }

    /**
     * @inheritdoc
     * @throws \yii\base\InvalidConfigException
     */
    protected function initSandboxEnvironment()
    {
        $clientConfig = require(__DIR__ . '/sandbox-client.php');
        $this->setClient($clientConfig);
    }

    /**
     * @inheritdoc
     */
    public function beforeRequest(RequestEvent $event)
    {
        if ($event->command === self::RC_AUTHENTICATE) {
            $this->trigger(self::EVENT_BEFORE_AUTHENTICATE, $event);
        }

        parent::beforeRequest($event);
    }

    /**
     * @inheritdoc
     */
    public function afterRequest(RequestEvent $event)
    {
        if ($event->command === self::RC_AUTHENTICATE) {
            $this->trigger(self::EVENT_AFTER_AUTHENTICATE, $event);
        }

        parent::afterRequest($event);
    }

    /**
     * @inheritdoc
     * @throws \yii\base\InvalidConfigException|\yii\httpclient\Exception
     */
    protected function requestInternal(\vxm\gatewayclients\RequestData $requestData, \yii\httpclient\Client $httpClient): array
    {
        $data = $requestData->get();

        return $httpClient->post('', $data)->send()->getData();
    }

    /**
     * @inheritdoc
     */
    protected function getVerifyRequestData($command, \yii\web\Request $request): array
    {
        return [
            'token' => $request->get('token')
        ];
    }

}