django-ctct 0.0.1.dev5__tar.gz → 0.0.1.dev6__tar.gz

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-ctct
-Version: 0.0.1.dev5
+Version: 0.0.1.dev6
 Summary: A Django interface for the Constant Contact API
 License: MIT
 License-File: LICENSE
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: django (>=3.2.0,<6.0.0)
+Requires-Dist: django (>=4.2)
 Requires-Dist: mypy (>=1.19.0,<2.0.0)
 Requires-Dist: pyjwt[crypto] (>=2.10.1,<3.0.0)
 Requires-Dist: ratelimit (>=2.2.1,<3.0.0)
@@ -123,7 +123,7 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
 > ./manage.py migrate
 ```
 
-4) **Create Authenticatin Token:**
+4) **Create Authentication Token:**
 
 After the app has been installed and configured, you must generate your first auth token:
 
@@ -173,9 +173,6 @@ To run tests:
 
 Once version 0.0.1 is released on PyPI, we hope to implement the following new features (in no particular order):
 
- * Support for API syncing using signals (`post_save`, `pre_delete`, `m2m_changed`, etc).
- This will be controlled by the `CTCT_SYNC_SIGNALS` setting.
- **Update** This probably won't work as desired since the primary object will be saved before related objects are.
  * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
  * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
   

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/README.md

@@ -99,7 +99,7 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
 > ./manage.py migrate
 ```
 
-4) **Create Authenticatin Token:**
+4) **Create Authentication Token:**
 
 After the app has been installed and configured, you must generate your first auth token:
 
@@ -149,9 +149,6 @@ To run tests:
 
 Once version 0.0.1 is released on PyPI, we hope to implement the following new features (in no particular order):
 
- * Support for API syncing using signals (`post_save`, `pre_delete`, `m2m_changed`, etc).
- This will be controlled by the `CTCT_SYNC_SIGNALS` setting.
- **Update** This probably won't work as desired since the primary object will be saved before related objects are.
  * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
  * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
   

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/django_ctct/admin.py

@@ -1,12 +1,11 @@
 import functools
-from typing import TypeVar, ParamSpec, Generic, Optional, Callable, Iterable
+from typing import TypeVar, ParamSpec, Generic, Callable, Iterable
 from requests.exceptions import HTTPError
 
 from django import forms
 from django.conf import settings
 from django.contrib import admin, messages
 from django.contrib.auth import get_user_model
-from django.db.models import signals
 from django.db.models import Model, QuerySet, When, Case, F, FloatField
 from django.db.models.functions import Cast
 from django.forms import ModelForm, BaseFormSet
@@ -24,7 +23,6 @@ from django_ctct.models import (
   EmailCampaign, CampaignActivity, CampaignSummary,
 )
 from django_ctct.signals import remote_save, remote_delete
-from django_ctct.vendor import mute_signals
 
 
 P = ParamSpec('P')
@@ -81,7 +79,7 @@ class ViewModelAdmin(admin.ModelAdmin[Model]):
   def has_add_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> bool:
     """Prevent creation in the Django admin."""
     return False
@@ -89,7 +87,7 @@ class ViewModelAdmin(admin.ModelAdmin[Model]):
   def has_change_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> bool:
     """Prevent updates in the Django admin."""
     return False
@@ -97,7 +95,7 @@ class ViewModelAdmin(admin.ModelAdmin[Model]):
   def get_readonly_fields(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> tuple[str, ...]:
     """Prevent updates in the Django admin."""
     if obj is not None:
@@ -113,7 +111,7 @@ class ViewModelAdmin(admin.ModelAdmin[Model]):
   def has_delete_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> bool:
     """Allow superusers to delete objects."""
     return request.user.is_superuser
@@ -124,17 +122,13 @@ class RemoteModelAdmin(
 ):
   """Facilitate remote saving and deleting."""
 
-  # ChangeView
-  @property
-  def remote_sync(self) -> bool:
-    sync_admin = getattr(settings, 'CTCT_SYNC_ADMIN', False)
-    sync_signals = getattr(settings, 'CTCT_SYNC_SIGNALS', False)
-    return sync_admin and not sync_signals
+  sync_admin: bool = getattr(settings, 'CTCT_SYNC_ADMIN', False)
 
+  # ChangeView
   @catch_api_errors
   def delete_model(self, request: HttpRequest, obj: Model) -> None:
     obj.delete()
-    if self.remote_sync:
+    if self.sync_admin:
       remote_delete(sender=self.model, instance=obj)
 
   @catch_api_errors
@@ -143,10 +137,9 @@ class RemoteModelAdmin(
     request: HttpRequest,
     queryset: QuerySet[E],
   ) -> None:
-    if self.remote_sync:
+    if self.sync_admin:
       queryset.model.remote.bulk_delete(queryset)
-    with mute_signals(signals.pre_delete):
-      queryset.delete()
+    queryset.delete()
 
   @catch_api_errors
   def save_related(
@@ -164,9 +157,8 @@ class RemoteModelAdmin(
     for saving objects remotely.
 
     """
-    with mute_signals(signals.m2m_changed):
-      # ManyToMany information is sent to CTCT in PUT call
-      form.save_m2m()
+    # ManyToMany information is sent to CTCT in PUT call
+    form.save_m2m()
     for formset in formsets:
       self.save_formset(request, form, formset, change=change)
     self.save_remotely(request, form, formsets, change)
@@ -179,7 +171,7 @@ class RemoteModelAdmin(
     formsets: list[BaseFormSet[ModelForm[Model]]],
     change: bool,
   ) -> None:
-    if self.remote_sync:
+    if self.sync_admin:
       # Remote save the primary object after related objects have been saved
       remote_save(
         sender=self.model,
@@ -285,7 +277,7 @@ class ContactNoteInline(admin.TabularInline[ContactNote, Contact]):
   def has_change_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Contact] = None,  # type: ignore[override]
+    obj: Contact | None = None,  # type: ignore[override]
   ) -> bool:
     return False
 
@@ -370,7 +362,7 @@ class ContactAdmin(RemoteModelAdmin[Contact]):
   def get_readonly_fields(
     self,
     request: HttpRequest,
-    obj: Optional[Contact] = None,
+    obj: Contact | None = None,
   ) -> list[str]:
     readonly_fields = list(Contact.API_READONLY_FIELDS)
     if obj and obj.opt_out_source and not request.user.is_superuser:
@@ -401,9 +393,8 @@ class ContactAdmin(RemoteModelAdmin[Contact]):
         instance.author = request.user
       instance.save()
 
-    with mute_signals(signals.m2m_changed):
-      # ManyToMany information is sent to CTCT in PUT call
-      formset.save_m2m()
+    # ManyToMany information is sent to CTCT in PUT call
+    formset.save_m2m()
 
 
 class ContactNoteAuthorFilter(admin.SimpleListFilter):
@@ -416,7 +407,7 @@ class ContactNoteAuthorFilter(admin.SimpleListFilter):
     self,
     request: HttpRequest,
     model_admin: admin.ModelAdmin[Model],
-  ) -> Optional[Iterable[tuple[str, str]]]:
+  ) -> Iterable[tuple[str, str]] | None:
     authors = get_user_model().objects.exclude(notes__isnull=True)
     return [(str(obj.id), str(obj)) for obj in authors]
 
@@ -473,7 +464,7 @@ class ContactNoteAdmin(RemoteSyncMixin, ViewModelAdmin):
   def has_delete_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> bool:
     """Allow superusers to delete Notes."""
     return request.user.is_superuser
@@ -516,7 +507,7 @@ class CampaignActivityInline(
   def get_readonly_fields(
     self,
     request: HttpRequest,
-    obj: Optional[CampaignActivity] = None,
+    obj: CampaignActivity | None = None,
   ) -> list[str]:
     readonly_fields = list(CampaignActivity.API_READONLY_FIELDS)
     if obj and obj.current_status == 'DONE':
@@ -559,7 +550,7 @@ class EmailCampaignAdmin(RemoteModelAdmin[EmailCampaign]):
   def get_readonly_fields(
     self,
     request: HttpRequest,
-    obj: Optional[EmailCampaign] = None,
+    obj: EmailCampaign | None = None,
   ) -> list[str]:
     readonly_fields = list(EmailCampaign.API_READONLY_FIELDS)
     if obj and obj.current_status == 'DONE':
@@ -574,16 +565,16 @@ class EmailCampaignAdmin(RemoteModelAdmin[EmailCampaign]):
     formsets: list[BaseFormSet[ModelForm[Model]]],
     change: bool,
   ) -> None:
-    if self.remote_sync:
+    if self.sync_admin:
 
       campaign = form.instance
       activity = formsets[0][0].instance
 
       # Handle remote saving the EmailCampaign
+      # NOTE: The only EmailCampaign field that can be updated is 'name'
       campaign_created = not change
       campaign_updated = change and ('name' in form.changed_data)
       if campaign_created or campaign_updated:
-        # The only EmailCampaign field that can be updated is 'name'
         remote_save(
           sender=self.model,
           instance=campaign,

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/django_ctct/apps.py

@@ -1,5 +1,4 @@
 from django.apps import AppConfig
-from django.db.models.signals import post_save, m2m_changed, pre_delete
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.translation import gettext_lazy as _
@@ -24,12 +23,3 @@ class CTCTConfig(AppConfig):
           f"[django-ctct] {value} must be defined in settings.py."
         )
         raise ImproperlyConfigured(message)
-
-    # Hook up the signals
-    from django_ctct.signals import (
-      remote_save, remote_delete, remote_update_m2m
-    )
-    if getattr(settings, 'CTCT_SYNC_SIGNALS', False):
-      post_save.connect(remote_save)
-      pre_delete.connect(remote_delete)
-      m2m_changed.connect(remote_update_m2m)

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/django_ctct/management/commands/import_ctct.py

@@ -1,6 +1,6 @@
 from argparse import ArgumentParser
 from collections import defaultdict
-from typing import Type, TypeVar, Optional, Any, Collection, Literal, cast
+from typing import Type, TypeVar, Any, Collection, Literal, cast
 from uuid import UUID
 
 from tqdm import tqdm
@@ -70,9 +70,9 @@ class Command(BaseCommand):
     model: Type[M],
     objs: list[M],
     update_conflicts: bool = True,
-    unique_fields: Optional[Collection[str]] = ['api_id'],
-    update_fields: Optional[Collection[str]] = None,
-    silent: Optional[bool] = None,
+    unique_fields: Collection[str] | None = ['api_id'],
+    update_fields: Collection[str] | None = None,
+    silent: bool | None = None,
   ) -> list[Model]:
     """Perform upsert using `bulk_create()`."""
 
@@ -101,7 +101,7 @@ class Command(BaseCommand):
       ]
 
     # Remove possible duplicates (CTCT API can't be trusted)
-    id_field: Optional[str] = None
+    id_field: str | None = None
     if model is CampaignSummary:
       id_field = 'campaign_id'
     elif issubclass(model, CTCTModel):
@@ -131,7 +131,7 @@ class Command(BaseCommand):
           setattr(o, 'pk', id_to_pk[str(o.api_id)])
 
     # Inform the user
-    if not silent:
+    if not silent:  # pragma: no cover
       message = self.style.SUCCESS(
         f'{verb} {len(objs):,} {model.__name__} instances.'
       )
@@ -173,7 +173,6 @@ class Command(BaseCommand):
       # CampaignActivities do not have a bulk API endpoint
       return self.import_campaign_activities()
 
-    model.remote.connect()
     try:
       # Split apart so we can save objs to db and get pks
       list_of_tuples = model.remote.all()
@@ -207,7 +206,6 @@ class Command(BaseCommand):
     """CampaignActivities must be imported one at a time."""
 
     # First, make sure all CampaignActivity API id's are stored locally
-    EmailCampaign.remote.connect()
     for campaign in EmailCampaign.objects.exclude(api_id__isnull=True):
       # Fetch from API
       assert isinstance(campaign.api_id, UUID)
@@ -226,8 +224,6 @@ class Command(BaseCommand):
                 obj.save()
 
     # Then, fetch CampaignActivity details
-    CampaignActivity.remote.connect()
-
     activities = CampaignActivity.objects.filter(
       role='primary_email',
       api_id__isnull=False,
@@ -309,6 +305,6 @@ class Command(BaseCommand):
 
       if self.noinput or (input(question).lower()[0] == 'y'):
         self.import_model(model)
-      else:
+      else:  # pragma: no cover
         message = _(f'Skipping {model.__name__}')
         self.stdout.write(self.style.NOTICE(message))

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/django_ctct/managers.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import datetime as dt
 from typing import (
   TYPE_CHECKING, TypeVar, ClassVar,
-  Iterable, Literal, Optional, NoReturn, Union, cast,
+  Iterable, Literal, NoReturn, Union, cast,
 )
 from urllib.parse import urlencode
 from uuid import UUID
@@ -17,7 +17,6 @@ from requests.models import Response
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.db import models
-from django.db.models import signals
 from django.db.models.manager import Manager
 from django.db.models.query import QuerySet
 from django.http import HttpRequest, Http404
@@ -26,10 +25,9 @@ from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
 
 from django_ctct.utils import get_related_fields
-from django_ctct.vendor import mute_signals
 
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
   from django_ctct.models import (
     JsonDict, RelatedObjects,
     EndpointMixin, SerialModel, CTCTModel, CTCTEndpointModel,
@@ -49,14 +47,17 @@ class ConnectionManagerMixin(Manager[T]):
   API_LIMIT_CALLS: int = 4   # four calls
   API_LIMIT_PERIOD: int = 1  # per second
 
+  session: requests.Session
+
   def connect(self) -> None:
-    from django_ctct.models import Token
+    if not hasattr(self, 'session'):
+      from django_ctct.models import Token
 
-    token = Token.remote.get()
-    self.session = requests.Session()
-    self.session.headers.update({
-      'Authorization': f"{token.token_type} {token.access_token}"
-    })
+      token = Token.remote.get()
+      self.session = requests.Session()
+      self.session.headers.update({
+        'Authorization': f"{token.token_type} {token.access_token}"
+      })
 
   @sleep_and_retry
   @limits(calls=API_LIMIT_CALLS, period=API_LIMIT_PERIOD)
@@ -64,11 +65,15 @@ class ConnectionManagerMixin(Manager[T]):
     """Honor the API's rate limit."""
     pass
 
+  def _pre_api_call(self) -> None:
+    self.connect()
+    self.check_api_limit()
+
   def get_url(
     self,
-    api_id: Optional[str | UUID] = None,
-    endpoint: Optional[str] = None,
-    endpoint_suffix: Optional[str] = None,
+    api_id: str | UUID | None = None,
+    endpoint: str | None = None,
+    endpoint_suffix: str | None = None,
   ) -> str:
     endpoint = endpoint or self.model.API_ENDPOINT
     if not endpoint.startswith(self.model.API_VERSION):
@@ -125,8 +130,9 @@ class TokenRemoteManager(ConnectionManagerMixin['Token'], Manager['Token']):
     return url
 
   def connect(self) -> None:
-    self.session = requests.Session()
-    self.session.auth = (settings.CTCT_PUBLIC_KEY, settings.CTCT_SECRET_KEY)
+    if not hasattr(self, 'session'):
+      self.session = requests.Session()
+      self.session.auth = (settings.CTCT_PUBLIC_KEY, settings.CTCT_SECRET_KEY)
 
   def create(self, auth_code: str) -> 'Token':  # type: ignore[override]
     """Creates the initial Token using an `auth_code` from CTCT.
@@ -138,6 +144,7 @@ class TokenRemoteManager(ConnectionManagerMixin['Token'], Manager['Token']):
 
     """
 
+    self.connect()
     response = self.session.post(
       url=self.get_url(),
       data={
@@ -164,7 +171,6 @@ class TokenRemoteManager(ConnectionManagerMixin['Token'], Manager['Token']):
     try:
       token.decode()
     except ExpiredSignatureError:
-      self.connect()
       token = self.update(token)
 
     return token
@@ -172,6 +178,7 @@ class TokenRemoteManager(ConnectionManagerMixin['Token'], Manager['Token']):
   def update(self, token: 'Token') -> 'Token':  # type: ignore[override]
     """Obtain a new Token from CTCT using the refresh code."""
 
+    self.connect()
     response = self.session.post(
       url=self.get_url(),
       data={
@@ -264,7 +271,7 @@ class Serializer(Manager[S]):
   def deserialize_related_obj_fields(
     self,
     data: JsonDict,
-    parent_pk: Optional[int] = None
+    parent_pk: int | None = None
   ) -> JsonDict:
     """Deserialize ForeignKeys and OneToOneFields.
 
@@ -292,7 +299,7 @@ class Serializer(Manager[S]):
   def deserialize_related_objs_fields(
     self,
     data: JsonDict,
-    parent_pk: Optional[int] = None,
+    parent_pk: int | None = None,
   ) -> tuple[JsonDict, list[RelatedObjects]]:
     """Deserialize ManyToManyFields and ReverseForeignKeys."""
 
@@ -346,7 +353,7 @@ class Serializer(Manager[S]):
   def deserialize(
     self,
     data: JsonDict,
-    pk: Optional[int] = None,
+    pk: int | None = None,
   ) -> tuple[S, list[RelatedObjects]]:
     """Convert from API response body to Django object."""
 
@@ -411,10 +418,10 @@ class RemoteManager(
 
     """
 
-    if not (pk := obj.pk):
+    if not obj.pk:
       raise ValueError('Must create object locally first.')
 
-    self.check_api_limit()
+    self._pre_api_call()
     response = self.session.post(
       url=self.get_url(),
       json=self.serialize(obj),
@@ -423,12 +430,10 @@ class RemoteManager(
 
     # NOTE: We don't need to do anything with `related_objs` since they were
     #       set locally before the API request.
-    obj, _ = self.deserialize(data, pk=pk)
+    obj, _ = self.deserialize(data, pk=obj.pk)
 
-    # TODO: GH #11?
     # Overwrite local obj with CTCT's response
-    with mute_signals(signals.post_save):
-      obj.save()
+    obj.save()
 
     return obj
 
@@ -445,7 +450,7 @@ class RemoteManager(
 
     """
 
-    self.check_api_limit()
+    self._pre_api_call()
 
     response = self.session.get(
       url=self.get_url(api_id),
@@ -462,7 +467,7 @@ class RemoteManager(
 
   def all(  # type: ignore[override]
     self,
-    endpoint: Optional[str] = None,
+    endpoint: str | None = None,
   ) -> list[tuple[E, list[RelatedObjects]]]:
     """Gets all existing objects from the remote server.
 
@@ -476,7 +481,7 @@ class RemoteManager(
 
     paginated = True
     while paginated:
-      self.check_api_limit()
+      self._pre_api_call()
 
       response = self.session.get(
         url=self.get_url(endpoint=endpoint),
@@ -507,12 +512,12 @@ class RemoteManager(
 
     """
 
-    if not (pk := obj.pk):
+    if obj.pk is None:
       raise ValueError('Must create object locally first.')
     elif obj.api_id is None:
       raise ValueError('Must create object remotely first.')
 
-    self.check_api_limit()
+    self._pre_api_call()
     response = self.session.put(
       url=self.get_url(obj.api_id),
       json=self.serialize(obj),
@@ -521,12 +526,10 @@ class RemoteManager(
 
     # NOTE: We don't need to do anything with `related_objs` since they were
     #       set locally before the API request.
-    obj, _ = self.deserialize(data, pk=pk)
+    obj, _ = self.deserialize(data, pk=obj.pk)
 
-    # TODO: GH #11?
     # Overwrite local obj with CTCT's response
-    with mute_signals(signals.post_save):
-      obj.save()
+    obj.save()
 
     return obj
 
@@ -534,7 +537,7 @@ class RemoteManager(
   def delete(
     self,
     obj: E,
-    endpoint_suffix: Optional[str] = None,
+    endpoint_suffix: str | None = None,
   ) -> None:
     """Deletes existing Django object(s) on the remote server.
 
@@ -549,7 +552,7 @@ class RemoteManager(
     """
 
     url = self.get_url(obj.api_id, endpoint_suffix=endpoint_suffix)
-    self.check_api_limit()
+    self._pre_api_call()
     response = self.session.delete(url)
 
     if response.status_code != 404:
@@ -579,7 +582,7 @@ class RemoteManager(
 
     # Remote delete in batches
     for i in range(0, len(api_ids), self.model.API_ENDPOINT_BULK_LIMIT):
-      self.check_api_limit()
+      self._pre_api_call()
       response = self.session.post(
         url=self.get_url(endpoint=self.model.API_ENDPOINT_BULK_DELETE),
         json={api_id_label: api_ids[i:i + self.model.API_ENDPOINT_BULK_LIMIT]},
@@ -593,9 +596,9 @@ class ContactListRemoteManager(RemoteManager['ContactList']):
   # @task(queue_name='ctct')
   def add_list_memberships(
     self,
-    contact_list: Optional[ContactList] = None,
-    contact_lists: Optional[QuerySet[ContactList]] = None,
-    contacts: Optional[QuerySet[Contact]] = None,
+    contact_list: ContactList | None = None,
+    contact_lists: QuerySet[ContactList] | None = None,
+    contacts: QuerySet[Contact] | None = None,
   ) -> None:
     """Adds multiple Contacts to (multiple) ContactLists."""
 
@@ -627,7 +630,7 @@ class ContactListRemoteManager(RemoteManager['ContactList']):
       raise ValueError(message)
 
     for i in range(0, len(contact_ids), step_size):
-      self.check_api_limit()
+      self._pre_api_call()
       response = self.session.post(
         url=self.get_url(endpoint='/activities/add_list_memberships'),
         json={
@@ -675,14 +678,14 @@ class ContactRemoteManager(RemoteManager['Contact']):
 
     """
 
-    if not obj.pk:
+    if obj.pk is None:
       raise ValueError('Must create object locally first.')
 
     # This endpoint expects a slightly different serialization
     data = self.serialize(obj)
     data['email_address'] = data.pop('email_address')['address']
 
-    self.check_api_limit()
+    self._pre_api_call()
     response = self.session.post(
       url=self.get_url(endpoint_suffix='/sign_up_form'),
       json=data,
@@ -695,9 +698,8 @@ class ContactRemoteManager(RemoteManager['Contact']):
       raise ValueError(f'Unexpected response data: {data}.')
 
     # Save the API id
-    with mute_signals(signals.post_save):
-      obj.api_id = api_id
-      obj.save(update_fields=['api_id'])
+    obj.api_id = api_id
+    obj.save(update_fields=['api_id'])
 
     return obj
 
@@ -732,7 +734,7 @@ class EmailCampaignRemoteManager(RemoteManager['EmailCampaign']):
     from django_ctct.models import CampaignActivity
 
     # Validate
-    if not (pk := obj.pk):
+    if obj.pk is None:
       raise ValueError('Must create object locally first.')
     try:
       activity = obj.campaign_activities.get(role='primary_email')
@@ -746,7 +748,7 @@ class EmailCampaignRemoteManager(RemoteManager['EmailCampaign']):
       activity = CampaignActivity()
 
     # Create EmailCampaign and CampaignActivity remotely
-    self.check_api_limit()
+    self._pre_api_call()
     response = self.session.post(
       url=self.get_url(),
       json={
@@ -758,7 +760,7 @@ class EmailCampaignRemoteManager(RemoteManager['EmailCampaign']):
     )
     data = self.raise_or_json(response)
 
-    obj, list_of_related_objs = self.deserialize(data, pk=pk)
+    obj, list_of_related_objs = self.deserialize(data, pk=obj.pk)
 
     # Set CTCT's assigned api_id on our local CampaignActivity instance
     for (model, related_objs) in list_of_related_objs:
@@ -771,13 +773,12 @@ class EmailCampaignRemoteManager(RemoteManager['EmailCampaign']):
             break
 
     # Overwrite local obj with CTCT's response
-    with mute_signals(signals.post_save):
-      obj.save()
-      if activity.pk is None:
-        activity.campaign = obj
-        activity.save()
-      else:
-        activity.save(update_fields=['api_id'])
+    obj.save()
+    if activity.pk is None:
+      activity.campaign = obj
+      activity.save()
+    else:
+      activity.save(update_fields=['api_id'])
 
     # Send preview and/or schedule the campaign
     if obj.send_preview or (obj.scheduled_datetime is not None):
@@ -797,12 +798,12 @@ class EmailCampaignRemoteManager(RemoteManager['EmailCampaign']):
     preview, the `primary_email` CampaignActivity must be updated remotely.
 
     """
-    if not (pk := obj.pk):
+    if obj.pk is None:
       raise ValueError('Must create object locally first.')
     elif obj.api_id is None:
       raise ValueError('Must create object remotely first.')
 
-    self.check_api_limit()
+    self._pre_api_call()
     response = self.session.patch(
       url=self.get_url(obj.api_id),
       json=self.serialize(obj),
@@ -811,12 +812,10 @@ class EmailCampaignRemoteManager(RemoteManager['EmailCampaign']):
 
     # NOTE: We don't need to do anything with `related_objs` since they were
     #       set locally before the API request.
-    obj, _ = self.deserialize(data, pk=pk)
+    obj, _ = self.deserialize(data, pk=obj.pk)
 
-    # TODO: GH #11?
     # Overwrite local obj with CTCT's response
-    with mute_signals(signals.post_save):
-      obj.save()
+    obj.save()
 
     return obj
 
@@ -869,8 +868,8 @@ class CampaignActivityRemoteManager(RemoteManager['CampaignActivity']):
   def send_preview(
     self,
     obj: 'CampaignActivity',
-    recipients: Optional[list[str]] = None,
-    message: Optional[str] = None,
+    recipients: list[str] | None = None,
+    message: str | None = None,
   ) -> None:
     """Sends a preview of the EmailCampaign."""
 
@@ -881,7 +880,7 @@ class CampaignActivityRemoteManager(RemoteManager['CampaignActivity']):
     if message is None:
       message = getattr(settings, 'CTCT_PREVIEW_MESSAGE', '')
 
-    self.check_api_limit()
+    self._pre_api_call()
     response = self.session.post(
       url=self.get_url(obj.api_id, endpoint_suffix='/tests'),
       json={
@@ -922,7 +921,7 @@ class CampaignActivityRemoteManager(RemoteManager['CampaignActivity']):
       raise ValueError(message)
 
     # Schedule the CampaignActivity
-    self.check_api_limit()
+    self._pre_api_call()
     response = self.session.post(
       url=self.get_url(obj.api_id, endpoint_suffix='/schedules'),
       json={'scheduled_date': obj.campaign.scheduled_datetime.isoformat()},

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/django_ctct/migrations/0001_initial.py

@@ -1,9 +1,10 @@
-# Generated by Django 4.2.20 on 2025-12-03 18:31
+# Generated by Django 4.2.20 on 2025-12-05 13:58
 
 from django.conf import settings
 from django.db import migrations, models
 import django.db.models.deletion
 import django.utils.timezone
+import django_ctct.models
 
 
 class Migration(migrations.Migration):
@@ -205,9 +206,9 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('api_id', models.UUIDField(default=None, null=True, unique=True, verbose_name='API ID')),
-                ('from_name', models.CharField(default='Django CTCT', max_length=100, verbose_name='From Name')),
-                ('from_email', models.EmailField(default='django@ctct.com', max_length=80, verbose_name='From Email')),
-                ('reply_to_email', models.EmailField(default='django@ctct.com', max_length=80, verbose_name='Reply-to Email')),
+                ('from_name', models.CharField(default=django_ctct.models.campaign_activity__from_name__default, max_length=100, verbose_name='From Name')),
+                ('from_email', models.EmailField(default=django_ctct.models.campaign_activity__from_email__default, max_length=80, verbose_name='From Email')),
+                ('reply_to_email', models.EmailField(default=django_ctct.models.campaign_activity__reply_to_email__default, max_length=80, verbose_name='Reply-to Email')),
                 ('subject', models.CharField(help_text='The text to display in the subject line that describes the email campaign activity', max_length=200, verbose_name='Subject')),
                 ('preheader', models.CharField(help_text='Contacts will view your preheader as a short summary that follows the subject line in their email client', max_length=250, verbose_name='Preheader')),
                 ('html_content', models.CharField(help_text='The HTML content for the email campaign activity', max_length=150000, verbose_name='HTML Content')),

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/django_ctct/models.py

@@ -2,7 +2,7 @@ import datetime as dt
 import re
 from typing import (
   Type, TypeAlias, ClassVar, TypeGuard,
-  Optional, Any, Literal,
+  Any, Literal,
 )
 from typing_extensions import Self
 
@@ -73,8 +73,8 @@ class EndpointMixin(Model):
   API_VERSION: str = '/v3'
   API_ENDPOINT: str
   API_GET_QUERIES: dict[str, str] = {}
-  API_ENDPOINT_BULK_DELETE: Optional[str] = None
-  API_ENDPOINT_BULK_LIMIT: Optional[int] = None
+  API_ENDPOINT_BULK_DELETE: str | None = None
+  API_ENDPOINT_BULK_LIMIT: int | None = None
 
   class Meta:
     abstract = True
@@ -210,12 +210,12 @@ class CTCTModel(SerialModel):
     cls,
     field_name: str,
     data: JsonDict,
-    default: Optional[str] = None,
-  ) -> Optional[str]:
+    default: str | None = None,
+  ) -> str | None:
     if default is None:
       field = cls._meta.get_field(field_name)
       assert hasattr(field, 'default')
-      if field.default is NOT_PROVIDED:
+      if field.default is NOT_PROVIDED:  # pragma: no cover
         message = _(
           f"Must provide a default value for {cls.__name__}.{field_name}."
         )
@@ -350,7 +350,7 @@ class ContactCustomField(SerialModel):
   def __str__(self) -> str:
     try:
       s = f'[{self.custom_field.label}] {self.value}'
-    except CustomField.DoesNotExist:
+    except CustomField.DoesNotExist:  # pragma: no cover
       s = super().__str__()
     return s
 
@@ -617,7 +617,7 @@ class Contact(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
     return s
 
   @classmethod
-  def clean_remote_opt_out_date(cls, data: JsonDict) -> Optional[dt.datetime]:  # noqa: E501
+  def clean_remote_opt_out_date(cls, data: JsonDict) -> dt.datetime | None:
     assert isinstance(data['email_address'], dict)
     if opt_out_date := data['email_address'].get('opt_out_date', None):
       assert isinstance(opt_out_date, str)
@@ -764,10 +764,7 @@ class ContactPhoneNumber(CreatedAtMixin, UpdatedAtMixin, CTCTModel):
     numbers = r'\d+'
     s = data.get('phone_number', '')
     assert isinstance(s, str)
-    if s := ''.join(re.findall(numbers, s)):
-      pass
-    else:
-      s = cls.MISSING_NUMBER
+    s = ''.join(re.findall(numbers, s)) or cls.MISSING_NUMBER
     return s
 
 
@@ -957,7 +954,7 @@ class EmailCampaign(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
     return self.name
 
   @classmethod
-  def clean_remote_scheduled_datetime(cls, data: JsonDict) -> Optional[dt.datetime]:  # noqa: E501
+  def clean_remote_scheduled_datetime(cls, data: JsonDict) -> dt.datetime | None:  # noqa: E501
     if last_sent_date := data.get('last_sent_date', None):
       # Not sure why this ts_format is different
       assert isinstance(last_sent_date, str)
@@ -967,6 +964,18 @@ class EmailCampaign(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
       return last_sent_date
 
 
+def campaign_activity__from_name__default() -> str:
+  return settings.CTCT_FROM_NAME
+
+
+def campaign_activity__from_email__default() -> str:
+  return settings.CTCT_FROM_EMAIL
+
+
+def campaign_activity__reply_to_email__default() -> str:
+  return getattr(settings, 'CTCT_REPLY_TO_EMAIL', settings.CTCT_FROM_EMAIL)
+
+
 class CampaignActivity(CTCTEndpointModel):
   """Django implementation of a CTCT CampaignActivity.
 
@@ -1045,17 +1054,17 @@ class CampaignActivity(CTCTEndpointModel):
   # API editable fields
   from_name = models.CharField(
     max_length=API_MAX_LENGTH['from_name'],
-    default=settings.CTCT_FROM_NAME,
+    default=campaign_activity__from_name__default,
     verbose_name=_('From Name'),
   )
   from_email = models.EmailField(
     max_length=API_MAX_LENGTH['from_email'],
-    default=settings.CTCT_FROM_EMAIL,
+    default=campaign_activity__from_email__default,
     verbose_name=_('From Email'),
   )
   reply_to_email = models.EmailField(
     max_length=API_MAX_LENGTH['reply_to_email'],
-    default=getattr(settings, 'CTCT_REPLY_TO_EMAIL', settings.CTCT_FROM_EMAIL),
+    default=campaign_activity__reply_to_email__default,
     verbose_name=_('Reply-to Email'),
   )
   subject = models.CharField(
@@ -1103,12 +1112,12 @@ class CampaignActivity(CTCTEndpointModel):
   # but imports could have other values
   format_type = models.IntegerField(
     choices=FORMAT_TYPES,
-    default=5,  # CustomCode API v3
+    default=FORMAT_TYPES[4][0],  # evals to 5
     verbose_name=_('Format Type'),
   )
 
   @property
-  def physical_address_in_footer(self) -> Optional[dict[str, str]]:
+  def physical_address_in_footer(self) -> dict[str, str] | None:
     """Returns the company address for email footers.
 
     Notes
@@ -1148,19 +1157,19 @@ class CampaignActivity(CTCTEndpointModel):
     return data
 
   @classmethod
-  def clean_remote_from_name(cls, data: JsonDict) -> Optional[str]:
+  def clean_remote_from_name(cls, data: JsonDict) -> str | None:
     return cls.clean_remote_string_with_default('from_name', data)
 
   @classmethod
-  def clean_remote_from_email(cls, data: JsonDict) -> Optional[str]:
+  def clean_remote_from_email(cls, data: JsonDict) -> str | None:
     return cls.clean_remote_string_with_default('from_email', data)
 
   @classmethod
-  def clean_remote_reply_to_email(cls, data: JsonDict) -> Optional[str]:
+  def clean_remote_reply_to_email(cls, data: JsonDict) -> str | None:
     return cls.clean_remote_string_with_default('reply_to_email', data)
 
   @classmethod
-  def clean_remote_subject(cls, data: JsonDict) -> Optional[str]:
+  def clean_remote_subject(cls, data: JsonDict) -> str | None:
     """Pass a `default` here so it won't appear in admin forms."""
     default = cls.MISSING_SUBJECT
     return cls.clean_remote_string_with_default('subject', data, default)

django_ctct-0.0.1.dev6/django_ctct/signals.py

@@ -0,0 +1,41 @@
+from typing import Any, Type
+
+from django.conf import settings
+from django.db.models import Model
+
+from django_ctct.models import CTCTEndpointModel
+
+
+def remote_save(sender: Type[Model], instance: Model, **kwargs: Any) -> None:
+  """Create or update the instance on CTCT servers."""
+
+  if (
+    issubclass(sender, CTCTEndpointModel) and
+    isinstance(instance, CTCTEndpointModel)
+  ):
+    if instance.api_id:
+      task = sender.remote.update
+    else:
+      task = sender.remote.create
+
+    enqueue = getattr(settings, 'CTCT_ENQUEUE_DEFAULT', False)
+    if getattr(instance, 'enqueue', enqueue) and hasattr(task, 'enqueue'):
+      task.enqueue(obj=instance)
+    else:
+      task(obj=instance)
+
+
+def remote_delete(sender: Type[Model], instance: Model, **kwargs: Any) -> None:
+  """Delete the instance from CTCT servers."""
+
+  if (
+    issubclass(sender, CTCTEndpointModel) and
+    isinstance(instance, CTCTEndpointModel)
+  ):
+    task = sender.remote.delete
+
+    enqueue = getattr(settings, 'CTCT_ENQUEUE_DEFAULT', False)
+    if getattr(instance, 'enqueue', enqueue) and hasattr(task, 'enqueue'):
+      task.enqueue(obj=instance)
+    else:
+      task(obj=instance)

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/django_ctct/utils.py

@@ -20,7 +20,9 @@ RelatedFields: TypeAlias = tuple[
 def to_dt(s: str, ts_format: str = '%Y-%m-%dT%H:%M:%SZ') -> dt.datetime:
   if '.' in s:
     # Remove milliseconds
-    s = s.split('.')[0] + 'Z'
+    s = s.split('.')[0]
+  if ts_format.endswith('Z') and not s.endswith('Z'):
+    s += 'Z'
   return timezone.make_aware(dt.datetime.strptime(s, ts_format))
 
 

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/django_ctct/views.py

@@ -9,7 +9,6 @@ def auth(request: HttpRequest) -> HttpResponse:
   """Facilitates OAuth2 authentication with CTCT."""
 
   if auth_code := request.GET.get('code'):
-    Token.remote.connect()
     try:
       Token.remote.create(auth_code)
     except Exception as e:

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-ctct"
-version = "0.0.1.dev5"
+version = "0.0.1.dev6"
 description = "A Django interface for the Constant Contact API"
 authors = [
     {name = "Geoffrey Eisenbarth",email = "geoffrey.eisenbarth@gmail.com"}
@@ -9,7 +9,7 @@ license = {text = "MIT"}
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-    "django (>=3.2.0,<6.0.0)",
+    "django (>=4.2)",
     "requests (>=2.32.3,<3.0.0)",
     "ratelimit (>=2.2.1,<3.0.0)",
     "tqdm (>=4.67.1,<5.0.0)",

django_ctct-0.0.1.dev5/django_ctct/signals.py

@@ -1,93 +0,0 @@
-from typing import Type, Literal, Any, cast
-
-from django.conf import settings
-from django.db.models import Model
-
-from django_ctct.models import (
-  CTCTEndpointModel, Contact, ContactList, CampaignActivity
-)
-
-
-def remote_save(sender: Type[Model], instance: Model, **kwargs: Any) -> None:
-  """Create or update the instance on CTCT servers."""
-
-  if (
-    issubclass(sender, CTCTEndpointModel) and
-    isinstance(instance, CTCTEndpointModel)
-  ):
-    sender.remote.connect()
-
-    if instance.api_id:
-      task = sender.remote.update
-    else:
-      task = sender.remote.create
-
-    enqueue = getattr(settings, 'CTCT_ENQUEUE_DEFAULT', False)
-    if getattr(instance, 'enqueue', enqueue) and hasattr(task, 'enqueue'):
-      task.enqueue(obj=instance)
-    else:
-      task(obj=instance)
-
-
-def remote_delete(sender: Type[Model], instance: Model, **kwargs: Any) -> None:
-  """Delete the instance from CTCT servers."""
-
-  if (
-    issubclass(sender, CTCTEndpointModel) and
-    isinstance(instance, CTCTEndpointModel)
-  ):
-    sender.remote.connect()
-
-    task = sender.remote.delete
-
-    enqueue = getattr(settings, 'CTCT_ENQUEUE_DEFAULT', False)
-    if getattr(instance, 'enqueue', enqueue) and hasattr(task, 'enqueue'):
-      task.enqueue(obj=instance)
-    else:
-      task(obj=instance)
-
-
-# TODO: GH #15
-def remote_update_m2m(
-  sender: Type[Model],
-  instance: Model,
-  action: Literal['pre_add', 'post_add', 'pre_remove', 'post_remove', 'pre_clear', 'post_clear'],  # noqa: E501
-  **kwargs: Any,
-) -> None:
-  """Updates a Contact's list membership on CTCT servers."""
-
-  senders = (
-    Contact.list_memberships.through,
-    ContactList.members.through,
-    CampaignActivity.contact_lists.through,
-    ContactList.campaign_activities.through,
-  )
-  actions = ['post_add', 'post_remove', 'post_clear']
-
-  if (sender in senders) and (action in actions):
-
-    if isinstance(instance, (Contact, CampaignActivity)):
-      # Just update the instance using PUT
-      task_name = 'update'
-      kwargs = {'obj': instance}
-    elif isinstance(instance, ContactList):
-      # Must use special methods defined on the remote manager
-      if sender is ContactList.members.through:
-        task_name = 'add_list_memberships'
-        kwargs = {
-          'contact_list': instance,
-          'contacts': Contact.objects.filter(pk__in=kwargs['pk_set']),
-        }
-      elif sender is ContactList.campaign_activities.through:
-        raise NotImplementedError
-
-    model = cast(Type[CTCTEndpointModel], instance._meta.model)
-    model.remote.connect()
-
-    task = getattr(model.remote, task_name)
-
-    enqueue = getattr(settings, 'CTCT_ENQUEUE_DEFAULT', False)
-    if getattr(instance, 'enqueue', enqueue) and hasattr(task, 'enqueue'):
-      task.enqueue(**kwargs)
-    else:
-      task(**kwargs)

django_ctct-0.0.1.dev5/django_ctct/vendor.py

@@ -1,108 +0,0 @@
-import functools
-import logging
-
-from django.dispatch import Signal
-
-logger = logging.getLogger('factory.generate')
-
-
-class mute_signals:
-    """Temporarily disables and then restores any django signals.
-
-    Args:
-        *signals (django.dispatch.dispatcher.Signal): any django signals
-
-    Examples:
-        with mute_signals(pre_init):
-            user = UserFactory.build()
-            ...
-
-        @mute_signals(pre_save, post_save)
-        class UserFactory(factory.Factory):
-            ...
-
-        @mute_signals(post_save)
-        def generate_users():
-            UserFactory.create_batch(10)
-
-    License:
-        Copyright (c) 2010 Mark Sandstrom
-        Copyright (c) 2011-2015 Raphaël Barrois
-        Copyright (c) The FactoryBoy project
-
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-
-        The above copyright notice and this permission notice shall be included in
-        all copies or substantial portions of the Software.
-
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-        THE SOFTWARE.
-    """
-
-    def __init__(self, *signals: Signal):
-        self.signals = signals
-        self.paused = {}
-
-    def __enter__(self):
-        for signal in self.signals:
-            logger.debug('mute_signals: Disabling signal handlers %r',
-                         signal.receivers)
-
-            # Note that we're using implementation details of
-            # django.signals, since arguments to signal.connect()
-            # are lost in signal.receivers
-            self.paused[signal] = signal.receivers
-            signal.receivers = []
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        for signal, receivers in self.paused.items():
-            logger.debug('mute_signals: Restoring signal handlers %r',
-                         receivers)
-
-            signal.receivers = receivers + signal.receivers
-            with signal.lock:
-                # Django uses some caching for its signals.
-                # Since we're bypassing signal.connect and signal.disconnect,
-                # we have to keep messing with django's internals.
-                signal.sender_receivers_cache.clear()
-        self.paused = {}
-
-    def copy(self):
-        return mute_signals(*self.signals)
-
-    def __call__(self, callable_obj):
-        if isinstance(callable_obj, base.FactoryMetaClass):
-            # Retrieve __func__, the *actual* callable object.
-            callable_obj._create = self.wrap_method(callable_obj._create.__func__)
-            callable_obj._generate = self.wrap_method(callable_obj._generate.__func__)
-            callable_obj._after_postgeneration = self.wrap_method(
-                callable_obj._after_postgeneration.__func__
-            )
-            return callable_obj
-
-        else:
-            @functools.wraps(callable_obj)
-            def wrapper(*args, **kwargs):
-                # A mute_signals() object is not reentrant; use a copy every time.
-                with self.copy():
-                    return callable_obj(*args, **kwargs)
-            return wrapper
-
-    def wrap_method(self, method):
-        @classmethod
-        @functools.wraps(method)
-        def wrapped_method(*args, **kwargs):
-            # A mute_signals() object is not reentrant; use a copy every time.
-            with self.copy():
-                return method(*args, **kwargs)
-        return wrapped_method