Specify the software version to be the detailed request information on Omise dashboard

omise/controllers/front/base.php

@@ -10,6 +10,18 @@
     require_once _PS_MODULE_DIR_ . 'omise/setting.php';
 }
 
+/**
+ * Specify the software version when sending the request to Omise API. The specified versions will be displayed at
+ * Omise dashboard.
+ *
+ * This constant is used to append to request header, User-Agent. The request is send by library, Omise PHP.
+ *
+ * @see OmiseApiResource::genOptions() The function in library, Omise PHP, that uses this constant.
+ */
+if (! defined('OMISE_USER_AGENT_SUFFIX')) {
+    define('OMISE_USER_AGENT_SUFFIX', sprintf('OmisePrestaShop/%s PrestaShop/%s', Omise::MODULE_VERSION, _PS_VERSION_));
+}
+
 abstract class OmiseBasePaymentModuleFrontController extends ModuleFrontController
 {
     protected $charge;

tests/unit/controllers/OmiseBasePaymentModuleFrontControllerTest.php

@@ -0,0 +1,64 @@
+<?php
+use \Mockery as m;
+
+class OmiseBasePaymentModuleFrontControllerTest extends PHPUnit_Framework_TestCase
+{
+    public function setup()
+    {
+        $this->getMockBuilder(get_class(new stdClass()))
+            ->setMockClassName('ModuleFrontController')
+            ->setMethods(
+                array(
+                    '__construct',
+                )
+            )
+            ->getMock();
+
+        $this->getMockBuilder(get_class(new stdClass()))
+            ->setMockClassName('PaymentModule')
+            ->setMethods(
+                array(
+                    '__construct',
+                )
+            )
+            ->getMock();
+
+        m::mock('alias:\OmiseChargeClass');
+        m::mock('alias:\OmiseTransactionModel');
+        m::mock('alias:\PaymentOrder');
+
+        $this->getMockBuilder('OmiseBasePaymentModuleFrontController')
+            ->getMockForAbstractClass();
+    }
+
+    /**
+      * @runInSeparateProcess
+      * @preserveGlobalState disabled
+      */
+    public function testOmiseUserAgentSuffix_beforeCreateOmiseCharge_omisePrestaShopVersionForOmiseUserAgentSuffixMustBeDefined()
+    {
+        $omise_prestashop_version = 'OmisePrestaShop/' . Omise::MODULE_VERSION;
+
+        $omise_user_agent_suffix = explode(' ', OMISE_USER_AGENT_SUFFIX);
+
+        $this->assertEquals($omise_prestashop_version, $omise_user_agent_suffix[0]);
+    }
+
+    /**
+      * @runInSeparateProcess
+      * @preserveGlobalState disabled
+      */
+    public function testOmiseUserAgentSuffix_beforeCreateOmiseCharge_prestaShopVersionForOmiseUserAgentSuffixMustBeDefined()
+    {
+        $prestashop_version = 'PrestaShop/' . _PS_VERSION_;
+
+        $omise_user_agent_suffix = explode(' ', OMISE_USER_AGENT_SUFFIX);
+
+        $this->assertEquals($prestashop_version, $omise_user_agent_suffix[1]);
+    }
+
+    public function tearDown()
+    {
+        m::close();
+    }
+}