feature: add deveasy command to make DevJson easier in the development process

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>
-		/// <param name="path">Path to request node</param>
+		/// <param name="path"></param>
 		public void SendText(string path)
 		{
-            var url = string.Format("http://{0}/{1}", Client.HostName, path);
+			HttpClientRequest request = new HttpClientRequest();
-            var request = new HttpClientRequest()
+			string url = string.Format("http://{0}/{1}", Client.HostName, path);
-            {
+			request.Url = new UrlParser(url);
-                Url = new UrlParser(url)
+			HttpClient.DISPATCHASYNC_ERROR error = Client.DispatchAsyncEx(request, Response, request); 
-            };
-            var 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));
+			HttpClientRequest request = new HttpClientRequest();
-            var request = new HttpClientRequest()
+			string url = string.Format("http://{0}/{1}", Client.HostName, string.Format(format, items));
-            {
+			request.Url = new UrlParser(url);
-                Url = new UrlParser(url)
+			HttpClient.DISPATCHASYNC_ERROR error = Client.DispatchAsyncEx(request, Response, request);
-            };
-            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));
+			HttpClientRequest request = new HttpClientRequest();
-            var request = new HttpClientRequest()
+			string url = string.Format("http://{0}/{1}", Client.HostName, string.Format(format, items));
-            {
+			request.Url = new UrlParser(url);
-                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);
 		}
 
 		private void Response(HttpClientResponse response, HTTP_CALLBACK_ERROR error, object request)
 		{
-		    if (error != HTTP_CALLBACK_ERROR.COMPLETED) return;
+			if (error == HTTP_CALLBACK_ERROR.COMPLETED)
+			{
 				var responseReceived = response;
 
-		    if (responseReceived.ContentString.Length <= 0) return;
+				if (responseReceived.ContentString.Length > 0)
-		    if (ResponseRecived == null) return;
+				{
-		    var httpClientRequest = request as HttpClientRequest;
+					if (ResponseRecived != null)
-		    if (httpClientRequest != null)
+						ResponseRecived(this, new GenericHttpClientEventArgs(responseReceived.ContentString, (request as HttpClientRequest).Url.ToString(), error));
-		        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/Devices/DeviceJsonApi.cs

@@ -3,6 +3,7 @@ using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.Text.RegularExpressions;
 using Crestron.SimplSharp;
 using Crestron.SimplSharp.Reflection;
 using Newtonsoft.Json;
@@ -38,6 +39,53 @@ namespace PepperDash.Essentials.Core
 		    }
 		    
 		}
+        private const string ParamsPattern = @"(?<=\[).*?(?=])";
+        private const string DevKeySpacePattern = @"(?<=\().*?(?=\))";
+        private const string MethodStringPattern = @"(?<=\)\s).*?(?=\s)";
+        private static readonly Regex ParamsRegex = new Regex(ParamsPattern);
+        private static readonly Regex DevKeySpaceRegex = new Regex(DevKeySpacePattern);
+        private static readonly Regex MethodStringRegex = new Regex(MethodStringPattern);
+
+
+
+        public static void BuildJsonForDeviceAction(string cmd)
+	    {
+	        if (String.IsNullOrEmpty(cmd))
+	        {
+	            CrestronConsole.ConsoleCommandResponse(
+	                "Please provide some data matching the format '<deviceKey> <methodName> [parameters]'  The parameters support strings, numbers, and booleans, and are optional.  If your device key has spaces in it, wrap it in parenthesis");
+	        }
+	        try
+	        {
+	            var paramsMatch = ParamsRegex.Match(cmd);
+	            var devKeySpaceMatch = DevKeySpaceRegex.Match(cmd);
+	            var methodStringMatch = MethodStringRegex.Match(cmd);
+                var deviceString = devKeySpaceMatch.Value ?? string.Empty;
+                var methodString = methodStringMatch.Value ?? string.Empty;
+
+	            var cmdParts = cmd.Split(' ');
+	            if (cmdParts.Length <= 1)
+	            {
+	                CrestronConsole.ConsoleCommandResponse("Malformed 'deveasy' command - not enough arguments");
+	                return;
+	            }
+	            deviceString = String.IsNullOrEmpty(deviceString) ? cmdParts[0] : deviceString;
+	            methodString = String.IsNullOrEmpty(methodString) ? cmdParts[1] : methodString;
+	            var action = new DeviceActionWrapper()
+	            {
+	                DeviceKey = deviceString,
+	                MethodName = methodString,
+                    Params = (paramsMatch != null) ? new object[] { paramsMatch.Value } : new object[] { }
+	            };
+
+                DoDeviceAction(action);
+	        }
+	        catch (Exception ex)
+	        {
+                CrestronConsole.ConsoleCommandResponse("Malformed 'deveasy' command - consult command help.");
+	        }
+	    }
+
 
 
 		/// <summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Devices/DeviceManager.cs

@@ -39,8 +39,13 @@ namespace PepperDash.Essentials.Core
 				ConsoleAccessLevelEnum.AccessOperator);
 			CrestronConsole.AddNewConsoleCommand(ListDevices, "devlist", "Lists current managed devices", 
 				ConsoleAccessLevelEnum.AccessOperator);
+		    CrestronConsole.AddNewConsoleCommand(DeviceJsonApi.BuildJsonForDeviceAction, "deveasy",
+		        "Easier way to build devjson commands",
+		        ConsoleAccessLevelEnum.AccessOperator);
+
 			CrestronConsole.AddNewConsoleCommand(DeviceJsonApi.DoDeviceActionWithJson, "devjson", "", 
 				ConsoleAccessLevelEnum.AccessOperator);
+
 			CrestronConsole.AddNewConsoleCommand(s => CrestronConsole.ConsoleCommandResponse(DeviceJsonApi.GetProperties(s)), "devprops", "", ConsoleAccessLevelEnum.AccessOperator);
 			CrestronConsole.AddNewConsoleCommand(s => CrestronConsole.ConsoleCommandResponse(DeviceJsonApi.GetMethods(s)), "devmethods", "", ConsoleAccessLevelEnum.AccessOperator);
 			CrestronConsole.AddNewConsoleCommand(s => CrestronConsole.ConsoleCommandResponse(DeviceJsonApi.GetApiMethods(s)), "apimethods", "", ConsoleAccessLevelEnum.AccessOperator);