python-roborock 2.17.0__tar.gz → 2.18.0__tar.gz

{python_roborock-2.17.0 → python_roborock-2.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-roborock
-Version: 2.17.0
+Version: 2.18.0
 Summary: A package to control Roborock vacuums.
 Home-page: https://github.com/humbertogontijo/python-roborock
 License: GPL-3.0-only
@@ -24,6 +24,7 @@ Requires-Dist: construct (>=2.10.57,<3.0.0)
 Requires-Dist: paho-mqtt (>=1.6.1,<3.0.0)
 Requires-Dist: pycryptodome (>=3.18,<4.0)
 Requires-Dist: pycryptodomex (>=3.18,<4.0) ; sys_platform == "darwin"
+Requires-Dist: pyrate-limiter (>=3.7.0,<4.0.0)
 Requires-Dist: vacuum-map-parser-roborock
 Project-URL: Documentation, https://python-roborock.readthedocs.io/
 Project-URL: Repository, https://github.com/humbertogontijo/python-roborock

{python_roborock-2.17.0 → python_roborock-2.18.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-roborock"
-version = "2.17.0"
+version = "2.18.0"
 description = "A package to control Roborock vacuums."
 authors = ["humbertogontijo <humbertogontijo@users.noreply.github.com>"]
 license = "GPL-3.0-only"
@@ -30,6 +30,7 @@ pycryptodomex = {version = "^3.18", markers = "sys_platform == 'darwin'"}
 paho-mqtt = ">=1.6.1,<3.0.0"
 construct = "^2.10.57"
 vacuum-map-parser-roborock = "*"
+pyrate-limiter = "^3.7.0"
 
 
 [build-system]

{python_roborock-2.17.0 → python_roborock-2.18.0}/roborock/exceptions.py

@@ -72,3 +72,7 @@ class RoborockMissingParameters(RoborockException):
 
 class RoborockTooManyRequest(RoborockException):
     """Class for Roborock too many request exceptions."""
+
+
+class RoborockRateLimit(RoborockException):
+    """Class for our rate limits exceptions."""

{python_roborock-2.17.0 → python_roborock-2.18.0}/roborock/web_api.py

@@ -10,6 +10,7 @@ import time
 
 import aiohttp
 from aiohttp import ContentTypeError, FormData
+from pyrate_limiter import BucketFullException, Duration, Limiter, Rate
 
 from roborock.containers import HomeData, HomeDataRoom, HomeDataScene, ProductResponse, RRiot, UserData
 from roborock.exceptions import (
@@ -21,6 +22,7 @@ from roborock.exceptions import (
     RoborockInvalidUserAgreement,
     RoborockMissingParameters,
     RoborockNoUserAgreement,
+    RoborockRateLimit,
     RoborockTooFrequentCodeRequests,
     RoborockTooManyRequest,
     RoborockUrlException,
@@ -30,6 +32,22 @@ _LOGGER = logging.getLogger(__name__)
 
 
 class RoborockApiClient:
+    _LOGIN_RATES = [
+        Rate(1, Duration.SECOND),
+        Rate(3, Duration.MINUTE),
+        Rate(10, Duration.HOUR),
+        Rate(20, Duration.DAY),
+    ]
+    _HOME_DATA_RATES = [
+        Rate(1, Duration.SECOND),
+        Rate(5, Duration.MINUTE),
+        Rate(15, Duration.HOUR),
+        Rate(40, Duration.DAY),
+    ]
+
+    _login_limiter = Limiter(_LOGIN_RATES)
+    _home_data_limiter = Limiter(_HOME_DATA_RATES)
+
     def __init__(self, username: str, base_url=None, session: aiohttp.ClientSession | None = None) -> None:
         """Sample API Client."""
         self._username = username
@@ -175,6 +193,11 @@ class RoborockApiClient:
         return add_device_response["result"]
 
     async def request_code(self) -> None:
+        try:
+            self._login_limiter.try_acquire("login")
+        except BucketFullException as ex:
+            _LOGGER.info(ex.meta_info)
+            raise RoborockRateLimit("Reached maximum requests for login. Please try again later.") from ex
         base_url = await self._get_base_url()
         header_clientid = self._get_header_client_id()
         code_request = PreparedRequest(base_url, self.session, {"header_clientid": header_clientid})
@@ -199,6 +222,11 @@ class RoborockApiClient:
                 raise RoborockException(f"{code_response.get('msg')} - response code: {code_response.get('code')}")
 
     async def pass_login(self, password: str) -> UserData:
+        try:
+            self._login_limiter.try_acquire("login")
+        except BucketFullException as ex:
+            _LOGGER.info(ex.meta_info)
+            raise RoborockRateLimit("Reached maximum requests for login. Please try again later.") from ex
         base_url = await self._get_base_url()
         header_clientid = self._get_header_client_id()
 
@@ -289,6 +317,11 @@ class RoborockApiClient:
         return home_id_response["data"]["rrHomeId"]
 
     async def get_home_data(self, user_data: UserData) -> HomeData:
+        try:
+            self._home_data_limiter.try_acquire("home_data")
+        except BucketFullException as ex:
+            _LOGGER.info(ex.meta_info)
+            raise RoborockRateLimit("Reached maximum requests for home data. Please try again later.") from ex
         rriot = user_data.rriot
         if rriot is None:
             raise RoborockException("rriot is none")
@@ -313,6 +346,11 @@ class RoborockApiClient:
 
     async def get_home_data_v2(self, user_data: UserData) -> HomeData:
         """This is the same as get_home_data, but uses a different endpoint and includes non-robotic vacuums."""
+        try:
+            self._home_data_limiter.try_acquire("home_data")
+        except BucketFullException as ex:
+            _LOGGER.info(ex.meta_info)
+            raise RoborockRateLimit("Reached maximum requests for home data. Please try again later.") from ex
         rriot = user_data.rriot
         if rriot is None:
             raise RoborockException("rriot is none")
@@ -337,6 +375,11 @@ class RoborockApiClient:
 
     async def get_home_data_v3(self, user_data: UserData) -> HomeData:
         """This is the same as get_home_data, but uses a different endpoint and includes non-robotic vacuums."""
+        try:
+            self._home_data_limiter.try_acquire("home_data")
+        except BucketFullException as ex:
+            _LOGGER.info(ex.meta_info)
+            raise RoborockRateLimit("Reached maximum requests for home data. Please try again later.") from ex
         rriot = user_data.rriot
         home_id = await self._get_home_id(user_data)
         if rriot.r.a is None: