Add file listing API

Author: kdouda

src/pyrdfrules/api/workspace/workspace_http_api.py

@@ -11,27 +11,28 @@ def __init__(self, context: HTTPRDFRulesApiContext) -> None:
         super().__init__(context)
         pass
 
-    async def get_all_files(self):
+    async def get_all_files(self) -> dict:
+        """Get all files and directories recursively from the workspace directory.
+        """
 
         response = self.context.get_http_client().get(WORKSPACE_URL)
 
-        print(response.text)
-        
-        """Get all files and directories recursively from the workspace directory.
-        """
-        pass
+        return response.json()
 
     async def get_file(self, path: str):
         """Get the file content.
         """
+        
         pass
 
     async def delete_file(self, path: str):
         """Delete a file.
         """
+        
         pass
 
     async def upload_file(self, path: str, content: bytes):
         """Upload a file.
         """
+        
         pass

src/pyrdfrules/application.py

@@ -42,8 +42,4 @@ async def stop(self) -> None:
         """Stops the application.
         """
 
-        await self.__rdfrules.engine.stop()
-
-    def check(self):
-        """Checks the liveliness state of the application.
-        """
+        await self.__rdfrules.engine.stop()

src/pyrdfrules/common/file/workspace.py

@@ -1,27 +1,27 @@
 from pathlib import Path
-from pydantic import BaseModel
 
-from pyrdfrules.common.file.workspace_file import WorkspaceFile
+from pyrdfrules.api.workspace.workspace_api import WorkspaceApi
+from pyrdfrules.common.file.workspace_tree import WorkspaceTree
 
-class Workspace(BaseModel):
+class Workspace():
     """
     Path in which RDFRules can find datasets and store results.
     """
 
-    """
-    Base path to the workspace root directory.
-    """
-    base_path: Path
+    api: WorkspaceApi
 
-    def open(self, path: str) -> WorkspaceFile:
-        """Creates a file reference if the specified path exists.
-
-        Args:
-            path (str): Relative path from the workspace root.
+    def __init__(self, api: WorkspaceApi) -> None:
+        self.api = api
+        pass
+    
+    async def get_files(self) -> WorkspaceTree:
+        """Returns a list of all files in the workspace.
 
         Returns:
-            WorkspaceFile: Workspace file abstraction.
+            WorkspaceTree: List of workspace files.
         """
 
-        # todo - check if the file exists
-        return WorkspaceFile(path, self)
+        tree = WorkspaceTree()
+        tree.create_from_dict(await self.api.get_all_files())
+        
+        return tree

src/pyrdfrules/common/file/workspace_directory.py

@@ -0,0 +1,37 @@
+from pathlib import Path
+from typing import Optional
+
+from pyrdfrules.common.file.workspace_item import WorkspaceItem
+
+class WorkspaceDirectory(WorkspaceItem):
+    """Represents a directory in the workspace.
+    """
+    
+    name: str
+    """Name of the workspace diretory.
+    """
+    
+    size: int
+    """Size of the directory in bytes.
+    """
+    
+    path: Optional[Path]
+    """Full path to the file.
+    """
+    
+    writable: bool
+    """If the file is writable.
+    """
+    
+    files: list[WorkspaceItem] = []
+    
+    def add(self, item: WorkspaceItem) -> None:
+        """Adds a file or directory to the directory.
+        
+        Args:
+            item (WorkspaceItem): File or directory to add.
+        """
+        
+        self.files.append(item)
+        pass
+    

src/pyrdfrules/common/file/workspace_file.py

@@ -1,22 +1,22 @@
 from pathlib import Path
+from typing import List
 from pydantic import BaseModel
 
-from pyrdfrules.common.file.workspace import Workspace
+from pyrdfrules.common.file.workspace_item import WorkspaceItem
 
-class WorkspaceFile(BaseModel):
-    """
-    Represents a file in the workspace.
+class WorkspaceFile(WorkspaceItem):
+    """Represents a file in the workspace.
     """
 
+    name: str
+    """Name of the workspace file.
     """
-    Path relative to the workspace root.
-    """
-    path: str
 
+    size: int
+    """Size of the file in bytes.
     """
-    Workspace the file is in.
-    """
-    workspace: Workspace
 
-    def get_absolute_path(self) -> str:
-        return ''
+    path: Path
+    """Full path to the file.
+    """
+    

src/pyrdfrules/common/file/workspace_item.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+from pydantic import BaseModel
+
+class WorkspaceItem(BaseModel):
+    """Represents a directory in the workspace.
+    """
+    
+    name: str
+    """Name of the workspace diretory.
+    """
+    
+    path: Path
+    """Full path to the file.
+    """

src/pyrdfrules/common/file/workspace_tree.py

@@ -0,0 +1,57 @@
+from pathlib import Path
+from typing import List
+from pydantic import BaseModel
+
+from pyrdfrules.common.file.workspace_directory import WorkspaceDirectory
+from pyrdfrules.common.file.workspace_file import WorkspaceFile
+
+class WorkspaceTree(BaseModel):
+        
+    root: WorkspaceDirectory|None = None
+    
+    def create_from_dict(self, data: dict) -> None:
+        """Creates a workspace tree from a dictionary response.
+        
+        Args:
+            data (dict): Dictionary with workspace items.
+        """
+        
+        def create_folder(subdata: dict, base_path: Path) -> WorkspaceDirectory:
+
+            directory = WorkspaceDirectory(
+                name=subdata['name'],
+                path=base_path,
+                size=0,
+                writable=subdata['writable']
+            )
+            
+            if 'subfiles' in subdata:
+                for file in subdata['subfiles']:
+                    if "subfiles" in file:
+                        directory.add(
+                            create_folder(file, base_path / Path(file['name']))
+                        )
+                    else:
+                        directory.add(
+                            WorkspaceFile(
+                                name=file['name'],
+                                path=base_path / Path(file['name']),
+                                size=file['size']
+                            )
+                        )
+            
+            return directory
+        
+        
+        self.root = create_folder(data, Path('/'))
+        pass
+    
+    
+    def get_root(self) -> WorkspaceDirectory:
+        """Returns the root directory of the workspace tree.
+        
+        Returns:
+            WorkspaceDirectory: Root directory.
+        """
+        
+        return self.root

src/pyrdfrules/common/http/http_client.py

@@ -1,3 +1,4 @@
+from typing import Awaitable
 from pydantic_core import Url
 from requests import Response, Session
 
@@ -29,7 +30,7 @@ def set_base_url(self, url: str | Url) -> None:
 
         self.base_url = str(url)
 
-    def get(self, url: str | Url) -> Response:
+    def get(self, url: str | Url) -> Awaitable[Response]:
         """Sends a GET request.
 
         Args:

src/pyrdfrules/rdfrules/rdfrules.py

@@ -1,15 +1,25 @@
-from typing import Awaitable
+from typing import Any, Awaitable
 
+from pyrdfrules.api.workspace.workspace_api import WorkspaceApi
+from pyrdfrules.common.file.workspace import Workspace
 from pyrdfrules.engine.engine import Engine
 
 class RDFRules():
 
     engine: Engine
 
+    workspace: Workspace
+    
     def __init__(self, engine: Engine) -> None:
         self.engine = engine
         pass
 
+    def __getattr__(self, name: str) -> Any:
+        if name == 'workspace':
+            return Workspace(self.engine.api.workspace)
+        
+        pass
+    
     async def start(self) -> Awaitable:
         """
         Starts the engine.

src/tests/test_remote_application.py

@@ -19,7 +19,7 @@ async def test_runs_workspace(self):
         )
 
         self.assertIsNotNone(rdfrules, "Should not be None")
-        await rdfrules.engine.check()
+        await rdfrules.workspace.get_files()
 
         await app.stop()