python-terminusgps 51.0.0__tar.gz → 52.0.0__tar.gz

{python_terminusgps-51.0.0 → python_terminusgps-52.0.0}/.gitignore

@@ -3,6 +3,7 @@
 !.github/
 !.python-version
 docs/build/
+htmlcov/
 
 # Python-generated files
 __pycache__/

{python_terminusgps-51.0.0 → python_terminusgps-52.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 51.0.0
+Version: 52.0.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
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.12
 Requires-Dist: authorizenet>=1.1.5
-Requires-Dist: django>=5.2.7
+Requires-Dist: django>=6.0.2
 Requires-Dist: py-aiowialon>=1.3.5
 Requires-Dist: python-wialon>=1.2.4
 Description-Content-Type: text/markdown

python_terminusgps-52.0.0/htmlcov/.gitignore

@@ -0,0 +1,2 @@
+# Created by coverage.py
+*

{python_terminusgps-51.0.0 → python_terminusgps-52.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "51.0.0"
+version = "52.0.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" } ]
@@ -13,7 +13,7 @@ classifiers = [
 requires-python = ">=3.12"
 dependencies = [
     "authorizenet>=1.1.5",
-    "django>=5.2.7",
+    "django>=6.0.2",
     "py-aiowialon>=1.3.5",
     "python-wialon>=1.2.4",
 ]
@@ -71,6 +71,7 @@ skip-magic-trailing-comma = true
 
 [dependency-groups]
 dev = [
+    "coverage>=7.13.4",
     "django-stubs>=5.1.3",
 ]
 docs = [

{python_terminusgps-51.0.0 → python_terminusgps-52.0.0}/terminusgps/authorizenet/api/address_profiles.py

@@ -12,7 +12,7 @@ __all__ = [
 
 def create_customer_shipping_address(
     customer_profile_id: int,
-    address: apicontractsv1.customerAddressType,
+    contract: apicontractsv1.customerAddressType,
     default: bool = False,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
@@ -20,8 +20,8 @@ def create_customer_shipping_address(
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: int
-    :param address: An Authorizenet customer address element.
-    :type address: ~authorizenet.apicontractsv1.customerAddressType
+    :param contract: An Authorizenet customer address contract.
+    :type contract: ~authorizenet.apicontractsv1.customerAddressType
     :param default: Whether to set the address profile as default. Default is :py:obj:`False`.
     :type default: bool
     :returns: A tuple containing an Authorizenet API request element and controller class.
@@ -30,8 +30,8 @@ def create_customer_shipping_address(
     """
     request = apicontractsv1.createCustomerShippingAddressRequest()
     request.customerProfileId = str(customer_profile_id)
-    request.address = address
-    request.defaultShippingAddress = str(default).lower()
+    request.address = contract
+    request.defaultShippingAddress = int(default)
     return request, apicontrollers.createCustomerShippingAddressController
 
 
@@ -57,8 +57,7 @@ def get_customer_shipping_address(
 
 def update_customer_shipping_address(
     customer_profile_id: int,
-    address_profile_id: int,
-    address: apicontractsv1.customerAddressType,
+    contract: apicontractsv1.customerAddressExType,
     default: bool,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
@@ -66,40 +65,21 @@ def update_customer_shipping_address(
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: int
-    :param address_profile_id: An Authorizenet address profile id.
-    :type address_profile_id: int
-    :type address: ~authorizenet.apicontractsv1.customerAddressType
-    :param address: An Authorizenet customer address element.
-    :type address: ~authorizenet.apicontractsv1.customerAddressType
+    :type contract: ~authorizenet.apicontractsv1.customerAddressExType
+    :param contract: An Authorizenet customer address ex element.
     :param default: Whether to set the address profile as default.
     :type default: bool
+    :raises ValueError: If the contract didn't have :py:attr:`customerAddressId` set.
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
-    address_ex = apicontractsv1.customerAddressExType()
-    address_ex.customerAddressId = str(address_profile_id)
-    if first_name := getattr(address, "firstName", None):
-        address_ex.firstName = str(first_name)
-    if last_name := getattr(address, "lastName", None):
-        address_ex.lastName = str(last_name)
-    if street := getattr(address, "address", None):
-        address_ex.address = str(street)
-    if city := getattr(address, "city", None):
-        address_ex.city = str(city)
-    if state := getattr(address, "state", None):
-        address_ex.state = str(state)
-    if country := getattr(address, "country", None):
-        address_ex.country = str(country)
-    if phone_number := getattr(address, "phoneNumber", None):
-        address_ex.phoneNumber = str(phone_number)
-    if zip_code := getattr(address, "zip", None):
-        address_ex.zip = str(zip_code)
-
+    if not contract.customerAddressId:
+        raise ValueError("'customerAddressId' is required in contract")
     request = apicontractsv1.updateCustomerShippingAddressRequest()
     request.customerProfileId = str(customer_profile_id)
-    request.address = address_ex
-    request.defaultShippingAddress = str(default).lower()
+    request.address = contract
+    request.defaultShippingAddress = int(default)
     return request, apicontrollers.updateCustomerShippingAddressController
 
 

{python_terminusgps-51.0.0 → python_terminusgps-52.0.0}/terminusgps/authorizenet/api/customer_profiles.py

@@ -6,94 +6,76 @@ __all__ = [
     "create_customer_profile",
     "delete_customer_profile",
     "get_customer_profile",
-    "get_customer_profile_by_email",
-    "get_customer_profile_by_merchant_id",
     "get_customer_profile_ids",
     "update_customer_profile",
 ]
 
 
 def create_customer_profile(
-    merchant_id: str, email: str, description: str = ""
+    contract: apicontractsv1.customerProfileType,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `createCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile>`_.
 
-    :param merchant_id: A merchant designated customer id.
-    :type merchant_id: str
-    :param email: A customer email address.
-    :type email: str
-    :param description: An optional customer description.
-    :type description: str
+    :param contract: A customer profile contract element.
+    :type contract: ~apicontractsv1.customerProfileType
+    :raises ValueError: If the contract didn't have at least one of ``email``, ``merchantCustomerId`` or ``description``.
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
+    if not any(
+        [contract.email, contract.merchantCustomerId, contract.description]
+    ):
+        raise ValueError(
+            "At least one of 'email', 'merchantCustomerId' or 'description' is required in contract"
+        )
     request = apicontractsv1.createCustomerProfileRequest()
-    request.profile = apicontractsv1.customerProfileType()
-    request.profile.merchantCustomerId = merchant_id
-    request.profile.description = description
-    request.profile.email = email
+    request.profile = contract
     return request, apicontrollers.createCustomerProfileController
 
 
 def get_customer_profile(
-    customer_profile_id: int, include_issuer_info: bool = False
+    customer_profile_id: int | None = None,
+    email: str | None = None,
+    merchant_id: str | None = None,
+    description: str | None = None,
+    include_issuer_info: bool = False,
+    unmask_expiration_date: bool = False,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_.
 
     :param customer_profile_id: Authorizenet customer profile id.
-    :type customer_profile_id: int
+    :type customer_profile_id: int | None
+    :param email: Authorizenet customer profile email.
+    :type email: str | None
+    :param merchant_id: Authorizenet customer profile merchant id.
+    :type merchant_id: str | None
+    :param description: Authorizenet customer profile description.
+    :type description: str | None
     :param include_issuer_info: Whether to include issuer info in the response. Default is :py:obj:`False`.
     :type include_issuer_info: bool
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
-    request = apicontractsv1.getCustomerProfileRequest()
-    request.customerProfileId = str(customer_profile_id)
-    request.includeIssuerInfo = str(include_issuer_info).lower()
-    return request, apicontrollers.getCustomerProfileController
-
-
-def get_customer_profile_by_email(
-    email: str, include_issuer_info: bool = False
-) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
-    """
-    `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_.
-
-    :param email: Merchant designated customer profile email address.
-    :type email: str
-    :param include_issuer_info: Whether to include issuer info in the response. Default is :py:obj:`False`.
-    :type include_issuer_info: bool
-    :returns: A tuple containing an Authorizenet API request element and controller class.
-    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
+    if not any([customer_profile_id, email, merchant_id, description]):
+        raise ValueError(
+            "At least one of 'customer_profile_id', 'email', 'merchant_id' or 'description' is required."
+        )
 
-    """
-    request = apicontractsv1.getCustomerProfileRequest()
-    request.email = str(email)
-    request.includeIssuerInfo = str(include_issuer_info).lower()
-    return request, apicontrollers.getCustomerProfileController
-
-
-def get_customer_profile_by_merchant_id(
-    merchant_id: str, include_issuer_info: bool = False
-) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
-    """
-    `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_.
-
-    :param merchant_id: Merchant designated customer profile id.
-    :type merchant_id: str
-    :param include_issuer_info: Whether to include issuer info in the response. Default is :py:obj:`False`.
-    :type include_issuer_info: bool
-    :returns: A tuple containing an Authorizenet API request element and controller class.
-    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
-
-    """
     request = apicontractsv1.getCustomerProfileRequest()
-    request.merchantCustomerId = str(merchant_id)
     request.includeIssuerInfo = str(include_issuer_info).lower()
+    request.unmaskExpirationDate = str(unmask_expiration_date).lower()
+    if customer_profile_id is not None:
+        request.customerProfileId = str(customer_profile_id)
+    if email is not None:
+        request.email = email
+    if merchant_id is not None:
+        request.merchantCustomerId = merchant_id
+    if description is not None:
+        request.description = description
     return request, apicontrollers.getCustomerProfileController
 
 
@@ -112,19 +94,25 @@ def get_customer_profile_ids() -> tuple[
 
 
 def update_customer_profile(
-    profile: apicontractsv1.customerProfileExType,
+    contract: apicontractsv1.customerProfileExType,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_.
 
-    :param profile: An Authorizenet customer profile ex element.
-    :type profile: ~authorizenet.apicontractsv1.customerProfileExType
+    :param contract: An Authorizenet customer profile ex contract.
+    :type contract: ~authorizenet.apicontractsv1.customerProfileExType
+    :raises TypeError: If the contract wasn't of type :py:class:`~apicontractsv1.customerProfileExType`.
+    :raises ValueError: If the contract didn't have all required attributes.
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
+    if not contract.customerProfileId:
+        raise ValueError(
+            f"Invalid value for 'customerProfileId': '{contract.customerProfileId}'"
+        )
     request = apicontractsv1.updateCustomerProfileRequest()
-    request.profile = profile
+    request.profile = contract
     return request, apicontrollers.updateCustomerProfileController
 
 

{python_terminusgps-51.0.0 → python_terminusgps-52.0.0}/terminusgps/authorizenet/api/payment_profiles.py

@@ -13,8 +13,7 @@ __all__ = [
 
 def create_customer_payment_profile(
     customer_profile_id: int,
-    payment: apicontractsv1.paymentType,
-    address: apicontractsv1.customerAddressType,
+    contract: apicontractsv1.customerPaymentProfileType,
     default: bool = False,
     validation: str = "liveMode",
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
@@ -23,10 +22,8 @@ def create_customer_payment_profile(
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: int
-    :param payment: An Authorizenet payment element.
-    :type payment: ~authorizenet.apicontractsv1.paymentType
-    :param address: An Authorizenet address element.
-    :type address: ~authorizenet.apicontractsv1.customerAddressType
+    :param contract: A customer payment profile element.
+    :type contract: ~authorizenet.apicontractsv1.customerPaymentProfileType
     :param default: Whether to set the payment profile as default. Default is :py:obj:`False`.
     :type default: bool
     :param validation: Validation mode. Default is :py:obj:`"liveMode"`.
@@ -35,13 +32,15 @@ def create_customer_payment_profile(
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
+    if not contract.payment:
+        raise ValueError("'payment' attribute is required in contract")
+    if not contract.billTo:
+        raise ValueError("'billTo' attribute is required in contract")
     request = apicontractsv1.createCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
     request.validationMode = validation
-    request.paymentProfile = apicontractsv1.customerPaymentProfileType()
-    request.paymentProfile.payment = payment
-    request.paymentProfile.billTo = address
-    request.paymentProfile.defaultPaymentProfile = str(default).lower()
+    request.paymentProfile = contract
+    request.paymentProfile.defaultPaymentProfile = int(default)
     return request, apicontrollers.createCustomerPaymentProfileController
 
 
@@ -66,7 +65,7 @@ def get_customer_payment_profile(
     request = apicontractsv1.getCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
     request.customerPaymentProfileId = str(payment_profile_id)
-    request.includeIssuerInfo = str(include_issuer_info).lower()
+    request.includeIssuerInfo = int(include_issuer_info)
     return request, apicontrollers.getCustomerPaymentProfileController
 
 
@@ -97,9 +96,7 @@ def validate_customer_payment_profile(
 
 def update_customer_payment_profile(
     customer_profile_id: int,
-    payment_profile_id: int,
-    payment: apicontractsv1.paymentType,
-    address: apicontractsv1.customerAddressType,
+    contract: apicontractsv1.customerPaymentProfileExType,
     default: bool,
     validation: str = "liveMode",
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
@@ -108,12 +105,8 @@ def update_customer_payment_profile(
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: int
-    :param payment_profile_id: An Authorizenet customer payment profile id.
-    :type payment_profile_id: int
-    :param payment: An Authorizenet payment element.
-    :type payment: ~authorizenet.apicontractsv1.paymentType
-    :param address: An Authorizenet address element.
-    :type address: ~authorizenet.apicontractsv1.customerAddressType
+    :param contract: A customer payment profile ex element.
+    :type contract: ~authorizenet.apicontractsv1.customerPaymentProfileExType
     :param default: Whether to set the payment profile as default.
     :type default: bool
     :param validation: Validation mode. Default is :py:obj:`"liveMode"`.
@@ -123,14 +116,17 @@ def update_customer_payment_profile(
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
+    if not contract.payment:
+        raise ValueError("'payment' attribute is required in contract")
+    if not contract.billTo:
+        raise ValueError("'billTo' attribute is required in contract")
+    if not contract.customerPaymentProfileId:
+        raise ValueError("'customerPaymentProfileId' is required in contract")
     request = apicontractsv1.updateCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
     request.validationMode = validation
-    request.paymentProfile = apicontractsv1.customerPaymentProfileExType()
-    request.paymentProfile.customerPaymentProfileId = str(payment_profile_id)
-    request.paymentProfile.payment = payment
-    request.paymentProfile.billTo = address
-    request.paymentProfile.defaultPaymentProfile = str(default).lower()
+    request.paymentProfile = contract
+    request.paymentProfile.defaultPaymentProfile = int(default)
     return request, apicontrollers.updateCustomerPaymentProfileController
 
 

{python_terminusgps-51.0.0 → python_terminusgps-52.0.0}/terminusgps/authorizenet/api/subscriptions.py

@@ -12,19 +12,19 @@ __all__ = [
 
 
 def create_subscription(
-    subscription: apicontractsv1.ARBSubscriptionType,
+    contract: apicontractsv1.ARBSubscriptionType,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `ARBCreateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-create-a-subscription>`_.
 
-    :param subscription: An Authorizenet ARBSubscriptionType element.
-    :type subscription: ~authorizenet.apicontractsv1.ARBSubscriptionType
+    :param contract: An Authorizenet ARBSubscriptionType element.
+    :type contract: ~authorizenet.apicontractsv1.ARBSubscriptionType
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.ARBCreateSubscriptionRequest()
-    request.subscription = subscription
+    request.subscription = contract
     return request, apicontrollers.ARBCreateSubscriptionController
 
 
@@ -66,22 +66,22 @@ def get_subscription_status(
 
 
 def update_subscription(
-    subscription_id: int, subscription: apicontractsv1.ARBSubscriptionType
+    subscription_id: int, contract: apicontractsv1.ARBSubscriptionType
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `ARBUpdateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-update-a-subscription>`_.
 
     :param subscription_id: An Authorizenet subscription id.
     :type subscription_id: int
-    :param subscription: An Authorizenet ARBSubscriptionType element.
-    :type subscription: ~authorizenet.apicontractsv1.ARBSubscriptionType
+    :param contract: An Authorizenet ARBSubscriptionType element.
+    :type contract: ~authorizenet.apicontractsv1.ARBSubscriptionType
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.ARBUpdateSubscriptionRequest()
     request.subscriptionId = str(subscription_id)
-    request.subscription = subscription
+    request.subscription = contract
     return request, apicontrollers.ARBUpdateSubscriptionController
 
 

python_terminusgps-52.0.0/terminusgps/mixins.py

@@ -0,0 +1,28 @@
+from django.views.generic.base import TemplateResponseMixin
+
+
+class HtmxTemplateResponseMixin(TemplateResponseMixin):
+    """
+    Renders a partial HTML template depending on HTTP headers.
+
+    `htmx documentation <https://htmx.org/docs/>`_
+
+    """
+
+    partial_name: str = "#main"
+    """
+    A partial template rendered by htmx.
+
+    :type: str
+    :value: ``"#main"``
+
+    """
+
+    def get_template_names(self) -> list[str]:
+        hx_request: bool = bool(self.request.headers.get("HX-Request"))
+        hx_boosted: bool = bool(self.request.headers.get("HX-Boosted"))
+
+        template_names: list[str] = super().get_template_names()
+        if hx_request and not hx_boosted:
+            template_names.insert(0, self.template_name + self.partial_name)
+        return template_names