Allow to set the voucherify-channel header

voucherifyio · Mar 14, 2022 · 8a00de6 · 8a00de6
1 parent 13a2e90
commit 8a00de6
Show file tree

Hide file tree

Showing 14 changed files with 162 additions and 85 deletions.
diff --git a/README.md b/README.md
@@ -101,7 +101,25 @@ $customHeaders = [
 ];
 
 $client = new VoucherifyClient($apiID, $apiKey, $apiVersion, $apiUrl, $customHeaders);
+
+# RESULT:
+#   x-custom-1: Value-1
+```
+
+Special: Voucherify-Channel customization
+```php
+$apiVersion = null;
+$apiUrl = null;
+$customHeaders = [
+    "V-Voucherify-Channel" => "Value-1"
+];
+
+$client = new VoucherifyClient($apiID, $apiKey, $apiVersion, $apiUrl, $customHeaders);
+
+# RESULT:
+#   x-voucherify-channel: PHP-SDK-Value-1
 ```
+
 ### PHP autoloading
 
 When you aren't using composer you can load Voucherify module by including `autoload.php` file from `/src` directory.

diff --git a/src/ApiClient.php b/src/ApiClient.php
@@ -52,30 +52,44 @@ public function __construct($apiId, $apiKey, $apiVersion = null, $apiUrl = null,
 
         $this->apiId = $apiId;
         $this->apiKey = $apiKey;
-        $this->headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . $this->apiId,
-            "X-App-Token: " . $this->apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
-        ];
 
         if (isset($apiUrl)) {
             $this->basePath = $apiUrl;
         }
-        if (isset($apiVersion)) {
-            $this->headers[] = "X-Voucherify-API-Version: " . $apiVersion;
-        }
-        $this->resolveCustomHeaders($customHeaders);
+
+        $this->setHeaders($apiVersion, $customHeaders);
     }
 
-    private function resolveCustomHeaders($customHeaders) {
-        if (!isset($customHeaders)) {
-            return;
+    private function setHeaders($apiVersion, $customHeaders) {
+        $channel = "PHP-SDK";
+
+        $headers = [
+            "content-type" => "application/json",
+            "x-app-id" => $this->apiId,
+            "x-app-token" => $this->apiKey,
+            "x-voucherify-channel" => $channel
+        ];
+
+        if (isset($apiVersion)) {
+            $headers["x-voucherify-api-version"] = $apiVersion;
+        }
+        if (isset($customHeaders)) {
+            if (!is_array($customHeaders) && !is_object($customHeaders)) {
+                throw new \Exception("CustomHeaders type not allowed. Must be an array or an object");
+            }
+            foreach ($customHeaders as $key => $value) {
+                if (is_null($value)) {
+                    continue;
+                }
+                $headers[strtolower($key)] = $value;
+            }
         }
-        if (!is_array($customHeaders) && !is_object($customHeaders)) {
-            throw new \Exception("CustomHeaders type not allowed. Must be an array or an object");
+        if (substr($headers["x-voucherify-channel"], 0, strlen($channel)) !== $channel) {
+            $headers["x-voucherify-channel"] = $channel . "-" . $headers["x-voucherify-channel"];
         }
-        foreach ($customHeaders as $key => $value) {
+        $this->headers = array();
+
+        foreach ($headers as $key => $value) {
             if (is_null($value)) {
                 continue;
             }

diff --git a/test/CampaignsTest.php b/test/CampaignsTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/ClientTest.php b/test/ClientTest.php
@@ -16,10 +16,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
 
         CurlMock::enable();
@@ -50,10 +50,10 @@ public function testInitialization()
     public function testCustomApiUrl()
     {
         $headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
 
         CurlMock::register("https://api.voucherify.io/v1", $headers)
@@ -81,10 +81,10 @@ public function testCustomApiUrl()
     public function testVersioning()
     {
         $headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
 
         CurlMock::register("https://api.voucherify.io/v1", $headers)
@@ -97,11 +97,11 @@ public function testVersioning()
         $this->assertEquals($result, (object)[ "status" => "ok" ]);
 
         $headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK",
-            "X-Voucherify-API-Version: v2017-04-05",
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK",
+            "x-voucherify-api-version: v2017-04-05"
         ];
 
         CurlMock::register("https://api.voucherify.io/v1", $headers)
@@ -119,28 +119,73 @@ public function testVersioning()
     public function testCustomHeaders()
     {
         $headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK",
-            "X-Custom-1: Value-1",
-            "X-Custom-2: Value-2"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK",
+            "x-custom-1: Value-1",
+            "x-custom-2: Value-2"
         ];
 
         CurlMock::register("https://api.voucherify.io/v1", $headers)
             ->get("/vouchers/test-voucher-1")
             ->reply(200, [ "status" => "ok" ]);
 
         $customHeaders = [
-            "X-Custom-1" => "Value-1",
-            "X-Custom-2" => "Value-2"
+            "x-custom-1" => "Value-1",
+            "X-CustoM-2" => "Value-2"
         ];
 
         $client = new VoucherifyClient(self::$apiId, self::$apiKey, null, null, $customHeaders);
 
         $result = $client->vouchers->get("test-voucher-1");
         $this->assertEquals($result, (object)[ "status" => "ok" ]);
 
+        $headers = [
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK-Value-2",
+            "x-custom-1: Value-1"
+        ];
+
+        CurlMock::register("https://api.voucherify.io/v1", $headers)
+            ->get("/vouchers/test-voucher-2")
+            ->reply(200, [ "status" => "ok" ]);
+
+        $customHeaders = [
+            "x-custom-1" => "Value-1",
+            "X-Voucherify-ChanneL" => "Value-2"
+        ];
+
+        $client = new VoucherifyClient(self::$apiId, self::$apiKey, null, null, $customHeaders);
+
+        $result = $client->vouchers->get("test-voucher-2");
+        $this->assertEquals($result, (object)[ "status" => "ok" ]);
+
+
+        $headers = [
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK-value-2",
+            "x-custom-1: value-1"
+        ];
+
+        CurlMock::register("https://api.voucherify.io/v1", $headers)
+            ->get("/vouchers/test-voucher-3")
+            ->reply(200, [ "status" => "ok" ]);
+
+        $customHeaders = [
+            "x-custom-1" => "value-1",
+            "X-VoucherifY-ChanneL" => "value-2"
+        ];
+
+        $client = new VoucherifyClient(self::$apiId, self::$apiKey, null, null, $customHeaders);
+
+        $result = $client->vouchers->get("test-voucher-3");
+        $this->assertEquals($result, (object)[ "status" => "ok" ]);
+
         CurlMock::done();
     }
 

diff --git a/test/CustomersTest.php b/test/CustomersTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/DistributionsTest.php b/test/DistributionsTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/OrdersTest.php b/test/OrdersTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/ProductsTest.php b/test/ProductsTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/PromotionsTest.php b/test/PromotionsTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/RedemptionsTest.php b/test/RedemptionsTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/SegmentsTest.php b/test/SegmentsTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/ValidationRulesTest.php b/test/ValidationRulesTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/ValidationsTest.php b/test/ValidationsTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
 

diff --git a/test/VouchersTest.php b/test/VouchersTest.php
@@ -17,10 +17,10 @@ public static function setUpBeforeClass()
         self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
         self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
         self::$headers = [
-            "Content-Type: application/json",
-            "X-App-Id: " . self::$apiId,
-            "X-App-Token: " . self::$apiKey,
-            "X-Voucherify-Channel: PHP-SDK"
+            "content-type: application/json",
+            "x-app-id: " . self::$apiId,
+            "x-app-token: " . self::$apiKey,
+            "x-voucherify-channel: PHP-SDK"
         ];
         self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);