Merge pull request #507 from appwrite/feat-add-user-agent

Author: lohanidamodar

src/SDK/Language/PHP.php

@@ -384,7 +384,10 @@ public function getFilters(): array
         return [
             new TwigFilter('getReturn', function ($value) {
                 return $this->getReturn($value);
-            })
+            }),
+            new TwigFilter('deviceInfo', function ($value) {
+                return php_uname('s') . '; ' . php_uname('v') . '; ' . php_uname('m');
+            }),
         ];
     }
 }

templates/dart/lib/src/client_io.dart.twig

@@ -43,6 +43,7 @@ class ClientIO extends ClientBase with ClientMixin {
       'x-sdk-platform': '{{ sdk.platform }}',
       'x-sdk-language': '{{ language.name | caseLower }}',
       'x-sdk-version': '{{ sdk.version }}',
+      'user-agent' : '{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} ({{Platform.operatingSystem}}; {{Platform.operatingSystemVersion}})',
 {% for key,header in spec.global.defaultHeaders %}
       '{{key}}' : '{{header}}',
 {% endfor %}

templates/deno/src/client.ts.twig

@@ -11,6 +11,7 @@ export class Client {
     endpoint: string = '{{spec.endpoint}}';
     headers: Payload = {
         'content-type': '',
+        'user-agent' : `{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} (${Deno.build.os}; ${Deno.build.arch})`,
         'x-sdk-name': '{{ sdk.name }}',
         'x-sdk-platform': '{{ sdk.platform }}',
         'x-sdk-language': '{{ language.name | caseLower }}',

templates/dotnet/src/Appwrite/Client.cs.twig

@@ -30,6 +30,7 @@ namespace {{ spec.title | caseUcfirst }}
             this.headers = new Dictionary<string, string>()
             {
                 { "content-type", "application/json" },
+                { "user-agent" , "{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} (${Environment.OSVersion.Platform}; ${Environment.OSVersion.VersionString})"},
                 { "x-sdk-name", "{{ sdk.name }}" },
                 { "x-sdk-platform", "{{ sdk.platform }}" },
                 { "x-sdk-language", "{{ language.name | caseLower }}" },

templates/go/client.go.twig

@@ -18,6 +18,7 @@ import (
 	"strconv"
 	"strings"
 	"time"
+	"runtime"
 )
 
 const (
@@ -65,6 +66,7 @@ func NewClient() Client {
 	headers := map[string]string{
 {% for key,header in spec.global.defaultHeaders %}
 		"{{key}}" : "{{header}}",
+		"user-agent" : fmt.Sprintf("{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} (%s; %s)", runtime.GOOS, runtime.GOARCH),
 		"x-sdk-name": "{{ sdk.name }}",
 		"x-sdk-platform": "{{ sdk.platform }}",
 		"x-sdk-language": "{{ language.name | caseLower }}",
@@ -387,4 +389,4 @@ func toString(arg interface{}) string {
 	default:
 		return fmt.Sprintf("%s", v)
 	}
-}
+}

templates/kotlin/src/main/kotlin/io/appwrite/Client.kt.twig

@@ -62,11 +62,11 @@ class Client @JvmOverloads constructor(
     init {
         headers = mutableMapOf(
             "content-type" to "application/json",
+            "user-agent" to "{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} ${System.getProperty("http.agent")}",
             "x-sdk-name" to "{{ sdk.name }}",
             "x-sdk-platform" to "{{ sdk.platform }}",
             "x-sdk-language" to "{{ language.name | caseLower }}",
             "x-sdk-version" to "{{ sdk.version }}"{% if spec.global.defaultHeaders | length > 0 %},{% endif %}
-            
 {% for key,header in spec.global.defaultHeaders %}
             "{{ key | caseLower }}" to "{{ header }}"{% if not loop.last %},{% endif %}
 {% endfor %}

templates/node/lib/client.js.twig

@@ -1,3 +1,4 @@
+const os = require('os');
 const URL = require('url').URL;
 const axios = require('axios');
 const FormData = require('form-data');
@@ -11,6 +12,7 @@ class Client {
         this.headers = {
             'accept-encoding': '*',
             'content-type': '',
+            'user-agent' : `{{spec.title | caseUcfirst}}{{language.name | caseUcfirst}}SDK/{{ sdk.version }} (${os.type()}; ${os.version()}; ${os.arch()})`,
             'x-sdk-name': '{{ sdk.name }}',
             'x-sdk-platform': '{{ sdk.platform }}',
             'x-sdk-language': '{{ language.name | caseLower }}',

templates/php/src/Client.php.twig

@@ -37,6 +37,7 @@ class Client
      */
     protected $headers = [
         'content-type' => '',
+        'user-agent' => '{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} ({{deviceInfo}})',
         'x-sdk-name'=> '{{ sdk.name }}',
         'x-sdk-platform'=> '{{ sdk.platform }}',
         'x-sdk-language'=> '{{ language.name | caseLower }}',

templates/python/package/client.py.twig

@@ -11,6 +11,7 @@ class Client:
         self._endpoint = '{{spec.endpoint}}'
         self._global_headers = {
             'content-type': '',
+            'user-agent' : '{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} (${os.uname().sysname}; ${os.uname().version}; ${os.uname().machine})',
             'x-sdk-name': '{{ sdk.name }}',
             'x-sdk-platform': '{{ sdk.platform }}',
             'x-sdk-language': '{{ language.name | caseLower }}',