fix: SeamAPIException should be named SeamApiException (#134)

Author: razor-x

seamapi/__init__.py

@@ -2,4 +2,4 @@
 # type: ignore
 
 from seamapi.seam import Seam
-from seamapi.seam import SeamAPIException
+from seamapi.seam import SeamApiException

seamapi/seam.py

@@ -6,7 +6,7 @@
 import sentry_sdk
 import pkg_resources
 from typing import Optional, cast
-from .types import AbstractSeam, SeamAPIException
+from .types import AbstractSeam, SeamApiException
 
 
 class Seam(AbstractSeam):
@@ -126,7 +126,7 @@ def make_request(self, method: str, path: str, **kwargs):
 
 
         if response.status_code != 200:
-            raise SeamAPIException(response)
+            raise SeamApiException(response)
 
         if "application/json" in response.headers["content-type"]:
             return response.json()

seamapi/types.py

@@ -19,7 +19,7 @@
 ClimateSettingScheduleId = str
 
 
-class SeamAPIException(Exception):
+class SeamApiException(Exception):
     def __init__(
         self,
         response,
@@ -33,7 +33,7 @@ def __init__(
             self.metadata = parsed_response.get("error", None)
 
         super().__init__(
-            f"SeamAPIException: status={self.status_code}, request_id={self.request_id}, metadata={self.metadata}"
+            f"SeamApiException: status={self.status_code}, request_id={self.request_id}, metadata={self.metadata}"
         )
 
 

seamapi/utils/report_error.py

@@ -1,4 +1,4 @@
-from seamapi.types import SeamAPIException
+from seamapi.types import SeamApiException
 
 """
 A decorator for model methods that will report errors to Sentry (if enabled).
@@ -9,7 +9,7 @@ def wrapper(self, *args, **kwargs):
     try:
       return f(self, *args, **kwargs)
     except Exception as error:
-      if self.seam.should_report_exceptions and type(error) is not SeamAPIException:
+      if self.seam.should_report_exceptions and type(error) is not SeamApiException:
         self.seam.sentry_client.capture_exception(error)
 
       raise error

tests/access_codes/test_access_codes.py

@@ -1,5 +1,5 @@
 from seamapi import Seam
-from seamapi.types import SeamAPIException
+from seamapi.types import SeamApiException
 from tests.fixtures.run_august_factory import run_august_factory
 import pytest
 
@@ -28,7 +28,7 @@ def test_access_codes(seam: Seam):
     access_code = seam.access_codes.get(created_access_code.access_code_id)
     assert access_code.code == "4444"
 
-    with pytest.raises(SeamAPIException):
+    with pytest.raises(SeamApiException):
         seam.access_codes.create(
             some_device.device_id, "Duplicate Access Code", "4444"
         )

tests/devices/test_devices.py

@@ -1,5 +1,5 @@
 from seamapi import Seam
-from seamapi.types import SeamAPIException
+from seamapi.types import SeamApiException
 from tests.fixtures.run_august_factory import run_august_factory
 from seamapi.utils.deep_attr_dict import DeepAttrDict
 
@@ -59,7 +59,7 @@ def test_devices(seam: Seam):
     try:
         seam.devices.get(name="foo")
         assert False
-    except SeamAPIException as error:
+    except SeamApiException as error:
         assert error.status_code == 404
         assert type(error.request_id) == str
         assert error.metadata["type"] == "device_not_found"

tests/noise_sensors/noise_thresholds/test_noise_thresholds.py

@@ -1,6 +1,6 @@
 import time
 from seamapi import Seam
-from seamapi.types import SeamAPIException
+from seamapi.types import SeamApiException
 from tests.fixtures.run_minut_factory import run_minut_factory