From f1b6ae8784fe91fdb8b82bf7efd13943f1c6bb19 Mon Sep 17 00:00:00 2001
From: Franck Nijhof <git@frenck.dev>
Date: Fri, 4 Oct 2024 11:21:22 +0200
Subject: [PATCH] Adjust polling rate of Rituals Perfume Genie (#127544)

---
 .../components/rituals_perfume_genie/__init__.py     |  9 +++++++--
 .../components/rituals_perfume_genie/config_flow.py  |  1 +
 .../components/rituals_perfume_genie/const.py        |  6 +++++-
 .../components/rituals_perfume_genie/coordinator.py  | 12 +++++++++---
 4 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/homeassistant/components/rituals_perfume_genie/__init__.py b/homeassistant/components/rituals_perfume_genie/__init__.py
index 792a470ca3c..d0d16ba6324 100644
--- a/homeassistant/components/rituals_perfume_genie/__init__.py
+++ b/homeassistant/components/rituals_perfume_genie/__init__.py
@@ -12,7 +12,7 @@ from homeassistant.exceptions import ConfigEntryNotReady
 from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
-from .const import ACCOUNT_HASH, DOMAIN
+from .const import ACCOUNT_HASH, DOMAIN, UPDATE_INTERVAL
 from .coordinator import RitualsDataUpdateCoordinator
 
 PLATFORMS = [
@@ -37,9 +37,14 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     # Migrate old unique_ids to the new format
     async_migrate_entities_unique_ids(hass, entry, account_devices)
 
+    # The API provided by Rituals is currently rate limited to 30 requests
+    # per hour per IP address. To avoid hitting this limit, we will adjust
+    # the polling interval based on the number of diffusers one has.
+    update_interval = UPDATE_INTERVAL * len(account_devices)
+
     # Create a coordinator for each diffuser
     coordinators = {
-        diffuser.hublot: RitualsDataUpdateCoordinator(hass, diffuser)
+        diffuser.hublot: RitualsDataUpdateCoordinator(hass, diffuser, update_interval)
         for diffuser in account_devices
     }
 
diff --git a/homeassistant/components/rituals_perfume_genie/config_flow.py b/homeassistant/components/rituals_perfume_genie/config_flow.py
index 4f108d9bc22..f6736ab78e4 100644
--- a/homeassistant/components/rituals_perfume_genie/config_flow.py
+++ b/homeassistant/components/rituals_perfume_genie/config_flow.py
@@ -45,6 +45,7 @@ class RitualsPerfumeGenieConfigFlow(ConfigFlow, domain=DOMAIN):
         try:
             await account.authenticate()
         except ClientResponseError:
+            _LOGGER.exception("Unexpected response")
             errors["base"] = "cannot_connect"
         except AuthenticationException:
             errors["base"] = "invalid_auth"
diff --git a/homeassistant/components/rituals_perfume_genie/const.py b/homeassistant/components/rituals_perfume_genie/const.py
index 35d1c32d306..45428ced9d2 100644
--- a/homeassistant/components/rituals_perfume_genie/const.py
+++ b/homeassistant/components/rituals_perfume_genie/const.py
@@ -6,4 +6,8 @@ DOMAIN = "rituals_perfume_genie"
 
 ACCOUNT_HASH = "account_hash"
 
-UPDATE_INTERVAL = timedelta(minutes=2)
+# The API provided by Rituals is currently rate limited to 30 requests
+# per hour per IP address. To avoid hitting this limit, the polling
+# interval is set to 3 minutes. This also gives a little room for
+# Home Assistant restarts.
+UPDATE_INTERVAL = timedelta(minutes=3)
diff --git a/homeassistant/components/rituals_perfume_genie/coordinator.py b/homeassistant/components/rituals_perfume_genie/coordinator.py
index 4c86f110b17..a83e823bd4e 100644
--- a/homeassistant/components/rituals_perfume_genie/coordinator.py
+++ b/homeassistant/components/rituals_perfume_genie/coordinator.py
@@ -1,5 +1,6 @@
 """The Rituals Perfume Genie data update coordinator."""
 
+from datetime import timedelta
 import logging
 
 from pyrituals import Diffuser
@@ -7,7 +8,7 @@ from pyrituals import Diffuser
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
 
-from .const import DOMAIN, UPDATE_INTERVAL
+from .const import DOMAIN
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -15,14 +16,19 @@ _LOGGER = logging.getLogger(__name__)
 class RitualsDataUpdateCoordinator(DataUpdateCoordinator[None]):
     """Class to manage fetching Rituals Perfume Genie device data from single endpoint."""
 
-    def __init__(self, hass: HomeAssistant, diffuser: Diffuser) -> None:
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        diffuser: Diffuser,
+        update_interval: timedelta,
+    ) -> None:
         """Initialize global Rituals Perfume Genie data updater."""
         self.diffuser = diffuser
         super().__init__(
             hass,
             _LOGGER,
             name=f"{DOMAIN}-{diffuser.hublot}",
-            update_interval=UPDATE_INTERVAL,
+            update_interval=update_interval,
         )
 
     async def _async_update_data(self) -> None: