python-terminusgps 1.7.0__py3-none-any.whl → 1.8.0__py3-none-any.whl

{python_terminusgps-1.7.0.dist-info → python_terminusgps-1.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.7.0
+Version: 1.8.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

{python_terminusgps-1.7.0.dist-info → python_terminusgps-1.8.0.dist-info}/RECORD

@@ -1,8 +1,12 @@
 terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/settings.py,sha256=CIWif9AJYXk5nE-9Mqmqkeoum6-ON5MTuh0WJilgv3E,185
+terminusgps/settings.py,sha256=Mdeuo6ghfW28QVrBqe5mwwX2_Lk79fJ5kLfR9LV7zZM,314
 terminusgps/test.py,sha256=SmvDgRMqLnj_t29eWbckYjK7e9n-Yy-oWwlbN3IdhqE,2004
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/authorizenet/auth.py,sha256=zITSQMH8F-3vw-lDQRbuR2s9AVlGqbOyyFo0zqU00qU,870
+terminusgps/authorizenet/auth.py,sha256=yznomWGTRbFiTDiugsRw1HqxJAV4aJKZFN3Bzdt_V8E,1119
+terminusgps/authorizenet/profiles/addresses.py,sha256=WdJGYaQdjyn5QRP3_6lQx8ZseSopPv3hTZnn0fiXw8E,2490
+terminusgps/authorizenet/profiles/base.py,sha256=LDggXdPmZdHtb5FwqPKGev7w9FE5k2XvtQelVRfDZ1I,1979
+terminusgps/authorizenet/profiles/customers.py,sha256=ezyWSlpsLFsLezi11Z8GWzg-Qa36gGU1n9FwyFEmI7Y,2448
+terminusgps/authorizenet/profiles/payments.py,sha256=BudjFkpfycQbhv2L5SPmg82GWyR0-nl-FlRqRQ1HP6U,3918
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/secrets.py,sha256=kgRA77rs0mD4berWRLkPtJLOe4Grf--o5f8NzwQqXCk,360
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -10,7 +14,7 @@ terminusgps/wialon/constants.py,sha256=aybYcNcHyar2lz_6BlQbMWpbcHW6eyJeq05QwuiqZ
 terminusgps/wialon/errors.py,sha256=SV9pVwU6FZ_zGlGP6zJN6aLE2auF4TfHFISQLiPMKrI,1758
 terminusgps/wialon/flags.py,sha256=-OoH-eZM54yjRqxsAXL8VImdQu_7C0OAxCrFqaCEuko,13510
 terminusgps/wialon/session.py,sha256=segEjyt-K9AAlMq_OYLVtxFBp_jE5c3KL-AJQhOVa9U,9936
-terminusgps/wialon/utils.py,sha256=yBB3clo_wGPoLyhll7hJ_2vChMdeJV_KffeGq2PhxUY,3151
+terminusgps/wialon/utils.py,sha256=9xJq5eAWm-vu0nJVJ7eUcwhJhMCrGjS1p__4CIBXYm4,3407
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
 terminusgps/wialon/items/base.py,sha256=Z6aGEC2_m5CPHYCa1rgAvkGtSegbrvZ68mifCqo-07A,6617
 terminusgps/wialon/items/resource.py,sha256=xElMYSMyKA5y8rIP0EeF429MBV2hbLZcS6SokftvrOs,5641
@@ -19,7 +23,7 @@ terminusgps/wialon/items/route.py,sha256=qOHPN_rejwiGqvwWzlwmUIAIyc3lKavCalf8ki6
 terminusgps/wialon/items/unit.py,sha256=wzcLa0adMTKX6rtO4Vz6ntaxgY50rLk2KK_VBXlW_lQ,4680
 terminusgps/wialon/items/unit_group.py,sha256=1yc7ldPIgGbtiTj0djRDWmt6Q9K_VT9sxOaioasbbLY,5212
 terminusgps/wialon/items/user.py,sha256=bkcMw_YiocaMuhP_pBfB7apjAZwnsOzGScnGkn8Ybbw,6107
-python_terminusgps-1.7.0.dist-info/METADATA,sha256=D5bRJDHDFZTiXDsHWU8QOn6_Zk4TaExZ2afP7MTsN2A,882
-python_terminusgps-1.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-1.7.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-1.7.0.dist-info/RECORD,,
+python_terminusgps-1.8.0.dist-info/METADATA,sha256=Zg3Ou8OA-8MVM32m2MIMnmq7uV7qUR2t4UPavYYFFE4,882
+python_terminusgps-1.8.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-1.8.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-1.8.0.dist-info/RECORD,,

terminusgps/authorizenet/auth.py

@@ -4,18 +4,32 @@ from authorizenet.constants import constants
 from django.conf import ImproperlyConfigured, settings
 
 
+def settings_required(settings_list: list[str]):
+    def decorator(func):
+        def wrapped(*args, **kwargs):
+            for setting_name in settings_list:
+                if not hasattr(settings, setting_name):
+                    raise ImproperlyConfigured(f"'{setting_name}' setting is required.")
+            return func(*args, **kwargs)
+
+        return wrapped
+
+    return decorator
+
+
+@settings_required(["MERCHANT_AUTH_LOGIN_ID", "MERCHANT_AUTH_TRANSACTION_KEY"])
 def get_merchant_auth() -> merchantAuthenticationType:
-    if not hasattr(settings, "MERCHANT_AUTH_LOGIN_ID"):
-        raise ImproperlyConfigured("'MERCHANT_AUTH_LOGIN_ID' is required.")
-    if not hasattr(settings, "MERCHANT_AUTH_TRANSACTION_KEY"):
-        raise ImproperlyConfigured("'MERCHANT_AUTH_TRANSACTION_KEY' is required.")
     return merchantAuthenticationType(
         name=str(settings.MERCHANT_AUTH_LOGIN_ID),
         transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
     )
 
 
+@settings_required(["DEBUG"])
 def get_environment() -> str:
-    if not hasattr(settings, "DEBUG"):
-        raise ImproperlyConfigured("'DEBUG' is required.")
     return constants.SANDBOX if settings.DEBUG else constants.PRODUCTION
+
+
+@settings_required(["DEBUG"])
+def get_validation_mode() -> str:
+    return "testMode" if settings.DEBUG else "liveMode"

terminusgps/authorizenet/profiles/addresses.py

@@ -0,0 +1,60 @@
+from authorizenet.apicontractsv1 import (
+    createCustomerShippingAddressRequest,
+    customerAddressType,
+    deleteCustomerShippingAddressRequest,
+    updateCustomerShippingAddressRequest,
+    getCustomerShippingAddressRequest,
+    getCustomerShippingAddressResponse,
+)
+from authorizenet.apicontrollers import (
+    createCustomerShippingAddressController,
+    deleteCustomerShippingAddressController,
+    getCustomerShippingAddressController,
+    updateCustomerShippingAddressController,
+)
+from terminusgps.authorizenet.profiles.base import AuthorizenetCustomerProfileBase
+
+
+class AddressProfile(AuthorizenetCustomerProfileBase):
+    def create(self, **kwargs) -> int:
+        if not kwargs.get("address"):
+            raise ValueError("'address' is required on creation.")
+
+        request = createCustomerShippingAddressRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            address=kwargs["address"],
+            defaultShippingAddress=self.default,
+        )
+        controller = createCustomerShippingAddressController(request)
+        response = self.execute_controller(controller)
+        return int(response.get("customerAddressId"))
+
+    def delete(self) -> None:
+        request = deleteCustomerShippingAddressRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            customerAddressId=self.id,
+        )
+        controller = deleteCustomerShippingAddressController(request)
+        self.execute_controller(controller)
+
+    def update(self, address: customerAddressType, default: bool = False) -> None:
+        request = updateCustomerShippingAddressRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            address=address,
+            defaultShippingAddress=default,
+        )
+        controller = updateCustomerShippingAddressController(request)
+        self.execute_controller(controller)
+        self._default = default
+
+    def get_details(self) -> getCustomerShippingAddressResponse:
+        request = getCustomerShippingAddressRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            customerAddressId=self.id,
+        )
+        controller = getCustomerShippingAddressController(request)
+        return self.execute_controller(controller)

terminusgps/authorizenet/profiles/base.py

@@ -0,0 +1,62 @@
+from authorizenet.apicontractsv1 import merchantAuthenticationType
+from ..auth import get_environment, get_merchant_auth, get_validation_mode
+
+
+class AuthorizenetProfileBase:
+    def __init__(
+        self, merchant_id: int | str, id: int | str | None = None, **kwargs
+    ) -> None:
+        self.merchant_id = merchant_id
+        self.id = id if id else str(self.create(**kwargs))
+
+    def __str__(self) -> str:
+        return f"#{self.id}"
+
+    @property
+    def environment(self) -> str:
+        return get_environment()
+
+    @property
+    def merchantAuthentication(self) -> merchantAuthenticationType:
+        return get_merchant_auth()
+
+    @property
+    def validationMode(self) -> str:
+        return get_validation_mode()
+
+    @property
+    def merchantCustomerId(self) -> str:
+        return str(self.merchant_id)
+
+    def create(self, **kwargs) -> int:
+        raise NotImplementedError("Subclasses must implement this method.")
+
+    def execute_controller(self, controller):
+        controller.setenvironment(self.environment)
+        controller.execute()
+        response = controller.getresponse()
+        if response.messages.resultCode != "Ok":
+            raise ValueError(response.messages.message[0]["text"].text)
+        return response
+
+
+class AuthorizenetCustomerProfileBase(AuthorizenetProfileBase):
+    def __init__(
+        self, customer_profile_id: int | str, default: bool = False, **kwargs
+    ) -> None:
+        if isinstance(customer_profile_id, str) and not customer_profile_id.isdigit():
+            raise ValueError(
+                f"'customer_profile_id' must be a digit, got '{customer_profile_id}'."
+            )
+
+        self._default = default
+        self.customer_profile_id = customer_profile_id
+        return super().__init__(**kwargs)
+
+    @property
+    def customerProfileId(self) -> str:
+        return str(self.customer_profile_id)
+
+    @property
+    def default(self) -> str:
+        return "true" if self._default else "false"

terminusgps/authorizenet/profiles/customers.py

@@ -0,0 +1,72 @@
+from authorizenet.apicontrollers import (
+    createCustomerProfileController,
+    deleteCustomerProfileController,
+    getCustomerProfileController,
+    updateCustomerProfileController,
+)
+from authorizenet.apicontractsv1 import (
+    customerProfileType,
+    createCustomerProfileRequest,
+    deleteCustomerProfileRequest,
+    getCustomerProfileRequest,
+    updateCustomerProfileRequest,
+)
+
+from terminusgps.authorizenet.profiles.base import AuthorizenetProfileBase
+
+
+class CustomerProfile(AuthorizenetProfileBase):
+    def create(self, **kwargs) -> int:
+        if not kwargs.get("email"):
+            raise ValueError("'email' is required for creation.")
+
+        request = createCustomerProfileRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            profile=customerProfileType(
+                merchantCustomerId=self.merchantCustomerId,
+                email=kwargs["email"],
+                description=kwargs.get("desc", ""),
+            ),
+        )
+        controller = createCustomerProfileController(request)
+        response = self.execute_controller(controller)
+        return int(response.customerProfileId)
+
+    def update(self, merchant_id: str, email: str, desc: str = "") -> None:
+        request = updateCustomerProfileRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            profile=CustomerProfile(
+                self.id, merchantCustomerId=merchant_id, email=email, description=desc
+            ),
+        )
+        controller = updateCustomerProfileController(request)
+        self.execute_controller(controller)
+
+    def delete(self) -> None:
+        request = deleteCustomerProfileRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=str(self.id),
+        )
+        controller = deleteCustomerProfileController(request)
+        self.execute_controller(controller)
+
+    @property
+    def payment_profiles(self) -> list[dict]:
+        request = getCustomerProfileRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.id,
+            includeIssuerInfo="true",
+        )
+        controller = getCustomerProfileController(request)
+        response = self.execute_controller(controller)
+        return response
+
+
+def main() -> None:
+    profile = CustomerProfile(merchant_id=55, id=522226003)
+    profile.delete()
+    return
+
+
+if __name__ == "__main__":
+    main()

terminusgps/authorizenet/profiles/payments.py

@@ -0,0 +1,90 @@
+from authorizenet.apicontractsv1 import (
+    createCustomerPaymentProfileRequest,
+    getCustomerPaymentProfileRequest,
+    deleteCustomerPaymentProfileRequest,
+    paymentProfile,
+    validateCustomerPaymentProfileRequest,
+)
+from authorizenet.apicontrollers import (
+    createCustomerPaymentProfileController,
+    deleteCustomerPaymentProfileController,
+    getCustomerPaymentProfileController,
+    validateCustomerPaymentProfileController,
+)
+from terminusgps.authorizenet.profiles.base import AuthorizenetCustomerProfileBase
+
+
+class PaymentProfile(AuthorizenetCustomerProfileBase):
+    def create(self, **kwargs) -> int:
+        """
+        Creates an Authorize.NET payment profile.
+
+        :param billing_address: A billing address for the payment profile.
+        :type billing_address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param payment: An Authorize.NET API payment object. Usually a credit card, but could be a bank account.
+        :type payment: :py:obj:`~authorizenet.apicontractsv1.paymentType`
+        :param default: Whether or not the payment method should be marked as default. Default is :py:obj:`False`.
+        :type default: :py:obj:`bool`
+        :returns: The new payment profile id.
+        :rtype: :py:obj:`int`
+
+        """
+        if not kwargs.get("billing_address"):
+            raise ValueError("'billing_address' is required on creation.")
+        if not kwargs.get("payment"):
+            raise ValueError("'payment' is required on creation.")
+
+        request = createCustomerPaymentProfileRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            paymentProfile=paymentProfile(
+                billTo=kwargs["billing_address"],
+                payment=kwargs["payment"],
+                defaultPaymentProfile=self.default,
+            ),
+            validationMode=self.validationMode,
+        )
+        controller = createCustomerPaymentProfileController(request)
+        response = self.execute_controller(controller)
+        return int(response.get("customerPaymentProfileId"))
+
+    def delete(self) -> None:
+        """Deletes the Authorize.NET payment profile."""
+        request = deleteCustomerPaymentProfileRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            customerPaymentProfileId=self.id,
+        )
+        controller = deleteCustomerPaymentProfileController(request)
+        self.execute_controller(controller)
+
+    def validate(self) -> None:
+        """Validates the Authorize.NET payment profile."""
+        request = validateCustomerPaymentProfileRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            customerPaymentProfileId=self.id,
+            validationMode=self.validationMode,
+        )
+        controller = validateCustomerPaymentProfileController(request)
+        self.execute_controller(controller)
+
+    def get_details(self, issuer_info: bool = False) -> dict:
+        """
+        Calls the Authorize.NET API and retrieves the payment profile.
+
+        :param issuer_info: Whether or not Authorize.NET should return issuer info for the payment profile.
+        :type issuer_info: :py:obj:`bool`
+        :returns: The Authorize.NET API payment profile.
+        :rtype: :py:obj:`~authorizenet.apicontractsv1.paymentProfile`
+
+        """
+        request = getCustomerPaymentProfileRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            customerPaymentProfileId=self.id,
+            includeIssuerInfo="true" if issuer_info else "false",
+        )
+        controller = getCustomerPaymentProfileController(request)
+        response = self.execute_controller(controller)
+        return response

terminusgps/settings.py

@@ -1,6 +1,8 @@
 from os import getenv
 
-DEBUG = False
+DEBUG = True
 SECRET_KEY = "xem*6no%8d9%^qzt2f3x3ar-uq4_+7h9myc$t0!+4%bj5us6f)"
 WIALON_ADMIN_ID = getenv("WIALON_ADMIN_ID")
 WIALON_TOKEN = getenv("WIALON_TOKEN")
+MERCHANT_AUTH_LOGIN_ID = getenv("MERCHANT_AUTH_LOGIN_ID")
+MERCHANT_AUTH_TRANSACTION_KEY = getenv("MERCHANT_AUTH_TRANSACTION_KEY")

terminusgps/wialon/utils.py

@@ -50,23 +50,33 @@ def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit")
     return not bool(result)
 
 
-def gen_wialon_password(length: int = 16) -> str:
+def gen_wialon_password(length: int = 32) -> str:
     """Generates a Wialon compliant password."""
-    if length > 64:
-        raise ValueError(f"Passwords cannot be greater than 64 chars. Got '{length}'.")
-    if length < 4:
-        raise ValueError(f"Password cannot be less than 4 chars. Got '{length}'.")
-
-    symbols: str = "!@#$%^*()[]-_+"
-    alphabet: str = string.ascii_letters + string.digits + symbols
-    password: str = "".join(secrets.choice(alphabet) for _ in range(length - 4))
-    return (
-        password
-        + secrets.choice(string.ascii_lowercase)
-        + secrets.choice(string.ascii_uppercase)
-        + secrets.choice(string.digits)
-        + secrets.choice(symbols)
-    )
+    min_length, max_length = 4, 64
+    if length > max_length:
+        raise ValueError(
+            f"Password cannot be greater than {max_length} characters in length. Got {length}."
+        )
+    elif length < min_length:
+        raise ValueError(
+            f"Password cannot be less than {min_length} characters in length. Got {length}."
+        )
+
+    s0 = list(string.ascii_uppercase)
+    s1 = list(string.ascii_lowercase)
+    s2 = list(string.digits)
+    s3 = list("!@#$%^*()[]-_+")
+
+    while True:
+        password = "".join([secrets.choice(s0 + s1 + s2 + s3) for _ in range(length)])
+        if (
+            any(c.islower() for c in password)
+            and any(c.isupper() for c in password)
+            and sum(c.isdigit() for c in password) >= 3
+            and any(c in s3 for c in password)
+        ):
+            break
+    return password
 
 
 def get_id_from_iccid(iccid: str, session: WialonSession) -> str | None: