Merge pull request #9 from DenisaCG/contentManagerS3

Add S3ContentsManager

Author: DenisaCG

jupyter_drives/handlers.py

@@ -4,9 +4,9 @@
 import json
 import logging 
 import traceback
-from typing import Optional
+from typing import Optional, Tuple, Union
 
-from jupyter_server.base.handlers import APIHandler
+from jupyter_server.base.handlers import APIHandler, path_regex
 from jupyter_server.utils import url_path_join
 import tornado
 import traitlets
@@ -42,27 +42,56 @@ def write_error(self, status_code, **kwargs):
                 reply["error"] = "".join(traceback.format_exception(*exc_info))
         self.finish(json.dumps(reply))
 
-class ListJupyterDrives(JupyterDrivesAPIHandler):
+class ListJupyterDrivesHandler(JupyterDrivesAPIHandler):
     """
-    Returns list of available drives.
+    List available drives. Mounts drives.
     """
     def initialize(self, logger: logging.Logger, manager: JupyterDrivesManager):
         return super().initialize(logger, manager)
 
     # Later on, filters can be added for the listing 
     @tornado.web.authenticated
     async def get(self):
-        drives, error = await self._manager.list_drives()
-        self.finish(json.dumps(drives))
-        self._jp_log.debug(error)
+        result = await self._manager.list_drives()
+        self.finish(json.dumps(result))
+    
+    @tornado.web.authenticated
+    async def post(self):
+        body = self.get_json_body()
+        result = await self._manager.mount_drive(**body)
+        self.finish(json.dump(result.message))
+
+class ContentsJupyterDrivesHandler(JupyterDrivesAPIHandler):
+    """
+    Deals with contents of a drive.
+    """
+    @tornado.web.authenticated
+    async def get(self, path: str = "", drive: str = ""):
+        result = await self._manager.get_contents(drive, path)
+        self.finish(json.dump(result))
+
+    @tornado.web.authenticated
+    async def post(self, path: str = "", drive: str = ""):
+        result = await self._manager.new_file(drive, path)
+        self.finish(json.dump(result))
+
+    @tornado.web.authenticated
+    async def patch(self, path: str = "", drive: str = ""):
+        body = self.get_json_body()
+        result = await self._manager.rename_file(drive, path, **body)
+        self.finish(json.dump(result))
+
+handlers = [
+    ("drives", ListJupyterDrivesHandler)
+]
 
-default_handlers = [
-    ("drives", ListJupyterDrives)
+handlers_with_path = [
+    ("drives", ContentsJupyterDrivesHandler)
 ]
 
 def setup_handlers(web_app: tornado.web.Application, config: traitlets.config.Config, log: Optional[logging.Logger] = None):
     host_pattern = ".*$"
-    base_url = url_path_join(web_app.settings["base_url"], NAMESPACE)
+    base_url = web_app.settings["base_url"]
 
     log = log or logging.getLogger(__name__)
 
@@ -80,15 +109,26 @@ def setup_handlers(web_app: tornado.web.Application, config: traitlets.config.Co
         logging.error("JupyterDrives Manager Exception", exc_info=1)
         raise err
 
-    handlers = [
-        (
-            url_path_join(base_url, pattern),
-            handler,
-            {"logger": log, "manager": manager}
-        )
-        for pattern, handler in default_handlers
-    ]
+    drives_handlers = (
+        [
+            (
+                url_path_join(base_url, NAMESPACE, pattern),
+                handler,
+                {"logger": log, "manager": manager}
+            )
+            for pattern, handler in handlers
+        ] 
+        + [
+            (
+                url_path_join(
+                    base_url, NAMESPACE, pattern, r"(?P<drive>\w+)", path_regex 
+                ),
+                handler,
+            )
+            for pattern, handler in handlers_with_path
+        ]
+    )
 
-    log.debug(f"Jupyter-Drives Handlers: {handlers}")
+    log.debug(f"Jupyter-Drives Handlers: {drives_handlers}")
 
-    web_app.add_handlers(host_pattern, handlers)
+    web_app.add_handlers(host_pattern, drives_handlers)

jupyter_drives/managers/manager.py

@@ -2,7 +2,7 @@
 import http 
 import json
 import logging
-from typing import Dict, List, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple, Union, Any
 
 import nbformat
 import tornado
@@ -53,31 +53,64 @@ def per_page_argument(self) -> Optional[Tuple[str, int]]:
         return None
 
     @abc.abstractclassmethod
-    async def list_drives(self) -> list: 
+    async def list_drives(self): 
         """Get list of available drives.
 
         Returns: 
             List of available drives and their properties.
         """
         raise NotImplementedError()
 
-    # @abc.abstractclassmethod
-    # async def mount_drive(self) -> str:
-    #     """Mount a drive. 
-
-    #     Returns:
-    #         The URL for the new drive content.
-    #     """
-    #     raise NotImplementedError()
+    @abc.abstractclassmethod
+    async def mount_drive(self, drive_name, **kwargs):
+        """Mount a drive.
+
+        Args:
+            drive_name: name of drive to mount
+
+        Returns:
+            The content manager for the drive.
+        """
+        raise NotImplementedError()
 
-    # @abc.abstractclassmethod
-    # async def unmount_drive(self, drive_name: str):
-    #     """Unmount a drive.
-
-    #     Args:
-    #         drive_name: name of drive to unmount
-    #     """
-    #     raise NotImplementedError()
+    @abc.abstractclassmethod
+    async def unmount_drive(self, drive_name: str, **kwargs):
+        """Unmount a drive.
+
+        Args:
+            drive_name: name of drive to unmount
+        """
+        raise NotImplementedError()
+    
+    @abc.abstractclassmethod
+    async def get_contents(self, drive_name, path, **kwargs):
+        """Get contents of a file or directory.
+
+        Args:
+            drive_name: name of drive to get the contents of
+            path: path to file or directory
+        """
+        raise NotImplementedError()
+    
+    @abc.abstractclassmethod
+    async def new_file(self, drive_name, path, **kwargs):
+        """Create a new file or directory at the given path.
+        
+        Args:
+            drive_name: name of drive where the new content is created
+            path: path where new content should be created
+        """
+        raise NotImplementedError()
+    
+    @abc.abstractclassmethod
+    async def rename_file(self, drive_name, path, **kwargs):
+        """Rename a file.
+        
+        Args:
+            drive_name: name of drive where file is located
+            path: path of file
+        """
+        raise NotImplementedError()
 
     async def _call_provider(
         self,
@@ -110,19 +143,19 @@ async def _call_provider(
         """
         if not self._config.session_token:
             raise tornado.web.HTTPError(
-                status_code=http.HTTPStatus.BAD_REQUEST,
+                status_code= httpx.codes.BAD_REQUEST,
                 reason="No session token specified. Please set DriversConfig.session_token in your user jupyter_server_config file.",
             )
 
         if not self._config.access_key_id:
             raise tornado.web.HTTPError(
-                status_code=http.HTTPStatus.BAD_REQUEST,
+                status_code= httpx.codes.BAD_REQUEST,
                 reason="No access key id specified. Please set DriversConfig.access_key_id in your user jupyter_server_config file.",
             )
 
         if not self._config.secret_access_key:
             raise tornado.web.HTTPError(
-                status_code=http.HTTPStatus.BAD_REQUEST,
+                status_code= httpx.codes.BAD_REQUEST,
                 reason="No secret access key specified. Please set DriversConfig.secret_access_key in your user jupyter_server_config file.",
             )