Merge pull request #6 from DavidFichtmueller/main

Added support for ORCID search

README.md

@@ -126,7 +126,13 @@ for key, value in works_data.items():
 # Generate a markdown file with the summary of various section's data
 orcid.generate_markdown_file(output_file = "md_generator_example.md")
 ```
-
+#### Searching ORCID records
+```python
+from pyorcid import OrcidSearch
+#search through ORCID records, for details on the query format see https://info.orcid.org/documentation/api-tutorials/api-tutorial-searching-the-orcid-registry/  
+orcidSearch = OrcidSearch(orcid_access_token=access_token)
+orcidSearch.search("John Smith")
+```
 ## Access through OrcidScrapper feature of PyOrcid
 This is an alternative to Orcid API. You can only read the orcid profiles on public database. All you need is the Orcid ID of the researchers you wish to retrieve.
 OrcidScrapper can access all methods of Orcid class as it is inherited from it.

src/pyorcid/__init__.py

@@ -1,3 +1,4 @@
 from .orcid import Orcid
 from .orcid_authentication import OrcidAuthentication
-from .orcid_scrapper import OrcidScrapper
+from .orcid_scrapper import OrcidScrapper
+from .orcid_search import OrcidSearch

src/pyorcid/orcid.py

@@ -13,6 +13,7 @@ def __init__(self,orcid_id, orcid_access_token = " ", state="public", sandbox=Fa
         orcid_id : Orcid ID of the user
         orcid_access_token : Orcid access token obtained from the user with this orcid_id
         state  : Whether to use public or member API of ORCID
+        sandbox : a boolean value to show if the ORCID sandbox API should be used (default: False)
         '''
         self._orcid_id = orcid_id
         self._orcid_access_token = orcid_access_token

src/pyorcid/orcid_authentication.py

@@ -15,7 +15,7 @@ def __init__(self, client_id, client_secret, redirect_uri="", sandbox=False):
         client_id : str : client id obtained from the registered application
         client_secret : str : client secret obtained from the registered application
         redirect_uri : str : redirect uri obtained from the registered application
-        sandbox : str : a boolean value to show if the ORCID sandbox API should be used (default: False)
+        sandbox : bool : a boolean value to show if the ORCID sandbox API should be used (default: False)
 
         '''
         self.__client_id = client_id

src/pyorcid/orcid_search.py

@@ -0,0 +1,162 @@
+import requests
+import os
+from urllib import parse
+
+class OrcidSearch():
+    '''
+    This is a wrapper class for ORCID Search API
+    '''
+    def __init__(self, orcid_access_token = " ", state = "public", sandbox=False) -> None:
+        '''
+        Initialize orcid search instance
+        state  : Whether to use public or member API of ORCID
+        orcid_access_token : Orcid access token obtained from the user with this orcid_id (default: "public")
+        sandbox : bool : a boolean value to show if the ORCID sandbox API should be used (default: False)
+        '''
+        self._orcid_access_token = orcid_access_token
+        self._state = state
+        self._sandbox = sandbox
+        # For testing purposes (pytesting on github workflow)
+        if orcid_access_token != " ":
+            try:
+                self.__is_access_token_valid()
+            except:
+                if not self.__test_is_access_token_valid():
+                    raise ValueError(
+                        f"Invalid access token! Please make sure the provided credentials are correct.")
+
+        return
+
+    def search(self, query, start = 0, rows = 1000, search_mode = "expanded-search", columns = "orcid,given-names,family-name,current-institution-affiliation-name"):
+        '''
+        Search orcid records
+        for details on the query format see https://info.orcid.org/documentation/api-tutorials/api-tutorial-searching-the-orcid-registry/
+
+        query       : the search query
+        start       : the offset for the paginated search, default = 0
+        rows        : the number of rows to be returned, default = 1000
+        search_mode : the search mode, either "expanded-search" (default), "search", or "csv-search"
+        columns     : for the csv-search, default: "orcid,given-names,family-name,current-institution-affiliation-name"
+        return      : a dictionary of search results
+        '''
+
+        access_token = self._orcid_access_token
+
+
+        _search_mode = "expanded-search"
+        if search_mode == "search" or search_mode == "csv-search":
+            _search_mode = search_mode
+        _columns = columns
+        query_encoded = parse.quote_plus(query)
+
+        api_url = ""
+
+        if self._state == "public":
+            # Specify the ORCID record endpoint for the desired ORCID iD
+            api_url = f'https://pub.orcid.org/'
+            if (self._sandbox):
+                api_url = f'https://pub.sandbox.orcid.org/'  # for testing
+
+        elif self._state == "member":
+            api_url = f'https://api.orcid.org/'
+            if (self._sandbox):
+                api_url = f'https://api.sandbox.orcid.org/'  # for testing
+
+        api_url = api_url + f'v3.0/{_search_mode}/?q={query_encoded}&start={start}&rows={rows}'
+
+        content_type = 'application/json'
+        if search_mode == "csv-search":
+            api_url = api_url + f'&fl={columns}'
+            content_type = "text/csv"
+
+        # Set the headers with the access token for authentication
+        headers = {
+            'Authorization': f'Bearer {access_token}',
+            'Content-Type': f'{content_type}'
+        }
+
+        #print(api_url)
+
+        # Make a GET request to retrieve the ORCID record
+        response = requests.get(api_url, headers=headers)
+
+        # The request was successful
+        data = response.json()
+        # Check the response status code
+        if response.status_code == 200 or data is not None:
+            return data
+        else:
+            # Handle the case where the request failed
+            print("Failed to retrieve ORCID search results. Status code:", response.status_code)
+            return None
+    def __is_access_token_valid(self):
+        '''
+        Checks if the current access token is valid
+        '''
+        access_token = self._orcid_access_token
+
+        if access_token == "":
+            raise ValueError(
+                "Empty value for access token! Please make sure you are authenticated by ORCID as developer.")
+        # Make a test request to the API using the token
+        headers = {
+            'Authorization': f'Bearer {access_token}',
+            'Content-Type': 'application/json'
+        }
+
+        api_url = ""
+
+        if self._state == "public":
+            # Specify the ORCID record endpoint for the desired ORCID iD
+            api_url = f'https://pub.orcid.org/v3.0/search'
+            if (self._sandbox):
+                api_url = f'https://pub.sandbox.orcid.org/v3.0/search'  # for testing
+
+        elif self._state == "member":
+            api_url = f'https://api.orcid.org/v3.0/search'
+            if (self._sandbox):
+                api_url = f'https://api.sandbox.orcid.org/v3.0/search'  # for testing
+
+        response = requests.get(api_url, headers=headers)
+
+        if response.status_code == 404:
+            # The request was successful, and the token is likely valid
+            return False
+        else:
+            # The request failed, indicating that the token may have expired or is invalid
+            return True
+
+        ## THESE FUNCTIONS ARE FOR TESTING PURPOSES ##
+
+    def __test_is_access_token_valid(self):
+        '''
+        FOR TESTING PURPOSES ONLY
+        Checks if the current access token is valid
+        '''
+        # Access the environment variable from github secrets
+        access_token = os.environ["ORCID_ACCESS_TOKEN"]
+        if access_token == "":
+            raise ValueError(
+                "Empty value for access token! Please make sure you are authenticated by ORCID as developer.")
+        # Make a test request to the API using the token
+        headers = {
+            'Authorization': f'Bearer {access_token}',
+            'Content-Type': 'application/json'
+        }
+
+        api_url = ""
+
+        if self._state == "public":
+            # Specify the ORCID record endpoint for the desired ORCID iD
+            api_url = f'https://pub.sandbox.orcid.org/v3.0/search'
+
+        elif self._state == "member":
+            api_url = f'https://api.sandbox.orcid.org/v3.0/search'
+
+        response = requests.get(api_url, headers=headers)
+        if response.status_code == 404:
+            # The request was successful, and the token is likely valid
+            return False
+        else:
+            # The request failed, indicating that the token may have expired or is invalid
+            return True