chore: update the user agent string for twilio-csharp

src/Twilio/Clients/TwilioRestClient.cs

@@ -40,6 +40,11 @@ public class TwilioRestClient : ITwilioRestClient
         /// </summary>
         public string Edge { get; set; }
 
+        /// <summary>
+        /// Additions to the user agent string
+        /// </summary>
+        public string[] UserAgentExtensions { get; set; }
+
         /// <summary>
         /// Log level for logging
         /// </summary>
@@ -95,6 +100,9 @@ public Response Request(Request request)
             if (Edge != null)
                 request.Edge = Edge;
 
+            if (UserAgentExtensions != null)
+                request.UserAgentExtensions = UserAgentExtensions;
+
             Response response;
             try
             {
@@ -132,6 +140,9 @@ public async Task<Response> RequestAsync(Request request)
             if (Edge != null)
                 request.Edge = Edge;
 
+            if (UserAgentExtensions != null)
+                request.UserAgentExtensions = UserAgentExtensions;
+
             Response response;
             try
             {

src/Twilio/Http/Net35/WebRequestClient.cs

@@ -9,7 +9,7 @@ namespace Twilio.Http.Net35
     /// </summary>
     public class WebRequestClient : HttpClient
     {
-        private const string PlatVersion = " (.NET 3.5)";
+        private const string PlatVersion = ".NET/3.5";
         private HttpWebRequestFactory factory;
 
         public WebRequestClient(HttpWebRequestFactory factory = null)
@@ -63,7 +63,20 @@ private IHttpWebRequestWrapper BuildHttpRequest(Request request)
         {
             IHttpWebRequestWrapper httpRequest = this.factory.Create(request.ConstructUrl());
 
-            httpRequest.UserAgent = "twilio-csharp/" + AssemblyInfomation.AssemblyInformationalVersion + PlatVersion;
+            string helperLibVersion = AssemblyInfomation.AssemblyInformationalVersion;
+            string osName = System.Environment.OSVersion.Platform.ToString();
+            string osArch = System.Environment.GetEnvironmentVariable("PROCESSOR_ARCHITECTURE") ?? "Unknown";
+            var libraryVersion = System.String.Format("twilio-csharp/{0} ({1} {2}) {3}", helperLibVersion,osName,osArch,PlatVersion);
+
+            if (request.UserAgentExtensions != null)
+            {
+                foreach (var extension in request.UserAgentExtensions)
+                {
+                    libraryVersion += " " + extension;
+                }
+            }
+
+            httpRequest.UserAgent = libraryVersion;
 
             httpRequest.Method = request.Method.ToString();
             httpRequest.Accept = "application/json";

src/Twilio/Http/Request.cs

@@ -46,6 +46,11 @@ public class Request
         /// </summary>
         public string Edge { get; set; }
 
+        /// <summary>
+        /// Additions to the user agent string
+        /// </summary>
+        public string[] UserAgentExtensions { get; set; }
+
         /// <summary>
         /// Query params
         /// </summary>
@@ -86,6 +91,7 @@ public Request(HttpMethod method, string url)
         /// <param name="postParams">Post data</param>
         /// <param name="edge">Twilio edge</param>
         /// <param name="headerParams">Custom header data</param>
+
         public Request(
             HttpMethod method,
             Domain domain,

src/Twilio/Http/SystemNetHttpClient.cs

@@ -14,9 +14,9 @@ namespace Twilio.Http
     public class SystemNetHttpClient : HttpClient
     {
 #if NET451
-        private string PlatVersion = " (.NET Framework 4.5.1+)";
+        private string PlatVersion = ".NET Framework 4.5.1+";
 #else
-        private string PlatVersion = $" ({RuntimeInformation.FrameworkDescription})";
+        private string PlatVersion = $"{RuntimeInformation.FrameworkDescription}";
 #endif
 
         private readonly System.Net.Http.HttpClient _httpClient;
@@ -91,7 +91,46 @@ private HttpRequestMessage BuildHttpRequest(Request request)
             httpRequest.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
             httpRequest.Headers.AcceptEncoding.Add(new StringWithQualityHeaderValue("utf-8"));
 
-            var libraryVersion = "twilio-csharp/" + AssemblyInfomation.AssemblyInformationalVersion + PlatVersion;
+            int lastSpaceIndex = PlatVersion.LastIndexOf(" ");
+            System.Text.StringBuilder PlatVersionSb= new System.Text.StringBuilder(PlatVersion);
+            PlatVersionSb[lastSpaceIndex] = '/';
+
+            string helperLibVersion = AssemblyInfomation.AssemblyInformationalVersion;
+
+            string osName = "Unknown";
+#if !NETSTANDARD1_4
+            osName = Environment.OSVersion.Platform.ToString();
+#else       
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+            {
+                osName = "Windows";
+            }
+            else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+            {
+                osName = "MacOS";
+            }
+            else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+            {
+                osName = "Linux";
+            }
+#endif
+
+            string osArch;
+#if !NET451
+            osArch = RuntimeInformation.OSArchitecture.ToString();
+#else
+            osArch = Environment.GetEnvironmentVariable("PROCESSOR_ARCHITECTURE") ?? "Unknown"; 
+#endif
+            var libraryVersion = String.Format("twilio-csharp/{0} ({1} {2}) {3}", helperLibVersion,osName,osArch,PlatVersionSb);
+
+            if (request.UserAgentExtensions != null)
+            {
+                foreach (var extension in request.UserAgentExtensions)
+                {
+                    libraryVersion += " " + extension;
+                }
+            }
+
             httpRequest.Headers.TryAddWithoutValidation("User-Agent", libraryVersion);
 
             foreach (var header in request.HeaderParams)

test/Twilio.Test/Clients/TwilioRestClientTest.cs

@@ -147,6 +147,20 @@ public void RequestPropagatesEdgeAndRegion()
             Assert.AreEqual(request.Region, "us1");
         }
 
+        [Test]
+        public void RequestWithUserAgentExtensions()
+        {
+            client.MakeRequest(Arg.Any<Request>()).Returns(new Response(HttpStatusCode.OK, "OK"));
+            Request request = new Request(HttpMethod.Get, "https://verify.twilio.com/");
+            string[] userAgentExtensions = new string[] { "twilio-run/2.0.0-test", "flex-plugin/3.4.0" };
+            TwilioRestClient twilioClient = new TwilioRestClient("foo", "bar", httpClient: client);
+            twilioClient.UserAgentExtensions = userAgentExtensions;
+
+            twilioClient.Request(request);
+
+            Assert.AreEqual(request.UserAgentExtensions, userAgentExtensions);
+        }
+
 #if !NET35
         [Test]
         public async Task RequestAsyncPropagatesEdgeAndRegion()
@@ -161,6 +175,20 @@ public async Task RequestAsyncPropagatesEdgeAndRegion()
             Assert.AreEqual(request.Edge, "frankfurt");
             Assert.AreEqual(request.Region, "us1");
         }
+
+        [Test]
+        public async Task RequestAsyncWithUserAgentExtensions()
+        {
+            client.MakeRequestAsync(Arg.Any<Request>()).Returns(new Response(HttpStatusCode.OK, "OK"));
+            Request request = new Request(HttpMethod.Get, "https://verify.twilio.com/");
+            string[] userAgentExtensions = new string[] { "twilio-run/2.0.0-test", "flex-plugin/3.4.0" };
+            TwilioRestClient twilioClient = new TwilioRestClient("foo", "bar", httpClient: client);
+            twilioClient.UserAgentExtensions = userAgentExtensions;
+
+            await twilioClient.RequestAsync(request);
+
+            Assert.AreEqual(request.UserAgentExtensions, userAgentExtensions);
+        }
 #endif
     }
 }

test/Twilio.Test/Http/SystemNetHttpClientTest.cs

@@ -5,6 +5,7 @@
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
+using System.Text.RegularExpressions;
 using NUnit.Framework;
 using Twilio.Http;
 using HttpMethod = Twilio.Http.HttpMethod;
@@ -237,7 +238,29 @@ public void TestMakeRequestAddsHeadersAndUserAgent()
             Assert.AreEqual("utf-8", internalRequest.Headers.AcceptEncoding.ToString());
 
             Assert.IsNotNull(internalRequest.Headers.UserAgent);
-            StringAssert.StartsWith("twilio-csharp/", internalRequest.Headers.UserAgent.ToString());
+            Regex rgx = new Regex(@"^twilio-csharp/[0-9.]+\s\(\w+\s\w+\)\s[.\s\w]+/[^\s]+$");
+            Assert.IsTrue(rgx.IsMatch(internalRequest.Headers.UserAgent.ToString()));
+        }
+
+        [Test]
+        public void TestMakeRequestAddUserAgentExtensions()
+        {
+            string[] userAgentExtensions = new string[] { "twilio-run/2.0.0-test", "flex-plugin/3.4.0" };
+
+            this._mockHttp.Respond("https://api.twilio.com/v1/Resource.json", HttpStatusCode.OK);
+
+            Request testRequest = new Request(HttpMethod.Get, "https://api.twilio.com/v1/Resource.json");
+            testRequest.UserAgentExtensions = userAgentExtensions;
+            testRequest.SetAuth("username", "password");
+
+            this.TwilioHttpClient.MakeRequest(testRequest);
+
+            HttpRequestMessage internalRequest = this._mockHttp.InternalRequest;
+            string userAgent = internalRequest.Headers.UserAgent.ToString();
+            var actualUserAgent = userAgent.Split(' ');
+            var actualUserAgentExtensions = new string[userAgentExtensions.Length];
+            Array.Copy(actualUserAgent, actualUserAgent.Length - userAgentExtensions.Length, actualUserAgentExtensions, 0, userAgentExtensions.Length);
+            CollectionAssert.AreEqual(userAgentExtensions, actualUserAgentExtensions);
         }
     }
 }

test/Twilio.Test/Http/WebRequestClientTest.cs

@@ -9,6 +9,7 @@
 using System.Collections.Specialized;
 using System.IO;
 using System.Text;
+using System.Text.RegularExpressions;
 
 namespace Twilio.Tests.Http
 {
@@ -185,7 +186,30 @@ public void TestMakeRequestAddsHeadersAndUserAgent()
             Assert.Contains("Authorization", this._mockRequest.Headers.AllKeys);
             Assert.AreEqual("Basic " + authString, this._mockRequest.Headers["Authorization"]);
 
-            StringAssert.StartsWith("twilio-csharp/", this._mockRequest.UserAgent);
+            Assert.IsNotNull(this._mockRequest.UserAgent);
+            Regex rgx = new Regex(@"^twilio-csharp/[0-9.]+\s\(\w+\s\w+\)\s.NET/3.5$");
+            Assert.IsTrue(rgx.IsMatch(this._mockRequest.UserAgent));
+        }
+
+        [Test]
+        public void TestMakeRequestAddUserAgentExtensions()
+        {
+            // Setup
+            this._mockResponse.StatusCode = HttpStatusCode.OK;
+            string[] userAgentExtensions = new string[] { "twilio-run/2.0.0-test", "flex-plugin/3.4.0" };
+
+            // Run Test
+            var request = new Request(HttpMethod.Post, "https://api.twilio.com/v1/Resource.json");
+            request.UserAgentExtensions = userAgentExtensions;
+            request.SetAuth("user", "pass");
+
+            var response = this.TwilioClient.MakeRequest(request);
+
+            // Assert
+            var actualUserAgent = this._mockRequest.UserAgent.Split(' ');
+            var actualUserAgentExtensions = new string[userAgentExtensions.Length];
+            Array.Copy(actualUserAgent, actualUserAgent.Length - userAgentExtensions.Length, actualUserAgentExtensions, 0, userAgentExtensions.Length);
+            CollectionAssert.AreEqual(userAgentExtensions, actualUserAgentExtensions);
         }
     }
 }