Changing how web responses are handled to improve testability

Author: AshleyPoole

SSLLWrapper/Domain/ResponsePopulation.cs

@@ -1,64 +1,59 @@
 using System.Net;
 using Newtonsoft.Json;
+using SSLLWrapper.Models;
 using SSLLWrapper.Models.Response;
+using SSLLWrapper.Models.Response.BaseSubModels;
 
 namespace SSLLWrapper.Domain
 {
 	class ResponsePopulation
 	{
 		public JsonSerializerSettings JsonSerializerSettings;
-		private readonly WebResponseReader _webResponseReader;
 
 		public ResponsePopulation()
 		{
 			// Ignoring null values when serializing json objects
 			JsonSerializerSettings = new JsonSerializerSettings {NullValueHandling = NullValueHandling.Ignore};
-
-			_webResponseReader = new WebResponseReader();
 		}
 
-		public Info InfoModel(HttpWebResponse webResponse, Info infoModel)
+		public Info InfoModel(WebResponseModel webResponse, Info infoModel)
 		{
-			var webResult = _webResponseReader.GetResponsePayload(webResponse);
-
-			infoModel = JsonConvert.DeserializeObject<Info>(webResult, JsonSerializerSettings);
-			infoModel.Header.statusCode = _webResponseReader.GetStatusCode(webResponse);
-			infoModel.Header.statusDescription = _webResponseReader.GetStatusDescription(webResponse);
+			infoModel = JsonConvert.DeserializeObject<Info>(webResponse.Payloay, JsonSerializerSettings);
+			infoModel.Header = PopulateHeader(infoModel.Header, webResponse);
 
 			return infoModel;
 		}
 
-		public Analyze AnalyzeModel(HttpWebResponse webResponse, Analyze analyzeModel)
+		public Analyze AnalyzeModel(WebResponseModel webResponse, Analyze analyzeModel)
 		{
-			var webResult = _webResponseReader.GetResponsePayload(webResponse);
-
-			analyzeModel = JsonConvert.DeserializeObject<Analyze>(webResult, JsonSerializerSettings);
-			analyzeModel.Header.statusCode = _webResponseReader.GetStatusCode(webResponse);
-			analyzeModel.Header.statusDescription = _webResponseReader.GetStatusDescription(webResponse);
+			analyzeModel = JsonConvert.DeserializeObject<Analyze>(webResponse.Payloay, JsonSerializerSettings);
+			analyzeModel.Header = PopulateHeader(analyzeModel.Header, webResponse);
 
 			return analyzeModel;
 		}
 
-		public Endpoint EndpointModel(HttpWebResponse webResponse, Endpoint endpointModel)
+		public Endpoint EndpointModel(WebResponseModel webResponse, Endpoint endpointModel)
 		{
-			var webResult = _webResponseReader.GetResponsePayload(webResponse);
-
-			endpointModel = JsonConvert.DeserializeObject<Endpoint>(webResult, JsonSerializerSettings);
-			endpointModel.Header.statusCode = _webResponseReader.GetStatusCode(webResponse);
-			endpointModel.Header.statusDescription = _webResponseReader.GetStatusDescription(webResponse);
+			endpointModel = JsonConvert.DeserializeObject<Endpoint>(webResponse.Payloay, JsonSerializerSettings);
+			endpointModel.Header = PopulateHeader(endpointModel.Header, webResponse);
 
 			return endpointModel;
 		}
 
-		public StatusCodes StatusCodesModel(HttpWebResponse webResponse, StatusCodes statusCodes)
+		public StatusCodes StatusCodesModel(WebResponseModel webResponse, StatusCodes statusCodes)
 		{
-			var webResult = _webResponseReader.GetResponsePayload(webResponse);
-
-			statusCodes = JsonConvert.DeserializeObject<StatusCodes>(webResult, JsonSerializerSettings);
-			statusCodes.Header.statusCode = _webResponseReader.GetStatusCode(webResponse);
-			statusCodes.Header.statusDescription = _webResponseReader.GetStatusDescription(webResponse);
+			statusCodes = JsonConvert.DeserializeObject<StatusCodes>(webResponse.Payloay, JsonSerializerSettings);
+			statusCodes.Header = PopulateHeader(statusCodes.Header, webResponse);
 
 			return statusCodes;
 		}
+
+		public Header PopulateHeader(Header header, WebResponseModel webResponse)
+		{
+			header.statusCode = webResponse.StatusCode;
+			header.statusDescription = webResponse.StatusDescription;
+
+			return header;
+		}
 	}
 }

SSLLWrapper/Domain/WebResponseReader.cs

@@ -1,36 +1,36 @@
-using System.Net;
+using System.IO;
+using System.Linq;
+using System.Net;
 using SSLLWrapper.Interfaces;
 using SSLLWrapper.Models;
 
 namespace SSLLWrapper.External
 {
 	class SSLLabsApi : IApiProvider
 	{
-		public HttpWebResponse MakeGetRequest(RequestModel requestModel)
+		public WebResponseModel MakeGetRequest(RequestModel requestModel)
 		{
 			var url = requestModel.ApiBaseUrl + "/" + requestModel.Action;
 
-			// ** TO DO - Refactor this
 			if (requestModel.Parameters.Count >= 1)
 			{
-				url = url + "?";
-				var iteration = 0;
-
-				foreach(var parameter in requestModel.Parameters)
-				{
-					iteration++;
-					url = url + parameter.Key + "=" + parameter.Value;
-
-					if (iteration != requestModel.Parameters.Count)
-						url = url + "&";
-				}
+				url = string.Format("{0}{1}{2}", url, "?", string.Join("&", (from parameter in requestModel.Parameters 
+									  where parameter.Value != null select string.Format("{0}={1}", parameter.Key, parameter.Value))));
 			}
 
+			var webResponseModel = new WebResponseModel() {Url = url};
+
 			var request = (HttpWebRequest)WebRequest.Create(url);
 			request.Method = "GET";
 
-			// Make request and return response
-			return (HttpWebResponse)request.GetResponse(); ;
+			var response = (HttpWebResponse)request.GetResponse();
+			var streamReader = new StreamReader(response.GetResponseStream());
+
+			webResponseModel.Payloay = streamReader.ReadToEnd();
+			webResponseModel.StatusCode = (int)response.StatusCode;
+			webResponseModel.StatusDescription = response.StatusDescription;
+
+			return webResponseModel;
 		}
 	}
 }

SSLLWrapper/External/SSLLabsApi.cs

@@ -5,6 +5,6 @@ namespace SSLLWrapper.Interfaces
 {
 	interface IApiProvider
 	{
-		HttpWebResponse MakeGetRequest(RequestModel requestModel);
+		WebResponseModel MakeGetRequest(RequestModel requestModel);
 	}
 }

SSLLWrapper/Interfaces/IApiProvider.cs

@@ -0,0 +1,10 @@
+namespace SSLLWrapper.Models
+{
+	class WebResponseModel
+	{
+		public int StatusCode;
+		public string Url;
+		public string Payloay;
+		public string StatusDescription;
+	}
+}

SSLLWrapper/Models/WebResponseModel.cs

@@ -46,8 +46,8 @@
   <ItemGroup>
     <Compile Include="External\SSLLabsApi.cs" />
     <Compile Include="Models\Response\StatusCodes.cs" />
+    <Compile Include="Models\WebResponseModel.cs" />
     <Compile Include="SSLLService.cs" />
-    <Compile Include="Domain\WebResponseReader.cs" />
     <Compile Include="Interfaces\IApiProvider.cs" />
     <Compile Include="Domain\RequestModelFactory.cs" />
     <Compile Include="Domain\UrlValidation.cs" />