Merge pull request #44 from packagist/t/api-client-version-tracking

Client: add HTTP header for the api client version

Author: glaubinix

composer.json

@@ -16,7 +16,8 @@
         "php-http/httplug": "^1.1 || ^2.0",
         "php-http/discovery": "^1.0",
         "php-http/client-implementation": "^1.0",
-        "php-http/client-common": "^1.9 || ^2.0"
+        "php-http/client-common": "^1.9 || ^2.0",
+        "composer-runtime-api": "^2.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^5.5 || ^7.0",

src/Client.php

@@ -29,14 +29,18 @@ public function __construct(HttpPluginClientBuilder $httpClientBuilder = null, $
     {
         $this->httpClientBuilder = $builder = $httpClientBuilder ?: new HttpPluginClientBuilder();
         $privatePackagistUrl = $privatePackagistUrl ? : 'https://packagist.com';
-        $this->responseMediator = $responseMediator ? $responseMediator : new ResponseMediator();
+        $this->responseMediator = $responseMediator ? : new ResponseMediator();
 
         $builder->addPlugin(new Plugin\AddHostPlugin(UriFactoryDiscovery::find()->createUri($privatePackagistUrl)));
         $builder->addPlugin(new PathPrepend('/api'));
         $builder->addPlugin(new Plugin\RedirectPlugin());
-        $builder->addPlugin(new Plugin\HeaderDefaultsPlugin([
+        $headers = [
             'User-Agent' => 'php-private-packagist-api (https://github.com/packagist/private-packagist-api-client)',
-        ]));
+        ];
+        if ($apiClientVersion = $this->getApiClientVersion()) {
+            $headers['API-CLIENT-VERSION'] = $apiClientVersion;
+        }
+        $builder->addPlugin(new Plugin\HeaderDefaultsPlugin($headers));
         $builder->addPlugin(new ExceptionThrower($this->responseMediator));
     }
 
@@ -118,4 +122,13 @@ protected function getHttpClientBuilder()
     {
         return $this->httpClientBuilder;
     }
+
+    private function getApiClientVersion()
+    {
+        try {
+            return \Composer\InstalledVersions::getVersion('private-packagist/api-client');
+        } catch (\OutOfBoundsException $exception) {
+            return null;
+        }
+    }
 }