Add ORCID to DocMaps (#287)

* edited typing to add ORCID

* added ORCID to actor

* updated regression test data by adding orcid

Author: HazalCiplak

data/docmaps/regression_test/docmap_by_manuscript_id/104779.json

@@ -202,6 +202,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0001-7119-9350",
                                 "name": "Kristine Krug",
                                 "firstName": "Kristine",
                                 "surname": "Krug",

data/docmaps/regression_test/docmap_by_manuscript_id/87198.json

@@ -142,6 +142,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0002-1228-5221",
                                 "name": "David Paz-Garcia",
                                 "firstName": "David",
                                 "_middleName": "A.",
@@ -158,6 +159,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0002-5369-9009",
                                 "name": "Molly Przeworski",
                                 "firstName": "Molly",
                                 "surname": "Przeworski",
@@ -431,6 +433,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0002-1228-5221",
                                 "name": "David Paz-Garcia",
                                 "firstName": "David",
                                 "_middleName": "A.",

data/docmaps/regression_test/docmap_by_manuscript_id/88266.json

@@ -142,6 +142,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0001-6699-259X",
                                 "name": "Arya Mani",
                                 "firstName": "Arya",
                                 "surname": "Mani",
@@ -437,6 +438,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0001-6699-259X",
                                 "name": "Arya Mani",
                                 "firstName": "Arya",
                                 "surname": "Mani",

data/docmaps/regression_test/docmap_by_manuscript_id/95285.json

@@ -142,6 +142,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0002-9570-2544",
                                 "name": "Jungsan Sohn",
                                 "firstName": "Jungsan",
                                 "surname": "Sohn",
@@ -388,6 +389,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0002-9570-2544",
                                 "name": "Jungsan Sohn",
                                 "firstName": "Jungsan",
                                 "surname": "Sohn",
@@ -686,6 +688,7 @@
                         {
                             "actor": {
                                 "type": "person",
+                                "id": "https://orcid.org/0000-0002-9570-2544",
                                 "name": "Jungsan Sohn",
                                 "firstName": "Jungsan",
                                 "surname": "Sohn",

data_hub_api/docmaps/v2/api_input_typing.py

@@ -24,7 +24,8 @@
         'first_name': str,
         'middle_name': Optional[str],
         'last_name': str,
-        'city': Optional[str]
+        'city': Optional[str],
+        'ORCID': Optional[str]
     }
 )
 

data_hub_api/docmaps/v2/codecs/evaluation.py

@@ -201,6 +201,7 @@ def get_docmap_actor_for_evaluation_summary_type(
 ) -> DocmapEditorActor:
     return {
         'type': 'person',
+        'id': ('https://orcid.org/' + editor_detail['ORCID'] if editor_detail['ORCID'] else None),
         'name': editor_detail['name'],
         'firstName': editor_detail['first_name'],
         '_middleName': (editor_detail['middle_name'] if editor_detail['middle_name'] else None),

data_hub_api/docmaps/v2/docmap_typing.py

@@ -119,6 +119,7 @@
     'DocmapEditorActor',
     {
         'type': str,
+        'id': Optional[str],
         'name': str,
         'firstName': str,
         '_middleName': Optional[str],

tests/unit_tests/docmaps/v2/codecs/evaluation_test.py

@@ -312,8 +312,9 @@ def test_should_populate_participants_with_and_given_reviewing_editor_detail_(se
         )
         assert result == {
             'actor': {
-                'name': 'editor_name_1',
                 'type': 'person',
+                'id': 'https://orcid.org/orcid_1',
+                'name': 'editor_name_1',
                 'firstName': 'editor_first_name_1',
                 '_middleName': 'editor_middle_name_1',
                 'surname': 'editor_last_name_1',
@@ -323,10 +324,11 @@ def test_should_populate_participants_with_and_given_reviewing_editor_detail_(se
             'role': 'editor'
         }
 
-    def test_should_return_none_for_middle_name_if_not_defined(self):
+    def test_should_return_none_for_middle_name_or_id_if_they_not_defined(self):
         editor_detail_dict = {
             **EDITOR_DETAIL_1,
-            'middle_name': None
+            'middle_name': None,
+            'ORCID': None
         }
         role = 'editor'
         result = get_docmap_evaluation_participants_for_evaluation_summary_type(
@@ -335,8 +337,9 @@ def test_should_return_none_for_middle_name_if_not_defined(self):
         )
         assert result == {
             'actor': {
-                'name': 'editor_name_1',
                 'type': 'person',
+                'id': None,
+                'name': 'editor_name_1',
                 'firstName': 'editor_first_name_1',
                 '_middleName': None,
                 'surname': 'editor_last_name_1',

tests/unit_tests/docmaps/v2/test_data.py

@@ -294,7 +294,8 @@
     'first_name': 'editor_first_name_1',
     'middle_name': 'editor_middle_name_1',
     'last_name': 'editor_last_name_1',
-    'city': 'editor_city_1'
+    'city': 'editor_city_1',
+    'ORCID': 'orcid_1'
 }
 
 SENIOR_EDITOR_DETAIL_1: ApiEditorDetailInput = {
@@ -305,5 +306,6 @@
     'first_name': 'senior_editor_first_name_1',
     'middle_name': 'senior_editor_middle_name_1',
     'last_name': 'senior_editor_last_name_1',
-    'city': 'senior_editor_city_1'
+    'city': 'senior_editor_city_1',
+    'ORCID': 'orcid_1'
 }