fix: Use the private body and header datamembers for DeserializeResponseBodyAsync and DeserializeResponseHeaders (#1151)

Author: Wind010

src/SendGrid/Permissions/SendGridClientExtensions.cs

@@ -19,7 +19,7 @@ public static class SendGridClientExtensions
         public static async Task<SendGridPermissionsBuilder> CreateMaskedPermissionsBuilderForClient(this ISendGridClient client)
         {
             var response = await client.RequestAsync(method: SendGridClient.Method.GET, urlPath: "scopes");
-            var body = await response.DeserializeResponseBodyAsync(response.Body);
+            var body = await response.DeserializeResponseBodyAsync();
             var userScopesJArray = (body["scopes"] as JArray);
             var includedScopes = userScopesJArray.Values<string>().ToArray();
             var builder = new SendGridPermissionsBuilder();

src/SendGrid/Response.cs

@@ -21,17 +21,17 @@ public class Response
         /// <summary>
         /// The status code returned from Twilio SendGrid.
         /// </summary>
-        private HttpStatusCode statusCode;
+        private HttpStatusCode _statusCode;
 
         /// <summary>
         /// The response body returned from Twilio SendGrid.
         /// </summary>
-        private HttpContent body;
+        private HttpContent _body;
 
         /// <summary>
         /// The response headers returned from Twilio SendGrid.
         /// </summary>
-        private HttpResponseHeaders headers;
+        private HttpResponseHeaders _headers;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Response"/> class.
@@ -53,12 +53,12 @@ public HttpStatusCode StatusCode
         {
             get
             {
-                return this.statusCode;
+                return this._statusCode;
             }
 
             set
             {
-                this.statusCode = value;
+                this._statusCode = value;
             }
         }
 
@@ -72,57 +72,67 @@ public bool IsSuccessStatusCode
 
         /// <summary>
         /// Gets or sets the response body returned from Twilio SendGrid.
+        /// <see href="https://docs.microsoft.com/dotnet/api/system.net.http.httpcontent"></see>
         /// </summary>
         public HttpContent Body
         {
             get
             {
-                return this.body;
+                return this._body;
             }
 
             set
             {
-                this.body = value;
+                this._body = value;
             }
         }
 
         /// <summary>
         /// Gets or sets the response headers returned from Twilio SendGrid.
+        /// <see href="https://docs.microsoft.com/dotnet/api/system.net.http.headers.httpresponseheaders"></see>
         /// </summary>
         public HttpResponseHeaders Headers
         {
             get
             {
-                return this.headers;
+                return this._headers;
             }
 
             set
             {
-                this.headers = value;
+                this._headers = value;
             }
         }
 
         /// <summary>
         /// Converts string formatted response body to a Dictionary.
         /// </summary>
-        /// <param name="content">https://docs.microsoft.com/dotnet/api/system.net.http.httpcontent.</param>
         /// <returns>Dictionary object representation of HttpContent.</returns>
-        public virtual async Task<Dictionary<string, dynamic>> DeserializeResponseBodyAsync(HttpContent content)
+        public virtual async Task<Dictionary<string, dynamic>> DeserializeResponseBodyAsync()
         {
-            var stringContent = await content.ReadAsStringAsync().ConfigureAwait(false);
+            if (this._body is null)
+            {
+                return new Dictionary<string, dynamic>();
+            }
+
+            var stringContent = await this._body.ReadAsStringAsync().ConfigureAwait(false);
             var dsContent = JsonConvert.DeserializeObject<Dictionary<string, dynamic>>(stringContent);
             return dsContent;
         }
 
         /// <summary>
         /// Converts string formatted response headers to a Dictionary.
         /// </summary>
-        /// <param name="content">https://docs.microsoft.com/dotnet/api/system.net.http.headers.httpresponseheaders.</param>
         /// <returns>Dictionary object representation of HttpResponseHeaders.</returns>
-        public virtual Dictionary<string, string> DeserializeResponseHeaders(HttpResponseHeaders content)
+        public virtual Dictionary<string, string> DeserializeResponseHeaders()
         {
             var dsContent = new Dictionary<string, string>();
-            foreach (var pair in content)
+            if (this._headers == null)
+            {
+                return dsContent;
+            }
+
+            foreach (var pair in this._headers)
             {
                 dsContent.Add(pair.Key, pair.Value.First());
             }

tests/SendGrid.Tests/ResponseTests.cs

@@ -0,0 +1,49 @@
+using Newtonsoft.Json.Linq;
+
+using System.Collections.Generic;
+using System.Net;
+using System.Net.Http;
+using System.Threading.Tasks;
+
+using Xunit;
+
+namespace SendGrid.Tests
+{
+    public class ResponseTests
+    {
+        [Fact]
+        public async Task DeserializeResponseBodyAsync_NullHttpContent_ReturnsEmptyDictionary()
+        {
+            var response = new Response(HttpStatusCode.OK, null, null);
+            Dictionary<string, dynamic> responseBody = await response.DeserializeResponseBodyAsync();
+            Assert.Empty(responseBody);
+        }
+
+        [Fact]
+        public async Task DeserializeResponseBodyAsync_JsonHttpContent_ReturnsBodyAsDictionary()
+        {
+            var content = "{\"scopes\": [\"alerts.read\"]}";
+            var response = new Response(HttpStatusCode.OK, new StringContent(content), null);
+            Dictionary<string, dynamic> responseBody = await response.DeserializeResponseBodyAsync();
+            Assert.Equal(new JArray() { "alerts.read" }, responseBody["scopes"]);
+        }
+
+        [Fact]
+        public void DeserializeResponseHeaders_NullHttpResponseHeaders_ReturnsEmptyDictionary()
+        {
+            var response = new Response(HttpStatusCode.OK, null, null);
+            Dictionary<string, string> responseHeadersDeserialized = response.DeserializeResponseHeaders();
+            Assert.Empty(responseHeadersDeserialized);
+        }
+
+        [Fact]
+        public void DeserializeResponseHeaders_NullHttpResponseHeaders_ReturnsHeadersAsDictionary()
+        {
+            var message = new HttpResponseMessage();
+            message.Headers.Add("HeaderKey", "HeaderValue");
+            var response = new Response(HttpStatusCode.OK, null, message.Headers);
+            Dictionary<string, string> responseHeadersDeserialized = response.DeserializeResponseHeaders();
+            Assert.Equal("HeaderValue", responseHeadersDeserialized["HeaderKey"]);
+        }
+    }
+}