API Key checks: #20

Author: iluvdata

custom_components/liebherr/config_flow.py

@@ -1,6 +1,7 @@
 """Config flow for Liebherr Integration."""
 
 from collections.abc import Mapping
+import re
 from typing import Any
 
 from pyliebherr import LiebherrAPI, LiebherrDevice
@@ -145,13 +146,16 @@ async def async_step_user(
 
         if user_input is not None:
             # check the API key
-            api: LiebherrAPI = LiebherrAPI(user_input[CONF_API_KEY])
-            devices: list[LiebherrDevice] = []
-            try:
-                devices = await api.async_get_appliances()
-            except LiebherrAuthException:
-                errors["base"] = "auth_error"
-            await api.async_close()
+            if not re.fullmatch("^\\S.*\\S$", user_input[CONF_API_KEY]):
+                errors[CONF_API_KEY] = "whitespace_api_key"
+            else:
+                api: LiebherrAPI = LiebherrAPI(user_input[CONF_API_KEY])
+                devices: list[LiebherrDevice] = []
+                try:
+                    devices = await api.async_get_appliances()
+                except LiebherrAuthException:
+                    errors["base"] = "auth_error"
+                await api.async_close()
             if not errors:
                 await self.async_set_unique_id(f"{DOMAIN}_{user_input[CONF_API_KEY]}")
                 self._abort_if_unique_id_configured()
@@ -181,9 +185,7 @@ async def async_step_user(
                 return self.async_abort(reason="invalid_source")
 
         data_schema: vol.Schema = vol.Schema(
-            {
-                vol.Required(CONF_API_KEY): TextSelector(),
-            }
+            {vol.Required(CONF_API_KEY): vol.All(TextSelector())}
         )
         return self.async_show_form(
             step_id="user", data_schema=data_schema, errors=errors

custom_components/liebherr/entity.py

@@ -2,8 +2,8 @@
 
 import logging
 
-from pyliebherr import LiebherrControl, LiebherrDevice
-from pyliebherr.models import ControlType, LiebherrMappedControls
+from pyliebherr import ControlType, LiebherrControl, LiebherrDevice
+from pyliebherr.models import LiebherrMappedControls
 
 from homeassistant.helpers.device_registry import DeviceInfo
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback

custom_components/liebherr/strings.json

@@ -15,7 +15,8 @@
       }
     },
     "error": {
-      "auth_error": "[%key:common::config_flow::error::invalid_api_key%]"
+      "auth_error": "[%key:common::config_flow::error::invalid_api_key%]",
+      "whitespace_api_key": "There is whitespace before or after the api key."
     },
     "abort": {
       "already_configured": "API Key already configured.",

custom_components/liebherr/translations/ar.json

@@ -15,7 +15,8 @@
       }
     },
     "error": {
-      "auth_error": "API-Schlüssel ist nicht autorisiert oder ungültig."
+      "auth_error": "API-Schlüssel ist nicht autorisiert oder ungültig.",
+      "whitespace_api_key": "There is whitespace before or after the api key."
     },
     "abort": {
       "already_configured": "HomeAPI-Schlüssel bereits konfiguriert.",

custom_components/liebherr/translations/de.json

@@ -15,7 +15,8 @@
       }
     },
     "error": {
-      "auth_error": "API Key is unauthorized or invalid."
+      "auth_error": "API Key is unauthorized or invalid.",
+      "whitespace_api_key": "There is whitespace before or after the api key."
     },
     "abort": {
       "already_configured": "API Key already configured.",

custom_components/liebherr/translations/en.json

@@ -10,7 +10,8 @@
       }
     },
     "error": {
-      "auth_error": "Clavo API no autorizado o inválido."
+      "auth_error": "Clavo API no autorizado o inválido.",
+      "whitespace_api_key": "Hay espacio en blanco antes o detras del Clavo API."
     },
     "abort": {
       "already_configured": "Clavo API ya configurada.",

custom_components/liebherr/translations/es.json

@@ -15,7 +15,8 @@
       }
     },
      "error": {
-      "auth_error": "Clé API non autorisée ou invalide."
+      "auth_error": "Clé API non autorisée ou invalide.",
+      "whitespace_api_key": "There is whitespace before or after the api key."
     },
 
     "abort": {

custom_components/liebherr/translations/fr.json

@@ -15,7 +15,8 @@
       }
     },
     "error": {
-      "auth_error": "API Key nincs engedélyezve vagy érvénytelen."
+      "auth_error": "API Key nincs engedélyezve vagy érvénytelen.",
+      "whitespace_api_key": "There is whitespace before or after the api key."
     },
     "abort": {
       "already_configured": "API Key már konfigurálva.",

custom_components/liebherr/translations/hu.json

@@ -15,7 +15,8 @@
       }
     },
     "error": {
-      "auth_error": "API Key non autorizzata o invalida."
+      "auth_error": "API Key non autorizzata o invalida.",
+      "whitespace_api_key": "There is whitespace before or after the api key."
     },
     "abort": {
       "already_configured": "API Key già configurata.",