Various improvements

- Added IApiClient interface to ApiClient to make extending easier
- Fixed operations classes having an internal constructor preventing extension
- Added DeviceOperations.AddSetupTokenAsync
- Sealed some classes which will never get inherited from
- Moved to 0.1.5

Author: alandoherty

samples/Example.Cli/Program.cs

@@ -5,6 +5,7 @@
 using WifiPlug.Api;
 using WifiPlug.Api.Authentication;
 using WifiPlug.Api.Entities;
+using WifiPlug.Api.Operations;
 using WifiPlug.Api.Schema;
 
 namespace Example.Cli
@@ -17,7 +18,7 @@ static async Task AsyncMain(string[] args) {
             ApiClient cc = new ApiClient(Environment.GetEnvironmentVariable("API_KEY"), Environment.GetEnvironmentVariable("API_SECRET"));
             cc.Authentication = new SessionAuthentication(Environment.GetEnvironmentVariable("SESSION_TOKEN"));
 
-            var p = await cc.PingAsync();
+            DeviceSetupTokenEntity entity = await cc.Devices.AddDeviceSetupTokenAsync();
         }
     }
 }

src/WifiPlug.Api/ApiClient.cs

@@ -17,7 +17,7 @@ namespace WifiPlug.Api
     /// <summary>
     /// Provides access to the WIFIPLUG API services and systems.
     /// </summary>
-    public class ApiClient
+    public class ApiClient : IApiClient
     {
         #region Constants
         internal const string API_URL = "https://api.wifiplug.co.uk/v1.0/";
@@ -411,7 +411,7 @@ await RequestAsync(method, path, content, cancellationToken).ConfigureAwait(fals
         /// Pings the API to check if it's up.
         /// </summary>
         /// <param name="cancellationToken">The cancellation token.</param>
-        /// <returns></returns>
+        /// <returns>The ping response.</returns>
         public async Task<string> PingAsync(CancellationToken cancellationToken = default(CancellationToken)) {
             return await (await RequestAsync(HttpMethod.Get, "ping", null, cancellationToken)).Content.ReadAsStringAsync();
         }

src/WifiPlug.Api/ApiError.cs

@@ -7,7 +7,7 @@ namespace WifiPlug.Api
     /// <summary>
     /// Represents a single API error.
     /// </summary>
-    public class ApiError
+    public sealed class ApiError
     {
         #region Properties
         /// <summary>

src/WifiPlug.Api/ApiException.cs

@@ -7,7 +7,7 @@ namespace WifiPlug.Api
     /// <summary>
     /// Represents a failure response from the API.
     /// </summary>
-    public class ApiException : Exception
+    public sealed class ApiException : Exception
     {
         private ApiError[] _errors;
         private HttpResponseMessage _response;

src/WifiPlug.Api/Converters/InaccurateIsoDateTimeConverter.cs

@@ -8,7 +8,7 @@ namespace WifiPlug.Api.Converters
     /// <summary>
     /// Downgrades any ISO 8061 to not format milliseconds.
     /// </summary>
-    internal class InaccurateIsoDateTimeConverter : IsoDateTimeConverter
+    internal sealed class InaccurateIsoDateTimeConverter : IsoDateTimeConverter
     {
         public InaccurateIsoDateTimeConverter() {
             DateTimeFormat = "yyyy-MM-ddTHH:mm:ssZ";

src/WifiPlug.Api/Converters/TimerItemEntityConverter.cs

@@ -10,7 +10,7 @@ namespace WifiPlug.Api.Converters
     /// <summary>
     /// Provides functionality to convert between a repetition enum and JSON.
     /// </summary>
-    internal class TimerItemEntityConverter : JsonConverter
+    internal sealed class TimerItemEntityConverter : JsonConverter
     {
         public override bool CanConvert(Type objectType) {
             return objectType == typeof(TimerItemEntity) || objectType == typeof(TimerItemEntity[]);

src/WifiPlug.Api/Converters/TimerRepetitionConverter.cs

@@ -10,7 +10,7 @@ namespace WifiPlug.Api.Converters
     /// <summary>
     /// Provides functionality to convert between a repetition enum and JSON.
     /// </summary>
-    internal class TimerRepetitionConverter : JsonConverter
+    internal sealed class TimerRepetitionConverter : JsonConverter
     {
         public override bool CanConvert(Type objectType) {
             return objectType == typeof(TimerRepetition);

src/WifiPlug.Api/Entities/DeviceSetupTokenEntity.cs

@@ -0,0 +1,22 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace WifiPlug.Api.Entities
+{
+    /// <summary>
+    /// Represents a device setup token.
+    /// </summary>
+    public class DeviceSetupTokenEntity
+    {
+        /// <summary>
+        /// Gets or sets the UUID.
+        /// </summary>
+        public Guid UUID { get; set; }
+
+        /// <summary>
+        /// Gets or sets the token.
+        /// </summary>
+        public string Token { get; set; }
+    }
+}

src/WifiPlug.Api/IApiClient.cs

@@ -0,0 +1,78 @@
+using System;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using WifiPlug.Api.Operations;
+
+namespace WifiPlug.Api
+{
+    /// <summary>
+    /// Defines the interface for an api client.
+    /// </summary>
+    public interface IApiClient
+    {
+        /// <summary>
+        /// Gets or sets the retry count for transient failures.
+        /// </summary>
+        int RetryCount { get; set; }
+
+        /// <summary>
+        /// Gets or sets the retry delay.
+        /// </summary>
+        TimeSpan RetryDelay { get; set; }
+
+        /// <summary>
+        /// Gets or sets the authentication method.
+        /// </summary>
+        ApiAuthentication Authentication { get; set; }
+
+        /// <summary>
+        /// Gets or sets the timeout for requests.
+        /// </summary>
+        TimeSpan Timeout { get; set; }
+
+        /// <summary>
+        /// Gets the underlying http client.
+        /// </summary>
+        HttpClient Client { get; }
+
+        /// <summary>
+        /// Gets or sets the base address.
+        /// </summary>
+        Uri BaseAddress { get; set; }
+
+        /// <summary>
+        /// Gets the device operations.
+        /// </summary>
+        IDeviceOperations Devices { get; }
+
+        /// <summary>
+        /// Gets the session operations.
+        /// </summary>
+        ISessionOperations Sessions { get; }
+
+        /// <summary>
+        /// Gets the user operations.
+        /// </summary>
+        IUserOperations Users { get; }
+
+        /// <summary>
+        /// Gets the group operations.
+        /// </summary>
+        IGroupOperations Groups { get; }
+
+        /// <summary>
+        /// Gets the event operations.
+        /// </summary>
+        IEventOperations Events { get; }
+
+        /// <summary>
+        /// Pings the API to check if it's up.
+        /// </summary>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>The ping response.</returns>
+        Task<string> PingAsync(CancellationToken cancellationToken = default(CancellationToken));
+    }
+}

src/WifiPlug.Api/Operations/DeviceOperations.cs

@@ -474,7 +474,21 @@ public class DeviceOperations : IDeviceOperations
             return events.ToArray();
         }
 
-        internal DeviceOperations(ApiClient client) {
+        /// <summary>
+        /// Creates a device setup token.
+        /// </summary>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <remarks>This operation is internal and won't work with normal API keys. Nor is it stable.</remarks>
+        /// <returns>The setup token.</returns>
+        public Task<DeviceSetupTokenEntity> AddDeviceSetupTokenAsync(CancellationToken cancellationToken = default(CancellationToken)) {
+            return _client.RequestJsonSerializedAsync<DeviceSetupTokenEntity>(HttpMethod.Post, $"device/setup_token/add", cancellationToken);
+        }
+
+        /// <summary>
+        /// Creates a device operations object.
+        /// </summary>
+        /// <param name="client">The client.</param>
+        protected internal DeviceOperations(ApiClient client) {
             _client = client;
         }
     }