From 30c236f1a926bc198278d5303269a6ab5c76749b Mon Sep 17 00:00:00 2001
From: Arksine <arksine.code@gmail.com>
Date: Mon, 9 Nov 2020 06:58:22 -0500
Subject: [PATCH] websockets:  add WebRequest class

This class encapsulates all request data received from a client.  This simplifies callbacks and makes it easier to add additional parameters to a client request.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
---
 moonraker/websockets.py | 61 +++++++++++++++++++++++++++++++++++++++--
 1 file changed, 59 insertions(+), 2 deletions(-)

diff --git a/moonraker/websockets.py b/moonraker/websockets.py
index 0574196..84a38a1 100644
--- a/moonraker/websockets.py
+++ b/moonraker/websockets.py
@@ -14,6 +14,61 @@ from utils import ServerError
 class Sentinel:
     pass
 
+class WebRequest:
+    def __init__(self, endpoint, args, action=""):
+        self.endpoint = endpoint
+        self.action = action
+        self.args = args
+
+    def get_endpoint(self):
+        return self.endpoint
+
+    def get_action(self):
+        return self.action
+
+    def get_args(self):
+        return self.args
+
+    def _get_converted_arg(self, key, default=Sentinel, dtype=str):
+        if key not in self.args:
+            if default == Sentinel:
+                raise ServerError(f"No data for argument: {key}")
+            return default
+        val = self.args[key]
+        try:
+            if dtype != bool:
+                return dtype(val)
+            else:
+                if isinstance(val, str):
+                    val = val.lower()
+                    if val in ["true", "false"]:
+                        return True if val == "true" else False
+                elif isinstance(val, bool):
+                    return val
+                raise TypeError
+        except Exception:
+            raise ServerError(
+                f"Unable to convert argument [{key}] to {dtype}: "
+                f"value recieved: {val}")
+
+    def get(self, key, default=Sentinel):
+        val = self.args.get(key, default)
+        if val == Sentinel:
+            raise ServerError(f"No data for argument: {key}")
+        return val
+
+    def get_str(self, key, default=Sentinel):
+        return self._get_converted_arg(key, default)
+
+    def get_int(self, key, default=Sentinel):
+        return self._get_converted_arg(key, default, int)
+
+    def get_float(self, key, default=Sentinel):
+        return self._get_converted_arg(key, default, float)
+
+    def get_boolean(self, key, default=Sentinel):
+        return self._get_converted_arg(key, default, bool)
+
 class JsonRPC:
     def __init__(self):
         self.methods = {}
@@ -155,13 +210,15 @@ class WebsocketManager:
 
     def _generate_callback(self, endpoint):
         async def func(**kwargs):
-            result = await self.server.make_request(endpoint, kwargs)
+            result = await self.server.make_request(
+                WebRequest(endpoint, kwargs))
             return result
         return func
 
     def _generate_local_callback(self, endpoint, request_method, callback):
         async def func(**kwargs):
-            result = await callback(endpoint, request_method, kwargs)
+            result = await callback(
+                WebRequest(endpoint, kwargs, request_method))
             return result
         return func