Add custom_user_status API section (#378)

Author: jadolg

rocketchat_API/APISections/custom_user_status.py

@@ -0,0 +1,40 @@
+from rocketchat_API.APISections.base import RocketChatBase
+
+
+class RocketChatCustomUserStatus(RocketChatBase):
+    def custom_user_status_list(self, **kwargs):
+        """Lists all available custom user's status."""
+        return self.call_api_get("custom-user-status.list", kwargs=kwargs)
+
+    def custom_user_status_create(self, name, status_type, **kwargs):
+        """Creates custom user status.
+
+        :param name: The name of the custom status.
+        :param status_type: The statusType of the custom status. Valid status type includes: Online, Busy, Away, Offline.
+        """
+        return self.call_api_post(
+            "custom-user-status.create",
+            name=name,
+            statusType=status_type,
+            kwargs=kwargs,
+        )
+
+    def custom_user_status_delete(self, custom_user_status_id, **kwargs):
+        """Deletes a custom user status."""
+        return self.call_api_post(
+            "custom-user-status.delete",
+            customUserStatusId=custom_user_status_id,
+            kwargs=kwargs,
+        )
+
+    def custom_user_status_update(
+        self, custom_user_status_id, name, status_type, **kwargs
+    ):
+        """Updates a custom user status."""
+        return self.call_api_post(
+            "custom-user-status.update",
+            _id=custom_user_status_id,
+            name=name,
+            statusType=status_type,
+            kwargs=kwargs,
+        )

rocketchat_API/rocketchat.py

@@ -6,6 +6,7 @@
 from rocketchat_API.APISections.chat import RocketChatChat
 from rocketchat_API.APISections.dm import RocketChatDM
 from rocketchat_API.APISections.custom_emoji import RocketChatCustomEmoji
+from rocketchat_API.APISections.custom_user_status import RocketChatCustomUserStatus
 from rocketchat_API.APISections.groups import RocketChatGroups
 from rocketchat_API.APISections.integrations import RocketChatIntegrations
 from rocketchat_API.APISections.invites import RocketChatInvites
@@ -31,6 +32,7 @@ class RocketChat(
     RocketChatChat,
     RocketChatDM,
     RocketChatCustomEmoji,
+    RocketChatCustomUserStatus,
     RocketChatGroups,
     RocketChatIntegrations,
     RocketChatInvites,

tests/test_custom_user_status.py

@@ -0,0 +1,71 @@
+import uuid
+
+import pytest
+
+
+@pytest.fixture
+def status_name():
+    return "test_status_" + str(uuid.uuid1()).replace("-", "")[:12]
+
+
+@pytest.fixture
+def created_status(logged_rocket, status_name):
+    result = logged_rocket.custom_user_status_create(
+        name=status_name, status_type="online"
+    )
+    status = result.get("customUserStatus")
+    assert status is not None
+
+    yield status
+
+    logged_rocket.custom_user_status_delete(custom_user_status_id=status["_id"])
+
+
+def test_custom_user_status_list(logged_rocket, created_status):
+    result = logged_rocket.custom_user_status_list()
+    assert "statuses" in result
+    found = any(s["_id"] == created_status["_id"] for s in result["statuses"])
+    assert found
+
+
+def test_custom_user_status_create_delete(logged_rocket):
+    name = "test_status_" + str(uuid.uuid1()).replace("-", "")[:12]
+    result = logged_rocket.custom_user_status_create(name=name, status_type="busy")
+    status = result.get("customUserStatus")
+    assert status is not None
+    assert status["name"] == name
+    assert status["statusType"] == "busy"
+
+    logged_rocket.custom_user_status_delete(custom_user_status_id=status["_id"])
+
+    statuses = logged_rocket.custom_user_status_list().get("statuses", [])
+    assert not any(s["_id"] == status["_id"] for s in statuses)
+
+
+def test_custom_user_status_update(logged_rocket, created_status):
+    new_name = created_status["name"] + "_upd"
+    result = logged_rocket.custom_user_status_update(
+        custom_user_status_id=created_status["_id"],
+        name=new_name,
+        status_type="away",
+    )
+    updated = result.get("customUserStatus")
+    assert updated is not None
+    assert updated["name"] == new_name
+    assert updated["statusType"] == "away"
+
+
+def test_custom_user_status_create_all_types(logged_rocket):
+    created_ids = []
+    for status_type in ("online", "busy", "away", "offline"):
+        name = "test_" + status_type + "_" + str(uuid.uuid1()).replace("-", "")[:8]
+        result = logged_rocket.custom_user_status_create(
+            name=name, status_type=status_type
+        )
+        status = result.get("customUserStatus")
+        assert status is not None
+        assert status["statusType"] == status_type
+        created_ids.append(status["_id"])
+
+    for sid in created_ids:
+        logged_rocket.custom_user_status_delete(custom_user_status_id=sid)