Added forbidden error handling for API #28

Author: erikkastelec

custom_components/wemportal/coordinator.py

@@ -8,7 +8,7 @@
     DataUpdateCoordinator,
     UpdateFailed,
 )
-from .exceptions import ServerError, WemPortalError
+from .exceptions import ForbiddenError, ServerError, WemPortalError
 from .const import _LOGGER, DEFAULT_TIMEOUT
 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
 from .wemportalapi import WemPortalApi
@@ -41,8 +41,7 @@ async def _async_update_data(self):
             try:
                 return await self.hass.async_add_executor_job(self.api.fetch_data)
             except WemPortalError as exc:
-                
-                if isinstance(exc.__cause__, ServerError):
+                if isinstance(exc.__cause__, (ServerError, ForbiddenError)):
                     _LOGGER.error("Creating new wemportal api instance")
                     # TODO: This is a temporary solution and should be removed when api cause from #28 is resolved
                     try:
@@ -55,12 +54,14 @@ async def _async_update_data(self):
                     except Exception as exc2:
                         raise UpdateFailed from exc2
                     try:
-                        return await self.hass.async_add_executor_job(self.api.fetch_data)
+                        return await self.hass.async_add_executor_job(
+                            self.api.fetch_data
+                        )
                     except WemPortalError as exc2:
-                        _LOGGER.error("Error fetching data from wemportal", exc_info=exc)
+                        _LOGGER.error(
+                            "Error fetching data from wemportal", exc_info=exc
+                        )
                         raise UpdateFailed from exc2
                 else:
                     _LOGGER.error("Error fetching data from wemportal", exc_info=exc)
                     raise UpdateFailed from exc
-                    
-                

custom_components/wemportal/exceptions.py

@@ -8,21 +8,29 @@ class WemPortalError(HomeAssistantError):
     Custom exception for WEM Portal errors
     """
 
+
 class AuthError(WemPortalError):
     """Exception to indicate an authentication error."""
 
 
 class UnknownAuthError(WemPortalError):
     """Exception to indicate an unknown authentication error."""
 
+
 class ServerError(WemPortalError):
     """Exception to indicate a server error."""
 
+
+class ForbiddenError(WemPortalError):
+    """Exception to indicate a forbidden error (403)."""
+
+
 class ExpiredSessionError(WemPortalError):
     """
     Custom exception for expired session errors
     """
 
+
 class ParameterChangeError(WemPortalError):
     """
     Custom exception for parameter change errors

custom_components/wemportal/wemportalapi.py

@@ -12,10 +12,11 @@
 import requests as reqs
 import scrapyscript
 from fuzzywuzzy import fuzz
-from homeassistant.const import CONF_PASSWORD, CONF_SCAN_INTERVAL, CONF_USERNAME
+from homeassistant.const import CONF_SCAN_INTERVAL
 from scrapy import FormRequest, Spider, Request
 from .exceptions import (
     AuthError,
+    ForbiddenError,
     UnknownAuthError,
     WemPortalError,
     ExpiredSessionError,
@@ -73,7 +74,7 @@ def __init__(self, username, password, config={}) -> None:
             "X-Api-Version": "2.0.0.0",
             "Accept": "*/*",
         }
-        self.scrapingMapper = {}
+        self.scraping_mapper = {}
 
         # Used to keep track of how many update intervals to wait before retrying spider
         self.spider_wait_interval = 0
@@ -197,12 +198,16 @@ def api_login(self):
             response_status, response_message = self.get_response_details(response)
             if response is None:
                 raise UnknownAuthError(
-                    f"Authentication Error: Encountered an unknown authentication error."
+                    "Authentication Error: Encountered an unknown authentication error."
                 ) from exc
             elif response.status_code == 400:
                 raise AuthError(
                     f"Authentication Error: Check if your login credentials are correct. Received response code: {response.status_code}, response: {response.content}. Server returned internal status code: {response_status} and message: {response_message}"
                 ) from exc
+            elif response.status_code == 403:
+                raise ForbiddenError(
+                    f"WemPortal forbidden error: Server returned internal status code: {response_status} and message: {response_message}"
+                ) from exc
             elif response.status_code == 500:
                 raise ServerError(
                     f"WemPortal server error: Server returned internal status code: {response_status} and message: {response_message}"
@@ -243,7 +248,7 @@ def make_api_call(
                 )
             response.raise_for_status()
         except Exception as exc:
-            if response and response.status_code == 401 and not login_retry:
+            if response and response.status_code in (401, 403) and not login_retry:
                 self.api_login()
                 headers = headers or self.headers
                 time.sleep(delay)
@@ -347,7 +352,7 @@ def change_value(
             headers=headers,
             data=json.dumps(data),
         )
-        if response.status_code == 401 and login:
+        if response.status_code in (401, 403) and login:
             self.api_login()
             self.change_value(
                 device_id,
@@ -516,7 +521,7 @@ def get_data(self):
                         # Only for single device, don't know how to handle multiple devices with scraping yet
                         if self.mode == "both" and len(self.data.keys()) < 2:
                             try:
-                                temp = self.scrapingMapper[value["ParameterID"]]
+                                temp = self.scraping_mapper[value["ParameterID"]]
                             except KeyError:
                                 for scraped_entity in self.data[device_id].keys():
                                     scraped_entity_id = self.data[device_id][
@@ -530,21 +535,21 @@ def get_data(self):
                                             )
                                             >= 90
                                         ):
-                                            self.scrapingMapper.setdefault(
+                                            self.scraping_mapper.setdefault(
                                                 value["ParameterID"], []
                                             ).append(scraped_entity_id)
                                     except IndexError:
                                         pass
                                 # Check if empty
                                 try:
-                                    temp = self.scrapingMapper[value["ParameterID"]]
+                                    temp = self.scraping_mapper[value["ParameterID"]]
                                 except KeyError:
-                                    self.scrapingMapper[value["ParameterID"]] = [
+                                    self.scraping_mapper[value["ParameterID"]] = [
                                         value["friendlyName"]
                                     ]
 
                             finally:
-                                for scraped_entity in self.scrapingMapper[
+                                for scraped_entity in self.scraping_mapper[
                                     value["ParameterID"]
                                 ]:
                                     sensor_dict = {