Rename repository module as services

Author: edan-bainglass

aiida_restapi/main.py

@@ -11,7 +11,11 @@
 
 
 def create_app() -> FastAPI:
-    """Create the FastAPI application and include the routers."""
+    """Create the FastAPI application and include the routers.
+
+    :return: The FastAPI application.
+    :rtype: FastAPI
+    """
 
     read_only = os.getenv('AIIDA_RESTAPI_READ_ONLY') == '1'
 

aiida_restapi/models/node/registry.py aiida_restapi/models/node.pyaiida_restapi/models/node/registry.py renamed to aiida_restapi/models/node.py

@@ -1,5 +1,3 @@
-"""REST API models for ORM nodes."""
-
 from __future__ import annotations
 
 import typing as t
@@ -10,6 +8,80 @@
 from importlib_metadata import EntryPoint
 
 
+class NodeStatistics(pdt.BaseModel):
+    """Pydantic model representing node statistics."""
+
+    total: int = pdt.Field(
+        description='Total number of nodes.',
+        examples=[47],
+    )
+    types: dict[str, int] = pdt.Field(
+        description='Number of nodes by type.',
+        examples=[
+            {
+                'data.core.int.Int.': 42,
+                'data.core.singlefile.SinglefileData.': 5,
+            }
+        ],
+    )
+    ctime_by_day: dict[str, int] = pdt.Field(
+        description='Number of nodes created per day (YYYY-MM-DD).',
+        examples=[
+            {
+                '2012-01-01': 10,
+                '2012-01-02': 15,
+            }
+        ],
+    )
+
+
+class NodeType(pdt.BaseModel):
+    """Pydantic model representing a node type."""
+
+    label: str = pdt.Field(description='The class name of the node type.')
+    node_type: str = pdt.Field(description='The AiiDA node type string.')
+    nodes: str = pdt.Field(description='The URL to access nodes of this type.')
+    projections: str = pdt.Field(description='The URL to access projectable properties of this node type.')
+    node_schema: str = pdt.Field(description='The URL to access the schema of this node type.')
+
+
+class RepoFileMetadata(pdt.BaseModel):
+    """Pydantic model representing the metadata of a file in the AiiDA repository."""
+
+    type: t.Literal['FILE'] = pdt.Field(
+        description='The type of the repository object.',
+    )
+    binary: bool = pdt.Field(
+        False,
+        description='Whether the file is binary.',
+    )
+    size: int = pdt.Field(
+        description='The size of the file in bytes.',
+    )
+    download: str = pdt.Field(
+        description='The URL to download the file.',
+    )
+
+
+class RepoDirMetadata(pdt.BaseModel):
+    """Pydantic model representing the metadata of a directory in the AiiDA repository."""
+
+    type: t.Literal['DIRECTORY'] = pdt.Field(
+        description='The type of the repository object.',
+    )
+    objects: dict[str, t.Union[RepoFileMetadata, 'RepoDirMetadata']] = pdt.Field(
+        description='A dictionary with the metadata of the objects in the directory.',
+    )
+
+
+MetadataType = t.Union[RepoFileMetadata, RepoDirMetadata]
+
+
+class NodeLink(Node.Model):
+    link_label: str = pdt.Field(description='The label of the link to the node.')
+    link_type: str = pdt.Field(description='The type of the link to the node.')
+
+
 class NodeModelRegistry:
     """Registry for AiiDA REST API node models.
 

aiida_restapi/models/node/__init__.py

@@ -11,14 +11,14 @@
 
 from aiida_restapi.common.pagination import PaginatedResults
 from aiida_restapi.common.query import QueryParams, query_params
-from aiida_restapi.repository.entity import EntityRepository
+from aiida_restapi.services.entity import EntityService
 
 from .auth import UserInDB, get_current_active_user
 
 read_router = APIRouter(prefix='/computers')
 write_router = APIRouter(prefix='/computers')
 
-repository = EntityRepository[orm.Computer, orm.Computer.Model](orm.Computer)
+service = EntityService[orm.Computer, orm.Computer.Model](orm.Computer)
 
 
 @read_router.get(
@@ -39,23 +39,23 @@ async def get_computers_schema(
         500 for any other failures.
     """
     try:
-        return repository.get_entity_schema(which=which)
+        return service.get_schema(which=which)
     except ValueError as exception:
         raise HTTPException(status_code=422, detail=str(exception)) from exception
     except Exception as exception:
         raise HTTPException(status_code=500, detail=str(exception)) from exception
 
 
 @read_router.get(
-    '/projectable_properties',
+    '/projections',
     response_model=list[str],
 )
-async def get_computer_projectable_properties() -> list[str]:
-    """Get projectable properties for AiiDA computers.
+async def get_computer_projections() -> list[str]:
+    """Get queryable projections for AiiDA computers.
 
-    :return: The list of projectable properties for AiiDA computers.
+    :return: The list of queryable projections for AiiDA computers.
     """
-    return repository.get_projectable_properties()
+    return service.get_projections()
 
 
 @read_router.get(
@@ -73,7 +73,7 @@ async def get_computers(
     :param queries: The query parameters, including filters, order_by, page_size, and page.
     :return: The paginated results, including total count, current page, page size, and list of computer models.
     """
-    return repository.get_entities(queries)
+    return service.get_many(queries)
 
 
 @read_router.get(
@@ -92,7 +92,7 @@ async def get_computer(pk: str) -> orm.Computer.Model:
         500 for any other failures.
     """
     try:
-        return repository.get_entity_by_id(pk)
+        return service.get_one(pk)
     except NotExistent as exception:
         raise HTTPException(status_code=404, detail=str(exception)) from exception
     except Exception as exception:
@@ -113,8 +113,7 @@ async def get_computer_metadata(pk: str) -> dict[str, t.Any]:
         500 for any other failures.
     """
     try:
-        computer = repository.get_entity_by_id(pk)
-        return computer.metadata
+        return service.get_field(pk, 'metadata')
     except NotExistent as exception:
         raise HTTPException(status_code=404, detail=str(exception)) from exception
     except Exception as exception:
@@ -140,6 +139,6 @@ async def create_computer(
     :raises HTTPException: 500 for any failures during computer creation.
     """
     try:
-        return repository.create_entity(computer_model)
+        return service.add_one(computer_model)
     except Exception as exception:
         raise HTTPException(status_code=500, detail=str(exception))

aiida_restapi/models/node/models.py

@@ -11,14 +11,14 @@
 
 from aiida_restapi.common.pagination import PaginatedResults
 from aiida_restapi.common.query import QueryParams, query_params
-from aiida_restapi.repository.entity import EntityRepository
+from aiida_restapi.services.entity import EntityService
 
 from .auth import UserInDB, get_current_active_user
 
 read_router = APIRouter(prefix='/groups')
 write_router = APIRouter(prefix='/groups')
 
-repository = EntityRepository[orm.Group, orm.Group.Model](orm.Group)
+service = EntityService[orm.Group, orm.Group.Model](orm.Group)
 
 
 @read_router.get(
@@ -39,23 +39,23 @@ async def get_groups_schema(
         500 for any other failures.
     """
     try:
-        return repository.get_entity_schema(which=which)
+        return service.get_schema(which=which)
     except ValueError as exception:
         raise HTTPException(status_code=422, detail=str(exception)) from exception
     except Exception as exception:
         raise HTTPException(status_code=500, detail=str(exception)) from exception
 
 
 @read_router.get(
-    '/projectable_properties',
+    '/projections',
     response_model=list[str],
 )
-async def get_group_projectable_properties() -> list[str]:
-    """Get projectable properties for AiiDA groups.
+async def get_group_projections() -> list[str]:
+    """Get queryable projections for AiiDA groups.
 
-    :return: The list of projectable properties for AiiDA groups.
+    :return: The list of queryable projections for AiiDA groups.
     """
-    return repository.get_projectable_properties()
+    return service.get_projections()
 
 
 @read_router.get(
@@ -73,7 +73,7 @@ async def get_groups(
     :param queries: The query parameters, including filters, order_by, page_size, and page.
     :return: The paginated results, including total count, current page, page size, and list of group models.
     """
-    return repository.get_entities(queries)
+    return service.get_many(queries)
 
 
 @read_router.get(
@@ -92,7 +92,7 @@ async def get_group(uuid: str) -> orm.Group.Model:
         500 for any other server error.
     """
     try:
-        return repository.get_entity_by_id(uuid)
+        return service.get_one(uuid)
     except NotExistent as exception:
         raise HTTPException(status_code=404, detail=str(exception)) from exception
     except Exception as exception:
@@ -113,7 +113,7 @@ async def get_group_extras(uuid: str) -> dict[str, t.Any]:
         500 for other failures during retrieval.
     """
     try:
-        return repository.get_entity_extras(uuid)
+        return service.get_field(uuid, 'extras')
     except NotExistent as exception:
         raise HTTPException(status_code=404, detail=str(exception)) from exception
     except Exception as exception:
@@ -139,6 +139,6 @@ async def create_group(
     :raises HTTPException: 500 for any failures during group creation.
     """
     try:
-        return repository.create_entity(group_model)
+        return service.add_one(group_model)
     except Exception as exception:
         raise HTTPException(status_code=500, detail=str(exception)) from exception