aboutsummaryrefslogtreecommitdiffstats
path: root/python/fatcat_tools/importers/orcid.py
blob: 430cdd0f4a4d2746a1caedad34dbcf45e3e656e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
import sys
from typing import Any, Dict, List, Optional

import fatcat_openapi_client
from fatcat_openapi_client import ApiClient, CreatorEntity

from .common import EntityImporter, clean


def value_or_none(e: Any) -> Any:
    if type(e) == dict:
        e = e.get("value")
    if type(e) == str and len(e) == 0:
        e = None
    # TODO: this is probably bogus; patched in desperation; remove?
    if e:
        try:
            e.encode()
        except UnicodeEncodeError:
            # Invalid JSON?
            print("BAD UNICODE")
            return None
    return e


class OrcidImporter(EntityImporter):
    def __init__(self, api: ApiClient, **kwargs) -> None:

        eg_desc = kwargs.get(
            "editgroup_description",
            "Automated import of ORCID metadata, from official bulk releases.",
        )
        eg_extra = kwargs.get("editgroup_extra", dict())
        eg_extra["agent"] = eg_extra.get("agent", "fatcat_tools.OrcidImporter")
        super().__init__(api, editgroup_description=eg_desc, editgroup_extra=eg_extra, **kwargs)

    def want(self, raw_record: Any) -> bool:
        return True

    def parse_record(self, obj: Dict[str, Any]) -> Optional[CreatorEntity]:
        """
        obj is a python dict (parsed from json).
        returns a CreatorEntity
        """

        if "person" not in obj:
            return False

        name = obj["person"]["name"]
        if not name:
            return None
        extra = None
        given = value_or_none(name.get("given-names"))
        sur = value_or_none(name.get("family-name"))
        display = value_or_none(name.get("credit-name"))
        if display is None:
            # TODO: sorry human beings
            if given and sur:
                display = "{} {}".format(given, sur)
            elif sur:
                display = sur
            elif given:
                display = given
        orcid = obj["orcid-identifier"]["path"]
        if not self.is_orcid(orcid):
            sys.stderr.write("Bad ORCID: {}\n".format(orcid))
            return None
        display = clean(display)
        if not display:
            # must have *some* name
            return None
        ce = CreatorEntity(
            orcid=orcid,
            given_name=clean(given),
            surname=clean(sur),
            display_name=display,
            extra=extra,
        )
        return ce

    def try_update(self, ce: CreatorEntity) -> bool:
        existing = None
        try:
            existing = self.api.lookup_creator(orcid=ce.orcid)
        except fatcat_openapi_client.rest.ApiException as err:
            if err.status != 404:
                raise err

        # eventually we'll want to support "updates", but for now just skip if
        # entity already exists
        if existing:
            self.counts["exists"] += 1
            return False

        return True

    def insert_batch(self, batch: List[CreatorEntity]) -> None:
        self.api.create_creator_auto_batch(
            fatcat_openapi_client.CreatorAutoBatch(
                editgroup=fatcat_openapi_client.Editgroup(
                    description=self.editgroup_description, extra=self.editgroup_extra
                ),
                entity_list=batch,
            )
        )