Adding support for Api v2.1

Author: AshleyPoole

README.md

@@ -189,6 +189,12 @@ public enum All
 }
 ```
 
+### Development ToDo List
+- Increase testing around ignoreMismatch parameter on Analyze call
+- Increase testing around maxAge parameter on Analyze call
+- Increase integration tests around positive and negative outcomes
+
+
 ### Author
 Ashley Poole - www.ashleypoole.co.uk.
 

SSLLabsApiWrapper.Tests/AnalyzeTests.cs

@@ -98,8 +98,8 @@ public static void Setup(TestContext testContext)
 			mockedApiProvider.Setup(x => x.MakeGetRequest(It.IsAny<RequestModel>())).Returns(webResponseModel);
 
 			var ssllService = new SSLLabsApiService("https://api.dev.ssllabs.com/api/fa78d5a4/", mockedApiProvider.Object);
-			Response = ssllService.Analyze(TestHost, SSLLabsApiService.Publish.On, SSLLabsApiService.ClearCache.On,
-				SSLLabsApiService.FromCache.Ignore, SSLLabsApiService.All.Done);
+			Response = ssllService.Analyze(TestHost, SSLLabsApiService.Publish.On, SSLLabsApiService.startNew.On,
+				SSLLabsApiService.FromCache.Ignore, null, SSLLabsApiService.All.Done, SSLLabsApiService.ignoreMismatch.Off);
 		}
 
 		[TestMethod]
@@ -130,8 +130,8 @@ public static void Setup(TestContext testContext)
 			mockedApiProvider.Setup(x => x.MakeGetRequest(It.IsAny<RequestModel>())).Returns(webResponseModel);
 
 			var ssllService = new SSLLabsApiService("https://api.dev.ssllabs.com/api/fa78d5a4/", mockedApiProvider.Object);
-			Response = ssllService.Analyze(TestHost, SSLLabsApiService.Publish.On, SSLLabsApiService.ClearCache.On,
-				SSLLabsApiService.FromCache.Ignore, SSLLabsApiService.All.Done);
+			Response = ssllService.Analyze(TestHost, SSLLabsApiService.Publish.On, SSLLabsApiService.startNew.On,
+				SSLLabsApiService.FromCache.Ignore, null, SSLLabsApiService.All.Done, SSLLabsApiService.ignoreMismatch.Off);
 		}
 
 		[TestMethod]
@@ -142,7 +142,7 @@ public void then_the_status_code_should_be_valid_for_response()
 	}
 
 	[TestClass]
-	public class when_a_invalid_request_is_made_with_both_clearCache_and_fromCache : NegativeTests
+	public class when_a_invalid_request_is_made_with_both_startNew_and_fromCache : NegativeTests
 	{
 		[ClassInitialize]
 		public static void Setup(TestContext testContext)
@@ -151,17 +151,17 @@ public static void Setup(TestContext testContext)
 			TestHost = "https://www.ashleypoole.co.uk";
 			var webResponseModel = new WebResponseModel()
 			{
-				Payloay = "{\"errors\":[{\"message\":\"Parameters \u0027fromCache\u0027 and \u0027clearCache\u0027 cannot be used at the same time\"}]}",
+				Payloay = "{\"errors\":[{\"message\":\"Parameters \u0027fromCache\u0027 and \u0027startNew\u0027 cannot be used at the same time\"}]}",
 				StatusCode = 400,
 				StatusDescription = "Ok",
-				Url = ("https://api.dev.ssllabs.com/api/fa78d5a4/analyze?host=" + TestHost + "&clearCache=on&fromCache=on&all=done")
+				Url = ("https://api.dev.ssllabs.com/api/fa78d5a4/analyze?host=" + TestHost + "&startNew=on&fromCache=on&all=done")
 			};
 
 			mockedApiProvider.Setup(x => x.MakeGetRequest(It.IsAny<RequestModel>())).Returns(webResponseModel);
 
 			var ssllService = new SSLLabsApiService("https://api.dev.ssllabs.com/api/fa78d5a4/", mockedApiProvider.Object);
-			Response = ssllService.Analyze(TestHost, SSLLabsApiService.Publish.On, SSLLabsApiService.ClearCache.On,
-				SSLLabsApiService.FromCache.Ignore, SSLLabsApiService.All.Done);
+			Response = ssllService.Analyze(TestHost, SSLLabsApiService.Publish.On, SSLLabsApiService.startNew.On,
+				SSLLabsApiService.FromCache.Ignore, null, SSLLabsApiService.All.Done, SSLLabsApiService.ignoreMismatch.Off);
 		}
 	}
 

SSLLabsApiWrapper/Domain/RequestModelFactory.cs

@@ -9,17 +9,19 @@ public RequestModel NewInfoRequestModel(string apiBaseUrl, string action)
 			return new RequestModel() {ApiBaseUrl = apiBaseUrl, Action = action};
 		}
 
-		public RequestModel NewAnalyzeRequestModel(string apiBaseUrl, string action, string host, string publish, string clearCache,
-			string fromCache, string all)
+		public RequestModel NewAnalyzeRequestModel(string apiBaseUrl, string action, string host, string publish, string startNew,
+			string fromCache, int? maxHours, string all, string ignoreMismatch)
 		{
 			var requestModel = new RequestModel() { ApiBaseUrl = apiBaseUrl, Action = action};
 
 			requestModel.Parameters.Add("host", host);
 			requestModel.Parameters.Add("publish", publish);
 			requestModel.Parameters.Add("all", all);
 
-			if (clearCache != "ignore") { requestModel.Parameters.Add("clearCache", clearCache); }
+			if (startNew != "ignore") { requestModel.Parameters.Add("startNew", startNew); }
 			if (fromCache != "ignore") { requestModel.Parameters.Add("fromCache", fromCache); }
+			if (maxHours != null) { requestModel.Parameters.Add("maxHours", maxHours.ToString()); }
+			if (ignoreMismatch != "off") { requestModel.Parameters.Add("ignoreMismatch", ignoreMismatch); }
 
 			return requestModel;
 		}

SSLLabsApiWrapper/SSLLabsApiService.cs

@@ -24,10 +24,9 @@ public enum Publish
 		    Off
 	    }
 
-	    public enum ClearCache
+	    public enum startNew
 	    {
 		    On,
-		    Off,
 			Ignore
 	    }
 
@@ -44,6 +43,12 @@ public enum All
 		    Done
 	    }
 
+		public enum ignoreMismatch
+		{
+			On,
+			Off
+		}
+
 		public SSLLabsApiService(string apiUrl) : this(apiUrl, new SSLLabsApi())
 	    {
 	    }
@@ -89,10 +94,10 @@ public Info Info()
 	    public Analyze Analyze(string host)
 	    {
 			// overloaded method to provide a default set of options
-		    return Analyze(host, Publish.Off, ClearCache.On, FromCache.Ignore, All.On);
+		    return Analyze(host, Publish.Off, startNew.On, FromCache.Ignore, null, All.On, ignoreMismatch.Off);
 	    }
 
-		public Analyze Analyze(string host, Publish publish, ClearCache clearCache, FromCache fromCache, All all)
+		public Analyze Analyze(string host, Publish publish, startNew startNew, FromCache fromCache, int? maxHours, All all, ignoreMismatch ignoreMismatch)
 		{
 			var analyzeModel = new Analyze();
 
@@ -105,8 +110,8 @@ public Analyze Analyze(string host, Publish publish, ClearCache clearCache, From
 			}
 
 			// Building request model
-			var requestModel = _requestModelFactory.NewAnalyzeRequestModel(ApiUrl, "analyze", host, publish.ToString().ToLower(), clearCache.ToString().ToLower(), 
-				fromCache.ToString().ToLower(), all.ToString().ToLower());
+			var requestModel = _requestModelFactory.NewAnalyzeRequestModel(ApiUrl, "analyze", host, publish.ToString().ToLower(), startNew.ToString().ToLower(), 
+				fromCache.ToString().ToLower(), maxHours, all.ToString().ToLower(), ignoreMismatch.ToString().ToLower());
 
 			try
 			{
@@ -132,25 +137,26 @@ public Analyze AutomaticAnalyze(string host)
 
 	    public Analyze AutomaticAnalyze(string host, int maxWaitInterval, int sleepInterval)
 	    {
-			return AutomaticAnalyze(host, Publish.Off, ClearCache.On, FromCache.Ignore, All.On, maxWaitInterval, sleepInterval);
+			return AutomaticAnalyze(host, Publish.Off, startNew.On, FromCache.Ignore, null, All.On, ignoreMismatch.Off, maxWaitInterval, sleepInterval);
 	    }
 
-		public Analyze AutomaticAnalyze(string host, Publish publish, ClearCache clearCache, FromCache fromCache, All all, int maxWaitInterval, int sleepInterval)
+		public Analyze AutomaticAnalyze(string host, Publish publish, startNew startNew, FromCache fromCache, int? maxHours, All all, ignoreMismatch ignoreMismatch,
+			int maxWaitInterval, int sleepInterval)
 	    {
 			var startTime = DateTime.Now;
 			var sleepIntervalMilliseconds = sleepInterval * 1000;
 			var apiPassCount = 1;
-			var analyzeModel = Analyze(host, publish, clearCache, fromCache, all);
+			var analyzeModel = Analyze(host, publish, startNew, fromCache, maxHours, all, ignoreMismatch);
 
 			// Ignoring cache settings after first request to prevent loop
-			clearCache = ClearCache.Ignore;
+			startNew = startNew.Ignore;
 
 			// Shouldn't have to check status header as HasErrorOccurred should be enough
 			while (analyzeModel.HasErrorOccurred == false && analyzeModel.status != "READY" && (DateTime.Now - startTime).TotalSeconds < maxWaitInterval)
 			{
 				Thread.Sleep(sleepIntervalMilliseconds);
 				apiPassCount ++;
-				analyzeModel = Analyze(host, publish, clearCache, fromCache, all);
+				analyzeModel = Analyze(host, publish, startNew, fromCache, null, all, ignoreMismatch);
 		    }
 
 			analyzeModel.Wrapper.ApiPassCount = apiPassCount;