Merge pull request #149 from darrencauthon/useragent

User agent

Author: darrencauthon

src/SparkPost.Tests/ClientTests.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Net.Http;
+using AutoMoq.Helpers;
 using NUnit.Framework;
 using Should;
 
@@ -61,5 +62,29 @@ public void It_should_set_any_subaccount_id_passed_to_it()
                     .SubaccountId.ShouldEqual(1234);
             }
         }
+
+        [TestFixture]
+        public class UserAgentTests : AutoMoqTestFixture<Client.Settings>
+        {
+            [SetUp]
+            public void Setup()
+            {
+                ResetSubject();
+            }
+
+            [Test]
+            public void It_should_default_to_the_library_version()
+            {
+                Subject.UserAgent.ShouldEqual($"csharp-sparkpost/1.13.1");
+            }
+
+            [Test]
+            public void It_should_allow_the_user_agent_to_be_changed()
+            {
+                var userAgent = Guid.NewGuid().ToString();
+                Subject.UserAgent = userAgent;
+                Subject.UserAgent.ShouldEqual(userAgent);
+            }
+        }
     }
 }

src/SparkPost/Client.cs

@@ -1,6 +1,9 @@
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Net.Http;
 using SparkPost.RequestSenders;
+using SparkPost.Utilities;
 
 namespace SparkPost
 {
@@ -79,9 +82,14 @@ public Settings()
                     httpClient.DefaultRequestHeaders.Accept.Clear();
                     return httpClient;
                 };
+
+                var currentVersion = GetTheCurrentVersion();
+                if (string.IsNullOrEmpty(currentVersion) == false)
+                    UserAgent = $"csharp-sparkpost/{currentVersion}";
             }
 
             public SendingModes SendingMode { get; set; }
+            public string UserAgent { get; set; }
 
             public HttpClient CreateANewHttpClient()
             {
@@ -92,7 +100,26 @@ public void BuildHttpClientsUsing(Func<HttpClient> httpClient)
             {
                 httpClientBuilder = httpClient;
             }
-        }
 
+            private static string GetTheCurrentVersion()
+            {
+                try
+                {
+                    return AttemptToPullTheVersionNumberOutOf(typeof(Client).AssemblyQualifiedName);
+                }
+                catch
+                {
+                    return null;
+                }
+            }
+
+            private static string AttemptToPullTheVersionNumberOutOf(string value)
+            {
+                return value.SplitOn("Version=")[1]
+                    .SplitOn(",")[0]
+                    .SplitOn(".").Take(3)
+                    .JoinWith(".");
+            }
+        }
     }
 }

src/SparkPost/RequestSenders/AsyncRequestSender.cs

@@ -23,6 +23,8 @@ public virtual async Task<Response> Send(Request request)
                 httpClient.BaseAddress = new Uri(client.ApiHost);
                 httpClient.DefaultRequestHeaders.Add("Authorization", client.ApiKey);
 
+                SetTheUserAgentIfItIsProvided(httpClient);
+
                 if (client.SubaccountId != 0)
                     httpClient.DefaultRequestHeaders.Add("X-MSYS-SUBACCOUNT",
                         client.SubaccountId.ToString(CultureInfo.InvariantCulture));
@@ -38,6 +40,12 @@ public virtual async Task<Response> Send(Request request)
             }
         }
 
+        private void SetTheUserAgentIfItIsProvided(HttpClient httpClient)
+        {
+            if (string.IsNullOrEmpty(client.CustomSettings.UserAgent) == false)
+                httpClient.DefaultRequestHeaders.TryAddWithoutValidation("User-Agent", client.CustomSettings.UserAgent);
+        }
+
         protected virtual async Task<HttpResponseMessage> GetTheResponse(Request request, HttpClient httpClient)
         {
             return await new RequestMethodFinder(httpClient, dataMapper)

src/SparkPost/SparkPost.csproj

@@ -98,6 +98,7 @@
     <Compile Include="Utilities\Jsonification.cs" />
     <Compile Include="Utilities\MailMessageMapping.cs" />
     <Compile Include="Utilities\SnakeCase.cs" />
+    <Compile Include="Utilities\StringHelper.cs" />
     <Compile Include="ValueMappers\AnonymousValueMapper.cs" />
     <Compile Include="ValueMappers\BooleanValueMapper.cs" />
     <Compile Include="RequestSenders\AsyncRequestSender.cs" />

src/SparkPost/Utilities/StringHelper.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+
+namespace SparkPost.Utilities
+{
+    public static class StringHelper
+    {
+        public static string[] SplitOn(this string value, string separator)
+        {
+            return value.Split(new[] {separator}, StringSplitOptions.RemoveEmptyEntries);
+        }
+
+        public static string JoinWith(this IEnumerable<string> value, string separator)
+        {
+            return string.Join(separator, value);
+        }
+    }
+}