Add support for tracking stats of party members in Habitica integration (home-assistant#151885)

Author: tr4nt0r

homeassistant/components/habitica/__init__.py

@@ -72,8 +72,7 @@ async def async_setup_entry(
     config_entry.runtime_data = coordinator
 
     party = coordinator.data.user.party.id
-    if HABITICA_KEY not in hass.data:
-        hass.data[HABITICA_KEY] = {}
+    hass.data.setdefault(HABITICA_KEY, {})
 
     if party is not None and party not in hass.data[HABITICA_KEY]:
         party_coordinator = HabiticaPartyCoordinator(hass, config_entry, api)
@@ -117,9 +116,20 @@ def _party_update_listener() -> None:
     coordinator.async_add_listener(_party_update_listener)
 
     await hass.config_entries.async_forward_entry_setups(config_entry, PLATFORMS)
+
+    config_entry.async_on_unload(
+        config_entry.add_update_listener(_async_update_listener)
+    )
     return True
 
 
+async def _async_update_listener(
+    hass: HomeAssistant, entry: HabiticaConfigEntry
+) -> None:
+    """Handle update."""
+    await hass.config_entries.async_reload(entry.entry_id)
+
+
 async def shutdown_party_coordinator(hass: HomeAssistant, party_added: UUID) -> None:
     """Handle party coordinator shutdown."""
     await hass.data[HABITICA_KEY][party_added].async_shutdown()

homeassistant/components/habitica/config_flow.py

@@ -5,6 +5,7 @@
 from collections.abc import Mapping
 import logging
 from typing import TYPE_CHECKING, Any
+from uuid import UUID
 
 from aiohttp import ClientError
 from habiticalib import (
@@ -17,7 +18,14 @@
 import voluptuous as vol
 
 from homeassistant import data_entry_flow
-from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.config_entries import (
+    ConfigEntry,
+    ConfigEntryState,
+    ConfigFlow,
+    ConfigFlowResult,
+    ConfigSubentryFlow,
+    SubentryFlowResult,
+)
 from homeassistant.const import (
     CONF_API_KEY,
     CONF_NAME,
@@ -26,15 +34,21 @@
     CONF_USERNAME,
     CONF_VERIFY_SSL,
 )
+from homeassistant.core import callback
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 from homeassistant.helpers.selector import (
+    SelectOptionDict,
+    SelectSelector,
+    SelectSelectorConfig,
     TextSelector,
     TextSelectorConfig,
     TextSelectorType,
 )
 
+from . import HABITICA_KEY
 from .const import (
     CONF_API_USER,
+    CONF_PARTY_MEMBER,
     DEFAULT_URL,
     DOMAIN,
     FORGOT_PASSWORD_URL,
@@ -374,3 +388,66 @@ async def validate_api_key(
             return errors, user.data
 
         return errors, None
+
+    @classmethod
+    @callback
+    def async_get_supported_subentry_types(
+        cls, config_entry: ConfigEntry
+    ) -> dict[str, type[ConfigSubentryFlow]]:
+        """Return subentries supported by this integration."""
+        return {"party_member": PartyMembersSubentryFlowHandler}
+
+
+class PartyMembersSubentryFlowHandler(ConfigSubentryFlow):
+    """Handle subentry flow for adding party members."""
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> SubentryFlowResult:
+        """Subentry user flow."""
+
+        entry: HabiticaConfigEntry = self._get_entry()
+        if entry.state is not ConfigEntryState.LOADED:
+            return self.async_abort(reason="config_entry_disabled")
+        if (party := entry.runtime_data.data.user.party.id) is None:
+            return self.async_abort(reason="not_in_a_party")
+
+        party_members = self.hass.data[HABITICA_KEY][party].data.members
+
+        if user_input is not None:
+            config_entries = self.hass.config_entries.async_entries(DOMAIN)
+
+            for entry in config_entries:
+                if user_input[CONF_PARTY_MEMBER] == entry.unique_id:
+                    return self.async_abort(reason="already_configured_as_entry")
+                if user_input[CONF_PARTY_MEMBER] in {
+                    subentry.unique_id for subentry in entry.subentries.values()
+                }:
+                    return self.async_abort(reason="already_configured")
+
+            return self.async_create_entry(
+                title=party_members[UUID(user_input[CONF_PARTY_MEMBER])].profile.name,
+                data={},
+                unique_id=user_input[CONF_PARTY_MEMBER],
+            )
+
+        options = [
+            SelectOptionDict(
+                value=str(member_id),
+                label=f"{member.profile.name} (@{member.auth.local.username})",
+            )
+            for member_id, member in party_members.items()
+            if member_id != str(entry.runtime_data.data.user.id)
+            and member.profile.name
+            and member.auth.local.username
+        ]
+        return self.async_show_form(
+            step_id="user",
+            data_schema=vol.Schema(
+                {
+                    vol.Required(CONF_PARTY_MEMBER): SelectSelector(
+                        SelectSelectorConfig(options=options)
+                    )
+                }
+            ),
+        )

homeassistant/components/habitica/const.py

@@ -3,6 +3,7 @@
 from homeassistant.const import APPLICATION_NAME, __version__
 
 CONF_API_USER = "api_user"
+CONF_PARTY_MEMBER = "party_member"
 
 DEFAULT_URL = "https://habitica.com"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"

homeassistant/components/habitica/coordinator.py

@@ -213,7 +213,9 @@ async def _update_data(self) -> HabiticaPartyData:
             party=(await self.habitica.get_group()).data,
             members={
                 member.id: member
-                for member in (await self.habitica.get_group_members()).data
+                for member in (
+                    await self.habitica.get_group_members(public_fields=True)
+                ).data
                 if member.id
             },
         )

homeassistant/components/habitica/entity.py

@@ -3,10 +3,12 @@
 from __future__ import annotations
 
 from typing import TYPE_CHECKING
+from uuid import UUID
 
-from habiticalib import ContentData
+from habiticalib import ContentData, UserData
 from yarl import URL
 
+from homeassistant.config_entries import ConfigSubentry
 from homeassistant.const import CONF_URL
 from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
 from homeassistant.helpers.entity import EntityDescription
@@ -29,26 +31,84 @@ def __init__(
         self,
         coordinator: HabiticaDataUpdateCoordinator,
         entity_description: EntityDescription,
+        subentry: ConfigSubentry | None = None,
     ) -> None:
         """Initialize a Habitica entity."""
         super().__init__(coordinator)
         if TYPE_CHECKING:
             assert coordinator.config_entry.unique_id
+            assert self.user
         self.entity_description = entity_description
-        self._attr_unique_id = (
-            f"{coordinator.config_entry.unique_id}_{entity_description.key}"
+        self.subentry = subentry
+        unique_id = (
+            subentry.unique_id
+            if subentry is not None and subentry.unique_id
+            else coordinator.config_entry.unique_id
         )
+
+        self._attr_unique_id = f"{unique_id}_{entity_description.key}"
         self._attr_device_info = DeviceInfo(
             entry_type=DeviceEntryType.SERVICE,
             manufacturer=MANUFACTURER,
             model=NAME,
-            name=coordinator.data.user.profile.name,
+            name=self.user.profile.name,
             configuration_url=(
-                URL(coordinator.config_entry.data[CONF_URL])
-                / "profile"
-                / coordinator.config_entry.unique_id
+                URL(coordinator.config_entry.data[CONF_URL]) / "profile" / unique_id
             ),
-            identifiers={(DOMAIN, coordinator.config_entry.unique_id)},
+            identifiers={(DOMAIN, unique_id)},
+        )
+
+        if subentry:
+            self._attr_device_info.update(
+                DeviceInfo(
+                    via_device=(
+                        (
+                            DOMAIN,
+                            f"{coordinator.config_entry.unique_id}_{self.user.party.id}",
+                        )
+                    )
+                )
+            )
+
+    @property
+    def user(self) -> UserData | None:
+        """Return the user data."""
+        return self.coordinator.data.user
+
+
+class HabiticaPartyMemberBase(HabiticaBase):
+    """Base Habitica party member entity."""
+
+    def __init__(
+        self,
+        coordinator: HabiticaDataUpdateCoordinator,
+        party_coordinator: HabiticaPartyCoordinator,
+        entity_description: EntityDescription,
+        subentry: ConfigSubentry | None = None,
+    ) -> None:
+        """Initialize a Habitica entity."""
+        self.party_coordinator = party_coordinator
+        super().__init__(coordinator, entity_description, subentry)
+
+    @property
+    def user(self) -> UserData | None:
+        """Return the user data of the party member."""
+        if TYPE_CHECKING:
+            assert self.subentry
+            assert self.subentry.unique_id
+        return self.party_coordinator.data.members.get(UUID(self.subentry.unique_id))
+
+    @property
+    def available(self) -> bool:
+        """Return True if entity is available."""
+
+        return super().available and self.user is not None
+
+    async def async_added_to_hass(self) -> None:
+        """When entity is added to hass."""
+        await super().async_added_to_hass()
+        self.async_on_remove(
+            self.party_coordinator.async_add_listener(self._handle_coordinator_update)
         )
 
 

homeassistant/components/habitica/image.py

@@ -3,10 +3,13 @@
 from __future__ import annotations
 
 from enum import StrEnum
+from typing import TYPE_CHECKING
+from uuid import UUID
 
 from habiticalib import Avatar, ContentData, extract_avatar
 
 from homeassistant.components.image import Image, ImageEntity, ImageEntityDescription
+from homeassistant.config_entries import ConfigSubentry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 from homeassistant.util import dt as dt_util
@@ -18,7 +21,7 @@
     HabiticaDataUpdateCoordinator,
     HabiticaPartyCoordinator,
 )
-from .entity import HabiticaBase, HabiticaPartyBase
+from .entity import HabiticaBase, HabiticaPartyBase, HabiticaPartyMemberBase
 
 PARALLEL_UPDATES = 1
 
@@ -47,6 +50,22 @@ async def async_setup_entry(
                 hass, party_coordinator, config_entry, coordinator.content
             )
         )
+        for subentry_id, subentry in config_entry.subentries.items():
+            if (
+                subentry.unique_id
+                and UUID(subentry.unique_id) in party_coordinator.data.members
+            ):
+                async_add_entities(
+                    [
+                        HabiticaPartyMemberImage(
+                            hass,
+                            coordinator,
+                            party_coordinator,
+                            subentry,
+                        )
+                    ],
+                    config_subentry_id=subentry_id,
+                )
 
     async_add_entities(entities)
 
@@ -66,18 +85,21 @@ def __init__(
         self,
         hass: HomeAssistant,
         coordinator: HabiticaDataUpdateCoordinator,
+        subentry: ConfigSubentry | None = None,
     ) -> None:
         """Initialize the image entity."""
-        super().__init__(coordinator, self.entity_description)
+        HabiticaBase.__init__(self, coordinator, self.entity_description, subentry)
         ImageEntity.__init__(self, hass)
         self._attr_image_last_updated = dt_util.utcnow()
-        self._avatar = extract_avatar(self.coordinator.data.user)
+        if TYPE_CHECKING:
+            assert self.user
+        self._avatar = extract_avatar(self.user)
 
     def _handle_coordinator_update(self) -> None:
         """Check if equipped gear and other things have changed since last avatar image generation."""
 
-        if self._avatar != self.coordinator.data.user:
-            self._avatar = extract_avatar(self.coordinator.data.user)
+        if self.user is not None and self._avatar != self.user:
+            self._avatar = extract_avatar(self.user)
             self._attr_image_last_updated = dt_util.utcnow()
             self._cache = None
 
@@ -90,6 +112,24 @@ async def async_image(self) -> bytes | None:
         return self._cache
 
 
+class HabiticaPartyMemberImage(HabiticaImage, HabiticaPartyMemberBase):
+    """A Habitica party member image entity."""
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        coordinator: HabiticaDataUpdateCoordinator,
+        party_coordinator: HabiticaPartyCoordinator,
+        subentry: ConfigSubentry | None = None,
+    ) -> None:
+        """Initialize the image entity."""
+
+        HabiticaPartyMemberBase.__init__(
+            self, coordinator, party_coordinator, self.entity_description, subentry
+        )
+        super().__init__(hass, coordinator, subentry)
+
+
 class HabiticaPartyImage(HabiticaPartyBase, ImageEntity):
     """A Habitica image entity of a party."""