Add API handlers to list&del servers from manager

Existing servers-info endpoint is moved with api sub directory to have
a consistent end point scheme.

Author: mahendrapaipuri

jupyter_server_proxy/__init__.py

@@ -1,8 +1,12 @@
 from jupyter_server.utils import url_path_join as ujoin
 
-from .api import IconHandler, ServersInfoHandler
+from .api import (
+    IconHandler, ServersInfoHandler, ServersAPIHandler, ListServersAPIHandler
+)
 from .config import ServerProxy as ServerProxyConfig
-from .config import get_entrypoint_server_processes, make_handlers, make_server_process
+from .config import (
+    get_entrypoint_server_processes, make_handlers, make_server_process
+)
 from .handlers import setup_handlers
 
 
@@ -63,11 +67,23 @@ def _load_jupyter_server_extension(nbapp):
         ".*",
         [
             (
-                ujoin(base_url, "server-proxy/servers-info"),
+                ujoin(base_url, "api/server-proxy/servers-info"),
                 ServersInfoHandler,
                 {"server_processes": server_processes},
             ),
-            (ujoin(base_url, "server-proxy/icon/(.*)"), IconHandler, {"icons": icons}),
+            (
+                ujoin(base_url, r"server-proxy/icon/(?P<name>.*)"),
+                IconHandler,
+                {"icons": icons}
+            ),
+            (
+                ujoin(base_url, r"api/server-proxy"),
+                ListServersAPIHandler
+            ),
+            (
+                ujoin(base_url, r"api/server-proxy/(?P<name>.*)"),
+                ServersAPIHandler
+            ),
         ],
     )
 

jupyter_server_proxy/api.py

@@ -1,9 +1,12 @@
 import mimetypes
+import json
 
 from jupyter_server.base.handlers import JupyterHandler
 from jupyter_server.utils import url_path_join as ujoin
 from tornado import web
 
+from .manager import manager
+
 
 class ServersInfoHandler(JupyterHandler):
     def initialize(self, server_processes):
@@ -70,3 +73,41 @@ async def get(self, name):
         with open(self.icons[name]) as f:
             self.write(f.read())
         self.set_header("Content-Type", content_type)
+
+
+class ServersAPIHandler(JupyterHandler):
+    """Handler to get metadata or terminate of a given server"""
+
+    @web.authenticated
+    async def delete(self, name):
+        """Delete a server proxy by name"""
+        try:
+            val = await manager.terminate_server_proxy_app(name)
+            if val is None:
+                raise Exception(
+                    f"Proxy {name} not found. Are you sure the {name} "
+                    f"is managed by jupyter-server-proxy?"
+                )
+            else:
+                self.set_status(204)
+                self.finish()
+        except Exception as e:
+            raise web.HTTPError(404, str(e))
+
+    @web.authenticated
+    async def get(self, name):
+        """Get meta data of a running server proxy"""
+        app = manager.get_server_proxy_app(name)
+        self.set_status(200)
+        self.finish(json.dumps(app._asdict()))
+
+
+class ListServersAPIHandler(JupyterHandler):
+    """Handler to list all running server proxies"""
+
+    @web.authenticated
+    async def get(self):
+        """list running servers"""
+        apps = manager.list_server_proxy_apps()
+        self.set_status(200)
+        self.finish(json.dumps([app._asdict() for app in apps]))