Merge remote-tracking branch 'refs/remotes/origin/master' into owre-master

# Conflicts:
#	SendGrid/UnitTest/UnitTest.cs

Author: thinkingserious

CHANGELOG.md

@@ -1,6 +1,17 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [8.0.1] - 2016-07-25 ## 
+### Added 
+- [Troubleshooting](https://github.com/sendgrid/sendgrid-csharp/blob/master/TROUBLESHOOTING.md) section 
+
+## [8.0.0] - 2016-07-22 ## 
+## BREAKING CHANGE 
+- updated dependency on [SendGrid.CSharp.HTTP.Client](https://github.com/sendgrid/csharp-http-client/releases/tag/v3.0.0), which had a breaking change 
+- Fixes [issue #259](https://github.com/sendgrid/sendgrid-csharp/issues/259) 
+- the async behavior in the HTTP client has changed, as we don’t block on .Result anymore  
+- Updated USAGE, examples and README to demonstrate await usage 
+
 ## [7.1.1] - 2016-07-20 ## 
 ### Added 
 - README updates 

README.md

@@ -2,7 +2,7 @@
 
 **This library allows you to quickly and easily use the SendGrid Web API v3 via C# with .NET.**
 
-Version 7.X.X of this library provides full support for all SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
+Version 7.X.X+ of this library provides full support for all SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
 
 This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-csharp/issues) and [pull requests](https://github.com/sendgrid/sendgrid-csharp/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
 
@@ -57,23 +57,29 @@ The following is the minimum needed code to send an email with the [/mail/send H
 using System;
 using SendGrid;
 using SendGrid.Helpers.Mail;
+using System.Threading.Tasks;
 
 namespace Example
 {
     internal class Example
     {
         private static void Main()
         {
-            String apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY", EnvironmentVariableTarget.User);
+	        Execute().Wait();
+        }
+
+        static async Task Execute()
+        {
+            string apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY", EnvironmentVariableTarget.User);
             dynamic sg = new SendGridAPIClient(apiKey);
 
             Email from = new Email("[email protected]");
-            String subject = "Hello World from the SendGrid CSharp Library!";
+            string subject = "Hello World from the SendGrid CSharp Library!";
             Email to = new Email("[email protected]");
             Content content = new Content("text/plain", "Hello, Email!");
             Mail mail = new Mail(from, subject, to, content);
 
-            dynamic response = sg.client.mail.send.post(requestBody: mail.Get());
+            dynamic response = await sg.client.mail.send.post(requestBody: mail.Get());
         }
     }
 }
@@ -89,12 +95,18 @@ The following is the minimum needed code to send an email without the /mail/send
 using System;
 using SendGrid;
 using Newtonsoft.Json; // You can generate your JSON string yourelf or with another library if you prefer
+using System.Threading.Tasks;
 
 namespace Example
 {
     internal class Example
     {
         private static void Main()
+        {
+	        Execute().Wait();
+        }
+
+	    static async Task Execute()
         {
             String apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY", EnvironmentVariableTarget.User);
             dynamic sg = new SendGridAPIClient(apiKey);
@@ -121,7 +133,7 @@ namespace Example
               ]
             }";
             Object json = JsonConvert.DeserializeObject<Object>(data);
-            dynamic response = sg.client.mail.send.post(requestBody: json.ToString());
+            dynamic response = await sg.client.mail.send.post(requestBody: json.ToString());
         }
     }
 }
@@ -132,17 +144,23 @@ namespace Example
 ```csharp
 using System;
 using SendGrid;
+using System.Threading.Tasks;
 
 namespace Example
 {
     internal class Example
     {
         private static void Main()
+        {
+	        Execute().Wait();
+        }
+
+        static async Task Execute()
         {
             string apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY", EnvironmentVariableTarget.User);
             dynamic sg = new SendGrid.SendGridAPIClient(apiKey);
-            dynamic response = sg.client.suppression.bounces.get();
-        }
+            dynamic response = await sg.client.suppression.bounces.get();
+	    }
     }
 }
 ```
@@ -152,16 +170,22 @@ namespace Example
 ```csharp
 using System;
 using SendGrid;
+using System.Threading.Tasks;
 
 namespace Example
 {
     internal class Example
     {
         private static void Main()
         {
-            string apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY", EnvironmentVariableTarget.User);
-            dynamic sg = new SendGrid.SendGridAPIClient(apiKey);
-            dynamic response = sg.client._("suppression/bounces").get();
+            Execute().Wait();
+        }
+
+        static async Task Execute()
+        {
+                string apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY", EnvironmentVariableTarget.User);
+                dynamic sg = new SendGrid.SendGridAPIClient(apiKey);
+                dynamic response = await sg.client._("suppression/bounces").get();
         }
     }
 }
@@ -194,6 +218,10 @@ Quick links:
 - [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#cla)
 - [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#improvements_to_the_codebase)
 
+# Troubleshooting
+
+Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-csharp/blob/master/TROUBLESHOOTING.md) for common library issues.
+
 # About
 
 sendgrid-csharp is guided and supported by the SendGrid [Developer Experience Team](mailto:[email protected]).

SendGrid/Example/Example.cs

@@ -3,6 +3,7 @@
 using System.Web.Script.Serialization;
 using SendGrid.Helpers.Mail;
 using Newtonsoft.Json;
+using System.Threading.Tasks;
 
 namespace Example
 {
@@ -11,15 +12,15 @@ internal class Example
         private static void Main()
         {
             // v3 Mail Helper
-            HelloEmail(); // this will actually send an email
-            KitchenSink(); // this will only send an email if you set SandBox Mode to false
+            HelloEmail().Wait(); // this will actually send an email
+            KitchenSink().Wait(); // this will only send an email if you set SandBox Mode to false
 
             // v3 Web API
-            ApiKeys();
+            ApiKeys().Wait();
 
         }
 
-        private static void HelloEmail()
+        private static async Task HelloEmail()
         {
             String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
             dynamic sg = new SendGrid.SendGridAPIClient(apiKey, "https://api.sendgrid.com");
@@ -32,7 +33,14 @@ private static void HelloEmail()
             Email email = new Email("[email protected]");
             mail.Personalization[0].AddTo(email);
 
-            dynamic response = sg.client.mail.send.post(requestBody: mail.Get());
+            // If you want to use a transactional [template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html),
+            // the following code will replace the above subject and content. The sample code assumes you have defined
+            // substitution variables [KEY_1] and [KEY_2], to be replaced by VALUE_1 and VALUE_2 respectively, in your template.
+            //mail.TemplateId = "TEMPLATE_ID";
+            //mail.Personalization[0].AddSubstitution("[KEY_1]", "VALUE_1");
+            //mail.Personalization[0].AddSubstitution("[KEY_2]", "VALUE_2");
+
+            dynamic response = await sg.client.mail.send.post(requestBody: mail.Get());
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.Body.ReadAsStringAsync().Result);
             Console.WriteLine(response.Headers.ToString());
@@ -42,7 +50,7 @@ private static void HelloEmail()
 
         }
 
-        private static void KitchenSink()
+        private static async Task KitchenSink()
         {
             String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
             dynamic sg = new SendGrid.SendGridAPIClient(apiKey, "https://api.sendgrid.com");
@@ -229,7 +237,7 @@ private static void KitchenSink()
             email.Address = "[email protected]";
             mail.ReplyTo = email;
 
-            dynamic response = sg.client.mail.send.post(requestBody: mail.Get());
+            dynamic response = await sg.client.mail.send.post(requestBody: mail.Get());
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.Body.ReadAsStringAsync().Result);
             Console.WriteLine(response.Headers.ToString());
@@ -238,15 +246,15 @@ private static void KitchenSink()
             Console.ReadLine();
         }
 
-        private static void ApiKeys()
+        private static async Task ApiKeys()
         {
             String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
             dynamic sg = new SendGrid.SendGridAPIClient(apiKey, "https://api.sendgrid.com");
 
             string queryParams = @"{
                 'limit': 100
             }";
-            dynamic response = sg.client.api_keys.get(queryParams: queryParams);
+            dynamic response = await sg.client.api_keys.get(queryParams: queryParams);
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.Body.ReadAsStringAsync().Result);
             Console.WriteLine(response.Headers.ToString());
@@ -264,7 +272,7 @@ private static void ApiKeys()
                 ]
             }";
             Object json = JsonConvert.DeserializeObject<Object>(requestBody);
-            response = sg.client.api_keys.post(requestBody: json.ToString());
+            response = await sg.client.api_keys.post(requestBody: json.ToString());
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.Body.ReadAsStringAsync().Result);
             Console.WriteLine(response.Headers.ToString());
@@ -276,7 +284,7 @@ private static void ApiKeys()
             Console.ReadLine();
 
             // GET Single
-            response = sg.client.api_keys._(api_key_id).get();
+            response = await sg.client.api_keys._(api_key_id).get();
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.Body.ReadAsStringAsync().Result);
             Console.WriteLine(response.Headers.ToString());
@@ -289,7 +297,7 @@ private static void ApiKeys()
                 'name': 'A New Hope'
             }";
             json = JsonConvert.DeserializeObject<Object>(requestBody);
-            response = sg.client.api_keys._(api_key_id).patch(requestBody: json.ToString());
+            response = await sg.client.api_keys._(api_key_id).patch(requestBody: json.ToString());
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.Body.ReadAsStringAsync().Result);
             Console.WriteLine(response.Headers.ToString());
@@ -306,7 +314,7 @@ private static void ApiKeys()
                 ]
             }";
             json = JsonConvert.DeserializeObject<Object>(requestBody);
-            response = sg.client.api_keys._(api_key_id).put(requestBody: json.ToString());
+            response = await sg.client.api_keys._(api_key_id).put(requestBody: json.ToString());
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.Body.ReadAsStringAsync().Result);
             Console.WriteLine(response.Headers.ToString());
@@ -315,7 +323,7 @@ private static void ApiKeys()
             Console.ReadLine();
 
             // DELETE
-            response = sg.client.api_keys._(api_key_id).delete();
+            response = await sg.client.api_keys._(api_key_id).delete();
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.Headers.ToString());
 

SendGrid/Example/Properties/AssemblyInfo.cs

@@ -35,5 +35,5 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 
-[assembly: AssemblyVersion("7.1.1")]
-[assembly: AssemblyFileVersion("7.1.1")]
+[assembly: AssemblyVersion("8.0.1")]
+[assembly: AssemblyFileVersion("8.0.1")]

SendGrid/SendGrid/Properties/AssemblyInfo.cs

@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("7.1.1")]
-[assembly: AssemblyFileVersion("7.1.1")]
+[assembly: AssemblyVersion("8.0.1")]
+[assembly: AssemblyFileVersion("8.0.1")]

SendGrid/SendGrid/SendGrid.csproj

@@ -47,8 +47,8 @@
       <HintPath>..\packages\Newtonsoft.Json.9.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
       <Private>True</Private>
     </Reference>
-    <Reference Include="SendGrid.CSharp.HTTP.Client, Version=2.0.7.0, Culture=neutral, PublicKeyToken=79219bf4e5ecaaca, processorArchitecture=MSIL">
-      <HintPath>..\packages\SendGrid.CSharp.HTTP.Client.2.0.7\lib\SendGrid.CSharp.HTTP.Client.dll</HintPath>
+    <Reference Include="SendGrid.CSharp.HTTP.Client, Version=3.0.0.0, Culture=neutral, PublicKeyToken=79219bf4e5ecaaca, processorArchitecture=MSIL">
+      <HintPath>..\packages\SendGrid.CSharp.HTTP.Client.3.0.0\lib\SendGrid.CSharp.HTTP.Client.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

SendGrid/SendGrid/packages.config

@@ -2,5 +2,5 @@
 <packages>
   <package id="Microsoft.AspNet.WebApi.Client" version="5.2.3" targetFramework="net45" />
   <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net452" />
-  <package id="SendGrid.CSharp.HTTP.Client" version="2.0.7" targetFramework="net452" />
+  <package id="SendGrid.CSharp.HTTP.Client" version="3.0.0" targetFramework="net452" />
 </packages>

SendGrid/UnitTest/Properties/AssemblyInfo.cs

@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("7.1.1")]
-[assembly: AssemblyFileVersion("7.1.1")]
+[assembly: AssemblyVersion("8.0.1")]
+[assembly: AssemblyFileVersion("8.0.1")]