python-terminusgps 31.8.1__py3-none-any.whl → 32.0.1__py3-none-any.whl

{python_terminusgps-31.8.1.dist-info → python_terminusgps-32.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 31.8.1
+Version: 32.0.1
 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-31.8.1.dist-info → python_terminusgps-32.0.1.dist-info}/RECORD

@@ -2,11 +2,11 @@ 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=253SeY0CSYlcxsXUmjNJ4X-FgtFTdO3N1XAytAtb_R0,3970
+terminusgps/authorizenet/utils.py,sha256=JvU99PTfJrMlc0ufwR_iYYYlWg6GMgHhOoJ7eUEQNOc,3940
 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=RlvSDuBNmtotu1WD24fQEktiBKyqKiTkGaBgoS2_V84,8851
+terminusgps/authorizenet/profiles/base.py,sha256=qE2mZxtzNenVD7RDD8KF3ctfKdoK-1awcCi52Ajhb0c,2725
+terminusgps/authorizenet/profiles/customers.py,sha256=9cLZoakpTVlospAe3v15vbXep6CsxVQG5-khggoA1qc,9480
 terminusgps/authorizenet/profiles/payments.py,sha256=ohhZrs9MB7GkCi7jQvPVvELNKnR9BwzMd607jJmT4n4,11316
 terminusgps/authorizenet/profiles/subscriptions.py,sha256=N4_0kbBBJ0FtKdIydN8FLnAG2kSI9DHQWAwemMt7Qu8,11020
 terminusgps/authorizenet/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -32,20 +32,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-31.8.1.dist-info/METADATA,sha256=SAIylvokXcWj7ZD4knARCl2FwzCI1-VVxKDzcj5SIRw,1581
-python_terminusgps-31.8.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-31.8.1.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-31.8.1.dist-info/RECORD,,
+python_terminusgps-32.0.1.dist-info/METADATA,sha256=_vNbpBrKZT9QAhVQIJPAQBzN-ShJP0ygvzp3fNKjG6s,1581
+python_terminusgps-32.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-32.0.1.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-32.0.1.dist-info/RECORD,,

terminusgps/authorizenet/profiles/base.py

@@ -9,10 +9,25 @@ from ..utils import ControllerExecutionMixin
 
 class AuthorizenetProfileBase(ControllerExecutionMixin):
     def __init__(
-        self, merchant_id: int | str, id: int | str | None = None, *args, **kwargs
+        self,
+        id: int | str | None = None,
+        merchant_id: str | None = None,
+        *args,
+        **kwargs,
     ) -> None:
-        self._merchantCustomerId = merchant_id
-        self._id = int(id) if id else self.create(*args, **kwargs)
+        """
+        Sets :py:attr:`id` and :py:attr:`merchant_id`, if provided.
+
+        :raises ValueError: If ``id`` was provided as a string, and contained non-digit characters.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        if isinstance(id, str) and not id.isdigit():
+            raise ValueError(f"'id' can only contain digits, got '{id}'.")
+
+        self._merchantCustomerId: str | None = merchant_id
+        self._id: int | None = int(id) if id else None
 
     @override
     def __str__(self) -> str:
@@ -20,13 +35,13 @@ class AuthorizenetProfileBase(ControllerExecutionMixin):
 
     @property
     def merchantCustomerId(self) -> str:
-        """An internally designated customer id."""
-        return str(self._merchantCustomerId)
+        """An merchant designated customer id."""
+        return str(self._merchantCustomerId) if self._merchantCustomerId else ""
 
     @property
-    def id(self) -> str:
+    def id(self) -> str | None:
         """An Authorizenet generated id."""
-        return str(self._id)
+        return str(self._id) if self._id else None
 
     @property
     def merchantAuthentication(self) -> apicontractsv1.merchantAuthenticationType:

terminusgps/authorizenet/profiles/customers.py

@@ -1,8 +1,7 @@
 from authorizenet import apicontractsv1, apicontrollers
 from authorizenet.apicontractsv1 import customerProfileType
 
-from ..utils import ControllerExecutionError
-from .base import AuthorizenetProfileBase
+from terminusgps.authorizenet.profiles.base import AuthorizenetProfileBase
 
 
 class CustomerProfile(AuthorizenetProfileBase):
@@ -10,8 +9,12 @@ class CustomerProfile(AuthorizenetProfileBase):
 
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
-        self._email = None
-        self._desc = None
+        response = self._authorizenet_get_customer_profile()
+        self._id = (
+            int(response.profile.customerProfileId)
+            if response is not None
+            else self.create(*args, **kwargs)
+        )
 
     def create(self, email: str, desc: str = "") -> int:
         """
@@ -34,7 +37,12 @@ class CustomerProfile(AuthorizenetProfileBase):
         self._desc = desc
         return int(response.customerProfileId)
 
-    def update(self, email: str, desc: str = "") -> None:
+    def update(
+        self,
+        merchant_id: int | str | None = None,
+        email: str | None = None,
+        desc: str | None = None,
+    ) -> None:
         """
         Updates the customer profile.
 
@@ -47,11 +55,11 @@ class CustomerProfile(AuthorizenetProfileBase):
         :rtype: :py:obj:`None`
 
         """
-        self._authorizenet_update_customer_profile(email, desc)
-        if email:
+        if any([merchant_id, email, desc]):
+            self._authorizenet_update_customer_profile(merchant_id, email, desc)
             self._email = email
-        if desc:
             self._desc = desc
+            self._merchantCustomerId = merchant_id
 
     def delete(self) -> None:
         """
@@ -67,50 +75,51 @@ class CustomerProfile(AuthorizenetProfileBase):
     @property
     def payment_profile_ids(self) -> list[int]:
         """A list of the customer's payment profile ids, if any."""
-        try:
-            response = self._authorizenet_get_customer_profile(issuer_info=False)
-            return [
-                int(profile.customerPaymentProfileId)
-                for profile in response.profile.paymentProfiles
-            ]
-        except (ControllerExecutionError, AttributeError):
-            return []
+        response = self._authorizenet_get_customer_profile(issuer_info=False)
+        return [
+            int(profile.customerPaymentProfileId)
+            for profile in response.profile.paymentProfiles
+        ]
 
     @property
     def address_profile_ids(self) -> list[int]:
         """A list of the customer's address profile ids, if any."""
-        try:
-            response = self._authorizenet_get_customer_profile(issuer_info=False)
-            return [
-                int(profile.customerAddressId)
-                for profile in response.profile.shipToList
-            ]
-        except (ControllerExecutionError, AttributeError):
-            return []
+        response = self._authorizenet_get_customer_profile(issuer_info=False)
+        return [
+            int(profile.customerAddressId) for profile in response.profile.shipToList
+        ]
 
     @property
     def email(self) -> str | None:
-        if not self._email:
+        """A customer email address."""
+        if self._email is None:
             response = self._authorizenet_get_customer_profile(issuer_info=False)
-            self._email = response.profile.email if response else None
+            self._email = response.profile.email if response is not None else None
         return self._email
 
-    def _authorizenet_get_customer_profile_ids(self) -> dict | None:
-        """
-        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerProfileIdsRequest` using the Authorizenet API.
+    @email.setter
+    def email(self, other: str) -> None:
+        """Sets :py:attr:`email` and updates the customer profile email in Authorizenet."""
+        self._email = other
+        self._authorizenet_update_customer_profile(email=other)
 
-        `getCustomerProfileIdsRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile-ids>`_
+    @property
+    def desc(self) -> str | None:
+        """A customer description."""
+        if self._desc is None:
+            response = self._authorizenet_get_customer_profile(issuer_info=False)
+            self._desc = response.profile.description if response is not None else None
+        return self._desc
 
-        :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`
+    @desc.setter
+    def desc(self, other: str) -> None:
+        """Sets :py:attr:`desc` and updates the customer profile description in Authorizenet."""
+        self._desc = other
+        self._authorizenet_update_customer_profile(desc=other)
 
-        """
-        request = apicontractsv1.getCustomerProfileIdsRequest(
-            merchantAuthentication=self.merchantAuthentication
-        )
-        controller = apicontrollers.getCustomerProfileIdsController(request)
-        return self.execute_controller(controller)
+    @property
+    def exists(self) -> bool:
+        return bool(self._authorizenet_get_customer_profile())
 
     def _authorizenet_create_customer_profile(
         self, email: str, desc: str = ""
@@ -148,36 +157,41 @@ class CustomerProfile(AuthorizenetProfileBase):
 
         `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_
 
+        :param merchant_id: An optional customer merchant id.
+        :type merchant_id: :py:obj:`int` | :py:obj:`None`
         :param issuer_info: Whether or not to include issuer info in the response.
         :type issuer_info: :py:obj:`bool`
-        :raises AssertionError: If :py:attr:`id` was not 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.getCustomerProfileRequest(
             merchantAuthentication=self.merchantAuthentication,
-            customerProfileId=self.id,
             includeIssuerInfo=str(issuer_info).lower(),
         )
+        if self.id is not None:
+            request.customerProfileId = str(self.id)
+        elif self.id is None and self.merchantCustomerId is not None:
+            request.merchantCustomerId = str(self.merchantCustomerId)
+        else:
+            return
+
         controller = apicontrollers.getCustomerProfileController(request)
         return self.execute_controller(controller)
 
     def _authorizenet_update_customer_profile(
-        self, email: str, desc: str = ""
+        self, email: str | None = None, desc: str | None = None
     ) -> dict | None:
         """
         Executes an :py:obj:`~authorizenet.apicontractsv1.updateCustomerProfileRequest` using the Authorizenet API.
 
         `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_
 
-        :param email: An email address.
-        :type email: :py:obj:`str`
-        :param desc: An optional description.
-        :type desc: :py:obj:`str`
+        :param email: A customer email address.
+        :type email: :py:obj:`str` | :py:obj:`None`
+        :param desc: A customer description.
+        :type desc: :py:obj:`str` | :py:obj:`None`
         :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
         :raises AssertionError: If :py:attr:`id` wasn't set.
         :returns: An Authorizenet API response, if any.
@@ -186,14 +200,16 @@ class CustomerProfile(AuthorizenetProfileBase):
         """
         assert self.id, "'id' was not set."
 
+        new_profile: customerProfileType = customerProfileType(
+            merchantCustomerId=self.merchantCustomerId, customerProfileId=self.id
+        )
+        if email is not None:
+            new_profile.email = email
+        if desc is not None:
+            new_profile.desc = desc
+
         request = apicontractsv1.updateCustomerProfileRequest(
-            merchantAuthentication=self.merchantAuthentication,
-            profile=customerProfileType(
-                merchantCustomerId=self.merchantCustomerId,
-                email=email,
-                description=desc,
-                customerProfileId=self.id,
-            ),
+            merchantAuthentication=self.merchantAuthentication, profile=new_profile
         )
         controller = apicontrollers.updateCustomerProfileController(request)
         return self.execute_controller(controller)

terminusgps/authorizenet/utils.py

@@ -44,59 +44,57 @@ def get_customer_profile_ids() -> list[int]:
         merchantAuthentication=get_merchant_auth()
     )
     controller = apicontrollers.getCustomerProfileIdsController(request)
-    controller.setenvironment(get_environment())
-    controller.execute()
-    response = controller.getresponse()
-
-    if response is not None and response.messages.resultCode != "Ok":
-        raise ControllerExecutionError(
-            message=response.messages.message[0]["text"].text,
-            code=response.messages.message[0]["code"].text,
-        )
+    response = ControllerExecutionMixin.execute_controller(controller)
+    if response is None or "ids" not in response.getchildren():
+        return []
     return [int(id) for id in response.ids.getchildren()]
 
 
-def get_customer_profile_id(email: str) -> int | None:
+def generate_customer_address(form: forms.Form) -> apicontractsv1.customerAddressType:
     """
-    Retrieves an Authorizenet customer profile id by email address.
+    Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`.
 
-    :param email: A customer email address.
-    :type email: :py:obj:`str`
-    :raises ControllerExecutionError: If something goes wrong with the Authorizenet API.
-    :returns: A customer profile id, if found.
-    :rtype: :py:obj:`int` | :py:obj:`None`
+    :param form: A Django form.
+    :type form: :py:obj:`~django.forms.Form`
+    :raises ValueError: If ``address`` wasn't in the form.
+    :raises ValueError: If ``first_name`` wasn't in the form.
+    :raises ValueError: If ``last_name`` wasn't in the form.
+    :returns: A customer address object.
+    :rtype: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
 
     """
-    request = apicontractsv1.getCustomerProfileRequest(
-        merchantAuthentication=get_merchant_auth(), email=email, includeIssuerInfo=False
-    )
-    controller = apicontrollers.getCustomerProfileController(request)
-    controller.setenvironment(get_environment())
-    controller.execute()
-    response = controller.getresponse()
-
-    if response is not None and response.messages.resultCode != "Ok":
-        if response.messages.message[0]["code"].text == "E00040":
-            return  # Record not found
-
-        raise ControllerExecutionError(
-            message=response.messages.message[0]["text"].text,
-            code=response.messages.message[0]["code"].text,
-        )
-    elif response is not None:
-        return int(response.profile.customerProfileId)
-
+    required_fields: list[str] = ["address", "first_name", "last_name"]
+    for field in required_fields:
+        if field not in form.cleaned_data or form.cleaned_data.get(field) is None:
+            raise ValueError(
+                f"'{field}' was not provided by the form, got '{form.cleaned_data.get(field)}'."
+            )
 
-def generate_customer_address(form: forms.Form) -> apicontractsv1.customerAddressType:
-    """Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`."""
     address: apicontractsv1.customerAddressType = form.cleaned_data["address"]
     address.firstName = form.cleaned_data["first_name"]
     address.lastName = form.cleaned_data["last_name"]
-    address.phone = form.cleaned_data["phone"]
+    if form.cleaned_data.get("phone"):
+        address.phone = form.cleaned_data["phone"]
     return address
 
 
 def generate_customer_payment(form: forms.Form) -> apicontractsv1.paymentType:
-    """Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.paymentType`."""
-    credit_card = form.cleaned_data["credit_card"]
+    """
+    Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.paymentType`.
+
+    :param form: A Django form.
+    :type form: :py:obj:`~django.forms.Form`
+    :raises ValueError: If ``credit_card`` wasn't in the form.
+    :returns: A payment object.
+    :rtype: :py:obj:`~authorizenet.apicontractsv1.paymentType`
+
+    """
+    required_fields: list[str] = ["credit_card"]
+    for field in required_fields:
+        if field not in form.cleaned_data or form.cleaned_data.get(field) is None:
+            raise ValueError(
+                f"'{field}' was not provided by the form, got '{form.cleaned_data.get(field)}'."
+            )
+
+    credit_card: apicontractsv1.creditCardType = form.cleaned_data["credit_card"]
     return apicontractsv1.paymentType(creditCard=credit_card)

terminusgps/wialon/items/unit.py

@@ -153,61 +153,10 @@ class WialonUnit(WialonBase):
     @property
     def image_url(self) -> str | None:
         """Returns an absolute url to the unit's icon in Wialon."""
-        if hasattr(settings, "WIALON_HOST"):
+        if settings.configured and hasattr(settings, "WIALON_HOST"):
             return urljoin(settings.WIALON_HOST, self._image_uri)
         return urljoin("https://hst-api.wialon.com", self._image_uri)
 
-    def assign_to_number(self, value: str) -> None:
-        """
-        Sets ``value`` to the unit's ``to_number`` custom field.
-
-        :param value: A new value for the unit's ``to_number`` custom field.
-        :type value: :py:obj:`str`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        cfield_key: str = "to_number"
-        cfield_val: str = value
-        cfield_id: int | None = self.get_cfield_id(cfield_key)
-
-        if cfield_id:
-            self.update_cfield(cfield_id, cfield_key, cfield_val)
-
-    def assign_iccid(self, value: str) -> None:
-        """
-        Sets ``value`` to the unit's ``iccid`` admin field.
-
-        :param value: A new value for the unit's ``iccid`` custom field.
-        :type value: :py:obj:`str`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        afield_key: str = "iccid"
-        afield_val: str = value
-        afield_id: int | None = self.get_afield_id(afield_key)
-
-        if afield_id:
-            self.update_afield(afield_id, afield_key, afield_val)
-
-    def assign_carrier(self, value: str) -> None:
-        """
-        Sets ``value`` to the unit's ``carrier`` admin field.
-
-        :param value: A new value for the unit's ``carrier`` custom field.
-        :type value: :py:obj:`str`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        afield_key: str = "carrier"
-        afield_val: str = value
-        afield_id: int | None = self.get_afield_id(afield_key)
-
-        if afield_id:
-            self.update_afield(afield_id, afield_key, afield_val)
-
     def execute_command(
         self,
         name: str,

terminusgps/wialon/validators.py

@@ -6,7 +6,7 @@ from django.utils.translation import gettext_lazy as _
 
 from .session import WialonSession
 
-if not hasattr(settings, "WIALON_TOKEN"):
+if settings.configured and not hasattr(settings, "WIALON_TOKEN"):
     raise ImproperlyConfigured("'WIALON_TOKEN' setting is required.")