Merge pull request #65 from oslokommune/DP-1933-dataset-update-partial

DP-1933 Support partial dataset metadata updates

Author: simenheg

CHANGELOG.md

@@ -1,3 +1,8 @@
+## ?.?.?
+
+* `Dataset.update_dataset` now supports partial metadata updates when the
+  keyword argument `partial` is true.
+
 ## 0.6.3
 
 * PyJWT 2.0.0 or above is now required.

README.md

@@ -338,7 +338,7 @@ dataset.update_dataset(
         "description": "Describe your dataset here",
         "keywords": ["some-keyword", "another-keyword"], # Add another keyword
         "accessRights": "public",
-        "license": "Norsk lisens for offentlige data (NLOD) 1.0", # Add licensing information
+        "license": "http://data.norge.no/nlod/", # Add licensing information
         "objective": "Exemplify how to update an existing dataset", # Update objective text
         "contactPoint": {
             "name": "Your name",
@@ -349,3 +349,12 @@ dataset.update_dataset(
     }
 )
 ```
+
+The `update_dataset` method also supports an optional `partial` keyword,
+enabling partial updates when true:
+
+```py
+dataset.update_dataset(
+    "my-dataset-id", {"description": "Only update description"}, partial=True
+)
+```

okdata/sdk/data/dataset.py

@@ -39,12 +39,13 @@ def get_dataset(self, datasetid, retries=0):
         log.info(f"SDK:Getting dataset: {datasetid} from: {url}")
         return self.get(url, retries=retries).json()
 
-    def update_dataset(self, datasetid, data, retries=0):
+    def update_dataset(self, datasetid, data, partial=False, retries=0):
         datasetUrl = self.config.get("datasetUrl")
         url = f"{datasetUrl}/{datasetid}"
         log.info(f"SDK:Updating dataset: {datasetid} with payload: {data}")
-        result = self.put(url, data, retries=retries)
-        body = result.json()
+        method = self.patch if partial else self.put
+        response = method(url, data, retries=retries)
+        body = response.json()
         log.info(f"Updated dataset: {body['Id']}")
         return body
 

okdata/sdk/sdk.py

@@ -30,37 +30,31 @@ def headers(self):
             headers["Authorization"] = f"Bearer {self.auth.access_token}"
         return headers
 
-    def post(self, url, data, retries=0, **kwargs):
-        log.info(f"SDK:Posting resource to url: {url}")
+    def _request(self, method, url, retries, **kwargs):
         session = self.prepared_request_with_retries(retries)
-        result = session.post(
-            url, data=json.dumps(data), headers=self.headers(), **kwargs
-        )
-        result.raise_for_status()
-        return result
+        try:
+            request_method = getattr(session, method)
+        except AttributeError:
+            raise ValueError(f"'{method}' is not a valid request method")
+        log.info(f"SDK:Making a {method.upper()} request to URL: {url}")
+        response = request_method(url, headers=self.headers(), **kwargs)
+        response.raise_for_status()
+        return response
+
+    def post(self, url, data, retries=0, **kwargs):
+        return self._request("post", url, retries, data=json.dumps(data), **kwargs)
 
     def put(self, url, data, retries=0, **kwargs):
-        log.info(f"SDK:Putting resource to url: {url}")
-        session = self.prepared_request_with_retries(retries)
-        result = session.put(
-            url, data=json.dumps(data), headers=self.headers(), **kwargs
-        )
-        result.raise_for_status()
-        return result
+        return self._request("put", url, retries, data=json.dumps(data), **kwargs)
+
+    def patch(self, url, data, retries=0, **kwargs):
+        return self._request("patch", url, retries, data=json.dumps(data), **kwargs)
 
     def get(self, url, retries=0, **kwargs):
-        log.info(f"SDK:Getting resource from url: {url}")
-        session = self.prepared_request_with_retries(retries)
-        result = session.get(url, headers=self.headers(), **kwargs)
-        result.raise_for_status()
-        return result
+        return self._request("get", url, retries, **kwargs)
 
     def delete(self, url, retries=0, **kwargs):
-        log.info(f"SDK:Deleting resource from url: {url}")
-        session = self.prepared_request_with_retries(retries)
-        result = session.delete(url, headers=self.headers(), **kwargs)
-        result.raise_for_status()
-        return result
+        return self._request("delete", url, retries, **kwargs)
 
     @staticmethod
     def prepared_request_with_retries(retries):

tests/data/dataset_test.py

@@ -69,12 +69,21 @@ def test_getDataset(self, requests_mock):
     def test_updateDataset(self, requests_mock):
         ds = Dataset(config=config, auth=auth_default)
         datasetid = "test-dataset-updateDataset"
-        matcher = re.compile("datasets")
+        matcher = re.compile(f"datasets/{datasetid}")
         response = json.dumps({"Id": datasetid})
         requests_mock.register_uri("PUT", matcher, text=response, status_code=200)
         body = ds.update_dataset(datasetid, {"Id": datasetid})
         assert body["Id"] == datasetid
 
+    def test_update_dataset_partial(self, requests_mock):
+        ds = Dataset(config=config, auth=auth_default)
+        dataset_id = "test-dataset-update-partial"
+        matcher = re.compile(f"datasets/{dataset_id}")
+        response = json.dumps({"Id": dataset_id})
+        requests_mock.register_uri("PATCH", matcher, text=response, status_code=200)
+        body = ds.update_dataset(dataset_id, {"Id": dataset_id}, partial=True)
+        assert body["Id"] == dataset_id
+
 
 class TestVersion:
     def test_createDatasetVersion(self, requests_mock):