Merge pull request #3 from merch-one/#3

Added X-Library header

composer.json

@@ -11,7 +11,7 @@
  ],
  "type": "library",
  "license": "MIT",
- "version": "1.0.3",
+ "version": "1.0.4",
  "require": {
  "php": ">=7.4",
  "guzzlehttp/guzzle": "^6|^7",

src/Http/Client.php

@@ -41,7 +41,8 @@ class Client implements HttpClient
  */
  protected array $clientOptions = [
  'headers' => [
- 'User-Agent' => 'MerchOne PHP SDK v1.0.2',
+ 'User-Agent' => null,
+ 'X-Library' => null,
  'Accept' => 'application/json',
  'Content-Type' => 'application/json',
  ],
@@ -60,6 +61,7 @@ public function __construct(
  ) {
  $this->apiVersion = $version;
  $this->setClientOptions($clientOptions);
+ $this->setClientHeaders();
 
  $this->buildClient();
  }
@@ -234,4 +236,22 @@ private function buildClient(): void
 
  $this->httpClient = new GuzzleClient($this->clientOptions);
  }
+
+ /**
+ * @return void
+ */
+ private function setClientHeaders(): void
+ {
+ $this->clientOptions['headers']['X-Library'] = MerchOneApi::getSdkVersion();
+
+ $userAgent = new Collection([
+ 'host' => $_SERVER['HTTP_HOST'] ?? 'unknown',
+ 'software' => $_SERVER['SERVER_SOFTWARE'] ?? 'unknown',
+ 'php' => PHP_VERSION,
+ ]);
+
+ $this->clientOptions['headers']['User-Agent'] = $userAgent->map(
+ static fn ($value, $key) => "{$key}@{$value}"
+ )->implode(' ');
+ }
 }

src/Util/MerchOneApi.php

@@ -60,6 +60,14 @@ public static function getVersions(): array
  )->values()->toArray();
  }
 
+ /**
+ * @return string
+ */
+ public static function getSdkVersion(): string
+ {
+ return (new PackageInfo())->getVersionName();
+ }
+
  /**
  * @param string $version
  * @return void

src/Util/PackageInfo.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace MerchOne\PhpApiSdk\Util;
+
+use Composer\InstalledVersions;
+
+final class PackageInfo
+{
+ /**
+ * @var string
+ */
+ private string $name = 'PHP';
+
+ /**
+ * @var string
+ */
+ private string $version = 'unknown';
+
+ public function __construct()
+ {
+ $this->boot();
+ }
+
+ /**
+ * @return string
+ */
+ public function getVersionName(): string
+ {
+ return str_replace('merch-one/', '', $this->name) . '/' . $this->version;
+ }
+
+ /**
+ * @return void
+ */
+ private function boot(): void
+ {
+ $name = $this->name;
+
+ try {
+ $this->name = $this->currentPackage();
+ $this->version = InstalledVersions::getPrettyVersion($this->name);
+ } catch (\Throwable $e) {
+ $this->name = $name;
+ $this->version = $this->getVersionFromComposerJson();
+ }
+ }
+
+ /**
+ * @return string
+ * @noinspection JsonEncodingApiUsageInspection
+ */
+ private function getVersionFromComposerJson(): string
+ {
+ try {
+ $json = json_decode(
+ file_get_contents(__DIR__ . '/../../composer.json'),
+ true
+ );
+
+ return $json['version'];
+ } catch (\Throwable $e) {
+ return 'unknown';
+ }
+ }
+
+ /**
+ * @return string
+ */
+ private function currentPackage(): string
+ {
+ if (InstalledVersions::isInstalled('merch-one/laravel-api-sdk')) {
+ return 'merch-one/laravel-api-sdk';
+ }
+
+ return 'merch-one/php-api-sdk';
+ }
+}

tests/Unit/Http/ClientTest.php

@@ -9,6 +9,7 @@
 use MerchOne\PhpApiSdk\Exceptions\InvalidApiVersionException;
 use MerchOne\PhpApiSdk\Http\Client;
 use MerchOne\PhpApiSdk\Tests\TestCase;
+use MerchOne\PhpApiSdk\Util\MerchOneApi;
 use ReflectionException;
 
 class ClientTest extends TestCase
@@ -109,19 +110,25 @@ public function testDefaultClientOptionsAreImmutable(): void
  'user-agent' => 'test-user-agent',
  'accept' => 'test-accept',
  'content-type' => 'test-content-type',
+ 'x-library' => 'test-library',
  ],
  'http_errors' => true,
  ]);
 
  $options = $this->getObjectProperty($client, 'clientOptions');
 
  $this->assertArrayHasKey('headers', $options);
+ $this->assertEquals(MerchOneApi::getSdkVersion(), $options['headers']['X-Library']);
+
  $this->assertArrayHasKey('User-Agent', $options['headers']);
- $this->assertEquals('MerchOne PHP SDK v1.0.2', $options['headers']['User-Agent']);
+ $this->assertStringContainsString('php@' . PHP_VERSION, $options['headers']['User-Agent']);
+
  $this->assertEquals('application/json', $options['headers']['Accept']);
  $this->assertEquals('application/json', $options['headers']['Content-Type']);
+
  $this->assertArrayHasKey('http_errors', $options);
  $this->assertFalse($options['http_errors']);
+
  $this->assertArrayHasKey('X-Test', $options['headers']);
  $this->assertEquals('test-header', $options['headers']['X-Test']);
  }