datamodel: use dict for identifiers field

inveniosoftware · Mar 16, 2020 · f799282 · f799282
1 parent f113b09
commit f799282
Show file tree

Hide file tree

Showing 4 changed files with 134 additions and 118 deletions.
diff --git a/invenio_rdm_records/cli.py b/invenio_rdm_records/cli.py
@@ -47,20 +47,16 @@ def create_fake_record():
             "type": "image",
             "subtype": "photo"
         },
-        "identifiers": [{
-            "identifier": "10.9999/rdm.9999999",
-            "scheme": "DOI"
-        }, {
-            "identifier": "9999.99999",
-            "scheme": "arXiv"
-        }],
+        "identifiers": {
+            "DOI": "10.9999/rdm.9999999",
+            "arXiv": "9999.99999",
+        },
         "creators": [{
             "name": fake.name(),
             "type": "Personal",
-            "identifiers": [{
-                "identifier": "9999-9999-9999-9999",
-                "scheme": "Orcid"
-            }],
+            "identifiers": {
+                "Orcid": "9999-9999-9999-9999",
+            },
             "affiliations": [{
                 "name": fake.company(),
                 "identifier": "entity-one",
@@ -81,10 +77,9 @@ def create_fake_record():
         "contributors": [{
             "name": fake.name(),
             "type": "Personal",
-            "identifiers": [{
-                "identifier": "9999-9999-9999-9998",
-                "scheme": "Orcid"
-            }],
+            "identifiers": {
+                "Orcid": "9999-9999-9999-9998",
+            },
             "affiliations": [{
                 "name": fake.company(),
                 "identifier": "entity-one",

diff --git a/invenio_rdm_records/marshmallow/json.py b/invenio_rdm_records/marshmallow/json.py
@@ -28,11 +28,32 @@ class CommunitySchemaV1(BaseSchema):
     secondary = fields.List(SanitizedUnicode())
 
 
-class IdentifierSchemaV1(BaseSchema):
-    """Extra/Alternate identifiers of the record."""
+# 'Fake' Identifiers Field
+def _not_blank(error_msg):
+    """Returns a non-blank validation rule with custom error message."""
+    return validate.Length(min=1, error=error_msg)
 
-    identifier = SanitizedUnicode(required=True)
-    scheme = SanitizedUnicode(required=True)
+
+def Identifiers():
+    """Returns a "fake" Identifiers field.
+
+    Field expects:
+
+        "<scheme1>": "<identifier1>",
+        ...
+        "<schemeN>": "<identifierN>"
+    """
+    return fields.Dict(
+        # scheme
+        keys=SanitizedUnicode(
+            required=True, validate=_not_blank(_('Scheme cannot be blank.'))
+        ),
+        # identifier
+        values=SanitizedUnicode(
+            required=True,
+            validate=_not_blank(_('Identifier cannot be blank.'))
+        )
+    )
 
 
 class AffiliationSchemaV1(BaseSchema):
@@ -61,7 +82,7 @@ class CreatorSchemaV1(BaseSchema):
             ))
     given_name = SanitizedUnicode()
     family_name = SanitizedUnicode()
-    identifiers = fields.List(fields.Nested(IdentifierSchemaV1))
+    identifiers = Identifiers()
     affiliations = fields.List(fields.Nested(AffiliationSchemaV1))
 
 
@@ -379,8 +400,7 @@ class MetadataSchemaV1(BaseSchema):
     _contact = SanitizedUnicode(data_key="contact", attribute="contact")
 
     # Metadata fields
-    identifiers = fields.List(fields.Nested(IdentifierSchemaV1),
-                              required=True)  # TODO: not required
+    identifiers = Identifiers()
     creators = fields.List(Nested(CreatorSchemaV1), required=True)
     titles = fields.List(fields.Nested(TitleSchemaV1), required=True)
     resource_type = fields.Nested(ResourceTypeSchemaV1, required=True)

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -95,23 +95,19 @@ def full_record():
             "type": "image",
             "subtype": "photo"
         },
-        "identifiers": [{
-            "identifier": "10.5281/zenodo.9999999",
-            "scheme": "DOI"
-        }, {
-            "identifier": "9999.99999",
-            "scheme": "arXiv"
-        }],
+        "identifiers": {
+            "DOI": "10.5281/zenodo.9999999",
+            "arXiv": "9999.99999"
+        },
         "creators": [
             {
                 "name": "Julio Cesar",
                 "type": "Personal",
                 "given_name": "Julio",
                 "family_name": "Cesar",
-                "identifiers": [{
-                    "identifier": "9999-9999-9999-9999",
-                    "scheme": "Orcid"
-                }],
+                "identifiers": {
+                    "Orcid": "9999-9999-9999-9999"
+                },
                 "affiliations": [{
                     "name": "Entity One",
                     "identifier": "entity-one",
@@ -121,10 +117,9 @@ def full_record():
             {
                 "name": "California Digital Library",
                 "type": "Organizational",
-                "identifiers": [{
-                    "identifier": "03yrm5c26",
-                    "scheme": "ROR"
-                }]
+                "identifiers": {
+                    "ROR": "03yrm5c26",
+                }
             }
         ],
         "titles": [{
@@ -143,10 +138,9 @@ def full_record():
             "type": "Personal",
             "given_name": "Maximo",
             "family_name": "Decimo Meridio",
-            "identifiers": [{
-                "identifier": "9999-9999-9999-9998",
-                "scheme": "Orcid"
-            }],
+            "identifiers": {
+                "Orcid": "9999-9999-9999-9998",
+            },
             "affiliations": [{
                 "name": "Entity One",
                 "identifier": "entity-one",
@@ -218,13 +212,6 @@ def minimal_record():
             "type": "image",
             "subtype": "photo"
         },
-        "identifiers": [{
-            "identifier": "10.5281/zenodo.9999999",
-            "scheme": "DOI"
-        }, {
-            "identifier": "9999.99999",
-            "scheme": "arXiv"
-        }],
         # Technically not required
         "creators": [],
         "titles": [{