python-terminusgps 32.0.0__py3-none-any.whl → 33.0.0__py3-none-any.whl

{python_terminusgps-32.0.0.dist-info → python_terminusgps-33.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 32.0.0
+Version: 33.0.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://docs.terminusgps.com
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-32.0.0.dist-info → python_terminusgps-33.0.0.dist-info}/RECORD

@@ -1,17 +1,18 @@
 terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/auth.py,sha256=umNpOXObDrIt2K40padWBedQl7tVAmEg2alBWhGk-qQ,1238
-terminusgps/authorizenet/errors.py,sha256=HG5NwVxQCtOYidVl30y49PC0Ovw5VYdsy9wTgUFMw9M,949
-terminusgps/authorizenet/utils.py,sha256=T0ufuNiBgn54VS07qJRJHf7pmapA3sFLSiSGe_nfUog,2802
+terminusgps/authorizenet/constants.py,sha256=xmulPmiBLhFfZoc7Il3l-DZA9Nq5HSaJmJKU-v-5X-Y,420
+terminusgps/authorizenet/controllers.py,sha256=9t62qdGpmAkP4tNyPefd7vBRutXvMWsxql6z_pg52Bg,2146
+terminusgps/authorizenet/utils.py,sha256=zmBVqRamCmxEO6tZWRaGPn5uvL_Lr0yO36Lgc954m8k,2930
 terminusgps/authorizenet/profiles/__init__.py,sha256=IG4XCEEYtHKqXOatlZlob6J3ukAgF7cFR-RXxOSMS1c,161
-terminusgps/authorizenet/profiles/addresses.py,sha256=7yrOrb9kIsiiazgWbeH8v_YUBiWG3Y61g46R3S5DD-k,6592
-terminusgps/authorizenet/profiles/base.py,sha256=TOUHr22QRQBLErdysOkfcpJBusTjrUTqOmWEyNvMacA,2240
-terminusgps/authorizenet/profiles/customers.py,sha256=EkgYUmTt42nhDbIykvDdO5yDLbZra2hm1wimF9YMsKg,9832
-terminusgps/authorizenet/profiles/payments.py,sha256=ohhZrs9MB7GkCi7jQvPVvELNKnR9BwzMd607jJmT4n4,11316
-terminusgps/authorizenet/profiles/subscriptions.py,sha256=N4_0kbBBJ0FtKdIydN8FLnAG2kSI9DHQWAwemMt7Qu8,11020
+terminusgps/authorizenet/profiles/addresses.py,sha256=xDlnFlIjuR7NVXwfj5aJT9E_GolnYFuYASkfenvWfm8,6292
+terminusgps/authorizenet/profiles/base.py,sha256=lPc8Pugp5EcXtZmeBpeqicij7l0ROGvMYTV8J0fLLmQ,3768
+terminusgps/authorizenet/profiles/customers.py,sha256=ArXOHPgyBu01tgBPHHYyezb4PIeXh70IWjYCy-lHpWg,11734
+terminusgps/authorizenet/profiles/payments.py,sha256=MmjvE4ZSfgyGPRUzeREB_dX_n6QfpC3zGIlqFnIC8BQ,10956
+terminusgps/authorizenet/profiles/subscriptions.py,sha256=m_jb9GqeD1tLmeqSnaGwJrzPcQOulEkF8K1wCaqKR24,7924
 terminusgps/authorizenet/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/authorizenet/tests/test_auth.py,sha256=zetg5xlg6A0dKuBJR7sPTHfza8TOIG8yIEP_CvI9XWQ,1612
-terminusgps/authorizenet/tests/test_profiles.py,sha256=PWSynAZmosnAJVe6vNOpSui1-UwqggrYtaweD9uDDrg,1351
+terminusgps/authorizenet/tests/test_auth.py,sha256=sdByYrcv8RKjcJckOHbyHH1z_M4qrATFI3qj_XDQXbk,1624
+terminusgps/authorizenet/tests/test_profiles.py,sha256=24lo71F5MWOUNdB2MwTAstPUkyfZ58aOiIxiRwyWcd0,7476
 terminusgps/authorizenet/tests/test_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/connect.py,sha256=TWf2bVz6LqSNQfVD7FKRn3K71VuLOwBj05Gs-9BsROg,693
@@ -32,20 +33,20 @@ terminusgps/wialon/constants.py,sha256=Ju2XL2A4DPFD-w8NjYqEfnnqregl1luPT0XGhGSUn
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
 terminusgps/wialon/session.py,sha256=09WYWvON_H844IFfdt7_x1we6tHhQSkt9K_BEedBjv0,10396
 terminusgps/wialon/utils.py,sha256=JWHZ7VEeo8VNBH67gjOAQk5ITKuPllWDlJ4dVSQ5blA,11002
-terminusgps/wialon/validators.py,sha256=CVEpFsxqplEcpv4U2ipA6v9y5cSrMKFUXLvze-3vs4U,4223
+terminusgps/wialon/validators.py,sha256=j5vrtcfClAzRdRkWTvRRAmrne1t0R6cKkmYdE7fAkSs,4247
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
 terminusgps/wialon/items/base.py,sha256=7J5B-EPj997GJV7TbZP7pAfjl2G4nTcKmP-RMxmuzoY,10959
 terminusgps/wialon/items/resource.py,sha256=DDnyL_Y5P3DxiirUkQb9y4cokMXZVq3xnfn16Vx8sxk,16992
 terminusgps/wialon/items/retranslator.py,sha256=sVEWrp8q1I-tO_rMTCH7TeQDDbZryIq8d9KVnhYyhH0,3795
 terminusgps/wialon/items/route.py,sha256=amNPKZqgl8pEzKA_XJudnvBPzEsfHTmrC7uF15sZVI4,1216
-terminusgps/wialon/items/unit.py,sha256=iwHM4AfUED2blKkP940RbUxFFPD_4pTDe4Dut853cfA,12302
+terminusgps/wialon/items/unit.py,sha256=0XPLfpFh7djiVOcuZE-lUdB_-_LRSO8C2PvfzBFh3HQ,10744
 terminusgps/wialon/items/unit_group.py,sha256=QV2ZZgICaN3n6W1pFIyMLyNKB6KYBsLyKG64i-qXoOg,4113
 terminusgps/wialon/items/user.py,sha256=5LgwalGO8KS_7psmAVmAlnC0S6SPBDZMOuT5ZqPKRmo,7758
 terminusgps/wialon/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/tests/test_items.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/tests/test_session.py,sha256=9mBlYchMo9NeqRIZsmxYzrM1zBHorqu4ooxqSNppLpI,1336
 terminusgps/wialon/tests/test_utils.py,sha256=SK4PxJQGECFnzx_EQeRAQfsQ5_3FLaVcis2W9u_ibuI,1730
-python_terminusgps-32.0.0.dist-info/METADATA,sha256=v9Izrqd4pgBliL_jgwpnjN2iAg9Mj70Vxra2zeHXhtI,1581
-python_terminusgps-32.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-32.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-32.0.0.dist-info/RECORD,,
+python_terminusgps-33.0.0.dist-info/METADATA,sha256=4YbYgxxufZKqEuoRveOGbtRDupqslS3dx_JwW-PzZ9A,1581
+python_terminusgps-33.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-33.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-33.0.0.dist-info/RECORD,,

terminusgps/authorizenet/constants.py

@@ -0,0 +1,16 @@
+import enum
+
+
+class AuthorizenetSubscriptionStatus(enum.StrEnum):
+    """Authorizenet subscription statuses."""
+
+    ACTIVE = "active"
+    """An active subscription."""
+    EXPIRED = "expired"
+    """An expired subscription."""
+    SUSPENDED = "suspended"
+    """A suspended subscription."""
+    CANCELED = "canceled"
+    """A canceled subscription."""
+    TERMINATED = "terminated"
+    """A terminated subscription."""

terminusgps/authorizenet/controllers.py

@@ -0,0 +1,63 @@
+from authorizenet.apicontrollersbase import APIOperationBase
+
+from .auth import get_environment
+
+
+class AuthorizenetControllerExecutor:
+    """Allows objects to use :py:meth:`execute_controller` to execute Authorizenet API controllers."""
+
+    @staticmethod
+    def execute_controller(controller: APIOperationBase) -> dict | None:
+        """
+        Executes an Authorizenet API controller and returns its response.
+
+        :param controller: An Authorizenet API controller.
+        :type controller: :py:obj:`~authorizenet.apicontrollersbase.APIOperationBase`
+        :raises AuthorizenetControllerExecutionError: If the API call fails.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
+        controller.setenvironment(get_environment())
+        controller.execute()
+        response = controller.getresponse()
+
+        if response is not None and response.messages.resultCode != "Ok":
+            raise AuthorizenetControllerExecutionError(
+                message=response.messages.message[0]["text"].text,
+                code=response.messages.message[0]["code"].text,
+            )
+        return response
+
+
+class AuthorizenetControllerExecutionError(Exception):
+    """Raised when an Authorizenet API controller fails to execute."""
+
+    def __init__(self, message: str, code: str, *args, **kwargs) -> None:
+        """
+        Sets :py:attr:`message` and :py:attr`code` for the exception.
+
+        :param message: An Authorizenet API error message.
+        :type message: :py:obj:`str`
+        :param code: An Authorizenet API error code.
+        :type code: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        super().__init__(message, *args, **kwargs)
+        self._message = message
+        self._code = code
+
+    def __str__(self) -> str:
+        return f"{self.code}: {self.message}"
+
+    @property
+    def message(self) -> str:
+        """An Authorizenet API error message."""
+        return self._message
+
+    @property
+    def code(self) -> str:
+        """An Authorizenet API error code."""
+        return self._code

terminusgps/authorizenet/profiles/addresses.py

@@ -1,6 +1,6 @@
 from authorizenet import apicontractsv1, apicontrollers
 
-from .base import AuthorizenetSubProfileBase
+from terminusgps.authorizenet.profiles.base import AuthorizenetSubProfileBase
 
 
 class AddressProfile(AuthorizenetSubProfileBase):
@@ -8,54 +8,42 @@ class AddressProfile(AuthorizenetSubProfileBase):
 
     def create(self, address: apicontractsv1.customerAddressType) -> int:
         """
-        Creates an Authorizenet address profile.
+        Creates the customer shipping address profile in Authorizenet.
 
         :param address: A customer address.
         :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
-        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
-        :raises ValueError: If the Authorizenet API response was not retrieved.
-        :returns: A new address profile id.
-        :rtype: :py:obj:`int`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
 
         """
-        response = self._authorizenet_create_shipping_address(address)
-        if response is None:
-            raise ValueError("Failed to retrieve Authorizenet API response.")
-        return int(response.customerAddressId)
+        return int(
+            self._authorizenet_create_shipping_address(address).customerAddressId
+        )
 
-    def update(self, address: apicontractsv1.customerAddressType) -> dict | None:
+    def update(self, address: apicontractsv1.customerAddressType) -> None:
         """
-        Updates the Authorizenet address profile.
+        Updates the customer shipping address to the new address in Authorizenet.
 
-        :param address: A customer shipping address.
+        :param address: A customer address.
         :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
-        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
-        :returns: An Authorizenet API response, if any.
-        :rtype: :py:obj:`dict` | :py:obj:`None`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
 
         """
-        return self._authorizenet_update_shipping_address(address)
+        if self.id:
+            self._authorizenet_update_shipping_address(address)
 
-    def delete(self) -> dict | None:
+    def delete(self) -> None:
         """
-        Deletes the Authorizenet address profile.
+        Deletes the customer address profile in Authorizenet and sets :py:attr:`id` to :py:obj:`None` if :py:attr:`id` is set.
 
-        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
-        :returns: An Authorizenet API response, if any.
-        :rtype: :py:obj:`dict` | :py:obj:`None`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
 
         """
-        return self._authorizenet_delete_shipping_address()
-
-    def get_details(self) -> dict | None:
-        """
-        Gets details for the Authorizenet address profile.
-
-        :returns: An Authorizenet API response, if any.
-        :rtype: :py:obj:`dict` | :py:obj:`None`
-
-        """
-        return self._authorizenet_get_shipping_address()
+        if self.id:
+            self._authorizenet_delete_shipping_address()
+            self.id = None
 
     def _authorizenet_get_shipping_address(self) -> dict | None:
         """
@@ -64,12 +52,14 @@ class AddressProfile(AuthorizenetSubProfileBase):
         `getCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-shipping-address>`_
 
         :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AssertionError: If :py:attr:`customerProfileId` wasn't set.
         :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
         :returns: An Authorizenet API response, if any.
         :rtype: :py:obj:`dict` | :py:obj:`None`
 
         """
-        assert self.id, "'id' was not set."
+        assert self.id, "'id' wasn't set."
+        assert self.customerProfileId, "'customerProfileId' wasn't set."
 
         request = apicontractsv1.getCustomerShippingAddressRequest(
             merchantAuthentication=self.merchantAuthentication,
@@ -87,7 +77,6 @@ class AddressProfile(AuthorizenetSubProfileBase):
 
         `createCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-shipping-address>`_
 
-        :raises AssertionError: If :py:attr:`id` wasn't set.
         :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
         :returns: An Authorizenet API response, if any.
         :rtype: :py:obj:`dict` | :py:obj:`None`
@@ -99,6 +88,7 @@ class AddressProfile(AuthorizenetSubProfileBase):
             address=address,
             defaultShippingAddress=self.default,
         )
+
         controller = apicontrollers.createCustomerShippingAddressController(request)
         return self.execute_controller(controller)
 
@@ -111,12 +101,14 @@ class AddressProfile(AuthorizenetSubProfileBase):
         `updateCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-shipping-address>`_
 
         :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AssertionError: If :py:attr:`customerProfileId` wasn't set.
         :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
         :returns: An Authorizenet API response, if any.
         :rtype: :py:obj:`dict` | :py:obj:`None`
 
         """
-        assert self.id, "'id' was not set."
+        assert self.id, "'id' wasn't set."
+        assert self.customerProfileId, "'customerProfileId' wasn't set."
 
         address.customerAddressId = self.id
         request = apicontractsv1.updateCustomerShippingAddressRequest(
@@ -135,17 +127,20 @@ class AddressProfile(AuthorizenetSubProfileBase):
         `deleteCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-shipping-address>`_
 
         :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AssertionError: If :py:attr:`customerProfileId` wasn't set.
         :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
         :returns: An Authorizenet API response, if any.
         :rtype: :py:obj:`dict` | :py:obj:`None`
 
         """
-        assert self.id, "'id' was not set."
+        assert self.id, "'id' wasn't set."
+        assert self.customerProfileId, "'customerProfileId' wasn't set."
 
         request = apicontractsv1.deleteCustomerShippingAddressRequest(
             merchantAuthentication=self.merchantAuthentication,
             customerProfileId=self.customerProfileId,
             customerAddressId=self.id,
         )
+
         controller = apicontrollers.deleteCustomerShippingAddressController(request)
         return self.execute_controller(controller)

terminusgps/authorizenet/profiles/base.py

@@ -1,70 +1,129 @@
-from abc import abstractmethod
-from typing import override
-
 from authorizenet import apicontractsv1
 
-from ..auth import get_merchant_auth, get_validation_mode
-from ..utils import ControllerExecutionMixin
+from terminusgps.authorizenet.auth import get_merchant_auth, get_validation_mode
+from terminusgps.authorizenet.controllers import AuthorizenetControllerExecutor
 
 
-class AuthorizenetProfileBase(ControllerExecutionMixin):
-    def __init__(
-        self, merchant_id: int | str, id: int | str | None = None, *args, **kwargs
-    ) -> None:
-        self._merchantCustomerId = merchant_id
-        self._id = int(id) if id else self.create(*args, **kwargs)
+class AuthorizenetProfileBase(AuthorizenetControllerExecutor):
+    """Base class for Authorizenet profiles."""
+
+    def __init__(self, id: int | str | None = None, *args, **kwargs) -> None:
+        """
+        Sets :py:attr:`id` if provided.
+
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.id = id
 
-    @override
     def __str__(self) -> str:
-        return f"#{self.id}"
+        """
+        Returns a string representation of the profile, if :py:attr:`id` was set.
 
-    @property
-    def merchantCustomerId(self) -> str:
-        """An internally designated customer id."""
-        return str(self._merchantCustomerId)
+        :returns: A string in the format '#id' where 'id' is the profile's Authorizenet generated id number, or a blank string if :py:attr:`id` wasn't set.
+        :rtype: :py:obj:`str`
+
+        """
+        return f"#{self.id}" if self.id else ""
 
     @property
-    def id(self) -> str:
-        """An Authorizenet generated id."""
-        return str(self._id)
+    def id(self) -> str | None:
+        """
+        An Authorizenet generated id.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+
+        """
+        return self._id
+
+    @id.setter
+    def id(self, other: int | str | None) -> None:
+        """
+        Sets :py:attr:`id` to ``other``.
+
+        :raises ValueError: If ``other`` was provided as a string containing non-digit characters.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        if isinstance(other, str) and not other.isdigit():
+            raise ValueError(f"'id' can only contain digit characters, got '{other}'.")
+        self._id = str(other) if other is not None else None
 
     @property
     def merchantAuthentication(self) -> apicontractsv1.merchantAuthenticationType:
-        """Merchant authentication for Authorizenet API calls."""
-        return get_merchant_auth()
-
-    @abstractmethod
-    def create(self, *args, **kwargs) -> int:
-        raise NotImplementedError("Subclasses must implement this method.")
+        """
+        A merchant authentication object to authenticate Authorizenet API calls.
 
-    @abstractmethod
-    def update(self, *args, **kwargs) -> dict:
-        raise NotImplementedError("Subclasses must implement this method.")
+        :returns: A merchant authentication object.
+        :rtype: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
 
-    @abstractmethod
-    def delete(self, *args, **kwargs) -> dict:
-        raise NotImplementedError("Subclasses must implement this method.")
+        """
+        return get_merchant_auth()
 
 
 class AuthorizenetSubProfileBase(AuthorizenetProfileBase):
+    """Base class for Authorizenet 'sub-profiles', profiles that have an associated customer profile."""
+
     def __init__(
-        self, customer_profile_id: int | str, default: bool, *args, **kwargs
+        self,
+        customer_profile_id: int | str,
+        id: int | str | None = None,
+        default: bool = False,
     ) -> None:
-        self._customerProfileId = customer_profile_id
-        self._default = default
-        super().__init__(*args, **kwargs)
+        """
+        Sets :py:attr:`customerProfileId` for the sub-profile.
+
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        super().__init__(id=id)
+        self.customerProfileId = customer_profile_id
+        self.default = default
 
     @property
     def validationMode(self) -> str:
-        """The validation mode for Authorizenet API calls."""
         return get_validation_mode()
 
+    @property
+    def customerProfileId(self) -> str:
+        """
+        A customer profile id.
+
+        :type: :py:obj:`str`
+
+        """
+        return str(self._customerProfileId)
+
+    @customerProfileId.setter
+    def customerProfileId(self, other: int | str) -> None:
+        """
+        Sets :py:attr:`customerProfileId` to ``other``.
+
+        :raises ValueError: If the new customer profile id is a string that contains non-digits.
+        :param other: A new customer profile id.
+        :type other: :py:obj:`int` | :py:obj:`str`
+
+        """
+        if isinstance(other, str) and not other.isdigit():
+            raise ValueError(
+                f"'customerProfileId' can only contain digits, got '{other}'."
+            )
+        self._customerProfileId = str(other)
+
     @property
     def default(self) -> str:
-        """Whether or not the sub profile is set as default in Authorizenet."""
+        """
+        Whether or not the sub-profile is set as default.
+
+        :type: :py:obj:`str`
+
+        """
         return str(self._default).lower()
 
-    @property
-    def customerProfileId(self) -> str:
-        """An Authorizenet generated customer profile id."""
-        return str(self._customerProfileId)
+    @default.setter
+    def default(self, other: bool) -> None:
+        """Sets :py:attr:`default` to ``other``."""
+        self._default = other