Merge pull request #41 from apivideo/user-agent-extension

feat(nodejs): add applicationName parameter

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.2.1] - 2022-01-24
+- Add applicationName parameter (to allow user agent extension)
+
 ## [1.2.0] - 2022-01-07
 - Add watermark endpoints
 - Add video clips

src/BaseClient.php

@@ -16,6 +16,8 @@
  */
 class BaseClient
 {
+    private const DEFAULT_USER_AGENT = 'api.video client (php; v:1.2.1; )';
+
     /**
      * @var Authenticator
      */
@@ -41,12 +43,16 @@ class BaseClient
      */
     private $streamFactory;
 
-
     /**
      * @var int
      */
     private $chunkSize;
 
+    /**
+     * @var string
+     */
+    private $userAgent;
+
 
     /**
      * @param string                  $baseUri
@@ -63,6 +69,7 @@ public function __construct(string $baseUri, ?string $apiKey, ClientInterface $h
         $this->requestFactory = $requestFactory;
         $this->streamFactory = $streamFactory;
         $this->chunkSize = $chunkSize;
+        $this->userAgent = self::DEFAULT_USER_AGENT;
 
         if ($apiKey) {
             $this->authenticator = new Authenticator($this, $apiKey);
@@ -92,11 +99,28 @@ public function request(Request $commandRequest): ?array
             $request = $request->withHeader($name, $value);
         }
 
-        $request = $request->withHeader('User-Agent', 'api.video client (php; v:1.2.0; )');
+        $request = $request->withHeader('User-Agent', $this->userAgent);
 
         return $this->sendRequest($request);
     }
 
+    /**
+     * @param string $applicationName the application name. Allowed characters: A-Z, a-z, 0-9, -, _, /. Max length: 50.
+     */
+    public function setApplicationName(string $applicationName) {
+        if($applicationName) {
+            if (!preg_match_all('/^[\w\-.\/]{1,50}$/m', $applicationName)) {
+                throw new \InvalidArgumentException(
+                    'Invalid application name. Allowed characters: A-Z, a-z, 0-9, \'-\', \'_\', \'/\'. Max length: 50.'
+                );
+            }
+            $this->userAgent = self::DEFAULT_USER_AGENT . " " . $applicationName;
+            print("setted" . $this->userAgent . "\n");
+        } else {
+            $this->userAgent = self::DEFAULT_USER_AGENT;
+        }
+    }
+
     /**
      * @return int
      */

src/Client.php

@@ -52,6 +52,14 @@ public function __construct(string $baseUri, ?string $apiKey, ClientInterface $h
         $this->baseClient = new BaseClient($baseUri, $apiKey, $httpClient, $requestFactory, $streamFactory, $chunkSize);
     }
 
+    /**
+     * @param string $applicationName the application name. Allowed characters: A-Z, a-z, 0-9, -, _, /. Max length: 50.
+     */
+    public function setApplicationName(string $applicationName)
+    {
+        $this->baseClient->setApplicationName($applicationName);
+    }
+
 
     /**
      * @return \ApiVideo\Client\Api\CaptionsApi