Add support for version 2.1.0

.github/workflows/run-tests.yml

@@ -0,0 +1,38 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [7.4, 8.0, 8.1, 8.2]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Run test suite
+        run: composer run-script test

composer.json

@@ -19,12 +19,14 @@
         }
     ],
     "require": {
-        "php": "^7.1",
+        "php": "^7.4|^8",
         "omnipay/common": "^3.0"
     },
     "require-dev": {
-        "omnipay/tests": "^3.0",
-        "scrutinizer/ocular": "^1.5"
+        "http-interop/http-factory-guzzle": "^1.2",
+        "omnipay/tests": "^4.0",
+        "scrutinizer/ocular": "^1.5",
+        "php-http/guzzle7-adapter": "^1.0"
     },
     "autoload": {
         "psr-4": {

phpunit.xml.dist

@@ -1,22 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
-    <testsuites>
-        <testsuite name="PHP Viet Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="PHP Viet Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>

src/Concerns/Parameters.php

@@ -15,7 +15,7 @@
 trait Parameters
 {
     /**
-     * Trả về mã Tmn do VNPay cấp.
+     * Trả về mã Version
      *
      * @return null|string
      */
@@ -25,7 +25,7 @@ public function getVnpVersion(): ?string
     }
 
     /**
-     * Thiết lập mã Tmn.
+     * Thiết lập mã Version
      *
      * @param  null|string  $code
      * @return $this

src/Gateway.php

@@ -47,7 +47,7 @@ public function initialize(array $parameters = [])
     public function getDefaultParameters()
     {
         return [
-            'vnp_Version' => '2.0.0',
+            'vnp_Version' => '2.1.0',
         ];
     }
 

src/Message/AbstractSignatureRequest.php

@@ -7,6 +7,7 @@
 
 namespace Omnipay\VNPay\Message;
 
+use Omnipay\Common\Exception\InvalidRequestException;
 use Omnipay\Common\Message\AbstractRequest;
 use Omnipay\VNPay\Concerns\Parameters;
 use Omnipay\VNPay\Concerns\ParametersNormalization;
@@ -37,24 +38,23 @@ public function initialize(array $parameters = [])
         $this->setVnpCreateDate(
             $this->getVnpCreateDate() ?? date('Ymdhis')
         );
+        $this->setVnpExpireDate(
+            $this->getVnpExpireDate() ?? date('Ymdhis', strtotime('+15 minutes'))
+        );
 
         return $this;
     }
 
     /**
      * {@inheritdoc}
+     * @throws InvalidRequestException
      */
     public function getData(): array
     {
-        call_user_func_array(
-            [$this, 'validate'],
-            $this->getSignatureParameters()
-        );
+        $this->validate(...$this->getSignatureParameters());
 
         $parameters = $this->getParameters();
-        $parameters['vnp_SecureHash'] = $this->generateSignature(
-            $parameters['vnp_SecureHashType'] = $this->getSecureHashType() ?? 'sha256'
-        );
+        $parameters['vnp_SecureHash'] = $this->generateSignature();
 
         unset($parameters['vnp_HashSecret'], $parameters['testMode']);
 
@@ -77,7 +77,7 @@ public function getVnpTxnRef(): ?string
      * Thiết lập mã đơn hàng cần thực thi tác vụ.
      * Đây là phương thức ánh xạ của [[setTransactionId()]].
      *
-     * @param  null|string  $ref
+     * @param null|string $ref
      *
      * @return $this
      * @see setTransactionId
@@ -116,7 +116,7 @@ public function getVnpOrderInfo(): ?string
     /**
      * Thiết lập thông tin đơn hàng hay lý do truy vấn đến VNPay.
      *
-     * @param  null|string  $info
+     * @param null|string $info
      * @return $this
      */
     public function setVnpOrderInfo(?string $info)
@@ -139,7 +139,7 @@ public function getVnpCreateDate(): ?string
      * Thiết lập thời gian khởi tạo truy vấn đến VNPay.
      * Mặc định sẽ là thời gian hiện tại.
      *
-     * @param  null|string  $date
+     * @param null|string $date
      * @return $this
      * @see setReturnUrl
      */
@@ -148,6 +148,16 @@ public function setVnpCreateDate(?string $date)
         return $this->setParameter('vnp_CreateDate', $date);
     }
 
+    public function getVnpExpireDate(): ?string
+    {
+        return $this->getParameter('vnp_ExpireDate');
+    }
+
+    public function setVnpExpireDate(string $date)
+    {
+        $this->setParameter('vnp_ExpireDate', $date);
+    }
+
     /**
      * Trả về ip của khách dùng để thanh toán.
      * Đây là phương thức ánh xạ của [[getClientIp()]].
@@ -165,7 +175,7 @@ public function getVnpIpAddr(): ?string
      * Đây là phương thức ánh xạ của [[setClientIp()]].
      * Mặc định nếu không thiết lập sẽ là IP của khách.
      *
-     * @param  null|string  $ip
+     * @param null|string $ip
      * @return $this
      * @see setClientIp
      */
@@ -204,7 +214,7 @@ public function getSecureHashType(): ?string
     /**
      * Thiết lập phương thức mã hóa dùng để tạo chữ ký dự liệu.
      *
-     * @param  null|string  $secureHashType
+     * @param null|string $secureHashType
      *
      * @return $this
      * @since 1.0.1

src/Message/Concerns/RequestSignature.php

@@ -18,21 +18,18 @@ trait RequestSignature
     /**
      * Trả về chữ ký điện tử gửi đến VNPay dựa theo [[getSignatureParameters()]].
      *
-     * @param  string  $hashType
      * @return string
      */
-    protected function generateSignature(string $hashType = 'sha256'): string
+    protected function generateSignature(): string
     {
         $data = [];
-        $signature = new Signature(
-            $this->getVnpHashSecret(),
-            $hashType
-        );
 
         foreach ($this->getSignatureParameters() as $parameter) {
             $data[$parameter] = $this->getParameter($parameter);
         }
 
+        $signature = new Signature($this->getVnpHashSecret());
+
         return $signature->generate($data);
     }
 

src/Message/Concerns/ResponseSignatureValidation.php

@@ -30,18 +30,13 @@ protected function validateSignature(): void
         }
 
         $dataSignature = array_filter($this->getData(), function ($parameter) {
-            return 0 === strpos($parameter, 'vnp_')
-                && 'vnp_SecureHash' !== $parameter
-                && 'vnp_SecureHashType' !== $parameter;
+            return 0 === strpos($parameter, 'vnp_') && $parameter !== 'vnp_SecureHash';
         }, ARRAY_FILTER_USE_KEY);
 
-        $signature = new Signature(
-            $this->getRequest()->getVnpHashSecret(),
-            $data['vnp_SecureHashType'] ?? 'md5'
-        );
+        $signature = new Signature($this->getRequest()->getVnpHashSecret());
 
         if (! $signature->validate($dataSignature, $data['vnp_SecureHash'])) {
-            throw new InvalidResponseException(sprintf('Data signature response from VNPay is invalid!'));
+            throw new InvalidResponseException('Data signature response from VNPay is invalid!');
         }
     }
 }

src/Message/PurchaseRequest.php

@@ -248,7 +248,7 @@ public function setReturnUrl($value)
     protected function getSignatureParameters(): array
     {
         $parameters = [
-            'vnp_CreateDate', 'vnp_IpAddr', 'vnp_ReturnUrl', 'vnp_Amount', 'vnp_OrderType', 'vnp_OrderInfo',
+            'vnp_CreateDate', 'vnp_ExpireDate', 'vnp_IpAddr', 'vnp_ReturnUrl', 'vnp_Amount', 'vnp_OrderType', 'vnp_OrderInfo',
             'vnp_TxnRef', 'vnp_CurrCode', 'vnp_Locale', 'vnp_TmnCode', 'vnp_Command', 'vnp_Version',
         ];
 

src/Message/QueryTransactionRequest.php

@@ -42,7 +42,7 @@ public function initialize(array $parameters = [])
      */
     public function sendData($data): SignatureResponse
     {
-        $query = http_build_query($data, null, '&', PHP_QUERY_RFC3986);
+        $query = http_build_query($data, '', '&', PHP_QUERY_RFC3986);
         $requestUrl = $this->getEndpoint().'?'.$query;
         $response = $this->httpClient->request('GET', $requestUrl);
         $responseRawData = $response->getBody()->getContents();

src/Message/RefundRequest.php

@@ -42,7 +42,7 @@ public function initialize(array $parameters = [])
      */
     public function sendData($data): SignatureResponse
     {
-        $query = http_build_query($data, null, '&', PHP_QUERY_RFC3986);
+        $query = http_build_query($data, '', '&', PHP_QUERY_RFC3986);
         $requestUrl = $this->getEndpoint().'?'.$query;
         $response = $this->httpClient->request('GET', $requestUrl);
         $responseRawData = $response->getBody()->getContents();

src/Support/Signature.php

@@ -17,32 +17,17 @@ class Signature
 {
     /**
      * Khóa bí mật dùng để tạo và kiểm tra chữ ký dữ liệu.
-     *
-     * @var string
      */
-    protected $hashSecret;
-
-    /**
-     * Loại thuật toán mã hóa sẽ sử dụng.
-     *
-     * @var string
-     */
-    protected $hashType;
+    protected string $hashSecret;
 
     /**
      * Khởi tạo đối tượng DataSignature.
      *
      * @param  string  $hashSecret
-     * @param  string  $hashType
      * @throws InvalidArgumentException
      */
-    public function __construct(string $hashSecret, string $hashType = 'sha256')
+    public function __construct(string $hashSecret)
     {
-        if (! $this->isSupportHashType($hashType)) {
-            throw new InvalidArgumentException(sprintf('Hash type: `%s` is not supported by VNPay', $hashType));
-        }
-
-        $this->hashType = $hashType;
         $this->hashSecret = $hashSecret;
     }
 
@@ -55,9 +40,8 @@ public function __construct(string $hashSecret, string $hashType = 'sha256')
     public function generate(array $data): string
     {
         ksort($data);
-        $dataSign = $this->hashSecret.urldecode(http_build_query($data));
 
-        return hash($this->hashType, $dataSign);
+        return hash_hmac('sha512', http_build_query($data), $this->hashSecret);
     }
 
     /**
@@ -73,15 +57,4 @@ public function validate(array $data, string $expect): bool
 
         return 0 === strcasecmp($expect, $actual);
     }
-
-    /**
-     * Phương thức cho biết loại mã hóa truyền vào có được VNPay hổ trợ hay không.
-     *
-     * @param  string  $type
-     * @return bool
-     */
-    protected function isSupportHashType(string $type): bool
-    {
-        return 0 === strcasecmp($type, 'md5') || 0 === strcasecmp($type, 'sha256');
-    }
 }