feat: add user-agent with SDK version string (#69)

Author: matoous

.gitignore

@@ -2,8 +2,7 @@ composer.phar
 composer.lock
 /vendor/
 **/coverage
-
-# PHP CS Fixer
 .php_cs
 .php_cs.cache
 .php-cs-fixer.cache
+.phpunit.result.cache

.phpunit.result.cache

@@ -3,6 +3,7 @@
 namespace SumUp\Application;
 
 use SumUp\Exceptions\SumUpConfigurationException;
+use SumUp\SdkInfo;
 
 /**
  * Class ApplicationConfiguration
@@ -16,6 +17,11 @@ class ApplicationConfiguration implements ApplicationConfigurationInterface
      */
     const DEFAULT_SCOPES = ['payments', 'transactions.history', 'user.app-settings', 'user.profile_readonly'];
 
+    /**
+     * Header name for the SDK's User-Agent.
+     */
+    const USER_AGENT_HEADER = 'User-Agent';
+
     /**
      * The possible values for grant type.
      */
@@ -393,7 +399,10 @@ protected function setForceGuzzle($forceGuzzle)
      */
     public function setCustomHeaders($customHeaders)
     {
-        $this->customHeaders = is_array($customHeaders) ? $customHeaders : [];
+        $headers = is_array($customHeaders) ? $customHeaders : [];
+        $headers[self::USER_AGENT_HEADER] = SdkInfo::getUserAgent();
+
+        $this->customHeaders = $headers;
     }
 
     /**

src/SumUp/Application/ApplicationConfiguration.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace SumUp;
+
+/**
+ * Provides metadata about the SDK.
+ */
+class SdkInfo
+{
+    const USER_AGENT_TEMPLATE = 'sumup-php/v%s';
+
+    /**
+     * Returns the SDK version embedded in the build.
+     *
+     * @return string
+     */
+    public static function getVersion()
+    {
+        return Version::CURRENT;
+    }
+
+    /**
+     * Returns the formatted User-Agent string used in outbound requests.
+     *
+     * @return string
+     */
+    public static function getUserAgent()
+    {
+        return sprintf(self::USER_AGENT_TEMPLATE, self::getVersion());
+    }
+}

src/SumUp/SdkInfo.php

@@ -3,6 +3,7 @@
 namespace SumUp\Utils;
 
 use SumUp\Authentication\AccessToken;
+use SumUp\SdkInfo;
 
 /**
  * Class Headers
@@ -11,12 +12,6 @@
  */
 class Headers
 {
-    /**
-     * Cached value of the project's version.
-     *
-     * @var string $cacheVersion
-     */
-    protected static $cacheVersion;
     /**
      * Get the common header for Content-Type: application/json.
      *
@@ -49,39 +44,6 @@ public static function getAuth(AccessToken $accessToken)
         return ['Authorization' => 'Bearer ' . $accessToken->getValue()];
     }
 
-    /**
-     * Get custom array.
-     *
-     * @return array
-     */
-    public static function getTrk()
-    {
-        return ['X-SDK' => 'PHP-SDK/v' . self::getProjectVersion() . ' PHP/v' . phpversion()];
-    }
-
-    /**
-     * Get the version of the project accroding to the composer.json
-     *
-     * @return string
-     */
-    public static function getProjectVersion()
-    {
-        if (is_null(self::$cacheVersion)) {
-            self::$cacheVersion = 'unknown';
-            $pathToComposer = dirname(__FILE__) . '/../../../composer.json';
-
-            if (is_readable($pathToComposer)) {
-                $content = file_get_contents($pathToComposer);
-                $content = json_decode($content, true);
-                if (is_array($content) && !empty($content['version'])) {
-                    self::$cacheVersion = $content['version'];
-                }
-            }
-        }
-
-        return self::$cacheVersion;
-    }
-
     /**
      * Get standard headers needed for every request.
      *
@@ -90,7 +52,7 @@ public static function getProjectVersion()
     public static function getStandardHeaders()
     {
         $headers = self::getCTJson();
-        $headers += self::getTrk();
+        $headers['User-Agent'] = SdkInfo::getUserAgent();
         return $headers;
     }
 }

src/SumUp/Utils/Headers.php

@@ -0,0 +1,10 @@
+<?php
+
+// File generated from our OpenAPI spec
+
+namespace SumUp;
+
+class Version
+{
+    const CURRENT = '1.3.0'; // x-release-please-version
+}

src/SumUp/Version.php

@@ -5,6 +5,7 @@
 use PHPUnit\Framework\TestCase;
 use SumUp\Application\ApplicationConfiguration;
 use SumUp\Exceptions\SumUpConfigurationException;
+use SumUp\SdkInfo;
 
 class ApplicationConfigurationTest extends TestCase
 {
@@ -34,4 +35,32 @@ public function testInvalidGrantTypeThrowsException()
             'grant_type' => 'invalid',
         ]);
     }
+
+    public function testUserAgentHeaderIsAlwaysAdded()
+    {
+        $config = new ApplicationConfiguration([
+            'api_key' => 'test-api-key',
+        ]);
+
+        $headers = $config->getCustomHeaders();
+
+        $this->assertArrayHasKey(ApplicationConfiguration::USER_AGENT_HEADER, $headers);
+        $this->assertSame(SdkInfo::getUserAgent(), $headers[ApplicationConfiguration::USER_AGENT_HEADER]);
+    }
+
+    public function testCustomUserAgentHeaderIsOverridden()
+    {
+        $config = new ApplicationConfiguration([
+            'api_key' => 'test-api-key',
+            'custom_headers' => [
+                'User-Agent' => 'custom-agent',
+                'X-Custom' => 'value',
+            ],
+        ]);
+
+        $headers = $config->getCustomHeaders();
+
+        $this->assertSame(SdkInfo::getUserAgent(), $headers[ApplicationConfiguration::USER_AGENT_HEADER]);
+        $this->assertSame('value', $headers['X-Custom']);
+    }
 }