feature: Add extension methods to format strings with padding, length, and justification options for console notices or more attractive, easy to apply formatting options

essentials-framework/Essentials Core/PepperDashEssentialsBase/Comm and IR/GenericHttpClient.cs

@@ -1,10 +1,11 @@
 using System;
 using System.Collections.Generic;
-using System.ComponentModel;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
 using Crestron.SimplSharp.Net.Http;
-using Crestron.SimplSharp.Ssh;
-using Crestron.SimplSharpPro.EthernetCommunication;
 using PepperDash.Core;
+using PepperDash.Core.DebugThings;
 
 namespace PepperDash.Essentials.Core
 {
@@ -16,130 +17,52 @@ namespace PepperDash.Essentials.Core
 		public GenericHttpClient(string key, string name, string hostname)
 			: base(key, name)
 		{
-			Client = new HttpClient {HostName = hostname};
+			Client = new HttpClient();
+			Client.HostName = hostname;
+			
+			
 		}
 
-	    public GenericHttpClient(string key, string name, string hostname, GenericHttpClientConnectionOptions options)
-	        : base(key, name)
-	    {
-	        Client = new HttpClient
-	        {
-	            HostName = hostname,
-	            Accept = options.Accept,
-	            KeepAlive = options.KeepAlive,
-	            Password = options.Password,
-	            Timeout = options.Timeout,
-	            TimeoutEnabled = options.TimeoutEnabled,
-	            UserAgent = options.UserAgent,
-	            UserName = options.UserName,
-	            Version = options.Version
-	        };
-	        if (options.Port > 0) Client.Port = options.Port;
-	    }
-
-	    /// <summary>
-		/// Send a HTTP Get Request to a client
+		/// <summary>
+		/// 
 		/// </summary>
-		/// <param name="path">Path to request node</param>
-        public void SendText(string path)
-        {
-            var url = string.Format("http://{0}/{1}", Client.HostName, path);
-            var request = new HttpClientRequest()
-            {
-                Url = new UrlParser(url)
-            };
-            var error = Client.DispatchAsyncEx(request, Response, request);
-        }
+		/// <param name="path"></param>
+		public void SendText(string path)
+		{
+			HttpClientRequest request = new HttpClientRequest();
+			string url = string.Format("http://{0}/{1}", Client.HostName, path);
+			request.Url = new UrlParser(url);
+			HttpClient.DISPATCHASYNC_ERROR error = Client.DispatchAsyncEx(request, Response, request); 
+		}
+		public void SendText(string format, params object[] items)
+		{
+			HttpClientRequest request = new HttpClientRequest();
+			string url = string.Format("http://{0}/{1}", Client.HostName, string.Format(format, items));
+			request.Url = new UrlParser(url);
+			HttpClient.DISPATCHASYNC_ERROR error = Client.DispatchAsyncEx(request, Response, request);
+		}
 
-        /// <summary>
-        /// Send a HTTP Get Request to a client using a formatted string
-        /// </summary>
-        /// <param name="format">Path</param>
-        /// <param name="items">Parameters for Path String Formatting</param>
-        public void SendText(string format, params object[] items)
-        {
-            var url = string.Format("http://{0}/{1}", Client.HostName, string.Format(format, items));
-            var request = new HttpClientRequest()
-            {
-                Url = new UrlParser(url)
-            };
-            var error = Client.DispatchAsyncEx(request, Response, request);
-        }
-
-        /// <summary>
-        /// Send a unidirectional HTTP Get Request to a client using a formatted string
-        /// </summary>
-        /// <param name="format">Path</param>
-        /// <param name="items">Parameters for Path String Formatting</param>
-        public void SendTextNoResponse(string format, params object[] items)
-        {
-            var url = string.Format("http://{0}/{1}", Client.HostName, string.Format(format, items));
-            var request = new HttpClientRequest()
-            {
-                Url = new UrlParser(url)
-            };
-            Client.Dispatch(request);
-        }
-
-        /// <summary>
-        /// Send an HTTP Request of a specific request type
-        /// </summary>
-        /// <param name="requestType">HTTP Request Type</param>
-        /// <param name="path">Path to request node</param>
-        public void SendText(RequestType requestType, string path)
-        {
-            var url = string.Format("http://{0}/{1}", Client.HostName, path);
-            var request = new HttpClientRequest()
-            {
-                Url = new UrlParser(url),
-                RequestType = requestType
-            };
-            var error = Client.DispatchAsyncEx(request, Response, request);
-        }
-
-        /// <summary>
-        /// Send an HTTP Request of a specific request type using a formatted string
-        /// </summary>
-        /// <param name="requestType">HTTP Request Type</param>
-        /// <param name="format">Path</param>
-        /// <param name="items">Parameters for Path String Formatting</param>
-        public void SendText(RequestType requestType, string format, params object[] items)
-        {
-            var url = string.Format("http://{0}/{1}", Client.HostName, string.Format(format, items));
-            var request = new HttpClientRequest()
-            {
-                Url = new UrlParser(url),
-                RequestType = requestType
-            };
-            var error = Client.DispatchAsyncEx(request, Response, request);
-        }
-
-        /// <summary>
-        /// Send a unidirectional HTTP Request of a specific request type using a formatted string
-        /// </summary>
-        /// <param name="requestType">HTTP Request Type</param>
-        /// <param name="format">Path</param>
-        /// <param name="items">Parameters for Path String Formatting</param>
-        public void SendTextNoResponse(RequestType requestType, string format, params object[] items)
-        {
-            var url = string.Format("http://{0}/{1}", Client.HostName, string.Format(format, items));
-            var request = new HttpClientRequest()
-            {
-                Url = new UrlParser(url)
-            };
-            Client.Dispatch(request);
-        }
+		public void SendTextNoResponse(string format, params object[] items)
+		{
+			HttpClientRequest request = new HttpClientRequest();
+			string url = string.Format("http://{0}/{1}", Client.HostName, string.Format(format, items));
+			request.Url = new UrlParser(url);
+			Client.Dispatch(request);
+		}
 
 		private void Response(HttpClientResponse response, HTTP_CALLBACK_ERROR error, object request)
 		{
-		    if (error != HTTP_CALLBACK_ERROR.COMPLETED) return;
-		    var responseReceived = response;
+			if (error == HTTP_CALLBACK_ERROR.COMPLETED)
+			{
+				var responseReceived = response;
+
+				if (responseReceived.ContentString.Length > 0)
+				{
+					if (ResponseRecived != null)
+						ResponseRecived(this, new GenericHttpClientEventArgs(responseReceived.ContentString, (request as HttpClientRequest).Url.ToString(), error));
+				}
+			}
 
-		    if (responseReceived.ContentString.Length <= 0) return;
-		    if (ResponseRecived == null) return;
-		    var httpClientRequest = request as HttpClientRequest;
-		    if (httpClientRequest != null)
-		        ResponseRecived(this, new GenericHttpClientEventArgs(responseReceived.ContentString, httpClientRequest.Url.ToString(), error));
 		}
 
 
@@ -177,8 +100,6 @@ namespace PepperDash.Essentials.Core
 
 		#endregion
 	}
-
-
 	public class GenericHttpClientEventArgs : EventArgs
 	{
 		public string ResponseText { get; private set; }
@@ -191,84 +112,4 @@ namespace PepperDash.Essentials.Core
 			Error = error;
 		}
 	}
-
-    /// <summary>
-    /// Objedct to set parameters for HTTP Requests
-    /// </summary>
-    public class GenericHttpClientConnectionOptions
-    {
-        /// <summary>
-        ///     Gets or sets content types that are acceptable for the response. The default
-        ///     value is "text/html, image/gif, image/jpeg, image/png, */*".
-        /// </summary>
-        [DefaultValue("text/html, image/gif, image/jpeg, image/png")]
-        public string Accept { get; set; }
-
-        /// <summary>
-        ///     Controls whether to use HTTP Keep-Alive to keep the connection alive between
-        ///     requests. If enabled (true) , once a request is made and a connection is
-        ///     established, this connection is kept open and used for future requests. If
-        ///     disabled, the connection is closed, and a new connection is created for future
-        ///     requests.
-        /// </summary>
-        [DefaultValue(true)]
-        public bool KeepAlive { get; set; }
-
-        /// <summary>
-        ///     This property controls whether the request operation will do an automatic
-        ///     timeout checking. If timeout handling is turned on (i.e. this property is
-        ///     set to true) and a request takes longer than Timeout, it will be terminated.
-        /// </summary>
-        [DefaultValue(true)]
-        public bool TimeoutEnabled { get; set; }
-
-        /// <summary>
-        ///     Gets or sets the maximum amount of time (in seconds) that a client will wait
-        ///     for a server response within a single request. The default value is 60 seconds
-        ///     (1 minute).  The timeout handling can be activated via the TimeoutEnabled
-        ///     property.
-        /// </summary>
-        [DefaultValue(60)]
-        public int Timeout { get; set; }
-
-        /// <summary>
-        ///     Gets or sets the version identifier of the UserAgent. Can be used to mimic
-        ///     particular browsers like Internet Explorer 6.0
-        /// </summary>
-        [DefaultValue("1.1")]
-        public string Version { get; set; }
-
-        /// <summary>
-        ///     Gets or sets the identifier of the software being used to retrieve data via
-        ///     the URL. Some custom HTTP servers check this HTTP header to provide content
-        ///     optimized for particular HTTP browsers.
-        /// </summary>
-        [DefaultValue("Crestron SimplSharp HTTP Client")]
-        public string UserAgent { get; set; }
-
-        /// <summary>
-        ///    Name that will be inserted into the Authorization HTTP header in the request
-        ///    to the server.
-        /// </summary>
-        public string UserName { get; set; }
-
-        /// <summary>
-        ///     Password that will be inserted into the Authorization HTTP header in the
-        ///     request to the server.
-        /// </summary>
-        public string Password { get; set; }
-
-        /// <summary>
-        ///     The server Port that you intend the client to connect to.  If you do not
-        ///     assign a port number on this property, the port number in the parsed URL
-        ///     will be used. If a port number is assigned in the parsed URL, it will take
-        ///     precedence over this property.
-        /// </summary>
-        /// <remarks>
-        ///     If you do not assign a port number on this property, the port number in the
-        ///     parsed URL will be used.
-        /// </remarks>
-        /// 
-        public int Port { get; set; }
-    }
 }

essentials-framework/Essentials Core/PepperDashEssentialsBase/Extensions/StringExtensions.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.ComponentModel;
 using Crestron.SimplSharp;
 
 namespace PepperDash.Essentials.Core
@@ -20,5 +21,109 @@ namespace PepperDash.Essentials.Core
         {
             return string.IsNullOrEmpty(s) ? newString : s;
         }
+
+        /// <summary>
+        /// Formats string to meet specified parameters
+        /// </summary>
+        /// <param name="inputString">string to be formatted</param>
+        /// <param name="outputStringLength">length of output string</param>
+        /// <param name="padCharacter">character to pad string with to reach desired output length</param>
+        /// <param name="justification">Justification of input string with regards to the overall string</param>
+        /// <param name="separateInput">If true, seperate input string from pad characters with a single space</param>
+        /// <returns></returns>
+        public static string AutoPadAndJustify(this string inputString, int outputStringLength, char padCharacter,
+                    AutoPadJustification justification, bool separateInput)
+        {
+            var returnString = inputString;
+            var justifiedAndSeparateLength = (
+                separateInput
+                    ? (justification == AutoPadJustification.Center ? 2 : 1)
+                    : 0);
+            if (outputStringLength <= inputString.Length + justifiedAndSeparateLength) return returnString;
+            var fillLength = outputStringLength - inputString.Length - justifiedAndSeparateLength;
+            switch (justification)
+            {
+                case (AutoPadJustification.Left):
+                    {
+                        returnString =
+                            inputString +
+                            new string(' ', separateInput ? 1 : 0) +
+                            new string(padCharacter, fillLength);
+                        break;
+                    }
+                case (AutoPadJustification.Right):
+                    {
+                        returnString =
+                            new string(padCharacter, fillLength) +
+                            new string(' ', separateInput ? 1 : 0) +
+                            inputString;
+                        break;
+                    }
+                case (AutoPadJustification.Center):
+                    {
+                        var halfFill = fillLength / 2;
+                        returnString =
+                            new string(padCharacter, halfFill + (fillLength % 2)) +
+                            new string(' ', separateInput ? 1 : 0) +
+                            inputString +
+                            new string(' ', separateInput ? 1 : 0) +
+                            new string(padCharacter, halfFill);
+                        break;
+                    }
+            }
+            return returnString;
+        }
+
+        /// <summary>
+        /// Formats string to meet specified parameters
+        /// </summary>
+        /// <param name="inputString">string to be formatted</param>
+        /// <param name="options">String formatting options</param>
+        /// <returns></returns>
+        public static string AutoPadAndJustify(this string inputString, AutoPadJustificationOptions options)
+        {
+            if (options == null)
+                return inputString;
+
+            var outputStringLength = options.OutputStringLength;
+            var padCharacter = options.PadCharacter;
+            var justification = options.Justification;
+            var separateInput = options.SeparateInput;
+
+
+
+            return AutoPadAndJustify(inputString, outputStringLength, padCharacter, justification,
+                separateInput);
+        }
+    }
+
+    public enum AutoPadJustification
+    {
+        Center,
+        Left,
+        Right
+    }
+
+    /// <summary>
+    /// Options for setting AutoPadJustification
+    /// </summary>
+    public class AutoPadJustificationOptions
+    {
+        /// <summary>
+        /// Text Justification for the string, relative to the length
+        /// </summary>
+        public AutoPadJustification Justification { get; set; }
+        /// <summary>
+        /// If true, separate input string from pad characters by a single ' ' character
+        /// </summary>
+        public bool SeparateInput { get; set; }
+        /// <summary>
+        /// Pad character to be inserted
+        /// </summary>
+        public char PadCharacter { get; set; }
+        /// <summary>
+        /// Total length of the output string
+        /// </summary>
+        public int OutputStringLength { get; set; }
     }
 }