rocketchat-API 3.3.0__tar.gz → 3.5.0__tar.gz

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/.github/workflows/release.yml

@@ -28,3 +28,11 @@ jobs:
           python3 -m build
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Announce release
+        uses: jadolg/rocketchat-notification-action@v3.0.0
+        with:
+          server: https://open.rocket.chat
+          message: A new version (${{ github.event.release.tag_name }}) has been released! ${{ github.event.release.html_url }}
+          user-id: ${{ secrets.ROCKETCHAT_USER_ID }}
+          auth-token: ${{ secrets.ROCKETCHAT_AUTH_TOKEN }}
+          channel: "#python_rocketchat_api"

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
-        rocket-chat-version: [ '7.10.7', '7.11.3', '7.12.4', '7.13.3' , '8.0.1', '8.1.0']
+        rocket-chat-version: [ '7.11.6', '7.12.6', '7.13.5' , '8.0.3', '8.1.2', '8.2.1', '8.3.1']
     steps:
       - name: Checkout
         uses: actions/checkout@v6.0.2

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocketchat_API
-Version: 3.3.0
+Version: 3.5.0
 Summary: Python API wrapper for Rocket.Chat
 Author-email: "Jorge Alberto Díaz Orozco (Akiel)" <diazorozcoj@gmail.com>
 Maintainer-email: "Jorge Alberto Díaz Orozco (Akiel)" <diazorozcoj@gmail.com>

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/rocketchat_API/APISections/base.py

@@ -200,24 +200,37 @@ class RocketChatBase:
             )
         )
 
-    def call_api_post(self, method, files=None, use_json=None, **kwargs):
-        reduced_args = self.__reduce_kwargs(kwargs)
-        # Since pass is a reserved word in Python it has to be injected on the request dict
-        # Some methods use pass (users.register) and others password (users.create)
-        if "password" in reduced_args and method != "users.create":
-            reduced_args["pass"] = reduced_args["password"]
-            del reduced_args["password"]
-        if use_json is None:
-            # see https://requests.readthedocs.io/en/master/user/quickstart/#more-complicated-post-requests
-            # > The json parameter is ignored if either data or files is passed.
-            # If files are sent, json should not be used
-            use_json = files is None
-        if use_json:
+    def call_api_post(self, method, body=None, files=None, use_json=None, **kwargs):
+        """Send a POST request to the API.
+
+        There are two modes of operation:
+
+        1. **Raw body** — pass ``body`` directly. The value is serialized as-is
+           via ``json=body``, which supports any JSON-serializable structure
+           (lists, dicts, etc.). ``kwargs`` are ignored in this mode.
+
+        2. **Keyword arguments** (default) — individual kwargs are collected
+           into a dict and sent as the request payload.  By default the payload
+           is sent as JSON (``json=``), but when ``files`` are provided it
+           falls back to form-encoded ``data=`` because requests ignores the
+           ``json`` parameter when ``files`` is set.  You can override this
+           with ``use_json=True/False``.
+
+        :param method:   API method path, appended to ``self.api_path``.
+        :param body:     A raw JSON-serializable payload (e.g. a list).
+                         When provided, ``kwargs``, ``files``, and ``use_json``
+                         are ignored.
+        :param files:    Files to upload (passed to ``requests``).
+        :param use_json: Force JSON (True) or form-encoded (False) encoding.
+                         Defaults to JSON when no files are attached.
+        """
+        url = self.server_url + self.api_path + method
+
+        if body is not None:
             return json_or_error(
                 self.session.post(
-                    self.server_url + self.api_path + method,
-                    json=reduced_args,
-                    files=files,
+                    url,
+                    json=body,
                     headers=self.headers,
                     verify=self.ssl_verify,
                     cert=self.cert,
@@ -226,10 +239,21 @@ class RocketChatBase:
                 )
             )
 
+        reduced_args = self.__reduce_kwargs(kwargs)
+
+        # "pass" is a Python reserved word, but some endpoints (e.g.
+        # users.register) expect it instead of "password".
+        if "password" in reduced_args and method != "users.create":
+            reduced_args["pass"] = reduced_args.pop("password")
+
+        if use_json is None:
+            use_json = files is None
+
         return json_or_error(
             self.session.post(
-                self.server_url + self.api_path + method,
-                data=reduced_args,
+                url,
+                json=reduced_args if use_json else None,
+                data=None if use_json else reduced_args,
                 files=files,
                 headers=self.headers,
                 verify=self.ssl_verify,

rocketchat_api-3.5.0/rocketchat_API/APISections/custom_sounds.py

@@ -0,0 +1,12 @@
+from rocketchat_API.APISections.base import RocketChatBase, paginated
+
+
+class RocketChatCustomSounds(RocketChatBase):
+    @paginated("sounds")
+    def custom_sounds_list(self, **kwargs):
+        """Retrieves all custom sounds."""
+        return self.call_api_get("custom-sounds.list", kwargs=kwargs)
+
+    def custom_sounds_get_one(self, sound_id, **kwargs):
+        """Retrieves a single custom sound by its _id."""
+        return self.call_api_get("custom-sounds.getOne", _id=sound_id, kwargs=kwargs)

rocketchat_api-3.5.0/rocketchat_API/APISections/custom_user_status.py

@@ -0,0 +1,41 @@
+from rocketchat_API.APISections.base import RocketChatBase, paginated
+
+
+class RocketChatCustomUserStatus(RocketChatBase):
+    @paginated("statuses")
+    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-3.3.0 → rocketchat_api-3.5.0}/rocketchat_API/APISections/licenses.py

@@ -6,3 +6,7 @@ class RocketChatLicenses(RocketChatBase):
     def licenses_info(self, **kwargs):
         """Retrieves a list of all registered licenses in the workspace."""
         return self.call_api_get("licenses.info", kwargs=kwargs)
+
+    def licenses_max_active_users(self, **kwargs):
+        """Retrieves a list of the maximum active users."""
+        return self.call_api_get("licenses.maxActiveUsers", kwargs=kwargs)

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/rocketchat_API/APISections/livechat.py

@@ -70,3 +70,15 @@ class RocketChatLivechat(RocketChatBase):
         return self.call_api_get(
             "livechat/inquiries.getOne", roomId=room_id, kwargs=kwargs
         )
+
+    def livechat_get_appearance(self, **kwargs):
+        """Get the settings about the widget appearance. Permission required: view-livechat-manager"""
+        return self.call_api_get("livechat/appearance", kwargs=kwargs)
+
+    def livechat_set_appearance(self, settings):
+        """Update the livechat widget appearance settings. Permission required: view-livechat-manager
+
+        :param settings: list of dicts with '_id' and 'value' keys,
+                         e.g. [{"_id": "Livechat_title", "value": "Support"}]
+        """
+        return self.call_api_post("livechat/appearance", body=settings)

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/rocketchat_API/rocketchat.py

@@ -6,6 +6,8 @@ from rocketchat_API.APISections.channels import RocketChatChannels
 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_sounds import RocketChatCustomSounds
+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 +33,8 @@ class RocketChat(
     RocketChatChat,
     RocketChatDM,
     RocketChatCustomEmoji,
+    RocketChatCustomSounds,
+    RocketChatCustomUserStatus,
     RocketChatGroups,
     RocketChatIntegrations,
     RocketChatInvites,

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/rocketchat_API.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocketchat_API
-Version: 3.3.0
+Version: 3.5.0
 Summary: Python API wrapper for Rocket.Chat
 Author-email: "Jorge Alberto Díaz Orozco (Akiel)" <diazorozcoj@gmail.com>
 Maintainer-email: "Jorge Alberto Díaz Orozco (Akiel)" <diazorozcoj@gmail.com>

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/rocketchat_API.egg-info/SOURCES.txt

@@ -34,6 +34,8 @@ rocketchat_API/APISections/base.py
 rocketchat_API/APISections/channels.py
 rocketchat_API/APISections/chat.py
 rocketchat_API/APISections/custom_emoji.py
+rocketchat_API/APISections/custom_sounds.py
+rocketchat_API/APISections/custom_user_status.py
 rocketchat_API/APISections/dm.py
 rocketchat_API/APISections/groups.py
 rocketchat_API/APISections/integrations.py
@@ -58,6 +60,8 @@ tests/test_banners.py
 tests/test_channels.py
 tests/test_chat.py
 tests/test_custom_emoji.py
+tests/test_custom_sounds.py
+tests/test_custom_user_status.py
 tests/test_dms.py
 tests/test_exceptions.py
 tests/test_groups.py

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/tests/conftest.py

@@ -78,6 +78,18 @@ def secondary_user(logged_rocket):
     logged_rocket.users_delete(_testuser_id)
 
 
+@pytest.fixture
+def skip_if_version_under(rocket):
+    import semver
+
+    def _skip_if_version_under(minimum_version):
+        parse = lambda v: semver.Version.parse(v, optional_minor_and_patch=True)
+        if parse(rocket.info()["version"]) < parse(minimum_version):
+            pytest.skip(f"Requires Rocket.Chat >= {minimum_version}")
+
+    return _skip_if_version_under
+
+
 @pytest.fixture
 def skip_if_no_license(logged_rocket):
     try:

rocketchat_api-3.5.0/tests/test_custom_sounds.py

@@ -0,0 +1,79 @@
+import json
+import uuid
+
+
+def _sound_name():
+    return "test_sound_" + str(uuid.uuid1()).replace("-", "")[:12]
+
+
+def _create_sound(logged_rocket, name):
+    """Create a custom sound entry via method.call and return its _id."""
+    result = logged_rocket.call_api_post(
+        "method.call/insertOrUpdateSound",
+        message=json.dumps(
+            {
+                "msg": "method",
+                "id": "1",
+                "method": "insertOrUpdateSound",
+                "params": [{"name": name, "extension": "mp3", "newFile": True}],
+            }
+        ),
+    )
+    return json.loads(result["message"])["result"]
+
+
+def _delete_sound(logged_rocket, sound_id):
+    """Delete a custom sound entry via method.call."""
+    logged_rocket.call_api_post(
+        "method.call/deleteCustomSound",
+        message=json.dumps(
+            {
+                "msg": "method",
+                "id": "1",
+                "method": "deleteCustomSound",
+                "params": [sound_id],
+            }
+        ),
+    )
+
+
+def test_custom_sounds_list(logged_rocket):
+    result = list(logged_rocket.custom_sounds_list())
+    assert isinstance(result, list)
+
+
+def test_custom_sounds_list_structure(logged_rocket):
+    name = _sound_name()
+    sound_id = _create_sound(logged_rocket, name)
+    try:
+        sounds = list(logged_rocket.custom_sounds_list())
+        assert any(s["_id"] == sound_id for s in sounds)
+        sound = next(s for s in sounds if s["_id"] == sound_id)
+        assert "name" in sound
+        assert "extension" in sound
+    finally:
+        _delete_sound(logged_rocket, sound_id)
+
+
+def test_custom_sounds_list_filter_by_name(logged_rocket):
+    name = _sound_name()
+    sound_id = _create_sound(logged_rocket, name)
+    try:
+        sounds = list(logged_rocket.custom_sounds_list(name=name))
+        assert len(sounds) >= 1
+        assert all(name.lower() in s["name"].lower() for s in sounds)
+    finally:
+        _delete_sound(logged_rocket, sound_id)
+
+
+def test_custom_sounds_get_one(logged_rocket, skip_if_version_under):
+    skip_if_version_under("8.3.0")
+    name = _sound_name()
+    sound_id = _create_sound(logged_rocket, name)
+    try:
+        result = logged_rocket.custom_sounds_get_one(sound_id)
+        assert "sound" in result
+        assert result["sound"]["_id"] == sound_id
+        assert result["sound"]["name"] == name
+    finally:
+        _delete_sound(logged_rocket, sound_id)

rocketchat_api-3.5.0/tests/test_custom_user_status.py

@@ -0,0 +1,69 @@
+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):
+    statuses = list(logged_rocket.custom_user_status_list())
+    assert any(s["_id"] == created_status["_id"] for s in statuses)
+
+
+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 = list(logged_rocket.custom_user_status_list())
+    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)

rocketchat_api-3.5.0/tests/test_licenses.py

@@ -0,0 +1,22 @@
+def test_licenses_info_works_without_license(logged_rocket):
+    licenses_info = logged_rocket.licenses_info()
+    assert "license" in licenses_info
+
+
+def test_licenses_info(logged_rocket, skip_if_no_license, skip_if_version_under):
+    skip_if_version_under("8.1.0")
+    licenses_info = logged_rocket.licenses_info()
+    assert "license" in licenses_info
+    license_data = licenses_info["license"]
+    assert "activeModules" in license_data
+    assert "hasValidLicense" in license_data
+    assert "tags" in license_data
+    assert "limits" in license_data
+    assert isinstance(license_data["activeModules"], list)
+    assert isinstance(license_data["tags"], list)
+
+
+def test_licenses_max_active_users(logged_rocket, skip_if_no_license):
+    result = logged_rocket.licenses_max_active_users()
+    assert "maxActiveUsers" in result
+    assert "activeUsers" in result

{rocketchat_api-3.3.0 → rocketchat_api-3.5.0}/tests/test_livechat.py

@@ -125,3 +125,18 @@ def test_livechat_get_inquiries(logged_rocket, livechat_inquiry):
 def test_livechat_get_inquiries_non_existent_room(logged_rocket):
     inquiry_not_found = logged_rocket.livechat_inquiries_get_one(room_id="nonexistent")
     assert inquiry_not_found.get("inquiry") is None or "success" in inquiry_not_found
+
+
+def test_livechat_get_appearance(logged_rocket):
+    result = logged_rocket.livechat_get_appearance()
+    assert "appearance" in result
+
+
+def test_livechat_set_appearance(logged_rocket):
+    appearance = logged_rocket.livechat_get_appearance().get("appearance", [])
+    assert len(appearance) > 0, "Expected at least one appearance setting"
+
+    setting = appearance[0]
+    logged_rocket.livechat_set_appearance(
+        [{"_id": setting["_id"], "value": setting["value"]}]
+    )

rocketchat_api-3.3.0/tests/test_licenses.py

@@ -1,3 +0,0 @@
-def test_licenses_info(logged_rocket):
-    licenses_info = logged_rocket.licenses_info()
-    assert "license" in licenses_info