remove replace_user_property; fix person and group delete, patch and post_uri operations

Author: sszepe

dspace_rest_client/client.py

@@ -279,7 +279,13 @@ def api_get(self, url, params=None, data=None, headers=None):
         self.update_token(r)
         return r
 
-    def api_post(self, url, params, json, retry=False):
+    def api_post(
+        self,
+        url,
+        params,
+        json,
+        retry=False,
+    ):
         """
         Perform a POST request. Refresh XSRF token if necessary.
         POSTs are typically used to create objects.
@@ -1464,31 +1470,21 @@ def search_users_not_in_group(self, group_uuid, query=None, embeds=None):
             ]
         return users
 
-    def update_user_metadata(self, user_uuid, metadata_updates):
+    def update_user_metadata(self, user_uuid, path, value, embeds=None):
         """
         Update user metadata
         @param user_uuid: UUID of the user
         @param metadata_updates: List of metadata updates in the PATCH format
         @return: Updated User object or None if the operation fails
         """
         url = f"{self.API_ENDPOINT}/eperson/epersons/{user_uuid}"
-        headers = {"Content-Type": "application/json"}
-        r = self.api_patch(url, headers=headers, data=json.dumps(metadata_updates))
-        r_json = parse_json(response=r)
-        return User(r_json) if r_json else None
-
-    def replace_user_property(self, user_uuid, path, value):
-        """
-        Replace a specific property of a user
-        @param user_uuid: UUID of the user
-        @param path: Path of the property to update (e.g., "/canLogin", "/email")
-        @param value: New value for the property
-        @return: Updated User object or None if the operation fails
-        """
-        url = f"{self.API_ENDPOINT}/eperson/epersons/{user_uuid}"
-        headers = {"Content-Type": "application/json"}
-        data = [{"op": "replace", "path": path, "value": value}]
-        r = self.api_patch(url, headers=headers, data=json.dumps(data))
+        r = self.api_patch(
+            url=url,
+            operation="replace",
+            path=path,
+            value=value,
+            params=parse_params(embeds=embeds),
+        )
         r_json = parse_json(response=r)
         return User(r_json) if r_json else None
 
@@ -1503,19 +1499,21 @@ def change_user_password(self, user_uuid, current_password, new_password):
         # TODO: ensure this is only triggered when the user management is done in DSpace directly.
         # If the user management is done in an external system (e.g. LDAP), this method should not be used.
         url = f"{self.API_ENDPOINT}/eperson/epersons/{user_uuid}"
-        headers = {"Content-Type": "application/json"}
-        data = [
-            {
-                "op": "add",
-                "path": "/password",
-                "value": {
-                    "new_password": new_password,
-                    "current_password": current_password,
-                },
-            }
-        ]
-        r = self.api_patch(url, headers=headers, data=json.dumps(data))
-        return r.status_code == 200
+        r = self.api_patch(
+            url,
+            operation="add",
+            path="/password",
+            value={
+                "new_password": new_password,
+                "current_password": current_password,
+            },
+        )
+        if r.status_code == 200:
+            logging.info("Updated Password for user %s", user_uuid)
+            return True
+        else:
+            logging.error("An error occurred updating the password.")
+            return False
 
     # PAGINATION
     def get_users(self, page=0, size=20, sort=None, embeds=None):
@@ -1640,9 +1638,9 @@ def update_group_name(self, uuid, new_name):
         @return: Updated Group object or None if the update fails
         """
         url = f"{self.API_ENDPOINT}/eperson/groups/{uuid}"
-        headers = {"Content-Type": "application/json"}
-        data = [{"op": "replace", "path": "/name", "value": new_name}]
-        response = self.api_patch(url, headers=headers, data=json.dumps(data))
+        response = self.api_patch(
+            url, operation="replace", path="/name", value=new_name
+        )
         response_json = parse_json(response=response)
         return Group(response_json) if response_json else None
 
@@ -1674,9 +1672,8 @@ def add_subgroup(self, parent_uuid, child_uuid):
         @return: Boolean indicating success or failure
         """
         url = f"{self.API_ENDPOINT}/eperson/groups/{parent_uuid}/subgroups"
-        headers = {"Content-Type": "text/uri-list"}
         data = f"{self.API_ENDPOINT}/eperson/groups/{child_uuid}"
-        response = self.api_post(url, headers=headers, data=data)
+        response = self.api_post_uri(url, uri_list=data, params=None)
         if response.status_code == 204:
             return True
         elif response.status_code == 401:
@@ -1710,7 +1707,7 @@ def remove_subgroup(self, parent_uuid, child_uuid):
         @return: Boolean indicating success or failure
         """
         url = f"{self.API_ENDPOINT}/eperson/groups/{parent_uuid}/subgroups/{child_uuid}"
-        response = self.api_delete(url)
+        response = self.api_delete(url, params=None)
         if response.status_code == 204:
             return True
         if response.status_code == 401:
@@ -1782,9 +1779,24 @@ def add_eperson_to_group(self, group_uuid, eperson_uuid):
         @return: Boolean indicating success or failure
         """
         url = f"{self.API_ENDPOINT}/eperson/groups/{group_uuid}/epersons"
-        headers = {"Content-Type": "text/uri-list"}
+        # check if the eperson exists and is valid
+        eperson = self.get_user_by_uuid(eperson_uuid)
+        if eperson is None:
+            logging.error("The specified EPerson does not exist")
+            return False
+        if not isinstance(eperson, User):
+            logging.error("Invalid EPerson object")
+            return False
+        # check if the group exists and is valid
+        group = self.get_group_by_uuid(group_uuid)
+        if group is None:
+            logging.error("The specified group does not exist")
+            return False
+        if not isinstance(group, Group):
+            logging.error("Invalid Group object")
+            return False
         data = f"{self.API_ENDPOINT}/eperson/epersons/{eperson_uuid}"
-        response = self.api_post(url, headers=headers, data=data)
+        response = self.api_post_uri(url, uri_list=data, params=None)
         if response.status_code == 204:
             return True
         elif response.status_code == 401:
@@ -1813,7 +1825,7 @@ def remove_eperson_from_group(self, group_uuid, eperson_uuid):
         @return: Boolean indicating success or failure
         """
         url = f"{self.API_ENDPOINT}/eperson/groups/{group_uuid}/epersons/{eperson_uuid}"
-        response = self.api_delete(url)
+        response = self.api_delete(url, params=None)
         if response.status_code == 204:
             return True
         elif response.status_code == 401: