mesh-sandbox 1.0.5__py3-none-any.whl → 1.0.6__py3-none-any.whl

mesh_sandbox/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.5"
+__version__ = "1.0.6"

mesh_sandbox/handlers/admin.py

@@ -5,6 +5,7 @@ from fastapi import BackgroundTasks, Depends, HTTPException, status
 
 from ..common.messaging import Messaging
 from ..dependencies import get_messaging
+from ..models.mailbox import Mailbox
 from ..models.message import (
     Message,
     MessageEvent,
@@ -13,7 +14,7 @@ from ..models.message import (
     MessageStatus,
     MessageType,
 )
-from ..views.admin import AddMessageEventRequest, CreateReportRequest
+from ..views.admin import AddMessageEventRequest, CreateReportRequest, MailboxDetails
 
 
 class AdminHandler:
@@ -106,3 +107,10 @@ class AdminHandler:
         message = await self.messaging.add_message_event(message, event, background_tasks)
 
         return message
+
+    async def get_mailbox_details(self, mailbox_id: str) -> MailboxDetails:
+        mailbox: Optional[Mailbox] = await self.messaging.get_mailbox(mailbox_id)
+        if not mailbox:
+            raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+
+        return MailboxDetails.from_mailbox(mailbox)

mesh_sandbox/models/mailbox.py

@@ -13,6 +13,7 @@ class Mailbox:
     org_code: str = field(default="")
     org_name: str = field(default="")
     password: str = field(default="")
+    active: bool = field(default=True)
 
     _last_accessed: Optional[datetime] = None
     _inbox_count: Optional[int] = None

mesh_sandbox/routers/admin.py

@@ -1,4 +1,4 @@
-from fastapi import APIRouter, BackgroundTasks, Depends, Response, status
+from fastapi import APIRouter, BackgroundTasks, Depends, Path, Response, status
 
 from ..dependencies import (
     EnvConfig,
@@ -7,7 +7,7 @@ from ..dependencies import (
     normalise_message_id_path,
 )
 from ..handlers.admin import AdminHandler
-from ..views.admin import AddMessageEventRequest, CreateReportRequest
+from ..views.admin import AddMessageEventRequest, CreateReportRequest, MailboxDetails
 from .request_logging import RequestLoggingRoute
 
 router = APIRouter(
@@ -42,7 +42,7 @@ async def ping(config: EnvConfig = Depends(get_env_config)):
     response_model_exclude_none=True,
 )
 @router.delete(
-    "/messageexchange/reset",
+    "/messageexchange/admin/reset",
     status_code=status.HTTP_200_OK,
     include_in_schema=False,
     response_model_exclude_none=True,
@@ -61,7 +61,7 @@ async def reset(
     response_model_exclude_none=True,
 )
 @router.delete(
-    "/messageexchange/reset/{mailbox_id}",
+    "/messageexchange/admin/reset/{mailbox_id}",
     status_code=status.HTTP_200_OK,
     include_in_schema=False,
     response_model_exclude_none=True,
@@ -75,7 +75,7 @@ async def reset_mailbox(
 
 
 @router.post(
-    "/messageexchange/report",
+    "/messageexchange/admin/report",
     summary=f"Put a report messages into a particular inbox. {TESTING_ONLY}",
     status_code=status.HTTP_200_OK,
     response_model_exclude_none=True,
@@ -96,7 +96,7 @@ async def create_report(
     response_model_exclude_none=True,
 )
 @router.post(
-    "/messageexchange/message/{message_id}/event",
+    "/messageexchange/admin/message/{message_id}/event",
     summary=f"appends a status event to a given message, if exists. {TESTING_ONLY}",
     status_code=status.HTTP_200_OK,
     response_model_exclude_none=True,
@@ -109,3 +109,23 @@ async def add_message_event(
 ):
     await handler.add_message_event(message_id, new_event, background_tasks)
     return Response()
+
+
+@router.get(
+    "/admin/mailbox/{mailbox_id}",
+    summary=f"Get mailbox details. {TESTING_ONLY}",
+    status_code=status.HTTP_200_OK,
+    response_model_exclude_none=True,
+)
+@router.get(
+    "/messageexchange/admin/mailbox/{mailbox_id}",
+    summary=f"Get mailbox details. {TESTING_ONLY}",
+    status_code=status.HTTP_200_OK,
+    response_model_exclude_none=True,
+)
+async def get_mailbox_details(
+    mailbox_id: str = Path(..., title="mailbox_id", description="The Mailbox ID of the mailbox to retrieve"),
+    handler: AdminHandler = Depends(AdminHandler),
+) -> MailboxDetails:
+    mailbox = await handler.get_mailbox_details(mailbox_id)
+    return mailbox

mesh_sandbox/tests/admin.py

@@ -25,7 +25,7 @@ def test_reset_canned_store_should_return_bad_request(app: TestClient):
 
     with temp_env_vars(STORE_MODE="canned"):
 
-        res = app.delete("/messageexchange/reset")
+        res = app.delete("/messageexchange/admin/reset")
         assert res.status_code == status.HTTP_405_METHOD_NOT_ALLOWED
 
 
@@ -33,7 +33,7 @@ def test_reset_canned_store_with_valid_mailbox_id_should_return_bad_request(app:
 
     with temp_env_vars(STORE_MODE="canned"):
 
-        res = app.delete(f"/messageexchange/reset/{_CANNED_MAILBOX1}")
+        res = app.delete(f"/messageexchange/admin/reset/{_CANNED_MAILBOX1}")
         assert res.status_code == status.HTTP_405_METHOD_NOT_ALLOWED
 
 
@@ -41,7 +41,7 @@ def test_reset_memory_store_with_invalid_mailbox_id_should_return_bad_request(ap
 
     with temp_env_vars(STORE_MODE="memory"):
 
-        res = app.delete(f"/messageexchange/reset/{uuid4().hex}")
+        res = app.delete(f"/messageexchange/admin/reset/{uuid4().hex}")
         assert res.status_code == status.HTTP_404_NOT_FOUND
 
 
@@ -49,7 +49,7 @@ def test_reset_file_store_with_invalid_mailbox_id_should_return_bad_request(app:
 
     with temp_env_vars(STORE_MODE="file"):
 
-        res = app.delete(f"/messageexchange/reset/{uuid4().hex}")
+        res = app.delete(f"/messageexchange/admin/reset/{uuid4().hex}")
         assert res.status_code == status.HTTP_404_NOT_FOUND
 
 
@@ -63,7 +63,7 @@ def test_reset_memory_store_should_clear_all_mailboxes(app: TestClient):
         msg_2to1_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX2, _CANNED_MAILBOX1)
         assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
 
-        res = app.delete("/messageexchange/reset")
+        res = app.delete("/messageexchange/admin/reset")
         assert res.status_code == status.HTTP_200_OK
 
         assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 0
@@ -114,7 +114,7 @@ def test_reset_memory_store_should_clear_specified_mailbox_only(app: TestClient)
         assert len(messages) == 1
 
         # RESET mailbox 2
-        res = app.delete(f"/messageexchange/reset/{_CANNED_MAILBOX2}")
+        res = app.delete(f"/messageexchange/admin/reset/{_CANNED_MAILBOX2}")
         assert res.status_code == status.HTTP_200_OK
 
         assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
@@ -170,7 +170,7 @@ def test_reset_file_store_should_clear_all_mailboxes_and_maybe_files(app: TestCl
         shutil.rmtree(inbox_folder1)
         shutil.rmtree(inbox_folder2)
 
-        res = app.delete("/messageexchange/reset")
+        res = app.delete("/messageexchange/admin/reset")
         assert res.status_code == status.HTTP_200_OK
 
         assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 0
@@ -210,7 +210,7 @@ def test_reset_file_store_should_clear_specified_mailbox_only_and_maybe_files(ap
         assert len(messages) == 1
         assert messages[0] == msg_1to2_id
 
-        res = app.delete(f"/messageexchange/reset/{_CANNED_MAILBOX2}")
+        res = app.delete(f"/messageexchange/admin/reset/{_CANNED_MAILBOX2}")
         assert res.status_code == status.HTTP_200_OK
 
         assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
@@ -231,7 +231,7 @@ def test_reset_file_store_should_not_error_if_folder_does_not_exist_yet(
         assert not os.path.exists(inbox_folder)
 
         clear_disk_param = "" if clear_disk is None else f"?clear_disk={clear_disk}"
-        res = app.delete(f"/messageexchange/reset/{_CANNED_MAILBOX2}{clear_disk_param}")
+        res = app.delete(f"/messageexchange/admin/reset/{_CANNED_MAILBOX2}{clear_disk_param}")
         assert res.status_code == status.HTTP_200_OK
 
 
@@ -253,7 +253,7 @@ def test_put_report_in_inbox(app: TestClient, tmp_path: str):
             linked_message_id=uuid4().hex,
         )
 
-        res = app.post("/messageexchange/report", json=request.dict())
+        res = app.post("/messageexchange/admin/report", json=request.dict())
         assert res.status_code == status.HTTP_200_OK
 
         result = res.json()
@@ -318,7 +318,7 @@ def test_add_message_event(app: TestClient, tmp_path: str):
             linked_message_id=uuid4().hex,
         )
 
-        res = app.post("/messageexchange/report", json=create_report_request.dict())
+        res = app.post("/messageexchange/admin/report", json=create_report_request.dict())
         assert res.status_code == status.HTTP_200_OK
 
         result = res.json()
@@ -350,7 +350,7 @@ def test_add_message_event(app: TestClient, tmp_path: str):
         # move the message to accepted again
         add_event_request = AddMessageEventRequest(status=MessageStatus.ACCEPTED)
 
-        res = app.post(f"/messageexchange/message/{message_id}/event", json=add_event_request.dict())
+        res = app.post(f"/messageexchange/admin/message/{message_id}/event", json=add_event_request.dict())
         assert res.status_code == status.HTTP_200_OK
 
         res = app.get(
@@ -359,3 +359,32 @@ def test_add_message_event(app: TestClient, tmp_path: str):
         )
         messages = res.json().get("messages", [])
         assert messages == [message_id]
+
+
+@pytest.mark.parametrize("root_path", ["/admin/mailbox", "/messageexchange/admin/mailbox"])
+def test_get_mailbox_invalid_mailbox_returns_404(app: TestClient, root_path: str):
+
+    with temp_env_vars(STORE_MODE="canned"):
+
+        res = app.get(f"{root_path}/NotAMailboxId")
+        assert res.status_code == status.HTTP_404_NOT_FOUND
+
+
+@pytest.mark.parametrize("root_path", ["/admin/mailbox", "/messageexchange/admin/mailbox"])
+def test_get_mailbox_happy_path(app: TestClient, root_path: str):
+
+    with temp_env_vars(STORE_MODE="canned"):
+
+        res = app.get(f"{root_path}/{_CANNED_MAILBOX1}")
+        assert res.status_code == status.HTTP_200_OK
+
+        get_mailbox = res.json()
+        assert len(get_mailbox) == 7
+
+        assert get_mailbox["mailbox_id"] == _CANNED_MAILBOX1
+        assert get_mailbox["mailbox_name"] == "TESTMB1"
+        assert get_mailbox["billing_entity"] == "England"
+        assert get_mailbox["ods_code"] == "X26"
+        assert get_mailbox["org_code"] == "X26"
+        assert get_mailbox["org_name"] == ""
+        assert get_mailbox["active"] is True

mesh_sandbox/views/admin.py

@@ -1,7 +1,10 @@
+from __future__ import annotations
+
 from typing import Optional
 
 from pydantic import BaseModel, Field  # pylint: disable=no-name-in-module
 
+from mesh_sandbox.models.mailbox import Mailbox
 from mesh_sandbox.models.message import MessageStatus
 
 
@@ -23,3 +26,25 @@ class AddMessageEventRequest(BaseModel):
     event: str = Field(description="error event (SEND/TRANSFER) etc)", default=None)
     description: str = Field(description="error description", default=None)
     linked_message_id: Optional[str] = Field(description="linked message id", default=None)
+
+
+class MailboxDetails(BaseModel):
+    mailbox_id: str = Field(description="mailbox id")
+    mailbox_name: str = Field(description="mailbox name")
+    billing_entity: Optional[str] = Field(default=None, description="billing entity")
+    ods_code: str = Field(default="", description="ODS code")
+    org_code: str = Field(default="", description="Organisation code")
+    org_name: str = Field(default="", description="Organisation name")
+    active: bool = Field(default=True, description="Mailbox active flag")
+
+    @classmethod
+    def from_mailbox(cls, mailbox: Mailbox) -> MailboxDetails:
+        return cls(
+            mailbox_id=mailbox.mailbox_id,
+            mailbox_name=mailbox.mailbox_name,
+            billing_entity=mailbox.billing_entity,
+            ods_code=mailbox.ods_code,
+            org_code=mailbox.org_code,
+            org_name=mailbox.org_name,
+            active=mailbox.active,
+        )

{mesh_sandbox-1.0.5.dist-info → mesh_sandbox-1.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mesh-sandbox
-Version: 1.0.5
+Version: 1.0.6
 Summary: NHSDigital mesh sandbox, a locally testable version of the MESH api
 License: MIT
 Author: spinecore

{mesh_sandbox-1.0.5.dist-info → mesh_sandbox-1.0.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-mesh_sandbox/__init__.py,sha256=B9kKWJLln1i8LjtkcYecvNWGLTrez4gCUOHtnPlInFo,22
+mesh_sandbox/__init__.py,sha256=mqMuQB3aqJVPrHHqJMLjqiMKUiJjozc7EPLcX5DpKHg,22
 mesh_sandbox/api.py,sha256=F2KUKENAsSe6NAGG0wzHA2jebGF6mWFgta1q55oqacU,3925
 mesh_sandbox/common/__init__.py,sha256=MwKS4FixADUGgN49MQJI7vW0Wx6mnf9SBOPbgE4RddM,3403
 mesh_sandbox/common/constants.py,sha256=_hnaHDkAQGHWLF7n_WfC5ZHIY5D-fUbOdpSqLusUMNY,6504
@@ -10,19 +10,19 @@ mesh_sandbox/common/mex_headers.py,sha256=Eu-ixdVml2obROXggYyUyiS4QZHUA1JUgF7gO4
 mesh_sandbox/conftest.py,sha256=IXrb8Y8Hi4-0ZxDNfTDFI0L1uG1Iz9FBQdNBZtPMsEw,2233
 mesh_sandbox/dependencies.py,sha256=Crl7yEUED-XYl_odMenpvMJoYeIVDROWfvcrfvV85fc,4089
 mesh_sandbox/handlers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mesh_sandbox/handlers/admin.py,sha256=JwPqeN3LHpau0pk7QOEFVrKZ9DV_896j0L_eSZxHIX4,3783
+mesh_sandbox/handlers/admin.py,sha256=5-vdKhx-zDyzu9r0VsXtZucfK0K8bYlBibyj5xYHkEc,4143
 mesh_sandbox/handlers/handshake.py,sha256=p3_NveSscNBgCdIIJhBza34b0WreqgBxZwI2sw7ZMTk,605
 mesh_sandbox/handlers/inbox.py,sha256=J20JUX1dHlS2We2UIDQa1MMoVN_QsRoP0tC-3zKAlD8,15450
 mesh_sandbox/handlers/lookup.py,sha256=p_xmnCJi6BoNqRaQjRAGeQthL5EohQfZ_LA1h0QU36Q,1392
 mesh_sandbox/handlers/outbox.py,sha256=XrLOGhw0QqMTfMFevrh-_Z-EyFSEAQLO1BcmbL1bR0Y,10045
 mesh_sandbox/handlers/tracking.py,sha256=nmn5JexFhAvzFmj9C5l0w4sq8sNz3x-mMd3CsGVrEM4,2356
 mesh_sandbox/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mesh_sandbox/models/mailbox.py,sha256=W1b1R1XjhyiCp30LvTLtQVlxagfxXH8eb0XnNj3D4Dw,993
+mesh_sandbox/models/mailbox.py,sha256=58R6TyH8Qn3k_V3XzWIf5vAseGCmXqQQWFJ8-Tyv2yg,1032
 mesh_sandbox/models/message.py,sha256=ze-IPbCg6XlKZtOL1RWQvMnu04AzrGppwdk2mTyVAfU,4926
 mesh_sandbox/models/workflow.py,sha256=T8A1Q729TOUaz1MOa1Ly8oZs_G4769xMZpTYGF0TlO8,518
 mesh_sandbox/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mesh_sandbox/routers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mesh_sandbox/routers/admin.py,sha256=pJ9rPF-JDWs1dbVbQVqW8uKQrX3yh4oUxswBOnO5zR8,3852
+mesh_sandbox/routers/admin.py,sha256=ZMa6LfdUidHXkNMTtHsWnRvGYAoJ-ac0BKWYbA1AeFY,4560
 mesh_sandbox/routers/handshake.py,sha256=5TVyQ5OrHIe6W3UVpbap-hc5ia669Of6w6F1vgcYjm4,2693
 mesh_sandbox/routers/inbox.py,sha256=EkOmL9pxE6pYPBTzGU1CZJLu80ZR2EnKg9fe7DDMLLQ,8898
 mesh_sandbox/routers/inbox_count.py,sha256=hY88h7dBa6asnvYEP9mmx6CEBw5ZyRO7gz6lHg4Yj3c,1521
@@ -50,7 +50,7 @@ mesh_sandbox/test_plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 mesh_sandbox/test_plugin/example_plugin.py,sha256=MnNpyyWKziqvOr89LeIxOwqskwHcrSsh_te67SeNJr4,967
 mesh_sandbox/test_plugin/example_plugin.txt,sha256=aUePU6UUVhpxeP37Pdz5Zxyn_nxI6HCY3qtQBo1iUEI,24
 mesh_sandbox/tests/__init__.py,sha256=wPjH0Ka1334a0OR9VMUfeYxsr03JqWjHTBnAH_1SB7I,106
-mesh_sandbox/tests/admin.py,sha256=Y_nzBhqSGPCTjG3EczSHClA-mVALGNBd-iOShoYh8WU,14549
+mesh_sandbox/tests/admin.py,sha256=yVD3LRWaLzQMzXysu2GKrO1ZSmwjdIhiVCpCo6xb4oQ,15707
 mesh_sandbox/tests/docker_tests.py,sha256=-dLCnAdgZkpU6tkgO4FwO7Sjvt5zZe45ewBSXo5afT0,1598
 mesh_sandbox/tests/exceptions.py,sha256=j_jKskVzLAYpyu4qNAEY5ahkbk8Uh2Nc_CGpnpdXjnI,740
 mesh_sandbox/tests/handshake.py,sha256=X-fCbwaEAc8cAvvnniCvt4W4DAV9ItPq7tpIpZkfj6M,6259
@@ -64,13 +64,13 @@ mesh_sandbox/tests/messaging_tests.py,sha256=Bup6aJsiJ0xdtg0Ab37ME0VHI6HFJA-0ATm
 mesh_sandbox/tests/outbox.py,sha256=AbQR8vgRy8KAG0RMCU0jYFUXSCPQMrLRJMJTU3PGQhI,20061
 mesh_sandbox/tests/serialisation.py,sha256=kRSMZLDHlX6oRK6c2OCZL0XQoUCKQxqcYXrJWbc9VkA,663
 mesh_sandbox/views/__init__.py,sha256=nZkb6_1S8jz8Xl_AayfwjgEZG0JD2dfulfGxjJ5W9Ec,1237
-mesh_sandbox/views/admin.py,sha256=2YGslfDyC0QKoq3WTGXBicqrOMR9UmQYocP3R0qTbAY,1315
+mesh_sandbox/views/admin.py,sha256=gisfIpNezpnabbs-0jXDLGTdzetq8Age6KsK8dxOkCQ,2314
 mesh_sandbox/views/error.py,sha256=9lnUr3P93Vm-nOrBTEuAD6nrSBUvpI6-XqXzILWjgGk,3885
 mesh_sandbox/views/inbox.py,sha256=gnaD9Csx5BqilVRefQQ_tXmeq80lwcLJfepW005GrkU,5662
 mesh_sandbox/views/lookup.py,sha256=HHUqZ-Iy22ysC3qaO8Bl5GBQqf_7IiBbe5acyxqS78M,2775
 mesh_sandbox/views/outbox.py,sha256=jxYiHylEdpljZ6Wl45Ke3aaH5rEKb-kzUuCNEKDS3So,4932
 mesh_sandbox/views/tracking.py,sha256=1H7Ghcvqkmx__KS1Y-lm105EVx_Z1eJo3oMDh8pzRMQ,8918
-mesh_sandbox-1.0.5.dist-info/LICENSE,sha256=usgzIvDUpVX5pYZepJTRXQJqIaz0mdd32GuS5a3PFlY,1051
-mesh_sandbox-1.0.5.dist-info/METADATA,sha256=yP1kTIaacLRi87NEWBDfZKAM_dENdkCnBobL57T2QWE,2388
-mesh_sandbox-1.0.5.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-mesh_sandbox-1.0.5.dist-info/RECORD,,
+mesh_sandbox-1.0.6.dist-info/LICENSE,sha256=usgzIvDUpVX5pYZepJTRXQJqIaz0mdd32GuS5a3PFlY,1051
+mesh_sandbox-1.0.6.dist-info/METADATA,sha256=ZkSLOqdSsSUAond5nH90Bqz2X_EFaGnd8Ahp83igHlk,2388
+mesh_sandbox-1.0.6.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+mesh_sandbox-1.0.6.dist-info/RECORD,,