Strongly typed UnsubscribeGroups

Also allow the HttpClient to be injected (this is useful for mocking and for using Fiddler)

SendGrid/Example/Program.cs

@@ -2,26 +2,47 @@
 using SendGrid.Model;
 using System;
 using System.Collections.Generic;
+using System.Net;
 using System.Net.Http;
 using System.Net.Mail;
+using System.Net.Security;
 
 namespace Example
 {
     internal class Program
     {
         private static void Main()
         {
+            // Do you want to proxy requests through fiddler?
+            var useFiddler = false;
+
+            if (useFiddler)
+            {
+                // This is necessary to ensure HTTPS traffic can be proxied through Fiddler without any certificate validation error.
+                // This is fine for testing but not advisable in production
+                ServicePointManager.ServerCertificateValidationCallback = new RemoteCertificateValidationCallback(delegate { return true; });
+            }
+
+            // Direct all traffic through fiddler running on the local machine
+            var httpClient = new HttpClient(
+                new HttpClientHandler()
+                {
+                    Proxy = new WebProxy("http://localhost:8888"),
+                    UseProxy = useFiddler
+                }
+            );
+
             // Test sending email 
             var to = "example@example.com";
             var from = "example@example.com";
             var fromName = "Jane Doe";
             SendEmail(to, from, fromName);
             // Test viewing, creating, modifying and deleting API keys through our v3 Web API 
-            ApiKeys();
-            UnsubscribeGroups();
-            Suppressions();
-            GlobalSuppressions();
-            GlobalStats();
+            ApiKeys(httpClient);
+            UnsubscribeGroups(httpClient);
+            Suppressions(httpClient);
+            GlobalSuppressions(httpClient);
+            GlobalStats(httpClient);
         }
 
         private static void SendAsync(SendGrid.SendGridMessage message)
@@ -62,10 +83,10 @@ private static void SendEmail(string to, string from, string fromName)
             SendAsync(myMessage);
         }
 
-        private static void ApiKeys()
+        private static void ApiKeys(HttpClient httpClient)
         {
             String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
-            var client = new SendGrid.Client(apiKey);
+            var client = new SendGrid.Client(apiKey: apiKey, httpClient: httpClient);
 
             // GET API KEYS
             HttpResponseMessage responseGet = client.ApiKeys.Get().Result;
@@ -102,48 +123,38 @@ private static void ApiKeys()
             Console.ReadKey();
         }
 
-        private static void UnsubscribeGroups()
+        private static void UnsubscribeGroups(HttpClient httpClient)
         {
-            String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
-            var client = new SendGrid.Client(apiKey);
+            Console.WriteLine("\n***** UNSUBSCRIBE GROUPS *****");
+
+            var apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
+            var client = new SendGrid.Client(apiKey: apiKey, httpClient: httpClient);
+
+            // CREATE A NEW SUPPRESSION GROUP
+            var newGroup = client.UnsubscribeGroups.CreateAsync("New group", "This is a new group for testing purposes", false).Result;
+            Console.WriteLine("Unique ID of the new suppresion group: {0}", newGroup.Id);
+
+            // UPDATE A SUPPRESSION GROUP
+            var updatedGroup = client.UnsubscribeGroups.UpdateAsync(newGroup.Id, "This is the updated name").Result;
+            Console.WriteLine("Suppresion group {0} updated", updatedGroup.Id);
 
             // GET UNSUBSCRIBE GROUPS
-            HttpResponseMessage responseGet = client.UnsubscribeGroups.Get().Result;
-            Console.WriteLine(responseGet.StatusCode);
-            Console.WriteLine(responseGet.Content.ReadAsStringAsync().Result);
-            Console.WriteLine("These are your current Unsubscribe Groups. Press any key to continue.");
-            Console.ReadKey();
+            var groups = client.UnsubscribeGroups.GetAllAsync().Result;
+            Console.WriteLine("There are {0} suppresion groups", groups.Length);
 
             // GET A PARTICULAR UNSUBSCRIBE GROUP
-            int unsubscribeGroupID = 69;
-            HttpResponseMessage responseGetUnique = client.UnsubscribeGroups.Get(unsubscribeGroupID).Result;
-            Console.WriteLine(responseGetUnique.StatusCode);
-            Console.WriteLine(responseGetUnique.Content.ReadAsStringAsync().Result);
-            Console.WriteLine("This is an Unsubscribe Group with ID: " + unsubscribeGroupID.ToString() + ".\n\nPress any key to continue.");
-            Console.ReadKey();
-
-            // POST UNSUBSCRIBE GROUP
-            HttpResponseMessage responsePost = client.UnsubscribeGroups.Post("C Sharp Unsubscribes", "Testing the C Sharp Library", false).Result;
-            var rawString = responsePost.Content.ReadAsStringAsync().Result;
-            dynamic jsonObject = JObject.Parse(rawString);
-            var unsubscribeGroupId = jsonObject.id.ToString();
-            Console.WriteLine(responsePost.StatusCode);
-            Console.WriteLine(responsePost.Content.ReadAsStringAsync().Result);
-            Console.WriteLine("Unsubscribe Group created.\n\nPress any key to continue.");
-            Console.ReadKey();
+            var group = client.UnsubscribeGroups.GetAsync(newGroup.Id).Result;
+            Console.WriteLine("Retrieved unsubscribe group {0}: {1}", group.Id, group.Name);
 
             // DELETE UNSUBSCRIBE GROUP
-            Console.WriteLine("Deleting Unsubscribe Group, please wait.");
-            HttpResponseMessage responseDelete = client.UnsubscribeGroups.Delete(unsubscribeGroupId).Result;
-            Console.WriteLine(responseDelete.StatusCode);
-            HttpResponseMessage responseFinal = client.UnsubscribeGroups.Get().Result;
-            Console.WriteLine(responseFinal.StatusCode);
-            Console.WriteLine(responseFinal.Content.ReadAsStringAsync().Result);
-            Console.WriteLine("Unsubscribe Group Deleted.\n\nPress any key to end.");
+            client.UnsubscribeGroups.DeleteAsync(newGroup.Id).Wait();
+            Console.WriteLine("Suppression group {0} deleted", newGroup.Id);
+
+            Console.WriteLine("\n\nPress any key to continue");
             Console.ReadKey();
         }
 
-        private static void Suppressions()
+        private static void Suppressions(HttpClient httpClient)
         {
             String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
             var client = new SendGrid.Client(apiKey);
@@ -179,17 +190,17 @@ private static void Suppressions()
             Console.ReadKey();
         }
 
-        private static void GlobalSuppressions()
+        private static void GlobalSuppressions(HttpClient httpClient)
         {
             Console.WriteLine("\n***** GLOBAL SUPPRESSION *****");
 
             var apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
-            var client = new SendGrid.Client(apiKey);
+            var client = new SendGrid.Client(apiKey: apiKey, httpClient: httpClient);
 
             // ADD EMAILS TO THE GLOBAL SUPPRESSION LIST
             var emails = new[] { "example@example.com", "example2@example.com" };
             client.GlobalSuppressions.AddAsync(emails).Wait();
-            Console.WriteLine("\nThe following emails have been added to the global suppression list: {0}", string.Join(", ", emails));
+            Console.WriteLine("The following emails have been added to the global suppression list: {0}", string.Join(", ", emails));
             Console.WriteLine("Is {0} unsubscribed (should be true): {1}", emails[0], client.GlobalSuppressions.IsUnsubscribedAsync(emails[0]).Result);
             Console.WriteLine("Is {0} unsubscribed (should be true): {1}", emails[1], client.GlobalSuppressions.IsUnsubscribedAsync(emails[1]).Result);
 
@@ -206,12 +217,12 @@ private static void GlobalSuppressions()
             Console.ReadKey();
         }
 
-        private static void GlobalStats()
+        private static void GlobalStats(HttpClient httpClient)
         {
             Console.WriteLine("\n***** GLOBAL STATS *****");
 
             var apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
-            var client = new SendGrid.Client(apiKey);
+            var client = new SendGrid.Client(apiKey: apiKey, httpClient: httpClient);
 
             // Global Stats provide all of your user’s email statistics for a given date range.
             var startDate = new DateTime(2015, 11, 01);

SendGrid/SendGrid/Client.cs

@@ -13,34 +13,44 @@ namespace SendGrid
     public class Client
     {
         private string _apiKey;
-        public APIKeys ApiKeys;
-        public UnsubscribeGroups UnsubscribeGroups;
-        public Suppressions Suppressions;
-        public GlobalSuppressions GlobalSuppressions;
-        public GlobalStats GlobalStats;
-        public string Version;
         private Uri _baseUri;
+        private HttpClient _httpClient;
         private const string MediaType = "application/json";
         private enum Methods
         {
             GET, POST, PATCH, DELETE
         }
 
+        public APIKeys ApiKeys { get; private set; }
+        public UnsubscribeGroups UnsubscribeGroups { get; private set; }
+        public Suppressions Suppressions { get; private set; }
+        public GlobalSuppressions GlobalSuppressions { get; private set; }
+        public GlobalStats GlobalStats { get; private set; }
+        public string Version { get; private set; }
+
         /// <summary>
         ///     Create a client that connects to the SendGrid Web API
         /// </summary>
         /// <param name="apiKey">Your SendGrid API Key</param>
         /// <param name="baseUri">Base SendGrid API Uri</param>
-        public Client(string apiKey, string baseUri = "https://api.sendgrid.com/")
+        public Client(string apiKey, string baseUri = "https://api.sendgrid.com/", HttpClient httpClient = null)
         {
             _baseUri = new Uri(baseUri);
             _apiKey = apiKey;
+
             Version = Assembly.GetExecutingAssembly().GetName().Version.ToString();
             ApiKeys = new APIKeys(this);
             UnsubscribeGroups = new UnsubscribeGroups(this);
             Suppressions = new Suppressions(this);
             GlobalSuppressions = new GlobalSuppressions(this);
             GlobalStats = new GlobalStats(this);
+
+            _httpClient = httpClient ?? new HttpClient();
+            _httpClient.BaseAddress = _baseUri;
+            _httpClient.DefaultRequestHeaders.Accept.Clear();
+            _httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(MediaType));
+            _httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", _apiKey);
+            _httpClient.DefaultRequestHeaders.TryAddWithoutValidation("User-Agent", string.Format("sendgrid/{0};csharp", Version));
         }
 
         /// <summary>
@@ -78,50 +88,40 @@ private async Task<HttpResponseMessage> RequestAsync(Methods method, string endp
         /// <returns>An asyncronous task</returns>
         private async Task<HttpResponseMessage> RequestAsync(Methods method, string endpoint, StringContent content)
         {
-            using (var client = new HttpClient())
+            try
             {
-                try
+                var methodAsString = "";
+                switch (method)
                 {
-                    client.BaseAddress = _baseUri;
-                    client.DefaultRequestHeaders.Accept.Clear();
-                    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(MediaType));
-                    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", _apiKey);
-                    client.DefaultRequestHeaders.TryAddWithoutValidation("User-Agent", "sendgrid/" + Version + ";csharp");
-
-                    var methodAsString = "";
-                    switch (method)
-                    {
-                        case Methods.GET: methodAsString = "GET"; break;
-                        case Methods.POST: methodAsString = "POST"; break;
-                        case Methods.PATCH: methodAsString = "PATCH"; break;
-                        case Methods.DELETE: methodAsString = "DELETE"; break;
-                        default:
-                            var message = "{\"errors\":[{\"message\":\"Bad method call, supported methods are GET, POST, PATCH and DELETE\"}]}";
-                            var response = new HttpResponseMessage(HttpStatusCode.MethodNotAllowed)
-                            {
-                                Content = new StringContent(message)
-                            };
-                            return response;
-                    }
-
-                    var postRequest = new HttpRequestMessage()
-                    {
-                        Method = new HttpMethod(methodAsString),
-                        RequestUri = new Uri(_baseUri + endpoint),
-                        Content = content
-                    };
-                    return await client.SendAsync(postRequest);
-
+                    case Methods.GET: methodAsString = "GET"; break;
+                    case Methods.POST: methodAsString = "POST"; break;
+                    case Methods.PATCH: methodAsString = "PATCH"; break;
+                    case Methods.DELETE: methodAsString = "DELETE"; break;
+                    default:
+                        var message = "{\"errors\":[{\"message\":\"Bad method call, supported methods are GET, POST, PATCH and DELETE\"}]}";
+                        var response = new HttpResponseMessage(HttpStatusCode.MethodNotAllowed)
+                        {
+                            Content = new StringContent(message)
+                        };
+                        return response;
                 }
-                catch (Exception ex)
+
+                var httpRequest = new HttpRequestMessage()
                 {
-                    var message = string.Format(".NET {0}, raw message: \n\n{1}", (ex is HttpRequestException) ? "HttpRequestException" : "Exception", ex.Message);
-                    var response = new HttpResponseMessage(HttpStatusCode.BadRequest)
-                    {
-                        Content = new StringContent(message)
-                    };
-                    return response;
-                }
+                    Method = new HttpMethod(methodAsString),
+                    RequestUri = new Uri(_baseUri + endpoint),
+                    Content = content
+                };
+                return await _httpClient.SendAsync(httpRequest);
+            }
+            catch (Exception ex)
+            {
+                var message = string.Format(".NET {0}, raw message: \n\n{1}", (ex is HttpRequestException) ? "HttpRequestException" : "Exception", ex.Message);
+                var response = new HttpResponseMessage(HttpStatusCode.BadRequest)
+                {
+                    Content = new StringContent(message)
+                };
+                return response;
             }
         }
 

SendGrid/SendGrid/Model/SuppressionGroup.cs

@@ -0,0 +1,19 @@
+using Newtonsoft.Json;
+
+namespace SendGrid.Model
+{
+    public class SuppressionGroup
+    {
+        [JsonProperty("id")]
+        public int Id { get; set; }
+
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        [JsonProperty("description")]
+        public string Description { get; set; }
+
+        [JsonProperty("is_default")]
+        public bool IsDefault { get; set; }
+    }
+}

SendGrid/SendGrid/Resources/GlobalSuppressions.cs

@@ -55,8 +55,7 @@ public async Task<bool> IsUnsubscribedAsync(string email)
         /// <returns>https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/global_suppressions.html</returns>
         public async Task AddAsync(IEnumerable<string> emails)
         {
-            var receipient_emails = new JArray(emails.ToArray());
-            var data = new JObject(new JProperty("recipient_emails", receipient_emails));
+            var data = new JObject(new JProperty("recipient_emails", new JArray(emails.ToArray())));
             var response = await _client.Post(_endpoint, data);
             response.EnsureSuccess();
         }