python-terminusgps 1.7.1__tar.gz → 1.8.0__tar.gz

{python_terminusgps-1.7.1 → python_terminusgps-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.7.1
+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.1 → python_terminusgps-1.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.7.1"
+version = "1.8.0"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

python_terminusgps-1.8.0/terminusgps/authorizenet/auth.py

@@ -0,0 +1,35 @@
+from authorizenet.apicontractsv1 import merchantAuthenticationType
+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:
+    return merchantAuthenticationType(
+        name=str(settings.MERCHANT_AUTH_LOGIN_ID),
+        transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
+    )
+
+
+@settings_required(["DEBUG"])
+def get_environment() -> str:
+    return constants.SANDBOX if settings.DEBUG else constants.PRODUCTION
+
+
+@settings_required(["DEBUG"])
+def get_validation_mode() -> str:
+    return "testMode" if settings.DEBUG else "liveMode"

python_terminusgps-1.8.0/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)

python_terminusgps-1.8.0/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"

python_terminusgps-1.8.0/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()

python_terminusgps-1.8.0/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

{python_terminusgps-1.7.1 → python_terminusgps-1.8.0}/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")

{python_terminusgps-1.7.1 → python_terminusgps-1.8.0}/uv.lock

@@ -41,48 +41,48 @@ sdist = { url = "https://files.pythonhosted.org/packages/2d/9a/61c151f508a9b3201
 
 [[package]]
 name = "babel"
-version = "2.16.0"
+version = "2.17.0"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/2a/74/f1bc80f23eeba13393b7222b11d95ca3af2c1e28edca18af487137eefed9/babel-2.16.0.tar.gz", hash = "sha256:d1f3554ca26605fe173f3de0c65f750f5a42f924499bf134de6423582298e316", size = 9348104 }
+sdist = { url = "https://files.pythonhosted.org/packages/7d/6b/d52e42361e1aa00709585ecc30b3f9684b3ab62530771402248b1b1d6240/babel-2.17.0.tar.gz", hash = "sha256:0c54cffb19f690cdcc52a3b50bcbf71e07a808d1c80d549f2459b9d2cf0afb9d", size = 9951852 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/ed/20/bc79bc575ba2e2a7f70e8a1155618bb1301eaa5132a8271373a6903f73f8/babel-2.16.0-py3-none-any.whl", hash = "sha256:368b5b98b37c06b7daf6696391c3240c938b37767d4584413e8438c5c435fa8b", size = 9587599 },
+    { url = "https://files.pythonhosted.org/packages/b7/b8/3fe70c75fe32afc4bb507f75563d39bc5642255d1d94f1f23604725780bf/babel-2.17.0-py3-none-any.whl", hash = "sha256:4d0b53093fdfb4b21c92b5213dba5a1b23885afa8383709427046b21c366e5f2", size = 10182537 },
 ]
 
 [[package]]
 name = "boto3"
-version = "1.36.9"
+version = "1.36.11"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "botocore" },
     { name = "jmespath" },
     { name = "s3transfer" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/01/36/2e445688adf538259f469bd1f415619959df2aa9ac2972df8a5728791898/boto3-1.36.9.tar.gz", hash = "sha256:035ed3868ff3b9afe05a49d0bde35582315bc438e60b5e76727a00b107567bfb", size = 111028 }
+sdist = { url = "https://files.pythonhosted.org/packages/ee/ac/2b4346474bd3ae501a2fc0e2b5b4f12f412dc89c05bf321a8108d3a95b5c/boto3-1.36.11.tar.gz", hash = "sha256:b40fbf2c0f22e55b67df95475a68bb72be5169097180a875726b6b884339ac8b", size = 111010 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/16/27/d5a257251bd046409505034d76c7a76a692dd8d4aa31bdc1ebef7881ef1e/boto3-1.36.9-py3-none-any.whl", hash = "sha256:440d0b70990efb732f63b40fa16c663c86fee80347eb4bf3bcc08b593e8ac77f", size = 139166 },
+    { url = "https://files.pythonhosted.org/packages/4e/a5/e6f90b0a768560a0c44cb9076a313ee6d669ec98fd2747a8451832403ffe/boto3-1.36.11-py3-none-any.whl", hash = "sha256:641dd772eac111d9443258f0f5491c57c2af47bddae94a8d32de19edb5bf7b1c", size = 139177 },
 ]
 
 [[package]]
 name = "botocore"
-version = "1.36.9"
+version = "1.36.11"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "jmespath" },
     { name = "python-dateutil" },
     { name = "urllib3" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/e9/1e/976c79eeac461ddbf64b27ce42788c1f26e111c138bb931d14b4062127e5/botocore-1.36.9.tar.gz", hash = "sha256:cb3baefdb8326fdfae0750015e5868330e18d3a088a31da658df2cc8cba7ac73", size = 13493557 }
+sdist = { url = "https://files.pythonhosted.org/packages/a5/0f/6b92050154ad0e286b82ca36de5f87a466723e1cdc525df53270bcc36f60/botocore-1.36.11.tar.gz", hash = "sha256:c919be883f95b9e0c3021429a365d40cd7944b8345a07af30dc8d891ceefe07a", size = 13497505 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/52/e9/fc6e02d198d52818e6658c727a250e89c7570323fc983468f76d761563f1/botocore-1.36.9-py3-none-any.whl", hash = "sha256:e31d206c7708300c541d0799df73b576bbe7d8bed011687d96323ed48763ffd2", size = 13321702 },
+    { url = "https://files.pythonhosted.org/packages/2c/ce/e97be00389d51a010c0680ea688a073737ca3b2de6f924800fc61bf68e41/botocore-1.36.11-py3-none-any.whl", hash = "sha256:82c5660027f696608d0e55feb08c146c11c7ebeba7615961c7765dcf6009a00d", size = 13327743 },
 ]
 
 [[package]]
 name = "certifi"
-version = "2024.12.14"
+version = "2025.1.31"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/0f/bd/1d41ee578ce09523c81a15426705dd20969f5abf006d1afe8aeff0dd776a/certifi-2024.12.14.tar.gz", hash = "sha256:b650d30f370c2b724812bee08008be0c4163b163ddaec3f2546c1caf65f191db", size = 166010 }
+sdist = { url = "https://files.pythonhosted.org/packages/1c/ab/c9f1e32b7b1bf505bf26f0ef697775960db7932abeb7b516de930ba2705f/certifi-2025.1.31.tar.gz", hash = "sha256:3d5da6925056f6f18f119200434a4780a94263f10d1c21d032a6f6b2baa20651", size = 167577 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/a5/32/8f6669fc4798494966bf446c8c4a162e0b5d893dff088afddf76414f70e1/certifi-2024.12.14-py3-none-any.whl", hash = "sha256:1275f7a45be9464efc1173084eaa30f866fe2e47d389406136d332ed4967ec56", size = 164927 },
+    { url = "https://files.pythonhosted.org/packages/38/fc/bce832fd4fd99766c04d1ee0eead6b0ec6486fb100ae5e74c1d91292b982/certifi-2025.1.31-py3-none-any.whl", hash = "sha256:ca78db4565a652026a4db2bcdf68f2fb589ea80d0be70e03929ed730746b84fe", size = 166393 },
 ]
 
 [[package]]
@@ -285,7 +285,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "1.7.0"
+version = "1.8.0"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },

python_terminusgps-1.7.1/terminusgps/authorizenet/auth.py

@@ -1,21 +0,0 @@
-from authorizenet.apicontractsv1 import merchantAuthenticationType
-from authorizenet.constants import constants
-
-from django.conf import ImproperlyConfigured, settings
-
-
-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),
-    )
-
-
-def get_environment() -> str:
-    if not hasattr(settings, "DEBUG"):
-        raise ImproperlyConfigured("'DEBUG' is required.")
-    return constants.SANDBOX if settings.DEBUG else constants.PRODUCTION