Client interface (#17)

* Add interface to allow mocking the client

* Allow JenkinsClient to take a Context in ctor

Add ApiToken to context

Author: petelopez

Jenkins.Net/IJenkinsClient.cs

@@ -0,0 +1,60 @@
+using System.Threading;
+using System.Threading.Tasks;
+using JenkinsNET.Models;
+
+namespace JenkinsNET
+{
+    /// <summary>
+    /// Methods for interacting with Jenkins API.
+    /// </summary>
+    public interface IJenkinsClient
+    {
+        /// <summary>
+        /// Group of methods for interacting with Jenkins Jobs.
+        /// </summary>
+        JenkinsClientJobs Jobs {get;}
+
+        /// <summary>
+        /// Group of methods for interacting with Jenkins Builds.
+        /// </summary>
+        JenkinsClientBuilds Builds {get;}
+
+        /// <summary>
+        /// Group of methods for interacting with the Jenkins Job-Queue.
+        /// </summary>
+        JenkinsClientQueue Queue {get;}
+
+        /// <summary>
+        /// Group of methods for interacting with Jenkins Artifacts.
+        /// </summary>
+        JenkinsClientArtifacts Artifacts {get;}
+
+        /// <summary>
+        /// Updates the security Crumb attached to this client.
+        /// </summary>
+        /// <exception cref="JenkinsNetException"></exception>
+        void UpdateSecurityCrumb();
+
+
+        /// <summary>
+        /// Updates the security Crumb attached to this client asynchronously.
+        /// </summary>
+        /// <param name="token">An optional token for aborting the request.</param>
+        /// <exception cref="JenkinsNetException"></exception>
+        Task UpdateSecurityCrumbAsync(CancellationToken token = default(CancellationToken));
+
+        /// <summary>
+        /// Gets the root description of the Jenkins node.
+        /// </summary>
+        /// <exception cref="JenkinsNetException"></exception>
+        Jenkins Get();
+
+
+        /// <summary>
+        /// Gets the root description of the Jenkins node asynchronously.
+        /// </summary>
+        /// <param name="token">An optional token for aborting the request.</param>
+        /// <exception cref="JenkinsNetException"></exception>
+        Task<Jenkins> GetAsync(CancellationToken token = default(CancellationToken));
+    }
+}

Jenkins.Net/IJenkinsContext.cs

@@ -1,4 +1,5 @@
-using JenkinsNET.Models;
+using System;
+using JenkinsNET.Models;
 
 namespace JenkinsNET
 {
@@ -21,8 +22,14 @@ public interface IJenkinsContext
         /// <summary>
         /// [optional] Jenkins Password.
         /// </summary>
+        [Obsolete("This property will be removed in future versions; please use 'JenkinsContext.ApiToken' instead.")]
         string Password {get;}
 
+        /// <summary>
+        /// [optional] Jenkins ApiToken for the <see cref="UserName"/>.
+        /// </summary>
+        string ApiToken {get; set;}
+
         /// <summary>
         /// [optional] Jenkins CSRF Crumb.
         /// </summary>

Jenkins.Net/JenkinsClient.cs

@@ -10,7 +10,7 @@ namespace JenkinsNET
     /// <summary>
     /// HTTP-Client for interacting with Jenkins API.
     /// </summary>
-    public class JenkinsClient : IJenkinsContext
+    public class JenkinsClient : IJenkinsContext, IJenkinsClient
     {
         /// <summary>
         /// The address of the Jenkins instance.
@@ -82,6 +82,17 @@ public JenkinsClient(string baseUrl) : this()
             this.BaseUrl = baseUrl;
         }
 
+        /// <summary>
+        /// Creates a new Jenkins Client using the provided <see cref="IJenkinsContext"/>.
+        /// </summary>
+        public JenkinsClient(IJenkinsContext context) : this(context.BaseUrl)
+        {
+            this.UserName = context.UserName;
+            this.ApiToken = context.ApiToken;
+            this.Password = context.Password;
+            this.Crumb = context.Crumb;
+        }
+
         /// <summary>
         /// Updates the security Crumb attached to this client.
         /// </summary>