Merge pull request hyperledger#73 from Indicio-tech/feature/credentia…

…l-attachments-issuer

Add supplements and attachments to cred issue message

aries_cloudagent/messaging/agent_message.py

@@ -1,7 +1,7 @@
 """Agent message base class and schema."""
 
 from collections import OrderedDict
-from typing import Mapping, Union
+from typing import Mapping, Type, TypeVar, Union
 import uuid
 
 from marshmallow import (
@@ -43,6 +43,9 @@ class AgentMessageError(BaseModelError):
     """Base exception for agent message issues."""
 
 
+MessageType = TypeVar("MessageType", bound="AgentMessage")
+
+
 class AgentMessage(BaseModel, BaseMessage):
     """Agent message base class."""
 
@@ -418,8 +421,11 @@ def serialize(self, msg_format: DIDCommVersion = DIDCommVersion.v1, **kwargs):
 
     @classmethod
     def deserialize(
-        cls, value: dict, msg_format: DIDCommVersion = DIDCommVersion.v1, **kwargs
-    ):
+        cls: Type[MessageType],
+        value: dict,
+        msg_format: DIDCommVersion = DIDCommVersion.v1,
+        **kwargs,
+    ) -> MessageType:
         """Return message object deserialized from value in format specified."""
         if msg_format is DIDCommVersion.v2:
             raise NotImplementedError("DIDComm v2 is not yet supported")

aries_cloudagent/messaging/models/base.py

@@ -5,7 +5,7 @@
 
 from abc import ABC
 from collections import namedtuple
-from typing import Mapping, Union
+from typing import Mapping, Type, TypeVar, Union
 
 from marshmallow import Schema, post_dump, pre_load, post_load, ValidationError, EXCLUDE
 
@@ -70,6 +70,9 @@ class BaseModelError(BaseError):
     """Base exception class for base model errors."""
 
 
+ModelType = TypeVar("ModelType", bound="BaseModel")
+
+
 class BaseModel(ABC):
     """Base model that provides convenience methods."""
 
@@ -116,7 +119,9 @@ def Schema(self) -> type:
         return self._get_schema_class()
 
     @classmethod
-    def deserialize(cls, obj, unknown: str = None, none2none: str = False):
+    def deserialize(
+        cls: Type[ModelType], obj, unknown: str = None, none2none: str = False
+    ) -> ModelType:
         """
         Convert from JSON representation to a model instance.
 

aries_cloudagent/protocols/issue_credential/v2_0/messages/cred_issue.py

@@ -1,6 +1,6 @@
 """Credential issue message."""
 
-from typing import Sequence
+from typing import Optional, Sequence
 
 from marshmallow import EXCLUDE, fields, validates_schema, ValidationError
 
@@ -14,6 +14,7 @@
 from ..message_types import CRED_20_ISSUE, PROTOCOL_PACKAGE
 
 from .cred_format import V20CredFormat, V20CredFormatSchema
+from .inner.supplement import Supplement, SupplementSchema
 
 HANDLER_CLASS = f"{PROTOCOL_PACKAGE}.handlers.cred_issue_handler.V20CredIssueHandler"
 
@@ -30,12 +31,14 @@ class Meta:
 
     def __init__(
         self,
-        _id: str = None,
+        _id: Optional[str] = None,
         *,
-        replacement_id: str = None,
-        comment: str = None,
-        formats: Sequence[V20CredFormat] = None,
-        credentials_attach: Sequence[AttachDecorator] = None,
+        replacement_id: Optional[str] = None,
+        comment: Optional[str] = None,
+        formats: Optional[Sequence[V20CredFormat]] = None,
+        credentials_attach: Optional[Sequence[AttachDecorator]] = None,
+        supplements: Optional[Sequence[Supplement]] = None,
+        attachments: Optional[Sequence[AttachDecorator]] = None,
         **kwargs,
     ):
         """
@@ -53,6 +56,8 @@ def __init__(
         self.comment = comment
         self.formats = list(formats) if formats else []
         self.credentials_attach = list(credentials_attach) if credentials_attach else []
+        self.supplements = supplements or []
+        self.attachments = attachments or []
 
     def attachment(self, fmt: V20CredFormat.Format = None) -> dict:
         """
@@ -111,6 +116,19 @@ class Meta:
         data_key="credentials~attach",
         description="Credential attachments",
     )
+    supplements = fields.Nested(
+        SupplementSchema,
+        description="Supplements to the credential",
+        many=True,
+        required=False,
+    )
+    attachments = fields.Nested(
+        AttachDecoratorSchema,
+        many=True,
+        required=False,
+        description="Attachments of other data associated with the credential",
+        data_key="~attach",
+    )
 
     @validates_schema
     def validate_fields(self, data, **kwargs):

aries_cloudagent/protocols/issue_credential/v2_0/messages/tests/test_cred_issue.py

@@ -1,6 +1,10 @@
+from uuid import uuid4
 from asynctest import mock as async_mock, TestCase as AsyncTestCase
 
-from ......messaging.decorators.attach_decorator import AttachDecorator
+from ......messaging.decorators.attach_decorator import (
+    AttachDecorator,
+    AttachDecoratorData,
+)
 from ......messaging.models.base import BaseModelError
 
 from .....didcomm_prefix import DIDCommPrefix
@@ -10,6 +14,7 @@
 from .. import cred_issue as test_module
 from ..cred_format import V20CredFormat
 from ..cred_issue import V20CredIssue
+from ..inner.supplement import Supplement, SupplementAttribute
 
 
 class TestV20CredIssue(AsyncTestCase):
@@ -70,6 +75,10 @@ class TestV20CredIssue(AsyncTestCase):
         },
     }
 
+    ATTACHMENT = AttachDecorator(
+        ident=str(uuid4()), data=AttachDecoratorData(json_={"test": "value"})
+    )
+
     CRED_ISSUE = V20CredIssue(
         replacement_id="0",
         comment="Test",
@@ -85,6 +94,14 @@ class TestV20CredIssue(AsyncTestCase):
                 ident="indy",
             )
         ],
+        supplements=[
+            Supplement(
+                type="hashlink-data",
+                ref=ATTACHMENT.ident,
+                attrs=[SupplementAttribute(key="field", value="legalName")],
+            )
+        ],
+        attachments=[ATTACHMENT],
     )
 
     async def test_init_type(self):
@@ -119,8 +136,17 @@ async def test_deserialize(self):
         """Test deserialization."""
         obj = TestV20CredIssue.CRED_ISSUE.serialize()
 
+        assert obj["~attach"]
+        assert obj["~attach"][0]["@id"] == TestV20CredIssue.ATTACHMENT.ident
+
+        assert obj["supplements"]
+        assert obj["supplements"][0]["ref"] == TestV20CredIssue.ATTACHMENT.ident
+
         cred_issue = V20CredIssue.deserialize(obj)
         assert type(cred_issue) == V20CredIssue
+        assert isinstance(cred_issue.attachments, list)
+        assert cred_issue.attachments
+        assert isinstance(cred_issue.attachments[0], AttachDecorator)
 
         obj["credentials~attach"][0]["data"]["base64"] = "eyJub3QiOiAiaW5keSJ9"
         with self.assertRaises(BaseModelError):