Merge pull request #19 from magiclabs/dev-brian

Add additional parameters to HttpClient user-agent

Author: brianrlewis

.gitignore

@@ -15,6 +15,7 @@ composer.lock
 
 # Ignore PHPUnit coverage file
 clover.xml
+.phpunit.result.cache
 
 # Ignore IDE's configuration files
 .idea

CHANGELOG.md

@@ -12,6 +12,12 @@
 
 - <PR-#ISSUE> ...
 
+## `0.3.0` - 2/17/2023
+
+#### Added
+
+- PR-#19: Add additional parameters to HttpClient user-agent
+
 ## `0.2.0` - 11/29/2022
 
 #### Added

VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

composer.json

@@ -26,7 +26,7 @@
     "simplito/elliptic-php": "^1.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^7.3"
+    "phpunit/phpunit": "^8.0"
   },
   "autoload": {
     "psr-4": {

lib/HttpClient.php

@@ -22,6 +22,7 @@ class HttpClient
     public $_backoff_factor;
     public $_base_url;
     public $_api_secret_key;
+    public $_platform = 'php';
     public $ch;
 
     public function __construct($api_secret_key, $timeout, $retries, $backoff_factor)
@@ -68,6 +69,11 @@ public function _get_user_agent()
         $user_agent[] = 'sdk_version: ' . $this->get_version();
         $user_agent[] = 'publisher: Magic Labs Inc.';
         $user_agent[] = 'http_lib: magic-admin-php';
+        $user_agent[] = 'platform: '.$this->_platform;
+
+        if (isset($_SERVER['SERVER_NAME'])) {
+            $user_agent[] = 'server_name: '.$_SERVER['SERVER_NAME'];            
+        }
 
         return $user_agent;
     }
@@ -271,4 +277,9 @@ public function get_version()
     {
         return \file_get_contents(MAGIC_ADMIN_PHP_PATH . '/VERSION');
     }
+
+    public function _set_platform($platform)
+    {
+        $this->_platform = $platform;
+    }
 }

lib/Magic.php

@@ -28,4 +28,9 @@ public function __construct(
             $backoff_factor
         );
     }
+
+    public function _set_platform($platform)
+    {
+        $this->user->_set_platform($platform);
+    }
 }

lib/Resource/User.php

@@ -65,4 +65,9 @@ public function logout_by_token($did_token)
     {
         return $this->logout_by_issuer($this->token->get_issuer($did_token));
     }
+
+    public function _set_platform($platform)
+    {
+        $this->request_client->_set_platform($platform);
+    }
 }

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit
+    bootstrap="vendor/autoload.php"
+    colors="true"
+    stopOnFailure="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <php>
+        <server name="SERVER_NAME" value="local_phpunit"/>
+    </php>
+</phpunit>

tests/HttpClientTest.php

@@ -17,13 +17,16 @@ protected function setUp(): void
         $retries = 3;
         $backoff_factor = 0.02;
         $api_secret_key = 'magic_admin';
+        $platform = 'test_platform';
 
         $this->requestsClient = new \MagicAdmin\HttpClient(
             $api_secret_key,
             $timeout,
             $retries,
             $backoff_factor
         );
+
+        $this->requestsClient->_set_platform($platform);
     }
 
     public function testRetrieves()
@@ -54,6 +57,8 @@ public function testGetUserAgent()
         $expected_array[] = 'sdk_version: ' . $this->requestsClient->get_version();
         $expected_array[] = 'publisher: Magic Labs Inc.';
         $expected_array[] = 'http_lib: magic-admin-php';
+        $expected_array[] = 'platform: test_platform';
+        $expected_array[] = 'server_name: local_phpunit';
 
         static::assertSame($this->requestsClient->_get_user_agent(), $expected_array);
     }
@@ -69,6 +74,8 @@ public function testGetRequestHeaders()
                 'sdk_version: ' . $this->requestsClient->get_version(),
                 'publisher: Magic Labs Inc.',
                 'http_lib: magic-admin-php',
+                'platform: test_platform',
+                'server_name: local_phpunit',
             ]
         );
         $expected_headers = [];