Merge branch 'master' into automatic-analyzer

Author: AshleyPoole

.gitignore

@@ -15,3 +15,13 @@ SSLLWrapper.IntegrationTests/obj/Release/
 SSLLWrapper.IntegrationTests/obj/Debug/
 SSLLWrapper.IntegrationTests/bin/Release/
 SSLLWrapper.IntegrationTests/bin/Debug/
+SSLLabsApiWrapper/obj/Debug/
+SSLLabsApiWrapper.Tests/bin/Debug/
+SSLLabsApiWrapper/bin/
+SSLLabsApiWrapper.Tests/obj/
+SSLLabsApiWrapper/obj/
+SSLLabsApiWrapper.IntegrationTests/bin/
+SSLLabsApiWrapper.IntegrationTests/obj/Debug/SSLLWrapper.IntegrationTests.csproj.FileListAbsolute.txt
+SSLLabsApiWrapper.IntegrationTests/obj/
+SSLLabsApiWrapper.Tests/bin/
+*.nupkg

README.md

@@ -1,7 +1,7 @@
-SSLLWrapper
+What Is this wrapper?
 ===========
 
-SSLLWrapper stands for SSL Labs Wrapper which is the first publicly available .NET wrapper developed for the [SSL Labs' Assessment API's](https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md) that allow the consumer to test SSL servers on the public internet.
+This is the first publicly available .NET wrapper developed for the [SSL Labs' Assessment API's](https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md) that allow the consumer to test SSL servers on the public internet.
 
 This wrapper easies the communication to the API's for .NET developers which allows you as the developer to focus on your project rather than managing the plumbing and overhead required to consume the API's.
 
@@ -10,25 +10,25 @@ This wrapper easies the communication to the API's for .NET developers which all
 - The wrapper does **NOT** use web scrapping like other wrappers which don't use the assessment API's.
 
 ### NuGet Package
-The wrapper can easily be imported into your project using the [SSLLWrapper NuGet package](https://www.nuget.org/packages/SSLLWrapper/). The NuGet install command for this package is:
+The wrapper can easily be imported into your project using the [NuGet package](https://www.nuget.org/packages/SSLLabsApiWrapper/). The NuGet install command for this package is:
 
-**PM> Install-Package SSLLWrapper**
+**PM> Install-Package SSLLabsApiWrapper**
 
 ### Wrapper Usage
-When creating a new instance of SSLLWrapper you must supply the API url during the initialization. For example in C# this would be expressed as the following: 
+When creating a new instance of SSL Labs api wrapper service you must supply the API url during the initialization. For example in C# this would be expressed as the following: 
 ```C#
-var ssllService = new SSLLWrapper.SSLLService("https://api.dev.ssllabs.com/api/fa78d5a4");
+var ssllService = new SSLLabsApiWrapper.SSLLabsApiService("https://api.dev.ssllabs.com/api/fa78d5a4");
 
-// Or if you use the SSLWrapper namespace this can be shorten to
-var ssllService = new SSLLService("https://api.dev.ssllabs.com/api/fa78d5a4");
+// Or if you use the SSLLabsApiWrapper namespace this can be shorten to
+var ssllService = new SSLLabsApiService("https://api.dev.ssllabs.com/api/fa78d5a4");
 ```
 #### Methods
 
-Below are the method signatures of the SSLLWrapper Service.
+Below are the method signatures of the SSL Labs api wrapper service.
 
 ##### Info()
 
-The Info method is used to determine if the API is online and returns an [Info response object](https://github.com/AshleyPoole/SSLLWrapper/blob/master/README.md#info-1). No input parameters are taken.
+The Info method is used to determine if the API is online and returns an [Info response object](https://github.com/AshleyPoole/sslLabs-api-wrapper/blob/master/README.md#info-1). No input parameters are taken.
 
 ```C#
 public Info Info()
@@ -47,6 +47,20 @@ The wrapper also contains an overloaded Analyze method which only requires the h
 public Analyze Analyze(string host)
 ```
 
+##### AutomaticAnalyze()
+
+The Analyze method is used to initiate and wait for an assessment to complete before retrieving results. Compared to the normal Analyze() method this method keeps checking the Api and only when a scan has finished does it return. This saves the comsumer from having to write their own logic for handling an assessment in progress.
+Another call to GetEndpointDetails() may be needed to view the whole result set for a given endpoint.
+
+```C#
+public Analyze AutomaticAnalyze(string host, Publish publish, ClearCache clearCache, FromCache fromCache, All all)
+```
+
+The wrapper also contains an overloaded AutomaticAnalyze method which only requires the host parameter. Internal is uses the following parameter options - Publish.Off, ClearCache.On, FromCache.Ignore, All.On.
+```C#
+public Analyze AutomaticAnalyze(string host)
+```
+
 ##### GetEndpointData()
 
 The GetEndpointData method is used to retrieve a fully results set.
@@ -98,7 +112,8 @@ public class Error
 public string engineVersion { get; set; }
 public string criteriaVersion { get; set; }
 public int clientMaxAssessments { get; set; }
-public string notice { get; set; }
+public int currentAssessments { get; set; }
+public List<string> messages { get; set; }
 public bool Online { get; set; }
 ```
 
@@ -170,8 +185,8 @@ public enum All
 ### Author
 Ashley Poole - www.ashleypoole.co.uk.
 
-[SSLWrapper project's home page](http://www.ashleypoole.co.uk/ssllwrapper?utm_source=github&utm_medium=githubproject&utm_campaign=ssllwrapper)
+[Project's home page](http://www.ashleypoole.co.uk/ssllabs-api-wrapper?utm_source=github&utm_medium=githubproject&utm_campaign=ssllwrapper)
 
-Please contact me if you have any questions, issues or recommendations either via [my website](http://www.ashleypoole.co.uk), [Twitter](http://twitter.com/geekypants92) or [by email](mailto:[email protected]).
+Please contact me if you have any questions, issues or recommendations either via [my website](http://www.ashleypoole.co.uk), [Twitter](http://twitter.com/AshleyPooleUK) or [by email](mailto:[email protected]).
 
 

SSLLWrapper/Models/Response/EndpointSubModels/Key.cs

@@ -1,23 +1,23 @@
 using System.Configuration;
 using FluentAssertions;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-using SSLLWrapper;
-using SSLLWrapper.Models.Response;
+using SSLLabsApiWrapper;
+using SSLLabsApiWrapper.Models.Response;
 
 namespace given_that_I_make_a_analyze_request
 {
 	[TestClass]
 	public class when_i_expect_a_successful_result
 	{
-		private static SSLLService _ssllService;
+		private static SSLLabsApiService _ssllService;
 		private static Analyze _analyze;
 		private static string _host;
 
 		[ClassInitialize]
 		public static void Setup(TestContext testContext)
 		{
 			_host = ConfigurationManager.AppSettings.Get("EndpointHost");
-			_ssllService = new SSLLService(ConfigurationManager.AppSettings.Get("ApiUrl"));
+			_ssllService = new SSLLabsApiService(ConfigurationManager.AppSettings.Get("ApiUrl"));
 			_analyze = _ssllService.Analyze(_host);
 		}
 

SSLLWrapper/Models/Response/EndpointSubModels/List.cs

@@ -1,23 +1,23 @@
 using System.Configuration;
 using FluentAssertions;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-using SSLLWrapper;
-using SSLLWrapper.Models.Response;
+using SSLLabsApiWrapper;
+using SSLLabsApiWrapper.Models.Response;
 
 namespace given_that_I_make_a_automaticanalyze_request
 {
 	[TestClass]
 	public class when_i_expect_a_successful_result
 	{
-		private static SSLLService _ssllService;
+		private static SSLLabsApiService _ssllService;
 		private static Analyze _analyze;
 		private static string _host;
 
 		[ClassInitialize]
 		public static void Setup(TestContext testContext)
 		{
 			_host = ConfigurationManager.AppSettings.Get("EndpointHost");
-			_ssllService = new SSLLService(ConfigurationManager.AppSettings.Get("ApiUrl"));
+			_ssllService = new SSLLabsApiService(ConfigurationManager.AppSettings.Get("ApiUrl"));
 			_analyze = _ssllService.AutomaticAnalyze(_host);
 		}
 

SSLLWrapper.IntegrationTests/AnalyzeTests.cs renamed to SSLLabsApiWrapper.IntegrationTests/AnalyzeTests.cs

@@ -1,8 +1,8 @@
 using System.Configuration;
 using FluentAssertions;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-using SSLLWrapper;
-using SSLLWrapper.Models.Response;
+using SSLLabsApiWrapper;
+using SSLLabsApiWrapper.Models.Response;
 
 namespace given_that_I_make_a_GetEndpointDetails_request
 {
@@ -22,7 +22,7 @@ public static void Setup(TestContext testContext)
 			_endpointHost = ConfigurationManager.AppSettings.Get("EndpointHost");
 			_endpointIp = ConfigurationManager.AppSettings.Get("EndpointIP");
 
-			var ssllService = new SSLLService(ConfigurationManager.AppSettings.Get("ApiUrl"));
+			var ssllService = new SSLLabsApiService(ConfigurationManager.AppSettings.Get("ApiUrl"));
 			_endpoint = ssllService.GetEndpointData(_endpointHost, _endpointIp);
 		}
 

SSLLWrapper.IntegrationTests/App.config renamed to SSLLabsApiWrapper.IntegrationTests/App.config

@@ -1,8 +1,8 @@
 using System.Configuration;
 using FluentAssertions;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-using SSLLWrapper;
-using SSLLWrapper.Models.Response;
+using SSLLabsApiWrapper;
+using SSLLabsApiWrapper.Models.Response;
 
 namespace given_that_I_make_a_GetStatusCodes_request
 {
@@ -14,7 +14,7 @@ public class when_i_expect_a_successful_result
 		[ClassInitialize]
 		public static void Setup(TestContext testContext)
 		{
-			var ssllService = new SSLLService(ConfigurationManager.AppSettings.Get("ApiUrl"));
+			var ssllService = new SSLLabsApiService(ConfigurationManager.AppSettings.Get("ApiUrl"));
 			_statusCodes = ssllService.GetStatusCodes();
 		}
 

SSLLWrapper.IntegrationTests/AutomaticAnalyzeTests.cs renamed to SSLLabsApiWrapper.IntegrationTests/AutomaticAnalyzeTests.cs

@@ -1,8 +1,8 @@
 using System.Configuration;
 using FluentAssertions;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-using SSLLWrapper;
-using SSLLWrapper.Models.Response;
+using SSLLabsApiWrapper;
+using SSLLabsApiWrapper.Models.Response;
 
 namespace given_that_I_make_a_info_request
 {
@@ -14,7 +14,7 @@ public class when_i_expect_a_successful_result
 		[ClassInitialize]
 		public static void Setup(TestContext testContext)
 		{
-			var ssllService = new SSLLService(ConfigurationManager.AppSettings.Get("ApiUrl"));
+			var ssllService = new SSLLabsApiService(ConfigurationManager.AppSettings.Get("ApiUrl"));
 			_info = ssllService.Info();
 		}