feat(users): Add approve and reject methods to User

bgamari · bgamari · commit 7e78eb8dd462 · 2022-06-09T13:42:32.000-04:00
As requested in #1604.
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
@@ -106,6 +106,13 @@ List a user's starred projects
 
     user.starred_projects.list()
 
+If the GitLab instance has new user account approval enabled some users may
+have ``user.state == 'blocked_pending_approval'``. Administrators can approve
+and reject such users::
+
+    user.approve()
+    user.reject()
+
 User custom attributes
 ======================
 
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -286,6 +286,14 @@ class GitlabUnfollowError(GitlabOperationError):
     pass
 
 
+class GitlabUserApproveError(GitlabOperationError):
+    pass
+
+
+class GitlabUserRejectError(GitlabOperationError):
+    pass
+
+
 # For an explanation of how these type-hints work see:
 # https://mypy.readthedocs.io/en/stable/generics.html#declaring-decorators
 #
diff --git a/gitlab/v4/objects/users.py b/gitlab/v4/objects/users.py
@@ -283,6 +283,42 @@ def activate(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
             self._attrs["state"] = "active"
         return server_data
 
+    @cli.register_custom_action("User")
+    @exc.on_http_error(exc.GitlabUserApproveError)
+    def approve(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
+        """Approve a user creation request.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabUserApproveError: If the user could not be activated
+
+        Returns:
+            The new object data (*not* a RESTObject)
+        """
+        path = f"/users/{self.encoded_id}/approve"
+        return self.manager.gitlab.http_post(path, **kwargs)
+
+    @cli.register_custom_action("User")
+    @exc.on_http_error(exc.GitlabUserRejectError)
+    def reject(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
+        """Reject a user creation request.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabUserReject: If the user could not be rejected
+
+        Returns:
+            The new object data (*not* a RESTObject)
+        """
+        path = f"/users/{self.encoded_id}/reject"
+        return self.manager.gitlab.http_post(path, **kwargs)
+
 
 class UserManager(CRUDMixin, RESTManager):
     _path = "/users"
diff --git a/tests/unit/objects/test_users.py b/tests/unit/objects/test_users.py
@@ -80,6 +80,29 @@ def resp_activate():
         yield rsps
 
 
+@pytest.fixture
+def resp_approve():
+    content = {
+        "message": "Success",
+    }
+    with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
+        rsps.add(
+            method=responses.POST,
+            url="http://localhost/api/v4/users/1/approve",
+            json={},
+            content_type="application/json",
+            status=201,
+        )
+        rsps.add(
+            method=responses.POST,
+            url="http://localhost/api/v4/users/1/reject",
+            json={},
+            content_type="application/json",
+            status=201,
+        )
+        yield rsps
+
+
 @pytest.fixture
 def resp_get_user_status():
     content = {
@@ -216,6 +239,11 @@ def test_user_activate_deactivate(user, resp_activate):
     user.deactivate()
 
 
+def test_user_approve_reject(user, resp_approve):
+    user.approve()
+    user.reject()
+
+
 def test_delete_user_identity(user, resp_delete_user_identity):
     user.identityproviders.delete("test_provider")
 
