python-terminusgps 22.0.2__py3-none-any.whl → 24.0.0__py3-none-any.whl

{python_terminusgps-22.0.2.dist-info → python_terminusgps-24.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 22.0.2
+Version: 24.0.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://app.terminusgps.com/docs/apps/python-terminusgps/index.html
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps
@@ -17,8 +17,5 @@ Requires-Dist: authorizenet>=1.1.5
 Requires-Dist: boto3>=1.34.144
 Requires-Dist: django>=5.1.5
 Requires-Dist: matplotlib>=3.10.1
-Requires-Dist: opencv-python>=4.11.0.86
-Requires-Dist: pyqt6>=6.8.1
 Requires-Dist: python-wialon>=1.2.4
-Requires-Dist: pyzbar>=0.1.9
 Requires-Dist: twilio>=9.4.5

{python_terminusgps-22.0.2.dist-info → python_terminusgps-24.0.0.dist-info}/RECORD

@@ -1,26 +1,27 @@
 terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/settings.py,sha256=JMcMFqNQRIcljIZrEsU9pm9AhxG-gcnDC7EONKd3ShE,502
-terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/authorizenet/auth.py,sha256=JuP-l23PRnsnufda5f29Y61K9yhT6p6pRMEH5KGzmp0,564
-terminusgps/authorizenet/subscriptions.py,sha256=_SfaTYS_3rgHNqQuvZ59TK_zDFymU64sAzj9FCyqYyU,2217
+terminusgps/settings.py,sha256=UBj2tvuBzQDEz05PeFqHG4_ise3Bl6Iu7pxcrtjNaYE,568
+terminusgps/authorizenet/__init__.py,sha256=LiGLlWNNiqS7RSOP4Apabx-b9EBYyNbxRY_a0mvJoaE,466
+terminusgps/authorizenet/auth.py,sha256=ICxPPzoUc64VbsIIemEWKrn8xjHGwbNdo2VbtaFCFss,1107
+terminusgps/authorizenet/errors.py,sha256=HG5NwVxQCtOYidVl30y49PC0Ovw5VYdsy9wTgUFMw9M,949
+terminusgps/authorizenet/utils.py,sha256=5aczO2EcMX2bi-kRg8_fnzLzE7qMA9K1qBxAo2AJz1c,2021
 terminusgps/authorizenet/profiles/__init__.py,sha256=QKjMKcXpCSCEhv6LBCz0yGP8t0VxAyKyYRS4_HLYnxQ,114
-terminusgps/authorizenet/profiles/addresses.py,sha256=ffAi3LcEOB3Xsr9f4N_PfjSZcN3I9dTKNamoAmnLpo4,3838
-terminusgps/authorizenet/profiles/base.py,sha256=G7lXIYrWk5m1_MLuZT0xBs5vabKAUVbk9eZHl8Rahl8,3378
-terminusgps/authorizenet/profiles/customers.py,sha256=iEuNFP6PHuGdFQftgxxKpQFYaGw8IWLjsOaugvEOA-g,4513
-terminusgps/authorizenet/profiles/payments.py,sha256=qOWp-gO6qBCADP98WjoNCHm-jtq7DY5-moiPsOnT5yI,5263
+terminusgps/authorizenet/profiles/addresses.py,sha256=uowUkrr4fa4g7pjgNDrjW0es5t_gH9B8VHI74PbTWFc,6303
+terminusgps/authorizenet/profiles/base.py,sha256=TOUHr22QRQBLErdysOkfcpJBusTjrUTqOmWEyNvMacA,2240
+terminusgps/authorizenet/profiles/customers.py,sha256=xe7LNsqSB_oRCY-teojDTt0O6a5yVf0dyuu86ftc4hA,8377
+terminusgps/authorizenet/profiles/payments.py,sha256=O_oZGUwO8XTApzr0itu-1XQYnWFR4gDpNCusWNzBh7A,11152
+terminusgps/authorizenet/subscriptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+terminusgps/authorizenet/subscriptions/subscriptions.py,sha256=JQHo2FxQyRPJp1jlbD2mIt9RKEJZbADZcfozNTKWbz0,1514
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/aws/secrets.py,sha256=kgRA77rs0mD4berWRLkPtJLOe4Grf--o5f8NzwQqXCk,360
+terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/aws/ses.py,sha256=sDca2GjMaZvUt3kUPtGCpcqHiOkij9lMV1ogZofgYUU,2372
-terminusgps/opencv/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/opencv/barcodes.py,sha256=NmdpUnixlGJI-6shbKGcb6-M_IZvgSZJRDVSsI7pcFg,669
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 terminusgps/twilio/caller.py,sha256=nHCIwUulo-C_v2orsp6OY0nuJA6YetSkxpMTwrRQ-uA,1831
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=n1ux68oWYWnzeZdN811Iw_Lk78KBM0YMJMoonn67uZY,1723
 terminusgps/wialon/flags.py,sha256=_NIL3mrEGhvI5YISVjimjYtUatdgOqhZPJX368MtKSU,13959
 terminusgps/wialon/logger.py,sha256=nUBsaLMaffSaAHGHAM6mFXDzix9hbNecVtA3INVtii8,968
-terminusgps/wialon/session.py,sha256=6xg65LZz6cebWclTQp1KRLvPss0aM-bWhAmmwiDOlMg,10267
-terminusgps/wialon/utils.py,sha256=HUuBgkqJzzsFHGKPgf_YAE0e5Oui8xdaYtb9fv_ibOc,6344
+terminusgps/wialon/session.py,sha256=t3d7trBQRxnXFnex73alSSD5n2LDTZQ9VAtzUKIERto,9670
+terminusgps/wialon/utils.py,sha256=Y7fo9a81w84b3N39h1AmVLS-AnC3aRT5R137hIsqCHU,6723
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
 terminusgps/wialon/items/base.py,sha256=EAtzlnCvB7WTu3iX1bV1-S9TvwXc-Eez7e0X4TMiK9U,6943
 terminusgps/wialon/items/resource.py,sha256=qmQKEakJa9LH5YkI9-iBDA0hsotc5ctcwdb7kZuXdfQ,14549
@@ -29,7 +30,7 @@ terminusgps/wialon/items/route.py,sha256=PTJx1gmT_PGz7nlSSUS2VzjYD-aAuvkEOIdIFne
 terminusgps/wialon/items/unit.py,sha256=-jQL5Alvz77FZWteYNM9VNX15jtCufI-DWRRj3hRsgA,8539
 terminusgps/wialon/items/unit_group.py,sha256=vGVJMBY1BrKK0tP-C1DCIz4Bh6P-HKRnKY1g8g95UIs,5031
 terminusgps/wialon/items/user.py,sha256=INwAibQVmjNNelepQXMfDevgJqMvIjHHgEjAMLRvhB0,7082
-python_terminusgps-22.0.2.dist-info/METADATA,sha256=1YPz8oMH4ULPwmgyGVls3OiNRkzULUwCQLTMZ7746pA,1043
-python_terminusgps-22.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-22.0.2.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-22.0.2.dist-info/RECORD,,
+python_terminusgps-24.0.0.dist-info/METADATA,sha256=QU-Do0pVNWwhy5D08Y5-n2nKz_mknj6sQMRHgHWpf5s,946
+python_terminusgps-24.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-24.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-24.0.0.dist-info/RECORD,,

terminusgps/authorizenet/__init__.py

@@ -0,0 +1,9 @@
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+
+if not hasattr(settings, "DEBUG"):
+    raise ImproperlyConfigured("'DEBUG' setting is required.")
+if not hasattr(settings, "MERCHANT_AUTH_LOGIN_ID"):
+    raise ImproperlyConfigured("'MERCHANT_AUTH_LOGIN_ID' setting is required.")
+if not hasattr(settings, "MERCHANT_AUTH_TRANSACTION_KEY"):
+    raise ImproperlyConfigured("'MERCHANT_AUTH_TRANSACTION_KEY' setting is required.")

terminusgps/authorizenet/auth.py

@@ -1,10 +1,16 @@
 from authorizenet.apicontractsv1 import merchantAuthenticationType
 from authorizenet.constants import constants
-
 from django.conf import settings
 
 
 def get_merchant_auth() -> merchantAuthenticationType:
+    """
+    Returns the merchant authentication information for Authorizenet API requests.
+
+    :returns: A merchant authentication object.
+    :rtype: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
+
+    """
     return merchantAuthenticationType(
         name=str(settings.MERCHANT_AUTH_LOGIN_ID),
         transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
@@ -12,8 +18,22 @@ def get_merchant_auth() -> merchantAuthenticationType:
 
 
 def get_environment() -> str:
+    """
+    Returns the environment for Authorizenet API requests.
+
+    :returns: An Authorizenet API environment string.
+    :rtype: :py:obj:`str`
+
+    """
     return constants.SANDBOX if settings.DEBUG else constants.PRODUCTION
 
 
 def get_validation_mode() -> str:
+    """
+    Returns the validation mode for Authorizenet API requests.
+
+    :returns: An Authorizenet API validation string.
+    :rtype: :py:obj:`str`
+
+    """
     return "testMode" if settings.DEBUG else "liveMode"

terminusgps/authorizenet/errors.py

@@ -0,0 +1,31 @@
+class ControllerExecutionError(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,47 +1,64 @@
 from authorizenet import apicontractsv1, apicontrollers
-from authorizenet.apicontractsv1 import customerAddressType
 
-from terminusgps.authorizenet.profiles.base import AuthorizenetSubProfileBase
+from .base import AuthorizenetSubProfileBase
 
 
 class AddressProfile(AuthorizenetSubProfileBase):
-    def create(self, **kwargs) -> int:
+    """An Authorizenet customer address profile."""
+
+    def create(self, address: apicontractsv1.customerAddressType) -> int:
         """
-        Creates an Authorize.NET address profile.
+        Creates an Authorizenet address profile.
 
-        :param shipping_addr: An Authorize.NET customer address.
-        :type shipping_addr: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
-        :raises ValueError: If no customer address was provided.
-        :raises TypeError: If the customer address is not a :py:obj:`~authorizenet.apicontractsv1.customerAddressType` object.
-        :returns: The new address profile's id.
+        :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`
 
         """
-        shipping_addr = kwargs.get("shipping_addr")
+        response = self._authorizenet_create_shipping_address(address)
+        if response is None:
+            raise ValueError("Failed to retrieve Authorizenet API response.")
+        return int(response.customerAddressId)
 
-        if not shipping_addr:
-            raise ValueError("'shipping_addr' is required on creation.")
+    def update(self, address: apicontractsv1.customerAddressType) -> dict | None:
+        """
+        Updates the Authorizenet address profile.
 
-        if not isinstance(shipping_addr, customerAddressType):
-            raise TypeError(
-                f"'shipping_addr' must be customerAddressType, got '{type(shipping_addr)}'."
-            )
+        :param address: A customer shipping 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`
 
-        response = self._authorizenet_create_shipping_address(shipping_addr)
-        return int(response.customerAddressId)
+        """
+        return self._authorizenet_update_shipping_address(address)
+
+    def delete(self) -> dict | None:
+        """
+        Deletes the Authorizenet address profile.
 
-    def update(self, shipping_addr: customerAddressType) -> dict:
-        """Updates the Authorize.NET payment profile."""
-        return self._authorizenet_update_shipping_address(shipping_addr)
+        :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`
 
-    def delete(self) -> dict:
-        """Deletes the Authorize.NET payment profile."""
+        """
         return self._authorizenet_delete_shipping_address()
 
-    def get_details(self) -> dict:
-        return self._authorizenet_get_shipping_address()
+    def _authorizenet_get_shipping_address(self) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerShippingAddressRequest` using the Authorizenet API.
+
+        `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 ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
 
-    def _authorizenet_get_shipping_address(self) -> dict:
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.getCustomerShippingAddressRequest(
@@ -50,35 +67,69 @@ class AddressProfile(AuthorizenetSubProfileBase):
             customerAddressId=self.id,
         )
         controller = apicontrollers.getCustomerShippingAddressController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)
+
+    def _authorizenet_create_shipping_address(
+        self, address: apicontractsv1.customerAddressType
+    ) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerShippingAddressRequest` using the Authorizenet API.
 
-    def _authorizenet_create_shipping_address(self, addr: customerAddressType) -> dict:
+        `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`
+
+        """
         request = apicontractsv1.createCustomerShippingAddressRequest(
             merchantAuthentication=self.merchantAuthentication,
             customerProfileId=self.customerProfileId,
-            address=addr,
+            address=address,
             defaultShippingAddress=self.default,
         )
         controller = apicontrollers.createCustomerShippingAddressController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)
+
+    def _authorizenet_update_shipping_address(
+        self, address: apicontractsv1.customerAddressType
+    ) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.updateCustomerShippingAddressRequest` using the Authorizenet API.
+
+        `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 ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
 
-    def _authorizenet_update_shipping_address(self, addr: customerAddressType) -> dict:
+        """
         assert self.id, "'id' was not set."
-        addr.customerAddressId = self.id
 
+        address.customerAddressId = self.id
         request = apicontractsv1.updateCustomerShippingAddressRequest(
             merchantAuthentication=self.merchantAuthentication,
             customerProfileId=self.customerProfileId,
-            address=addr,
+            address=address,
             default=self.default,
         )
         controller = apicontrollers.updateCustomerShippingAddressController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)
+
+    def _authorizenet_delete_shipping_address(self) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerShippingAddressRequest` using the Authorizenet API.
 
-    def _authorizenet_delete_shipping_address(self) -> dict:
+        `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 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."
 
         request = apicontractsv1.deleteCustomerShippingAddressRequest(
@@ -87,5 +138,4 @@ class AddressProfile(AuthorizenetSubProfileBase):
             customerAddressId=self.id,
         )
         controller = apicontrollers.deleteCustomerShippingAddressController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)

terminusgps/authorizenet/profiles/base.py

@@ -1,81 +1,40 @@
 from abc import abstractmethod
+from typing import override
 
-from authorizenet.apicontractsv1 import merchantAuthenticationType
-from authorizenet.apicontrollersbase import APIOperationBase
+from authorizenet import apicontractsv1
 
-from ..auth import get_merchant_auth, get_environment, get_validation_mode
+from ..auth import get_merchant_auth, get_validation_mode
+from ..utils import ControllerExecutionMixin
 
 
-class AuthorizenetProfileBase:
+class AuthorizenetProfileBase(ControllerExecutionMixin):
     def __init__(
-        self, merchant_id: int | str, id: int | str | None = None, **kwargs
+        self, merchant_id: int | str, id: int | str | None = None, *args, **kwargs
     ) -> None:
         self._merchantCustomerId = merchant_id
-        self._id = str(id) if id else self.create(**kwargs)
+        self._id = int(id) if id else self.create(*args, **kwargs)
 
+    @override
     def __str__(self) -> str:
         return f"#{self.id}"
 
-    def execute_controller(self, controller: APIOperationBase) -> dict:
-        """
-        Executes an Authorize.NET controller and returns its response.
-
-        :param controller: An Authorize.NET API controller.
-        :raises ValueError: If the API call fails.
-        :returns: The Authorize.NET API response.
-        :rtype: :py:obj:`dict`
-
-        """
-        controller.setenvironment(self.environment)
-        controller.execute()
-        response = controller.getresponse()
-
-        if response.messages.resultCode != "Ok":
-            raise ValueError(response.messages.message[0]["text"].text)
-        return response
-
     @property
     def merchantCustomerId(self) -> str:
-        """
-        An internally designated customer id.
-
-        :type: :py:obj:`str`
-
-        """
+        """An internally designated customer id."""
         return str(self._merchantCustomerId)
 
     @property
     def id(self) -> str:
-        """
-        An Authorizenet generated id.
-
-        :type: :py:obj:`str`
-
-        """
+        """An Authorizenet generated id."""
         return str(self._id)
 
     @property
-    def merchantAuthentication(self) -> merchantAuthenticationType:
-        """
-        Merchant authentication for Authorizenet API calls.
-
-        :type: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
-
-        """
+    def merchantAuthentication(self) -> apicontractsv1.merchantAuthenticationType:
+        """Merchant authentication for Authorizenet API calls."""
         return get_merchant_auth()
 
-    @property
-    def environment(self) -> str:
-        """
-        Environment for Authorizenet API calls to execute within.
-
-        :type: :py:obj:`str`
-
-        """
-        return get_environment()
-
     @abstractmethod
-    def create(self, **kwargs) -> int:
+    def create(self, *args, **kwargs) -> int:
         raise NotImplementedError("Subclasses must implement this method.")
 
     @abstractmethod
@@ -93,34 +52,19 @@ class AuthorizenetSubProfileBase(AuthorizenetProfileBase):
     ) -> None:
         self._customerProfileId = customer_profile_id
         self._default = default
-        return super().__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     @property
     def validationMode(self) -> str:
-        """
-        The validation mode for Authorizenet API calls.
-
-        :type: :py:obj:`str`
-
-        """
+        """The validation mode for Authorizenet API calls."""
         return get_validation_mode()
 
     @property
     def default(self) -> str:
-        """
-        Whether or not the sub profile is set as default in Authorizenet.
-
-        :type: :py:obj:`str`
-
-        """
+        """Whether or not the sub profile is set as default in Authorizenet."""
         return str(self._default).lower()
 
     @property
     def customerProfileId(self) -> str:
-        """
-        An Authorizenet generated customer profile id.
-
-        :py:obj:`str`
-
-        """
+        """An Authorizenet generated customer profile id."""
         return str(self._customerProfileId)