python-terminusgps 45.3.0__tar.gz → 45.5.0__tar.gz

{python_terminusgps-45.3.0 → python_terminusgps-45.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 45.3.0
+Version: 45.5.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://terminusgps.github.io/python-terminusgps
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-45.3.0 → python_terminusgps-45.5.0}/docs/source/conf.py

@@ -12,7 +12,7 @@ sys.path.insert(0, os.path.abspath("../../"))
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "45.3.0"
+release = "45.5.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{python_terminusgps-45.3.0 → python_terminusgps-45.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "45.3.0"
+version = "45.5.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-45.3.0 → python_terminusgps-45.5.0}/terminusgps/authorizenet/api/payment_profiles.py

@@ -2,8 +2,6 @@ from authorizenet import apicontractsv1, apicontrollers
 from authorizenet.apicontrollersbase import APIOperationBase
 from lxml.objectify import ObjectifiedElement
 
-from terminusgps.authorizenet.auth import get_validation_mode
-
 __all__ = [
     "create_customer_payment_profile",
     "get_customer_payment_profile",
@@ -15,26 +13,37 @@ __all__ = [
 
 def create_customer_payment_profile(
     customer_profile_id: int,
-    payment_profile: apicontractsv1.customerPaymentProfileType,
-    validate: bool = True,
+    payment: apicontractsv1.paymentType,
+    address: apicontractsv1.customerAddressType,
+    default: bool = False,
+    validation: str | None = None,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `createCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-payment-profile>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: int
-    :param payment_profile: An Authorizenet payment profile element.
-    :type payment_profile: ~authorizenet.apicontractsv1.customerPaymentProfileType
-    :param validate: Whether to validate the payment profile. Default is True.
+    :param payment: An Authorizenet payment element.
+    :type payment: ~authorizenet.apicontractsv1.paymentType
+    :param address: An Authorizenet address element.
+    :type address: ~authorizenet.apicontractsv1.customerAddressType
+    :param default: Whether to set the payment profile as default. Default is :py:obj:`False`.
+    :type default: bool
+    :param validation: Validation mode to use when validating the payment profile. If not provided, the payment profile is not validated. Default is :py:obj:`None`.
+    :type validation: str | None
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.createCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
-    request.paymentProfile = payment_profile
-    if validate:
-        request.validationMode = get_validation_mode()
+    request.paymentProfile = apicontractsv1.customerPaymentProfileType()
+    request.paymentProfile.payment = payment
+    request.paymentProfile.billTo = address
+    request.paymentProfile.defaultPaymentProfile = str(default).lower()
+
+    if validation is not None:
+        request.validationMode = str(validation)
     return request, apicontrollers.createCustomerPaymentProfileController
 
 
@@ -64,7 +73,7 @@ def get_customer_payment_profile(
 
 
 def validate_customer_payment_profile(
-    customer_profile_id: int, payment_profile_id: int
+    customer_profile_id: int, payment_profile_id: int, validation: str
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `validateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-validate-customer-payment-profile>`_.
@@ -73,6 +82,8 @@ def validate_customer_payment_profile(
     :type customer_profile_id: int
     :param payment_profile_id: An Authorizenet customer payment profile id.
     :type payment_profile_id: int
+    :param validation: Validation mode to use when validating the payment profile.
+    :type validation: str
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
@@ -80,15 +91,17 @@ def validate_customer_payment_profile(
     request = apicontractsv1.validateCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
     request.customerPaymentProfileId = str(payment_profile_id)
-    request.validationMode = get_validation_mode()
+    request.validationMode = validation
     return request, apicontrollers.validateCustomerPaymentProfileController
 
 
 def update_customer_payment_profile(
     customer_profile_id: int,
     payment_profile_id: int,
-    payment_profile: apicontractsv1.customerPaymentProfileType,
-    validate: bool = True,
+    payment: apicontractsv1.paymentType | None = None,
+    address: apicontractsv1.customerAddressType | None = None,
+    default: bool | None = None,
+    validation: str | None = None,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `updateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-payment-profile>`_.
@@ -97,22 +110,37 @@ def update_customer_payment_profile(
     :type customer_profile_id: int
     :param payment_profile_id: An Authorizenet customer payment profile id.
     :type payment_profile_id: int
-    :param payment_profile: An Authorizenet payment profile element.
-    :type payment_profile: ~authorizenet.apicontractsv1.customerPaymentProfileType
-    :param validate: Whether to validate the payment profile. Default is True.
-    :type validate: bool
+    :param payment: An Authorizenet payment element.
+    :type payment: ~authorizenet.apicontractsv1.paymentType | None
+    :param address: An Authorizenet address element.
+    :type address: ~authorizenet.apicontractsv1.customerAddressType | None
+    :param default: Whether to set the payment profile as default. If not provided, the payment profile's default state is not updated. Default is :py:obj:`None`.
+    :type default: bool | None
+    :param validation: Validation mode to use when validating the payment profile. If not provided, the payment profile is not validated. Default is :py:obj:`None`.
+    :type validation: str | None
+    :raises ValueError: If neither payment nor address was provided.
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
-    if not hasattr(payment_profile, "customerPaymentProfileId"):
-        payment_profile.customerPaymentProfileId = str(payment_profile_id)
+    if payment is None and address is None:
+        raise ValueError(
+            f"At least one of 'payment' or 'address' is required, got '{payment}' and '{address}'."
+        )
 
     request = apicontractsv1.updateCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
-    request.paymentProfile = payment_profile
-    if validate:
-        request.validationMode = get_validation_mode()
+    request.paymentProfile = apicontractsv1.customerPaymentProfileType()
+    request.paymentProfile.customerPaymentProfileId = str(payment_profile_id)
+
+    if payment is not None:
+        request.paymentProfile.payment = payment
+    if address is not None:
+        request.paymentProfile.billTo = address
+    if default is not None:
+        request.paymentProfile.defaultPaymentProfile = str(default).lower()
+    if validation is not None:
+        request.validationMode = str(validation)
     return request, apicontrollers.updateCustomerPaymentProfileController
 
 

python_terminusgps-45.5.0/terminusgps/authorizenet/auth.py

@@ -0,0 +1,38 @@
+from authorizenet.apicontractsv1 import merchantAuthenticationType
+from django.conf import settings
+
+
+def get_merchant_auth() -> merchantAuthenticationType:
+    """
+    Returns the merchant authentication information for Authorizenet API controller execution.
+
+    :returns: A merchant authentication object.
+    :rtype: ~authorizenet.apicontractsv1.merchantAuthenticationType
+
+    """
+    return merchantAuthenticationType(
+        name=str(settings.MERCHANT_AUTH_LOGIN_ID),
+        transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
+    )
+
+
+def get_environment() -> str:
+    """
+    Returns the environment for Authorizenet API controller execution.
+
+    :returns: An Authorizenet API environment string.
+    :rtype: str
+
+    """
+    return settings.MERCHANT_AUTH_ENVIRONMENT
+
+
+def get_validation_mode() -> str:
+    """
+    Returns the validation mode for Authorizenet API controller execution.
+
+    :returns: An Authorizenet API validation string.
+    :rtype: str
+
+    """
+    return settings.MERCHANT_AUTH_VALIDATION_MODE

{python_terminusgps-45.3.0 → python_terminusgps-45.5.0}/terminusgps/authorizenet/controllers.py

@@ -3,7 +3,7 @@ from lxml.objectify import ObjectifiedElement
 
 
 def execute_controller(
-    controller: APIOperationBase,
+    controller: APIOperationBase, environment: str
 ) -> ObjectifiedElement | None:
     """
     Executes an Authorizenet API controller and returns its response.
@@ -19,8 +19,10 @@ def execute_controller(
     :rtype: ~lxml.objectify.ObjectifiedElement | None
 
     """
+    controller.setenvironment(environment)
     controller.execute()
     response = controller.getresponse()
+
     if response is None:
         raise AuthorizenetControllerExecutionError(
             message="Authorizenet controller response didn't exist.", code="1"

{python_terminusgps-45.3.0 → python_terminusgps-45.5.0}/terminusgps/authorizenet/services.py

@@ -1,18 +1,14 @@
 from abc import ABC
 from functools import cached_property
+from typing import Callable
 
-from authorizenet import apicontractsv1
-from authorizenet.apicontrollersbase import APIOperationBase
+from authorizenet.apicontractsv1 import merchantAuthenticationType
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from lxml.objectify import ObjectifiedElement
 
-from terminusgps.authorizenet.auth import (
-    get_environment,
-    get_merchant_auth,
-    get_validation_mode,
-)
-from terminusgps.authorizenet.controllers import execute_controller
+from .auth import get_environment, get_merchant_auth, get_validation_mode
+from .controllers import execute_controller
 
 
 class AuthorizenetService(ABC):
@@ -26,31 +22,30 @@ class AuthorizenetService(ABC):
     )
 
     def __init__(self) -> None:
+        """Raises :py:exc:`~django.core.exceptions.ImproperlyConfigured` if required settings weren't set."""
         for setting in self.REQUIRED_SETTINGS:
             if not hasattr(settings, setting):
                 raise ImproperlyConfigured(f"'{setting}' setting is required.")
 
-    def execute_controller(
-        self, controller: APIOperationBase
-    ) -> ObjectifiedElement:
+    def call_api(self, func: Callable, *args, **kwargs) -> ObjectifiedElement:
         """
-        Executes an Authorizenet API controller.
+        Calls the Authorizenet API function with arguments and returns the result.
 
-        :param controller: An Authorizenet controller.
-        :type controller: ~authorizenet.apicontrollersbase.APIOperationBase
+        :param func: An Authorizenet API function.
+        :type func: ~typing.Callable
+        :param args: Positional arguments for the API call.
+        :param kwargs: Keyword arguments for the API call.
         :raises ~terminusgps.authorizenet.controllers.AuthorizenetControllerExecutionError: If the API call failed.
-        :returns: The Authorizenet API controller response.
+        :returns: The Authorizenet API call response.
         :rtype: ~lxml.objectify.ObjectifiedElement
 
         """
-        controller.setenvironment(self.environment)
-        controller.setmerchantauthentication(self.merchantAuthentication)
-        return execute_controller(controller)
+        request, controller_cls = func(*args, **kwargs)
+        request.merchantAuthentication = self.merchantAuthentication
+        return execute_controller(controller_cls(request), self.environment)
 
     @cached_property
-    def merchantAuthentication(
-        self,
-    ) -> apicontractsv1.merchantAuthenticationType:
+    def merchantAuthentication(self) -> merchantAuthenticationType:
         """Merchant authentication element for Authorizenet API requests."""
         return get_merchant_auth()
 

{python_terminusgps-45.3.0 → python_terminusgps-45.5.0}/uv.lock

@@ -298,7 +298,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "45.3.0"
+version = "45.5.0"
 source = { editable = "." }
 dependencies = [
     { name = "authorizenet" },

python_terminusgps-45.3.0/terminusgps/authorizenet/auth.py

@@ -1,56 +0,0 @@
-from authorizenet.apicontractsv1 import merchantAuthenticationType
-from django.conf import settings
-from django.core.exceptions import ImproperlyConfigured
-
-
-def get_merchant_auth() -> merchantAuthenticationType:
-    """
-    Returns the merchant authentication information for Authorizenet API controller execution.
-
-    :raises ~django.core.exceptions.ImproperlyConfigured: If the :py:data:`MERCHANT_AUTH_LOGIN_ID` or the :py:data:`MERCHANT_AUTH_TRANSACTION_KEY` settings weren't set.
-    :returns: A merchant authentication object.
-    :rtype: ~authorizenet.apicontractsv1.merchantAuthenticationType
-
-    """
-    if not all(
-        [
-            hasattr(settings, "MERCHANT_AUTH_LOGIN_ID"),
-            hasattr(settings, "MERCHANT_AUTH_TRANSACTION_KEY"),
-        ]
-    ):
-        error_msg: str = "'MERCHANT_AUTH_LOGIN_ID' and 'MERCHANT_AUTH_TRANSACTION_KEY' settings are required."
-        raise ImproperlyConfigured(error_msg)
-    return merchantAuthenticationType(
-        name=str(settings.MERCHANT_AUTH_LOGIN_ID),
-        transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
-    )
-
-
-def get_environment() -> str:
-    """
-    Returns the environment for Authorizenet API controller execution.
-
-    :raises ~django.core.exceptions.ImproperlyConfigured: If the :py:data:`MERCHANT_AUTH_ENVIRONMENT` setting wasn't set.
-    :returns: An Authorizenet API environment string.
-    :rtype: str
-
-    """
-    if not hasattr(settings, "MERCHANT_AUTH_ENVIRONMENT"):
-        error_msg: str = "'MERCHANT_AUTH_ENVIRONMENT' setting is required."
-        raise ImproperlyConfigured(error_msg)
-    return settings.MERCHANT_AUTH_ENVIRONMENT
-
-
-def get_validation_mode() -> str:
-    """
-    Returns the validation mode for Authorizenet API controller execution.
-
-    :raises ~django.core.exceptions.ImproperlyConfigured: If the :py:data:`MERCHANT_AUTH_VALIDATION_MODE` setting wasn't set.
-    :returns: An Authorizenet API validation string.
-    :rtype: str
-
-    """
-    if not hasattr(settings, "MERCHANT_AUTH_VALIDATION_MODE"):
-        error_msg: str = "'MERCHANT_AUTH_VALIDATION_MODE' setting is required."
-        raise ImproperlyConfigured(error_msg)
-    return settings.MERCHANT_AUTH_VALIDATION_MODE

python_terminusgps-45.3.0/terminusgps/authorizenet/validators.py

@@ -1,120 +0,0 @@
-import calendar
-import datetime
-
-from django.core.exceptions import ValidationError
-from django.utils.translation import gettext_lazy as _
-
-
-def validate_credit_card_number(value: str) -> None:
-    """
-    Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is an invalid credit card number.
-
-    Uses the `Luhn algorithm <https://en.wikipedia.org/wiki/Luhn_algorithm>`_ to validate the credit card number.
-
-    :param value: A credit card number string.
-    :type value: :py:obj:`str`
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value fails the Luhn algorithm.
-    :returns: Nothing.
-    :rtype: :py:obj:`None`
-
-    """
-    if not value.isdigit():
-        raise ValidationError(
-            _("Credit card number can only contain digits. Got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-
-    card_number = [int(num) for num in reversed(value)]
-    even_digits = card_number[1::2]
-    odd_digits = card_number[0::2]
-
-    checksum = 0
-    checksum += sum(
-        [
-            digit * 2 if digit * 2 <= 9 else (digit * 2) % 9 or 9
-            for digit in even_digits
-        ]
-    )
-    checksum += sum([digit for digit in odd_digits])
-
-    if checksum % 10 != 0:
-        raise ValidationError(_("Invalid credit card number."), code="invalid")
-
-
-def validate_credit_card_expiry_month(value: str) -> None:
-    """
-    Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is an invalid credit card expiration date month.
-
-    :param value: A credit card expiration year string.
-    :type value: :py:obj:`str`
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value is negative.
-    :raises ValidationError: If the value isn't between 1-12.
-    :returns: Nothing.
-    :rtype: :py:obj:`None`
-
-    """
-    if not value.isdigit():
-        raise ValidationError(
-            _("Expiration month can only contain digits, got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-    if not int(value) > 0:
-        raise ValidationError(
-            _(
-                "Expiration month can only be a positive value, got '%(value)s'."
-            ),
-            code="invalid",
-            params={"value": value},
-        )
-
-    try:
-        calendar.Month(int(value))
-    except ValueError:
-        raise ValidationError(
-            _("Expiration month must be between 1-12, got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-
-
-def validate_credit_card_expiry_year(value: str) -> None:
-    """
-    Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is an invalid credit card expiration date year.
-
-    :param value: A credit card expiration year string.
-    :type value: :py:obj:`str`
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value is negative.
-    :raises ValidationError: If the value is a year in the past.
-    :returns: Nothing.
-    :rtype: :py:obj:`None`
-
-    """
-    if not value.isdigit():
-        raise ValidationError(
-            _("Expiration year can only contain digits, got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-    if not int(value) > 0:
-        raise ValidationError(
-            _(
-                "Expiration year can only be a positive value, got '%(value)s'."
-            ),
-            code="invalid",
-            params={"value": value},
-        )
-
-    input_year = datetime.datetime.strptime(value, "%y").year
-    this_year = datetime.datetime.now().year
-
-    if not input_year >= this_year:
-        raise ValidationError(
-            _("Expiration year cannot be in the past, got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )