[pull] dev from home-assistant:dev

.strict-typing

@@ -203,6 +203,7 @@ homeassistant.components.feedreader.*
 homeassistant.components.file_upload.*
 homeassistant.components.filesize.*
 homeassistant.components.filter.*
+homeassistant.components.firefly_iii.*
 homeassistant.components.fitbit.*
 homeassistant.components.flexit_bacnet.*
 homeassistant.components.flux_led.*

homeassistant/components/firefly_iii/__init__.py

@@ -0,0 +1,27 @@
+"""The Firefly III integration."""
+
+from __future__ import annotations
+
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+
+from .coordinator import FireflyConfigEntry, FireflyDataUpdateCoordinator
+
+_PLATFORMS: list[Platform] = [Platform.SENSOR]
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: FireflyConfigEntry) -> bool:
+    """Set up Firefly III from a config entry."""
+
+    coordinator = FireflyDataUpdateCoordinator(hass, entry)
+    await coordinator.async_config_entry_first_refresh()
+
+    entry.runtime_data = coordinator
+    await hass.config_entries.async_forward_entry_setups(entry, _PLATFORMS)
+
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: FireflyConfigEntry) -> bool:
+    """Unload a config entry."""
+    return await hass.config_entries.async_unload_platforms(entry, _PLATFORMS)

homeassistant/components/firefly_iii/config_flow.py

@@ -0,0 +1,97 @@
+"""Config flow for the Firefly III integration."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from pyfirefly import (
+    Firefly,
+    FireflyAuthenticationError,
+    FireflyConnectionError,
+    FireflyTimeoutError,
+)
+import voluptuous as vol
+
+from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.const import CONF_API_KEY, CONF_URL, CONF_VERIFY_SSL
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+STEP_USER_DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_URL): str,
+        vol.Optional(CONF_VERIFY_SSL, default=True): bool,
+        vol.Required(CONF_API_KEY): str,
+    }
+)
+
+
+async def _validate_input(hass: HomeAssistant, data: dict[str, Any]) -> bool:
+    """Validate the user input allows us to connect."""
+
+    try:
+        client = Firefly(
+            api_url=data[CONF_URL],
+            api_key=data[CONF_API_KEY],
+            session=async_get_clientsession(hass),
+        )
+        await client.get_about()
+    except FireflyAuthenticationError:
+        raise InvalidAuth from None
+    except FireflyConnectionError as err:
+        raise CannotConnect from err
+    except FireflyTimeoutError as err:
+        raise FireflyClientTimeout from err
+
+    return True
+
+
+class FireflyConfigFlow(ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for Firefly III."""
+
+    VERSION = 1
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle the initial step."""
+        errors: dict[str, str] = {}
+        if user_input is not None:
+            self._async_abort_entries_match({CONF_URL: user_input[CONF_URL]})
+            try:
+                await _validate_input(self.hass, user_input)
+            except CannotConnect:
+                errors["base"] = "cannot_connect"
+            except InvalidAuth:
+                errors["base"] = "invalid_auth"
+            except FireflyClientTimeout:
+                errors["base"] = "timeout_connect"
+            except Exception:
+                _LOGGER.exception("Unexpected exception")
+                errors["base"] = "unknown"
+            else:
+                return self.async_create_entry(
+                    title=user_input[CONF_URL], data=user_input
+                )
+
+        return self.async_show_form(
+            step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
+        )
+
+
+class CannotConnect(HomeAssistantError):
+    """Error to indicate we cannot connect."""
+
+
+class InvalidAuth(HomeAssistantError):
+    """Error to indicate there is invalid auth."""
+
+
+class FireflyClientTimeout(HomeAssistantError):
+    """Error to indicate a timeout occurred."""

homeassistant/components/firefly_iii/const.py

@@ -0,0 +1,6 @@
+"""Constants for the Firefly III integration."""
+
+DOMAIN = "firefly_iii"
+
+MANUFACTURER = "Firefly III"
+NAME = "Firefly III"

homeassistant/components/firefly_iii/coordinator.py

@@ -0,0 +1,137 @@
+"""Data Update Coordinator for Firefly III integration."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from datetime import datetime, timedelta
+import logging
+
+from aiohttp import CookieJar
+from pyfirefly import (
+    Firefly,
+    FireflyAuthenticationError,
+    FireflyConnectionError,
+    FireflyTimeoutError,
+)
+from pyfirefly.models import Account, Bill, Budget, Category, Currency
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_API_KEY, CONF_URL, CONF_VERIFY_SSL
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ConfigEntryError, ConfigEntryNotReady
+from homeassistant.helpers.aiohttp_client import async_create_clientsession
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
+
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+type FireflyConfigEntry = ConfigEntry[FireflyDataUpdateCoordinator]
+
+DEFAULT_SCAN_INTERVAL = timedelta(minutes=5)
+
+
+@dataclass
+class FireflyCoordinatorData:
+    """Data structure for Firefly III coordinator data."""
+
+    accounts: list[Account]
+    categories: list[Category]
+    category_details: list[Category]
+    budgets: list[Budget]
+    bills: list[Bill]
+    primary_currency: Currency
+
+
+class FireflyDataUpdateCoordinator(DataUpdateCoordinator[FireflyCoordinatorData]):
+    """Coordinator to manage data updates for Firefly III integration."""
+
+    config_entry: FireflyConfigEntry
+
+    def __init__(self, hass: HomeAssistant, config_entry: FireflyConfigEntry) -> None:
+        """Initialize the coordinator."""
+        super().__init__(
+            hass,
+            _LOGGER,
+            config_entry=config_entry,
+            name=DOMAIN,
+            update_interval=DEFAULT_SCAN_INTERVAL,
+        )
+        self.firefly = Firefly(
+            api_url=self.config_entry.data[CONF_URL],
+            api_key=self.config_entry.data[CONF_API_KEY],
+            session=async_create_clientsession(
+                self.hass,
+                self.config_entry.data[CONF_VERIFY_SSL],
+                cookie_jar=CookieJar(unsafe=True),
+            ),
+        )
+
+    async def _async_setup(self) -> None:
+        """Set up the coordinator."""
+        try:
+            await self.firefly.get_about()
+        except FireflyAuthenticationError as err:
+            raise ConfigEntryError(
+                translation_domain=DOMAIN,
+                translation_key="invalid_auth",
+                translation_placeholders={"error": repr(err)},
+            ) from err
+        except FireflyConnectionError as err:
+            raise ConfigEntryNotReady(
+                translation_domain=DOMAIN,
+                translation_key="cannot_connect",
+                translation_placeholders={"error": repr(err)},
+            ) from err
+        except FireflyTimeoutError as err:
+            raise ConfigEntryNotReady(
+                translation_domain=DOMAIN,
+                translation_key="timeout_connect",
+                translation_placeholders={"error": repr(err)},
+            ) from err
+
+    async def _async_update_data(self) -> FireflyCoordinatorData:
+        """Fetch data from Firefly III API."""
+        now = datetime.now()
+        start_date = now.replace(day=1, hour=0, minute=0, second=0, microsecond=0)
+        end_date = now
+
+        try:
+            accounts = await self.firefly.get_accounts()
+            categories = await self.firefly.get_categories()
+            category_details = [
+                await self.firefly.get_category(
+                    category_id=int(category.id), start=start_date, end=end_date
+                )
+                for category in categories
+            ]
+            primary_currency = await self.firefly.get_currency_primary()
+            budgets = await self.firefly.get_budgets()
+            bills = await self.firefly.get_bills()
+        except FireflyAuthenticationError as err:
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="invalid_auth",
+                translation_placeholders={"error": repr(err)},
+            ) from err
+        except FireflyConnectionError as err:
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="cannot_connect",
+                translation_placeholders={"error": repr(err)},
+            ) from err
+        except FireflyTimeoutError as err:
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="timeout_connect",
+                translation_placeholders={"error": repr(err)},
+            ) from err
+
+        return FireflyCoordinatorData(
+            accounts=accounts,
+            categories=categories,
+            category_details=category_details,
+            budgets=budgets,
+            bills=bills,
+            primary_currency=primary_currency,
+        )

homeassistant/components/firefly_iii/entity.py

@@ -0,0 +1,40 @@
+"""Base entity for Firefly III integration."""
+
+from __future__ import annotations
+
+from yarl import URL
+
+from homeassistant.const import CONF_URL
+from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
+from homeassistant.helpers.entity import EntityDescription
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
+
+from .const import DOMAIN, MANUFACTURER
+from .coordinator import FireflyDataUpdateCoordinator
+
+
+class FireflyBaseEntity(CoordinatorEntity[FireflyDataUpdateCoordinator]):
+    """Base class for Firefly III entity."""
+
+    _attr_has_entity_name = True
+
+    def __init__(
+        self,
+        coordinator: FireflyDataUpdateCoordinator,
+        entity_description: EntityDescription,
+    ) -> None:
+        """Initialize a Firefly entity."""
+        super().__init__(coordinator)
+
+        self.entity_description = entity_description
+        self._attr_device_info = DeviceInfo(
+            entry_type=DeviceEntryType.SERVICE,
+            manufacturer=MANUFACTURER,
+            configuration_url=URL(coordinator.config_entry.data[CONF_URL]),
+            identifiers={
+                (
+                    DOMAIN,
+                    f"{coordinator.config_entry.entry_id}_{self.entity_description.key}",
+                )
+            },
+        )

homeassistant/components/firefly_iii/icons.json

@@ -0,0 +1,18 @@
+{
+  "entity": {
+    "sensor": {
+      "account_type": {
+        "default": "mdi:bank",
+        "state": {
+          "expense": "mdi:cash-minus",
+          "revenue": "mdi:cash-plus",
+          "asset": "mdi:account-cash",
+          "liability": "mdi:hand-coin"
+        }
+      },
+      "category": {
+        "default": "mdi:label"
+      }
+    }
+  }
+}

homeassistant/components/firefly_iii/manifest.json

@@ -0,0 +1,10 @@
+{
+  "domain": "firefly_iii",
+  "name": "Firefly III",
+  "codeowners": ["@erwindouna"],
+  "config_flow": true,
+  "documentation": "https://www.home-assistant.io/integrations/firefly_iii",
+  "iot_class": "local_polling",
+  "quality_scale": "bronze",
+  "requirements": ["pyfirefly==0.1.5"]
+}