Add ApplicationNotAllowedException and update related tests (#1963)

This pull request introduces a new exception,
`ApplicationNotAllowedException`, to handle cases where access to a
setup is denied for a specific application. It also refactors the
exception hierarchy to group related access-denied errors under a new
base class, `ResourceAccessDeniedException`. Additionally, tests and
fixtures are updated to cover the new exception.

Exception hierarchy improvements:

* Introduced a new base exception, `ResourceAccessDeniedException`, and
updated `NotAuthenticatedException`,
`MissingAuthorizationTokenException`, and
`AccessDeniedToGatewayException` to inherit from it for better error
categorization.
[[1]](diffhunk://#diff-0dfa3f77b5b6d197b7ad275059dc5023e18e69b0cb889da6c6de67732257ddeeL32-R36)
[[2]](diffhunk://#diff-0dfa3f77b5b6d197b7ad275059dc5023e18e69b0cb889da6c6de67732257ddeeL64-R68)
[[3]](diffhunk://#diff-0dfa3f77b5b6d197b7ad275059dc5023e18e69b0cb889da6c6de67732257ddeeL100-R111)

New exception for application access denial:

* Added `ApplicationNotAllowedException` (inheriting from
`ResourceAccessDeniedException`) for handling cases when the API returns
a "RESOURCE_ACCESS_DENIED" error with the message "Your setup cannot be
accessed through this application".
[[1]](diffhunk://#diff-0dfa3f77b5b6d197b7ad275059dc5023e18e69b0cb889da6c6de67732257ddeeL100-R111)
[[2]](diffhunk://#diff-11513003e65960c0b1a4bccb3c6bf2b7dea08c03923a8e53b8dea1a05f213aa2R64)
[[3]](diffhunk://#diff-11513003e65960c0b1a4bccb3c6bf2b7dea08c03923a8e53b8dea1a05f213aa2R975-R978)

Test and fixture updates:

* Added a new test fixture (`cloud/resource-access-denied.json`) and
updated tests to verify that `ApplicationNotAllowedException` is raised
for the appropriate error response.
[[1]](diffhunk://#diff-0f9b9c678d1ade309735bdfcbc0d9ad8c6425b6d4d58d3ed017e5a8a9f215928R1-R4)
[[2]](diffhunk://#diff-0d92063e88430a02df61616c5f16b148b64ac4539d9cb9b8d883d5a23351b110R330-R334)

Author: iMicknl

pyoverkiz/client.py

@@ -44,6 +44,7 @@
 from pyoverkiz.exceptions import (
     AccessDeniedToGatewayException,
     ActionGroupSetupNotFoundException,
+    ApplicationNotAllowedException,
     BadCredentialsException,
     CozyTouchBadCredentialsException,
     CozyTouchServiceException,
@@ -971,6 +972,10 @@ async def check_response(response: ClientResponse) -> None:
             if "Access denied to gateway" in message:
                 raise AccessDeniedToGatewayException(message)
 
+            # {"errorCode": "RESOURCE_ACCESS_DENIED", "error": "Your setup cannot be accessed through this application"}
+            if message == "Your setup cannot be accessed through this application":
+                raise ApplicationNotAllowedException(message)
+
         # Undefined Overkiz exception
         raise OverkizException(result)
 

pyoverkiz/exceptions.py

@@ -29,7 +29,11 @@ class NoSuchResourceException(BaseOverkizException):
     """Raised when an invalid API call is made."""
 
 
-class NotAuthenticatedException(BaseOverkizException):
+class ResourceAccessDeniedException(BaseOverkizException):
+    """Raised when the API returns a RESOURCE_ACCESS_DENIED error."""
+
+
+class NotAuthenticatedException(ResourceAccessDeniedException):
     """Raised when the user is not authenticated."""
 
 
@@ -61,7 +65,7 @@ class MissingAPIKeyException(BaseOverkizException):
     """Raised when the API key is missing."""
 
 
-class MissingAuthorizationTokenException(BaseOverkizException):
+class MissingAuthorizationTokenException(ResourceAccessDeniedException):
     """Raised when the authorization token is missing."""
 
 
@@ -97,10 +101,14 @@ class UnknownObjectException(BaseOverkizException):
     """Raised when an unknown object is provided."""
 
 
-class AccessDeniedToGatewayException(BaseOverkizException):
+class AccessDeniedToGatewayException(ResourceAccessDeniedException):
     """Raised when access is denied to the gateway. This often happens when the user is not the owner of the gateway."""
 
 
+class ApplicationNotAllowedException(ResourceAccessDeniedException):
+    """Raised when the setup cannot be accessed through the application."""
+
+
 # Nexity
 class NexityBadCredentialsException(BadCredentialsException):
     """Raised when invalid credentials are provided to Nexity authentication API."""

tests/fixtures/exceptions/cloud/application-not-allowed.json

@@ -0,0 +1,4 @@
+{
+    "errorCode": "RESOURCE_ACCESS_DENIED",
+    "error": "Your setup cannot be accessed through this application"
+}

tests/test_client.py

@@ -327,6 +327,11 @@ async def test_get_diagnostic_data(self, client: OverkizClient, fixture_name: st
                 exceptions.AccessDeniedToGatewayException,
                 400,
             ),
+            (
+                "cloud/application-not-allowed.json",
+                exceptions.ApplicationNotAllowedException,
+                400,
+            ),
             (
                 "cloud/bad-credentials.json",
                 exceptions.BadCredentialsException,