Fix Rituals Perfume Genie (home-assistant#151537)

Co-authored-by: Joostlek <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

CODEOWNERS

@@ -1,20 +1,23 @@
 """The Rituals Perfume Genie integration."""
 
 import asyncio
+import logging
 
-import aiohttp
-from pyrituals import Account, Diffuser
+from aiohttp import ClientError, ClientResponseError
+from pyrituals import Account, AuthenticationException, Diffuser
 
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import Platform
+from homeassistant.const import CONF_EMAIL, CONF_PASSWORD, Platform
 from homeassistant.core import HomeAssistant, callback
-from homeassistant.exceptions import ConfigEntryNotReady
+from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
 from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
 from .const import ACCOUNT_HASH, DOMAIN, UPDATE_INTERVAL
 from .coordinator import RitualsDataUpdateCoordinator
 
+_LOGGER = logging.getLogger(__name__)
+
 PLATFORMS = [
     Platform.BINARY_SENSOR,
     Platform.NUMBER,
@@ -26,12 +29,38 @@
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up Rituals Perfume Genie from a config entry."""
+    # Initiate reauth for old config entries which don't have username / password in the entry data
+    if CONF_EMAIL not in entry.data or CONF_PASSWORD not in entry.data:
+        raise ConfigEntryAuthFailed("Missing credentials")
+
     session = async_get_clientsession(hass)
-    account = Account(session=session, account_hash=entry.data[ACCOUNT_HASH])
+
+    account = Account(
+        email=entry.data[CONF_EMAIL],
+        password=entry.data[CONF_PASSWORD],
+        session=session,
+    )
 
     try:
+        # Authenticate first so API token/cookies are available for subsequent calls
+        await account.authenticate()
         account_devices = await account.get_devices()
-    except aiohttp.ClientError as err:
+
+    except AuthenticationException as err:
+        # Credentials invalid/expired -> raise AuthFailed to trigger reauth flow
+
+        raise ConfigEntryAuthFailed(err) from err
+
+    except ClientResponseError as err:
+        _LOGGER.debug(
+            "HTTP error during Rituals setup: status=%s, url=%s, headers=%s",
+            err.status,
+            err.request_info,
+            dict(err.headers or {}),
+        )
+        raise ConfigEntryNotReady from err
+
+    except ClientError as err:
         raise ConfigEntryNotReady from err
 
     # Migrate old unique_ids to the new format
@@ -45,7 +74,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     # Create a coordinator for each diffuser
     coordinators = {
         diffuser.hublot: RitualsDataUpdateCoordinator(
-            hass, entry, diffuser, update_interval
+            hass, entry, account, diffuser, update_interval
         )
         for diffuser in account_devices
     }
@@ -106,3 +135,14 @@ def async_migrate_entities_unique_ids(
                     registry_entry.entity_id,
                     new_unique_id=f"{diffuser.hublot}-{new_unique_id}",
                 )
+
+
+# Migration helpers for API v2
+async def async_migrate_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Migrate config entry to version 2: drop legacy ACCOUNT_HASH and bump version."""
+    if entry.version < 2:
+        data = dict(entry.data)
+        data.pop(ACCOUNT_HASH, None)
+        hass.config_entries.async_update_entry(entry, data=data, version=2)
+        return True
+    return True

homeassistant/components/rituals_perfume_genie/__init__.py

@@ -2,20 +2,18 @@
 
 from __future__ import annotations
 
-import logging
-from typing import Any
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any
 
-from aiohttp import ClientResponseError
+from aiohttp import ClientError
 from pyrituals import Account, AuthenticationException
 import voluptuous as vol
 
 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
 from homeassistant.const import CONF_EMAIL, CONF_PASSWORD
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
-from .const import ACCOUNT_HASH, DOMAIN
-
-_LOGGER = logging.getLogger(__name__)
+from .const import DOMAIN
 
 DATA_SCHEMA = vol.Schema(
     {
@@ -28,39 +26,88 @@
 class RitualsPerfumeGenieConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a config flow for Rituals Perfume Genie."""
 
-    VERSION = 1
+    VERSION = 2
 
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
         """Handle the initial step."""
-        if user_input is None:
-            return self.async_show_form(step_id="user", data_schema=DATA_SCHEMA)
-
-        errors = {}
-
-        session = async_get_clientsession(self.hass)
-        account = Account(user_input[CONF_EMAIL], user_input[CONF_PASSWORD], session)
-
-        try:
-            await account.authenticate()
-        except ClientResponseError:
-            _LOGGER.exception("Unexpected response")
-            errors["base"] = "cannot_connect"
-        except AuthenticationException:
-            errors["base"] = "invalid_auth"
-        except Exception:
-            _LOGGER.exception("Unexpected exception")
-            errors["base"] = "unknown"
-        else:
-            await self.async_set_unique_id(account.email)
-            self._abort_if_unique_id_configured()
-
-            return self.async_create_entry(
-                title=account.email,
-                data={ACCOUNT_HASH: account.account_hash},
+        errors: dict[str, str] = {}
+        if user_input is not None:
+            session = async_get_clientsession(self.hass)
+            account = Account(
+                email=user_input[CONF_EMAIL],
+                password=user_input[CONF_PASSWORD],
+                session=session,
             )
 
+            try:
+                await account.authenticate()
+            except AuthenticationException:
+                errors["base"] = "invalid_auth"
+            except ClientError:
+                errors["base"] = "cannot_connect"
+            else:
+                await self.async_set_unique_id(user_input[CONF_EMAIL])
+                self._abort_if_unique_id_configured()
+                return self.async_create_entry(
+                    title=user_input[CONF_EMAIL],
+                    data=user_input,
+                )
+
         return self.async_show_form(
             step_id="user", data_schema=DATA_SCHEMA, errors=errors
         )
+
+    async def async_step_reauth(
+        self, entry_data: Mapping[str, Any]
+    ) -> ConfigFlowResult:
+        """Handle re-authentication with Rituals."""
+        return await self.async_step_reauth_confirm()
+
+    async def async_step_reauth_confirm(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Form to log in again."""
+        errors: dict[str, str] = {}
+
+        reauth_entry = self._get_reauth_entry()
+
+        if TYPE_CHECKING:
+            assert reauth_entry.unique_id is not None
+
+        if user_input:
+            session = async_get_clientsession(self.hass)
+            account = Account(
+                email=reauth_entry.unique_id,
+                password=user_input[CONF_PASSWORD],
+                session=session,
+            )
+
+            try:
+                await account.authenticate()
+            except AuthenticationException:
+                errors["base"] = "invalid_auth"
+            except ClientError:
+                errors["base"] = "cannot_connect"
+            else:
+                return self.async_update_reload_and_abort(
+                    reauth_entry,
+                    data={
+                        CONF_EMAIL: reauth_entry.unique_id,
+                        CONF_PASSWORD: user_input[CONF_PASSWORD],
+                    },
+                )
+
+        return self.async_show_form(
+            step_id="reauth_confirm",
+            data_schema=self.add_suggested_values_to_schema(
+                vol.Schema(
+                    {
+                        vol.Required(CONF_PASSWORD): str,
+                    }
+                ),
+                reauth_entry.data,
+            ),
+            errors=errors,
+        )

homeassistant/components/rituals_perfume_genie/config_flow.py

@@ -4,6 +4,7 @@
 
 DOMAIN = "rituals_perfume_genie"
 
+# Old (API V1)
 ACCOUNT_HASH = "account_hash"
 
 # The API provided by Rituals is currently rate limited to 30 requests

homeassistant/components/rituals_perfume_genie/const.py

@@ -3,11 +3,13 @@
 from datetime import timedelta
 import logging
 
-from pyrituals import Diffuser
+from aiohttp import ClientError, ClientResponseError
+from pyrituals import Account, AuthenticationException, Diffuser
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
+from homeassistant.exceptions import ConfigEntryAuthFailed
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from .const import DOMAIN
 
@@ -23,10 +25,12 @@ def __init__(
         self,
         hass: HomeAssistant,
         config_entry: ConfigEntry,
+        account: Account,
         diffuser: Diffuser,
         update_interval: timedelta,
     ) -> None:
         """Initialize global Rituals Perfume Genie data updater."""
+        self.account = account
         self.diffuser = diffuser
         super().__init__(
             hass,
@@ -37,5 +41,36 @@ def __init__(
         )
 
     async def _async_update_data(self) -> None:
-        """Fetch data from Rituals."""
-        await self.diffuser.update_data()
+        """Fetch data from Rituals, with one silent re-auth on 401.
+
+        If silent re-auth also fails, raise ConfigEntryAuthFailed to trigger reauth flow.
+        Other HTTP/network errors are wrapped in UpdateFailed so HA can retry.
+        """
+        try:
+            await self.diffuser.update_data()
+        except (AuthenticationException, ClientResponseError) as err:
+            # Treat 401/403 like AuthenticationException → one silent re-auth, single retry
+            if isinstance(err, ClientResponseError) and (status := err.status) not in (
+                401,
+                403,
+            ):
+                # Non-auth HTTP error → let HA retry
+                raise UpdateFailed(f"HTTP {status}") from err
+
+            self.logger.debug(
+                "Auth issue detected (%r). Attempting silent re-auth.", err
+            )
+            try:
+                await self.account.authenticate()
+                await self.diffuser.update_data()
+            except AuthenticationException as err2:
+                # Credentials invalid → trigger HA reauth
+                raise ConfigEntryAuthFailed from err2
+            except ClientResponseError as err2:
+                # Still HTTP auth errors after refresh → trigger HA reauth
+                if err2.status in (401, 403):
+                    raise ConfigEntryAuthFailed from err2
+                raise UpdateFailed(f"HTTP {err2.status}") from err2
+        except ClientError as err:
+            # Network issues (timeouts, DNS, etc.)
+            raise UpdateFailed(f"Network error: {err!r}") from err

homeassistant/components/rituals_perfume_genie/coordinator.py

@@ -1,10 +1,10 @@
 {
   "domain": "rituals_perfume_genie",
   "name": "Rituals Perfume Genie",
-  "codeowners": ["@milanmeu", "@frenck"],
+  "codeowners": ["@milanmeu", "@frenck", "@quebulm"],
   "config_flow": true,
   "documentation": "https://www.home-assistant.io/integrations/rituals_perfume_genie",
   "iot_class": "cloud_polling",
   "loggers": ["pyrituals"],
-  "requirements": ["pyrituals==0.0.6"]
+  "requirements": ["pyrituals==0.0.7"]
 }

homeassistant/components/rituals_perfume_genie/manifest.json

@@ -1,14 +1,21 @@
 {
   "config": {
     "abort": {
-      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+      "already_configured": "[%key:common::config_flow::abort::already_configured_account%]",
+      "reauth_successful": "Re-authentication was successful"
     },
     "error": {
       "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
       "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
       "unknown": "[%key:common::config_flow::error::unknown%]"
     },
     "step": {
+      "reauth_confirm": {
+        "data": {
+          "password": "[%key:common::config_flow::data::password%]"
+        },
+        "description": "Please enter the correct password."
+      },
       "user": {
         "data": {
           "email": "[%key:common::config_flow::data::email%]",