Jun 13, 2022 · Jun 13, 2022
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
    user.activate()
    user.deactivate()

 Ban/Unban a user::

    user.ban()
    user.unban()

 Follow/Unfollow a user::

    user.follow()
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
    pass


 class GitlabBanError(GitlabOperationError):
    pass


 class GitlabUnbanError(GitlabOperationError):
    pass


 class GitlabSubscribeError(GitlabOperationError):
    pass

diff --git a/gitlab/v4/objects/users.py b/gitlab/v4/objects/users.py
            self._attrs["state"] = "active"
        return server_data

    @cli.register_custom_action("User")
    @exc.on_http_error(exc.GitlabBanError)
    def ban(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
        """Ban the user.

        Args:
            **kwargs: Extra options to send to the server (e.g. sudo)

        Raises:
            GitlabAuthenticationError: If authentication is not correct
            GitlabBanError: If the user could not be banned

        Returns:
            Whether the user has been banned
        """
        path = f"/users/{self.encoded_id}/ban"
        server_data = self.manager.gitlab.http_post(path, **kwargs)
        if server_data:
            self._attrs["state"] = "banned"
        return server_data

    @cli.register_custom_action("User")
    @exc.on_http_error(exc.GitlabUnbanError)
    def unban(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
        """Unban the user.

        Args:
            **kwargs: Extra options to send to the server (e.g. sudo)

        Raises:
            GitlabAuthenticationError: If authentication is not correct
            GitlabUnbanError: If the user could not be unbanned

        Returns:
            Whether the user has been unbanned
        """
        path = f"/users/{self.encoded_id}/unban"
        server_data = self.manager.gitlab.http_post(path, **kwargs)
        if server_data:
            self._attrs["state"] = "active"
        return server_data


 class UserManager(CRUDMixin, RESTManager):
    _path = "/users"
diff --git a/tests/functional/api/test_users.py b/tests/functional/api/test_users.py
    assert user in users


 def test_ban_user(gl, user):
    user.ban()
    retrieved_user = gl.users.get(user.id)
    assert retrieved_user.state == "banned"

    user.unban()
    retrieved_user = gl.users.get(user.id)
    assert retrieved_user.state == "active"


 def test_delete_user(gl, wait_for_sidekiq):
    new_user = gl.users.create(
        {
diff --git a/tests/unit/objects/test_users.py b/tests/unit/objects/test_users.py
        yield rsps


 @pytest.fixture
 def resp_ban():
    with responses.RequestsMock() as rsps:
        rsps.add(
            method=responses.POST,
            url="http://localhost/api/v4/users/1/ban",
            json={},
            content_type="application/json",
            status=201,
        )
        yield rsps


 @pytest.fixture
 def resp_unban():
    with responses.RequestsMock() as rsps:
        rsps.add(
            method=responses.POST,
            url="http://localhost/api/v4/users/1/unban",
            json={},
            content_type="application/json",
            status=201,
        )
        yield rsps


 @pytest.fixture
 def resp_get_user_status():
    content = {
    user.deactivate()


 def test_user_ban(user, resp_ban):
    user.ban()


 def test_user_unban(user, resp_unban):
    user.unban()


 def test_delete_user_identity(user, resp_delete_user_identity):
    user.identityproviders.delete("test_provider")
Original file line number	Diff line number	Diff line change
Expand Up		@@ -72,6 +72,11 @@ Activate/Deactivate a user::
		user.activate()
		user.deactivate()

		Ban/Unban a user::

		user.ban()
		user.unban()

		Follow/Unfollow a user::

		user.follow()
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -186,6 +186,14 @@ class GitlabActivateError(GitlabOperationError):
		pass


		class GitlabBanError(GitlabOperationError):
		pass


		class GitlabUnbanError(GitlabOperationError):
		pass


		class GitlabSubscribeError(GitlabOperationError):
		pass

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -283,6 +283,48 @@ 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.GitlabBanError)
		def ban(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
		"""Ban the user.

		Args:
		**kwargs: Extra options to send to the server (e.g. sudo)

		Raises:
		GitlabAuthenticationError: If authentication is not correct
		GitlabBanError: If the user could not be banned

		Returns:
		Whether the user has been banned
nejch marked this conversation as resolved. Show resolvedHide resolved
		"""
		path = f"/users/{self.encoded_id}/ban"
		server_data = self.manager.gitlab.http_post(path, **kwargs)
		if server_data:
		self._attrs["state"] = "banned"
		return server_data

		@cli.register_custom_action("User")
		@exc.on_http_error(exc.GitlabUnbanError)
		def unban(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
		"""Unban the user.

		Args:
		**kwargs: Extra options to send to the server (e.g. sudo)

		Raises:
		GitlabAuthenticationError: If authentication is not correct
		GitlabUnbanError: If the user could not be unbanned

		Returns:
		Whether the user has been unbanned
		"""
		path = f"/users/{self.encoded_id}/unban"
		server_data = self.manager.gitlab.http_post(path, **kwargs)
		if server_data:
		self._attrs["state"] = "active"
		return server_data


		class UserManager(CRUDMixin, RESTManager):
		_path = "/users"
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,6 +37,16 @@ def test_block_user(gl, user):
		assert user in users


		def test_ban_user(gl, user):
		user.ban()
		retrieved_user = gl.users.get(user.id)
		assert retrieved_user.state == "banned"

		user.unban()
		retrieved_user = gl.users.get(user.id)
		assert retrieved_user.state == "active"


		def test_delete_user(gl, wait_for_sidekiq):
		new_user = gl.users.create(
		{
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -80,6 +80,32 @@ def resp_activate():
		yield rsps


		@pytest.fixture
		def resp_ban():
		with responses.RequestsMock() as rsps:
		rsps.add(
		method=responses.POST,
		url="http://localhost/api/v4/users/1/ban",
		json={},
		content_type="application/json",
		status=201,
		)
		yield rsps


		@pytest.fixture
		def resp_unban():
		with responses.RequestsMock() as rsps:
		rsps.add(
		method=responses.POST,
		url="http://localhost/api/v4/users/1/unban",
		json={},
		content_type="application/json",
		status=201,
		)
		yield rsps


		@pytest.fixture
		def resp_get_user_status():
		content = {
Expand DownExpand Up		@@ -216,6 +242,14 @@ def test_user_activate_deactivate(user, resp_activate):
		user.deactivate()


		def test_user_ban(user, resp_ban):
		user.ban()


		def test_user_unban(user, resp_unban):
		user.unban()


		def test_delete_user_identity(user, resp_delete_user_identity):
		user.identityproviders.delete("test_provider")

Expand Down