Merge pull request #14 from Princeton-CDH/release/0.4

Release/0.4

Author: blms

CHANGELOG.rst

@@ -3,6 +3,12 @@
 CHANGELOG
 =========
 
+0.4
+---
+
+* Updates for new VIAF /search API endpoint response
+* bugfix: VIAF entity request needs Accept header
+
 0.3
 ---
 

viapy/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.0"
+__version__ = "0.4.0"

viapy/api.py

@@ -1,4 +1,5 @@
 import logging
+import re
 import time
 
 from attrdict import AttrMap
@@ -66,14 +67,13 @@ def search(self, query):
         search_url = "%s/search" % self.api_base
         params = {
             "query": query,
-            "httpAccept": "application/json",
-            "maximumRecords": 50,  # TODO: configurable ?
+            "maximumRecords": 10,  # TODO: configurable ?
             # sort by number of holdings (default sort on web search)
             # - so better known names show up first
-            "sortKeys": "holdingscount",
+            "sortKey": "holdingscount",
         }
 
-        response = requests.get(search_url, params=params)
+        response = requests.get(search_url, params=params, headers={"Accept": "application/json"})
         logger.debug(
             "search '%s': %s %s, %0.2f",
             params["query"],
@@ -130,7 +130,10 @@ def rdf(self):
         """VIAF data for this entity as :class:`rdflib.Graph`"""
         start = time.time()
         graph = rdflib.Graph()
-        graph.parse(self.uri)
+        # 2025 update: Accept header now required, so use requests.get to retrieve RDF
+        response = requests.get(self.uri, headers={"Accept": "application/rdf+xml"})
+        response.raise_for_status()  # raise HTTPError on non-success status
+        graph.parse(data=response.text, format="xml")
         logger.debug("Loaded VIAF RDF %s: %0.2f sec", self.uri, time.time() - start)
         return graph
 
@@ -183,37 +186,59 @@ def __init__(self, data):
     @cached_property
     def total_results(self):
         """number of records matching the query"""
-        return int(self._data.get("numberOfRecords", 0))
+        return int(self._data.get("numberOfRecords", {}).get("content", 0))
 
     @cached_property
     def records(self):
-        """list of results as :class:`SRUItem`."""
-        return [SRUItem(d["record"]) for d in self._data.get("records", [])]
+        """List of results as :class:`SRUItem`."""
+        record_or_records = self._data.get("records", {}).get("record")
+        if isinstance(record_or_records, dict):
+            return [SRUItem(self.normalize_record(record_or_records))]
+        elif isinstance(record_or_records, list):
+            return [SRUItem(self.normalize_record(d)) for d in record_or_records]
+        return []
 
+    def normalize_record(self, data):
+        """Added in May 2025 to match updates to the /search API records, where
+        the JSON response now uses namespaced keys that increase per result:
+        ns2, ns3, ns4, and so on, applying to most subkeys (ns2:VIAFCluster,
+        ns2:Document, etc). This method strips all nsX: prefixes recursively"""
+        if isinstance(data, dict):
+            return {
+                re.sub(r"^ns\d+:", "", key): self.normalize_record(value)
+                for key, value in data.items()
+            }
+        elif isinstance(data, list):
+            return [self.normalize_record(item) for item in data]
+        else:
+            return data
 
 class SRUItem(AttrMap):
     """Single item returned by a SRU search, for use with
-    :meth:`ViafAPI.search` and :class:`SRUResult`."""
+    :meth:`ViafAPI.search` and :class:`SRUResult`.
+    
+    The `VIAFCluster` attribute was added to each property lookup in 2025 to
+    match updates to the /search API's JSON response."""
 
     @property
     def uri(self):
         """VIAF URI for this result"""
-        return self.recordData.Document["@about"]
+        return self.recordData.VIAFCluster.Document["about"]
 
     @property
     def viaf_id(self):
         """VIAF numeric identifier"""
-        return self.recordData.viafID
+        return self.recordData.VIAFCluster.viafID
 
     @property
     def nametype(self):
         """type of name (personal, corporate, title, etc)"""
-        return self.recordData.nameType
+        return self.recordData.VIAFCluster.nameType
 
     @property
     def label(self):
         """first main heading for this item"""
         try:
-            return self.recordData.mainHeadings.data[0].text
-        except KeyError:
-            return self.recordData.mainHeadings.data.text
+            return self.recordData.VIAFCluster.mainHeadings.data[0].text
+        except (KeyError, IndexError):
+            return self.recordData.VIAFCluster.mainHeadings.data.text