python-terminusgps 37.0.0__py3-none-any.whl → 37.2.0__py3-none-any.whl

{python_terminusgps-37.0.0.dist-info → python_terminusgps-37.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 37.0.0
+Version: 37.2.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
@@ -20,6 +20,8 @@ Requires-Dist: django>=5.1.5
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: matplotlib>=3.10.1
 Requires-Dist: pandas>=2.2.3
+Requires-Dist: pillow-heif>=0.22.0
+Requires-Dist: pillow>=11.2.1
 Requires-Dist: python-wialon>=1.2.4
 Requires-Dist: pyzbar>=0.1.9
 Requires-Dist: twilio>=9.4.5

{python_terminusgps-37.0.0.dist-info → python_terminusgps-37.2.0.dist-info}/RECORD

@@ -2,8 +2,13 @@ terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/auth.py,sha256=g2tJPxP9V1nXnUcKzhHSRSs6ruSIHej5_hcf8P7bod8,1262
 terminusgps/authorizenet/constants.py,sha256=xmulPmiBLhFfZoc7Il3l-DZA9Nq5HSaJmJKU-v-5X-Y,420
-terminusgps/authorizenet/controllers.py,sha256=9t62qdGpmAkP4tNyPefd7vBRutXvMWsxql6z_pg52Bg,2146
+terminusgps/authorizenet/controllers.py,sha256=rMuBwSoKJjte7wVuB1ewaqnzfuDXxwus-d5mkqbfnGE,2193
 terminusgps/authorizenet/utils.py,sha256=vxUTLT4rheWDd_2UprpcI8qo_Gw_zl0oiVHnUwHpNfE,6283
+terminusgps/authorizenet/items/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+terminusgps/authorizenet/items/address_profiles.py,sha256=oiFw2T3TmyhLn8Vw-GWFrAeBbyOEG_dV8LLGr3oH7aI,5669
+terminusgps/authorizenet/items/base.py,sha256=fcO0RRrOXytlSbBDLLFajfdkxYtqmniJ5FWV4z0UkOk,2004
+terminusgps/authorizenet/items/customer_profiles.py,sha256=53cqXooXszTqMv2PuifDsDknuDxGtA73jZkquWZl0zs,9262
+terminusgps/authorizenet/items/payment_profiles.py,sha256=kYvuq1xCmeIUmmXgbOapbA01roQ4k0zOLafcBtG-eM0,10830
 terminusgps/authorizenet/profiles/__init__.py,sha256=IG4XCEEYtHKqXOatlZlob6J3ukAgF7cFR-RXxOSMS1c,161
 terminusgps/authorizenet/profiles/addresses.py,sha256=5GudJStBa4P0Hd7G_hRFH2C-WpICAH_k3MT9YJkicKw,6305
 terminusgps/authorizenet/profiles/base.py,sha256=Pu1NGrvC5Ox2W1oZuVcPqUw3aUoSK191Evexw1U6_3k,3940
@@ -38,9 +43,9 @@ terminusgps/twilio/caller.py,sha256=RQax2iZ6SYHiuCvBxXkrooRWQ9J8DwKGAjxa8RYjrLI,
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=05pLc_0S-x0tT87cQcxOmr8plesjOQxoXfUdjIHwI90,7732
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
-terminusgps/wialon/session.py,sha256=eWRAWEikYdGr-0xa6yGHfTAxlCx9-1vsZDNwNZUJjZM,13771
+terminusgps/wialon/session.py,sha256=bmVMpqotIYbHPsTqHGN6vkBZz4TfQv6ciGeh0xqxXw0,14678
 terminusgps/wialon/utils.py,sha256=ntHLAVJSJBdIgJK704xxFNFRopaFz-No9YZZOMmvWO8,11627
-terminusgps/wialon/validators.py,sha256=j5vrtcfClAzRdRkWTvRRAmrne1t0R6cKkmYdE7fAkSs,4247
+terminusgps/wialon/validators.py,sha256=Z2eci8NzKDHU6oXl5ncgeYXmBYg336k-0R2m0DIxsDY,4346
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
 terminusgps/wialon/items/base.py,sha256=vS8xIo5WLiwzpB81i7aHFnwOHzCf4lQG6azjq79HDM4,11775
 terminusgps/wialon/items/resource.py,sha256=Rhy2ig-yxznNhi6ZSaUBbu8ViVx0Sg4n_XS08ijgXsA,18280
@@ -53,7 +58,7 @@ terminusgps/wialon/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 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-37.0.0.dist-info/METADATA,sha256=gSJ_ajG7w0h1nKrJnNd2LYwzLOb6XlIiVnL4ibmwO7c,1264
-python_terminusgps-37.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-37.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-37.0.0.dist-info/RECORD,,
+python_terminusgps-37.2.0.dist-info/METADATA,sha256=rnvtTi8e_-85MBMfS6fRjLTJslnyDsttXghmKXsESoI,1329
+python_terminusgps-37.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-37.2.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-37.2.0.dist-info/RECORD,,

terminusgps/authorizenet/controllers.py

@@ -1,3 +1,5 @@
+import typing
+
 from authorizenet.apicontrollersbase import APIOperationBase
 
 from .auth import get_environment
@@ -7,7 +9,9 @@ class AuthorizenetControllerExecutor:
     """Allows objects to use :py:meth:`execute_controller` to execute Authorizenet API controllers."""
 
     @staticmethod
-    def execute_controller(controller: APIOperationBase) -> dict | None:
+    def execute_controller(
+        controller: APIOperationBase,
+    ) -> dict[str, typing.Any] | None:
         """
         Executes an Authorizenet API controller and returns its response.
 

terminusgps/authorizenet/items/address_profiles.py

@@ -0,0 +1,126 @@
+import typing
+
+from authorizenet import apicontractsv1, apicontrollers
+
+from .base import AuthorizenetBase
+
+
+class AuthorizenetAddressProfile(AuthorizenetBase):
+    """An Authorizenet address profile."""
+
+    def __init__(self, customerProfileId: int | str, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        if isinstance(customerProfileId, str) and not customerProfileId.isdigit():
+            raise ValueError(
+                f"'customerProfileId' can only contain digits, got '{customerProfileId}'."
+            )
+        self.customerProfileId = customerProfileId
+
+    def _authorizenet_create_customer_shipping_address(
+        self, address: apicontractsv1.customerAddressType, default: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerShippingAddressRequest` using the Authorizenet API.
+
+        `createCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-shipping-address>`_
+
+        :param address: A customer address object.
+        :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param default: Whether or not to set the address profile as default.
+        :type default: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: 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()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.address = address
+        request.defaultShippingAddress = str(default).lower()
+
+        return self.execute_controller(
+            apicontrollers.createCustomerShippingAddressController(request)
+        )
+
+    def _authorizenet_get_customer_shipping_address(
+        self,
+    ) -> dict[str, typing.Any] | 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 AuthorizenetControllerExecutionError: 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, "Address profile id wasn't set."
+
+        request = apicontractsv1.getCustomerShippingAddressRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.customerAddressId = self.id
+
+        return self.execute_controller(
+            apicontrollers.getCustomerShippingAddressController(request)
+        )
+
+    def _authorizenet_update_customer_shipping_address(
+        self, address: apicontractsv1.customerAddressType, default: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.updateCustomerShippingAddress` using the Authorizenet API.
+
+        `updateCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-shipping-address>`_
+
+        :param address: A customer address object.
+        :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param default: Whether or not to set the address profile as default.
+        :type default: :py:obj:`bool`
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AuthorizenetControllerExecutionError: 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.updateCustomerShippingAddressRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.address = address
+        request.address.customerAddressId = self.id
+        request.defaultShippingAddress = str(default).lower()
+
+        return self.execute_controller(
+            apicontrollers.updateCustomerShippingAddressController(request)
+        )
+
+    def _authorizenet_delete_customer_shipping_address(
+        self,
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerShippingAddress` using the Authorizenet API.
+
+        `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 AuthorizenetControllerExecutionError: 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, "Address profile id wasn't set."
+
+        request = apicontractsv1.deleteCustomerShippingAddressRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.customerAddressId = self.id
+
+        return self.execute_controller(
+            apicontrollers.deleteCustomerShippingAddressController(request)
+        )

terminusgps/authorizenet/items/base.py

@@ -0,0 +1,68 @@
+from authorizenet import apicontractsv1
+
+from terminusgps.authorizenet.auth import get_merchant_auth, get_validation_mode
+from terminusgps.authorizenet.controllers import AuthorizenetControllerExecutor
+
+
+class AuthorizenetBase(AuthorizenetControllerExecutor):
+    """Base class for Authorizenet objects."""
+
+    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
+
+    def __str__(self) -> str:
+        """Returns the object in format: '#<ID>' if :py:attr:`id` is set."""
+        return f"#{self.id}" if self.id else ""
+
+    @property
+    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:
+        """
+        Current merchant authentication object to authenticate Authorizenet API calls.
+
+        :returns: A merchant authentication object.
+        :rtype: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
+
+        """
+        return get_merchant_auth()
+
+    @property
+    def validationMode(self) -> str:
+        """
+        Current Authorizenet API validation mode.
+
+        :returns: An Authorizenet API validation mode string.
+        :rtype: :py:obj:`str`
+
+        """
+        return get_validation_mode()

terminusgps/authorizenet/items/customer_profiles.py

@@ -0,0 +1,227 @@
+import typing
+
+from authorizenet import apicontractsv1, apicontrollers
+
+from .base import AuthorizenetBase
+
+
+class AuthorizenetCustomerProfile(AuthorizenetBase):
+    """An Authorizenet customer profile."""
+
+    def __init__(self, email: str, merchant_id: str, *args, **kwargs) -> None:
+        """
+        Sets :py:attr:`_email` and :py:attr:`_merchant_id`.
+
+        :param email: An email address.
+        :type email: :py:obj:`str`
+        :param merchant_id: A merchant designated id string.
+        :type merchant_id: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        super().__init__(*args, **kwargs)
+        self._email = email
+        self._merchant_id = merchant_id
+
+    @property
+    def email(self) -> str:
+        """An email address assigned to the customer profile."""
+        return str(self._email)
+
+    @property
+    def merchant_id(self) -> str:
+        """A merchant designated id assigned to the customer profile."""
+        return str(self._merchant_id)
+
+    @email.setter
+    def email(self, other: str) -> None:
+        """Sets :py:attr:`email` to ``other``."""
+        self._email = str(other)
+
+    @merchant_id.setter
+    def merchant_id(self, other: str) -> None:
+        """Sets :py:attr:`merchant_id` to ``other``."""
+        self._merchant_id = str(other)
+
+    def create(self, desc: str | None = None, validate: bool = False) -> int:
+        """
+        Creates an Authorizenet customer profile and returns its id as an integer.
+
+        If successfully created, sets :py:attr:`id` to the new customer profile id.
+
+        :param desc: An optional customer profile description. Default is :py:obj:`None`
+        :type desc: :py:obj:`str` | :py:obj:`None`
+        :param validate: Whether or not to validate a payment on the new customer profile. Default is :py:obj:`False`.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: A customer profile id integer.
+        :rtype: :py:obj:`int`
+
+        """
+
+        profile = apicontractsv1.customerProfileType()
+        profile.merchantCustomerId = self.merchant_id
+        if desc:
+            profile.description = desc
+
+        response = self._authorizenet_create_customer_profile(profile, validate)
+        profile_id = int(response.customerProfileId)
+        self.id = profile_id
+
+        return profile_id
+
+    def delete(self) -> None:
+        """
+        Deletes the Authorizenet customer profile.
+
+        If successfully deleted, sets :py:attr:`id` to :py:obj:`None`.
+
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+
+        if self.id:
+            self._authorizenet_delete_customer_profile()
+            self._id = None
+
+    def update(self, desc: str | None = None, validate: bool = False) -> None:
+        """
+        Updates the Authorizenet customer profile if :py:attr:`id` is set.
+
+        :param desc: An optional customer profile description. Default is :py:obj:`None`
+        :type desc: :py:obj:`str` | :py:obj:`None`
+        :param validate: Whether or not to validate a payment on the customer profile. Default is :py:obj:`False`.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+
+        if self.id:
+            profile = apicontractsv1.customerProfileExType()
+            profile.customerProfileId = self.id
+            profile.merchantCustomerId = self.merchant_id
+            profile.email = self.email
+            if desc is not None:
+                profile.description = desc
+
+            self._authorizenet_update_customer_profile(profile, validate)
+
+    def _authorizenet_get_customer_profile(
+        self, issuer_info: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerProfileRequest` using the Authorizenet API.
+
+        `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_
+
+        :param issuer_info: Whether or not to include issuer information in the response. Default is :py:obj:`False`.
+        :type issuer_info: :py:obj:`bool`
+        :raises AssertionError: If none of :py:attr:`id`, :py:attr:`email` or :py:attr:`merchant_id` were set.
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
+
+        assert any([self.id, self.email, self.merchant_id]), (
+            "At least one of 'id', 'email' or 'merchant_id' must be set."
+        )
+
+        request = apicontractsv1.getCustomerProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.includeIssuerInfo = str(issuer_info).lower()
+
+        if self.id:
+            request.customerProfileId = self.id
+        if self.email:
+            request.email = self.email
+        if self.merchant_id:
+            request.customerMerchantId = self.merchant_id
+
+        return self.execute_controller(
+            apicontrollers.getCustomerProfileController(request)
+        )
+
+    def _authorizenet_create_customer_profile(
+        self, profile: apicontractsv1.customerProfileType, validate: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerProfileRequest` using the Authorizenet API.
+
+        `createCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile>`_
+
+        :param profile: A customer profile object.
+        :type profile: :py:obj:`~authorizenet.apicontractsv1.customerProfileType`
+        :param validate: Whether or not to validate a payment profile for the customer profile. Default is :py:obj:`False`.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: If ``validate`` was :py:obj:`True` but validation was forbidden.
+        :raises AuthorizenetControllerExecutionError: 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.createCustomerProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.profile = profile
+        if validate:
+            request.validationMode = self.validationMode
+
+        return self.execute_controller(
+            apicontrollers.createCustomerProfileController(request)
+        )
+
+    def _authorizenet_update_customer_profile(
+        self, profile: apicontractsv1.customerProfileExType, validate: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.updateCustomerProfileRequest` using the Authorizenet API.
+
+        `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_
+
+        :param profile: A customer profile ex object.
+        :type profile: :py:obj:`~authorizenet.apicontractsv1.customerProfileExType`
+        :param validate: Whether or not to validate a payment profile for the customer profile. Default is :py:obj:`False`.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: 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.updateCustomerProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.profile = profile
+        if validate:
+            request.validationMode = self.validationMode
+
+        return self.execute_controller(
+            apicontrollers.updateCustomerProfileController(request)
+        )
+
+    def _authorizenet_delete_customer_profile(self) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerProfileRequest` using the Authorizenet API.
+
+        `deleteCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-profile>`_
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AuthorizenetControllerExecutionError: 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, "Customer profile id wasn't set."
+
+        request = apicontractsv1.deleteCustomerProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.id
+
+        return self.execute_controller(
+            apicontrollers.deleteCustomerProfileController(request)
+        )

terminusgps/authorizenet/items/payment_profiles.py

@@ -0,0 +1,253 @@
+import typing
+
+from authorizenet import apicontractsv1, apicontrollers
+
+from .base import AuthorizenetBase
+
+
+class AuthorizenetPaymentProfile(AuthorizenetBase):
+    """An Authorizenet payment profile."""
+
+    def __init__(self, customerProfileId: int | str, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        if isinstance(customerProfileId, str) and not customerProfileId.isdigit():
+            raise ValueError(
+                f"'customerProfileId' can only contain digits, got '{customerProfileId}'."
+            )
+        self.customerProfileId = customerProfileId
+
+    def create(
+        self,
+        payment: apicontractsv1.paymentType,
+        address: apicontractsv1.customerAddressType,
+        default: bool = False,
+        validate: bool = False,
+    ) -> int:
+        """
+        Creates an Authorizenet payment profile and returns its id as an integer.
+
+        If successfully created, sets :py:attr:`id` to the new payment profile id.
+
+        :param payment: A payment object.
+        :type payment: :py:obj:`~authorizenet.apicontractsv1.paymentType`
+        :param address: A customer address object.
+        :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param default: Whether or not to set the payment profile as default.
+        :type default: :py:obj:`bool`
+        :param validate: Whether or not to validate the payment profile.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: If something went wrong during an Authorizenet API call.
+        :returns: The new payment profile id.
+        :rtype: :py:obj:`int`
+
+        """
+        response = self._authorizenet_create_customer_payment_profile(
+            payment=payment, address=address, default=default, validate=validate
+        )
+
+        payment_id = int(response.customerPaymentProfileId)
+        self.id = payment_id
+
+        return payment_id
+
+    def update(
+        self,
+        payment: apicontractsv1.paymentType,
+        address: apicontractsv1.customerAddressType,
+        default: bool = False,
+        validate: bool = False,
+    ) -> None:
+        """
+        Updates the Authorizenet payment profile if :py:attr:`id` is set.
+
+        :param payment: A payment object.
+        :type payment: :py:obj:`~authorizenet.apicontractsv1.paymentType`
+        :param address: A customer address object.
+        :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param default: Whether or not to set the payment profile as default.
+        :type default: :py:obj:`bool`
+        :param validate: Whether or not to validate the payment profile.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        if self.id:
+            self._authorizenet_update_customer_payment_profile(
+                payment=payment, address=address, default=default, validate=validate
+            )
+
+    def delete(self) -> None:
+        """
+        Deletes the Authorizenet payment profile.
+
+        If successfully deleted, sets :py:attr:`id` to :py:obj:`None`.
+
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+
+        if self.id:
+            self._authorizenet_delete_customer_payment_profile()
+            self.id = None
+
+    def _authorizenet_create_customer_payment_profile(
+        self,
+        payment: apicontractsv1.paymentType,
+        address: apicontractsv1.customerAddressType,
+        default: bool = False,
+        validate: bool = False,
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        `createCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-payment-profile>`_
+
+        :param payment: A payment object.
+        :type payment: :py:obj:`~authorizenet.apicontractsv1.paymentType`
+        :param address: A customer address object.
+        :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param default: Whether or not to set the payment profile as default.
+        :type default: :py:obj:`bool`
+        :param validate: Whether or not to validate the payment profile in Authorizenet.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: 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.createCustomerPaymentProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.paymentProfile = apicontractsv1.customerPaymentProfileType()
+        request.paymentProfile.payment = payment
+        request.paymentProfile.address = address
+        request.paymentProfile.defaultPaymentProfile = str(default).lower()
+
+        if validate:
+            request.validationMode = self.validationMode
+
+        return self.execute_controller(
+            apicontrollers.createCustomerPaymentProfileController(request)
+        )
+
+    def _authorizenet_get_customer_payment_profile(
+        self, issuer_info: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        `getCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile>`_
+
+        :param issuer_info: Whether or not to include issuer information in the response.
+        :type issuer_info: :py:obj:`bool`
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AuthorizenetControllerExecutionError: 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, "Customer payment profile id wasn't set."
+
+        request = apicontractsv1.getCustomerPaymentProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.customerPaymentProfileId = self.id
+        request.includeIssuerInfo = str(issuer_info).lower()
+
+        return self.execute_controller(
+            apicontrollers.getCustomerPaymentProfileController(request)
+        )
+
+    def _authorizenet_validate_customer_payment_profile(
+        self,
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.validateCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        `validateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-validate-customer-payment-profile>`_
+
+        :raises AuthorizenetControllerExecutionError: 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.validateCustomerPaymentProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.customerPaymentProfileId = self.id
+        request.validationMode = self.validationMode
+
+        return self.execute_controller(
+            apicontrollers.validateCustomerPaymentProfileController(request)
+        )
+
+    def _authorizenet_update_customer_payment_profile(
+        self,
+        payment: apicontractsv1.paymentType,
+        address: apicontractsv1.customerAddressType,
+        default: bool = False,
+        validate: bool = False,
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.updateCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        `updateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-payment-profile>`_
+
+        :param payment: A payment object.
+        :type payment: :py:obj:`~authorizenet.apicontractsv1.paymentType`
+        :param address: A customer address object.
+        :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param default: Whether or not to set the payment profile as default.
+        :type default: :py:obj:`bool`
+        :param validate: Whether or not to validate the payment profile in Authorizenet.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: 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.updateCustomerPaymentProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+
+        request.paymentProfile = apicontractsv1.customerPaymentProfileType()
+        request.paymentProfile.payment = payment
+        request.paymentProfile.address = address
+        request.paymentProfile.defaultPaymentProfile = str(default).lower()
+        request.paymentProfile.customerPaymentProfileId = self.id
+
+        if validate:
+            request.validationMode = self.validationMode
+
+        return self.execute_controller(
+            apicontrollers.updateCustomerPaymentProfileController(request)
+        )
+
+    def _authorizenet_delete_customer_payment_profile(
+        self,
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        `deleteCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-payment-profile>`_
+
+        :raises AuthorizenetControllerExecutionError: 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.deleteCustomerPaymentProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.customerPaymentProfileId = self.id
+
+        return self.execute_controller(
+            apicontrollers.deleteCustomerPaymentProfileController(request)
+        )

terminusgps/wialon/session.py

@@ -345,7 +345,13 @@ class WialonSession:
 class WialonSessionManager:
     """Provides an interface for generating automatically activated Wialon sessions."""
 
-    def __init__(self, token: str | None = None, lifetime: int = 500) -> None:
+    def __init__(
+        self,
+        token: str | None = None,
+        lifetime: int = 500,
+        session: WialonSession | None = None,
+        session_id: str | None = None,
+    ) -> None:
         """
         Sets :py:attr:`token` and :py:attr:`lifetime`.
 
@@ -357,10 +363,13 @@ class WialonSessionManager:
         :rtype: :py:obj:`None`
 
         """
-        self._token = token
-        self._lifetime = lifetime
-        self._session = WialonSession(sid=None)
-        self.session.login(token=self.token)
+        self.token = token
+        self.lifetime = lifetime
+
+        target_sid = session.id if session and session.id else session_id
+        self.session = WialonSession(sid=target_sid)
+        if not target_sid or not self.validate_session():
+            self.session.login(token=self.token)
 
     def check_active(self) -> bool:
         """
@@ -370,13 +379,18 @@ class WialonSessionManager:
         :rtype: :py:obj:`bool`
 
         """
+        if not self.session.id:
+            return False
         if not self.session.wialon_api.last_call_datetime:
-            return True
+            return self.validate_session()
 
         now = datetime.datetime.now()
         last_call = self.session.wialon_api.last_call_datetime
         session_expiry = last_call + datetime.timedelta(seconds=self.lifetime)
-        return now <= session_expiry
+
+        if now > session_expiry:
+            return False
+        return self.validate_session()
 
     def get_session(self, sid: str | None = None) -> WialonSession:
         """
@@ -391,12 +405,23 @@ class WialonSessionManager:
 
         """
         if sid is not None:
-            self.sid = sid
+            self.session = WialonSession(sid=sid)
+            if not self.validate_session():
+                self.session = WialonSession()
+                self.session.login(token=self.token)
+                return self.session
         if not self.check_active():
-            self.session = WialonSession(sid=None)
-            self.session.login(self.token)
+            self.session = WialonSession()
+            self.session.login(token=self.token)
         return self.session
 
+    def validate_session(self) -> bool:
+        try:
+            result = self.session.wialon_api.core_duplicate()
+            return result is not None
+        except wialon.api.WialonError:
+            return False
+
     @property
     def sid(self) -> str | None:
         """
@@ -405,7 +430,7 @@ class WialonSessionManager:
         :type: :py:obj:`str` | :py:obj:`None`
 
         """
-        return self.session.wialon_api.sid
+        return self.session.wialon_api.sid if self.session else None
 
     @sid.setter
     def sid(self, other: str) -> None:
@@ -418,7 +443,10 @@ class WialonSessionManager:
         :rtype: :py:obj:`None`
 
         """
-        self.session.wialon_api.sid = other
+        if self.session:
+            self.session.wialon_api.sid = other
+        else:
+            self.session = WialonSession(sid=other)
 
     @property
     def token(self) -> str:
@@ -443,9 +471,7 @@ class WialonSessionManager:
         :rtype: :py:obj:`None`
 
         """
-        if other is None:
-            self._token = settings.WIALON_TOKEN
-        self._token = other
+        self._token = other if other is not None else settings.WIALON_TOKEN
 
     @property
     def session(self) -> WialonSession:

terminusgps/wialon/validators.py

@@ -4,7 +4,7 @@ from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured, ValidationError
 from django.utils.translation import gettext_lazy as _
 
-from .session import WialonSession
+from .session import WialonSessionManager
 
 if settings.configured and not hasattr(settings, "WIALON_TOKEN"):
     raise ImproperlyConfigured("'WIALON_TOKEN' setting is required.")
@@ -12,8 +12,7 @@ if settings.configured and not hasattr(settings, "WIALON_TOKEN"):
 
 class WialonValidatorBase:
     def __init__(self) -> None:
-        self.session: WialonSession = WialonSession()
-        self.session.login(settings.WIALON_TOKEN)
+        self.session_manager = WialonSessionManager(token=settings.WIALON_TOKEN)
 
     def __call__(self, value: str) -> None:
         raise NotImplementedError("Subclasses must implement this method.")
@@ -21,10 +20,11 @@ class WialonValidatorBase:
 
 class WialonVinNumberValidator(WialonValidatorBase):
     def __call__(self, value: str) -> None:
-        response = self.session.wialon_api.unit_get_vin_info(vin=value)
+        session = self.session_manager.get_session(sid=None)
+        response = session.wialon_api.unit_get_vin_info(vin=value)
         if "error" in response["vin_lookup_result"].keys():
             raise ValidationError(
-                _("Failed to get info for VIN '%(value)s': '%(message)s'"),
+                _("Failed to get info for VIN # '%(value)s': '%(message)s'"),
                 code="invalid",
                 params={
                     "value": value,
@@ -35,7 +35,8 @@ class WialonVinNumberValidator(WialonValidatorBase):
 
 class WialonImeiNumberValidator(WialonValidatorBase):
     def __call__(self, value: str) -> None:
-        response = self.session.wialon_api.core_search_items(
+        session = self.session_manager.get_session(sid=None)
+        response = session.wialon_api.core_search_items(
             **{
                 "spec": {
                     "itemsType": "avl_unit",
@@ -51,7 +52,7 @@ class WialonImeiNumberValidator(WialonValidatorBase):
         )
         if response is None or not response.get("items"):
             raise ValidationError(
-                _("IMEI '%(value)s' was not found in Wialon."),
+                _("IMEI # '%(value)s' wasn't found in Wialon."),
                 code="invalid",
                 params={"value": value},
             )