Merge branch 'main' into dc_demo_local_ngrok

Author: ianco

acapy_agent/protocols/out_of_band/v1_0/manager.py

@@ -1172,6 +1172,19 @@ async def delete_stale_connection_by_invitation(self, invi_msg_id: str):
             for conn_rec in conn_records:
                 await conn_rec.delete_record(session)
 
+    async def fetch_oob_invitation_record_by_id(self, oob_id: str) -> OobRecord:
+        """Fetch oob_record associated with an oob_id."""
+        async with self.profile.session() as session:
+            oob_record = await OobRecord.retrieve_by_id(
+                session,
+                record_id=oob_id,
+            )
+
+        if not oob_record:
+            raise StorageNotFoundError(f"No record found with oob_id {oob_id}")
+
+        return oob_record
+
     async def delete_conn_and_oob_record_invitation(self, invi_msg_id: str):
         """Delete conn_record and oob_record associated with an invi_msg_id."""
         async with self.profile.session() as session:
@@ -1180,7 +1193,6 @@ async def delete_conn_and_oob_record_invitation(self, invi_msg_id: str):
                 tag_filter={
                     "invitation_msg_id": invi_msg_id,
                 },
-                post_filter_positive={},
             )
             for conn_rec in conn_records:
                 await conn_rec.delete_record(session)
@@ -1189,7 +1201,6 @@ async def delete_conn_and_oob_record_invitation(self, invi_msg_id: str):
                 tag_filter={
                     "invi_msg_id": invi_msg_id,
                 },
-                post_filter_positive={},
             )
             for oob_rec in oob_records:
                 await oob_rec.delete_record(session)

acapy_agent/protocols/out_of_band/v1_0/routes.py

@@ -35,6 +35,16 @@ class OutOfBandModuleResponseSchema(OpenAPISchema):
     """Response schema for Out of Band Module."""
 
 
+class OobIdQueryStringSchema(OpenAPISchema):
+    """Parameters and validators for fetch invitation request query string."""
+
+    oob_id = fields.Str(
+        required=True,
+        validate=UUID4_VALIDATE,
+        metadata={"description": "The Out of Band id to fetch"},
+    )
+
+
 class InvitationCreateQueryStringSchema(OpenAPISchema):
     """Parameters and validators for create invitation request query string."""
 
@@ -217,6 +227,45 @@ class InvitationRecordMatchInfoSchema(OpenAPISchema):
     )
 
 
+class OobInvitationRecordMatchInfoSchema(OpenAPISchema):
+    """Path parameters and validators for request taking invitation record."""
+
+    oob_id = fields.Str(
+        required=True,
+        validate=UUID4_VALIDATE,
+        metadata={
+            "description": "OOB Invitation identifier",
+            "example": UUID4_EXAMPLE,
+        },
+    )
+
+
+@docs(tags=["out-of-band"], summary="Fetch an existing Out-of-Band invitation.")
+@querystring_schema(OobIdQueryStringSchema())
+@response_schema(InvitationRecordResponseSchema(), description="")
+@tenant_authentication
+async def invitation_fetch(request: web.BaseRequest):
+    """Request handler for fetching an invitation.
+
+    Args:
+        request: aiohttp request object
+
+    """
+    context: AdminRequestContext = request["context"]
+    profile = context.profile
+    oob_mgr = OutOfBandManager(profile)
+    try:
+        record = await oob_mgr.fetch_oob_invitation_record_by_id(
+            request.query.get("oob_id")
+        )
+    except StorageNotFoundError as err:
+        raise web.HTTPNotFound(reason=err.roll_up) from err
+    except StorageError as err:
+        raise web.HTTPBadRequest(reason=err.roll_up) from err
+
+    return web.json_response(record.serialize())
+
+
 @docs(
     tags=["out-of-band"],
     summary="Create a new connection invitation",
@@ -365,6 +414,11 @@ async def register(app: web.Application):
         [
             web.post("/out-of-band/create-invitation", invitation_create),
             web.post("/out-of-band/receive-invitation", invitation_receive),
+            web.get(
+                "/out-of-band/invitations",
+                invitation_fetch,
+                allow_head=False,
+            ),
             web.delete("/out-of-band/invitations/{invi_msg_id}", invitation_remove),
         ]
     )

acapy_agent/protocols/out_of_band/v1_0/tests/test_manager.py

@@ -1886,3 +1886,36 @@ async def test_delete_conn_and_oob_record_invitation(self):
             await self.manager.delete_conn_and_oob_record_invitation("test123")
             mock_connrecord_delete.assert_called_once()
             mock_oobrecord_delete.assert_called_once()
+
+    async def test_fetch_invitation_succeeds(self):
+        self.profile.context.update_settings({"public_invites": True})
+
+        with mock.patch.object(
+            AskarWallet, "get_public_did", autospec=True
+        ) as mock_wallet_get_public_did:
+            mock_wallet_get_public_did.return_value = DIDInfo(
+                TestConfig.test_did,
+                TestConfig.test_verkey,
+                None,
+                method=SOV,
+                key_type=ED25519,
+            )
+            invi_rec = await self.manager.create_invitation(
+                my_endpoint=TestConfig.test_endpoint,
+                public=True,
+                hs_protos=[HSProto.RFC23],
+            )
+
+            invi_rec = await self.manager.fetch_oob_invitation_record_by_id(
+                oob_id=invi_rec.oob_id
+            )
+
+            assert invi_rec.invitation._type == DIDCommPrefix.qualify_current(
+                self.TEST_INVI_MESSAGE_TYPE
+            )
+            assert not invi_rec.invitation.requests_attach
+            assert (
+                DIDCommPrefix.qualify_current(HSProto.RFC23.name)
+                in invi_rec.invitation.handshake_protocols
+            )
+            assert invi_rec.invitation.services == [f"did:sov:{TestConfig.test_did}"]

acapy_agent/protocols/out_of_band/v1_0/tests/test_routes.py

@@ -75,6 +75,27 @@ async def test_invitation_create(self):
             )
             mock_json_response.assert_called_once_with({"abc": "123"})
 
+    async def test_invitation_fetch(self):
+        self.request.query = {"oob_id": "dummy"}
+
+        with (
+            mock.patch.object(
+                test_module, "OutOfBandManager", autospec=True
+            ) as mock_oob_mgr,
+            mock.patch.object(
+                test_module.web, "json_response", mock.Mock()
+            ) as mock_json_response,
+        ):
+            mock_oob_mgr.return_value.fetch_oob_invitation_record_by_id = (
+                mock.CoroutineMock(
+                    return_value=mock.MagicMock(
+                        serialize=mock.MagicMock(return_value={"abc": "123"})
+                    )
+                )
+            )
+            await test_module.invitation_fetch(self.request)
+            mock_json_response.assert_called_once_with({"abc": "123"})
+
     async def test_invitation_remove(self):
         self.request.match_info = {"invi_msg_id": "dummy"}