config_flow.py

Go to the documentation of this file.

"""Config flow for Geocaching."""
 
from __future__ import annotations
 
from collections.abc import Mapping
import logging
from typing import Any
 
from geocachingapi.geocachingapi import GeocachingApi
 
from homeassistant.config_entries import ConfigFlowResult
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.config_entry_oauth2_flow import AbstractOAuth2FlowHandler
 
from .const import DOMAIN, ENVIRONMENT
 
 
class GeocachingFlowHandler(AbstractOAuth2FlowHandler, domain=DOMAIN):
    """Config flow to handle Geocaching OAuth2 authentication."""
 
    DOMAIN = DOMAIN
    VERSION = 1
 
    @property
    def logger(self) -> logging.Logger:
        """Return logger."""
        return logging.getLogger(__name__)
 
    async def async_step_reauth(
        self, entry_data: Mapping[str, Any]
    ) -> ConfigFlowResult:
        """Perform reauth upon an API authentication error."""
        return await self.async_step_reauth_confirmasync_step_reauth_confirm()
 
    async def async_step_reauth_confirm(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Dialog that informs the user that reauth is required."""
        if user_input is None:
            return self.async_show_formasync_show_formasync_show_form(step_id="reauth_confirm")
        return await self.async_step_userasync_step_userasync_step_user()
 
    async def async_oauth_create_entry(self, data: dict[str, Any]) -> ConfigFlowResult:
        """Create an oauth config entry or update existing entry for reauth."""
        api = GeocachingApi(
            environment=ENVIRONMENT,
            token=data["token"]["access_token"],
            session=async_get_clientsession(self.hass),
        )
        status = await api.update()
        if not status.user or not status.user.username:
            return self.async_abortasync_abortasync_abort(reason="oauth_error")
 
        if existing_entry := await self.async_set_unique_idasync_set_unique_id(
            status.user.username.lower()
        ):
            self.hass.config_entries.async_update_entry(existing_entry, data=data)
            await self.hass.config_entries.async_reload(existing_entry.entry_id)
            return self.async_abortasync_abortasync_abort(reason="reauth_successful")
        return self.async_create_entryasync_create_entryasync_create_entry(title=status.user.username, data=data)