django-ctct 0.0.1.dev2__tar.gz → 0.0.1.dev3__tar.gz

{django_ctct-0.0.1.dev2 → django_ctct-0.0.1.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-ctct
-Version: 0.0.1.dev2
+Version: 0.0.1.dev3
 Summary: A Django interface for the Constant Contact API
 License: MIT
 Author: Geoffrey Eisenbarth

{django_ctct-0.0.1.dev2 → django_ctct-0.0.1.dev3}/django_ctct/admin.py

@@ -6,18 +6,20 @@ 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
+from django.db.models import Model, QuerySet, When, Case, F, FloatField
+from django.db.models.functions import Cast
 from django.forms import ModelForm
 from django.forms.models import BaseInlineFormSet
 from django.http import HttpRequest
+from django.urls import reverse
 from django.utils.html import format_html
 from django.utils.formats import date_format
-from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
 from django_ctct.models import (
-  Token, CTCTRemoteModel, ContactList, CustomField,
+  CTCTRemoteModel, ContactList, CustomField,
   Contact,
   ContactCustomField, ContactStreetAddress, ContactPhoneNumber, ContactNote,
   EmailCampaign, CampaignActivity, CampaignSummary,
@@ -79,38 +81,6 @@ class ViewModelAdmin(admin.ModelAdmin):
     return False
 
 
-class TokenAdmin(ViewModelAdmin):
-  """Admin functionality for CTCT Tokens."""
-
-  # ListView
-  list_display_links = None
-  list_display = (
-    'scope',
-    'created_at',
-    'expires_at',
-    'copy_access_token',
-    'copy_refresh_token',
-  )
-
-  def copy_access_token(self, obj: Token) -> str:
-    html = format_html(
-      '<button class="button" onclick="{function}">{copy_icon}</button>',
-      function=f"navigator.clipboard.writeText('{obj.access_token}')",
-      copy_icon=mark_safe('&#128203;'),
-    )
-    return html
-  copy_access_token.short_description = _('Access Token')
-
-  def copy_refresh_token(self, obj: Token) -> str:
-    html = format_html(
-      '<button class="button" onclick="{function}">{copy_icon}</button>',
-      function=f"navigator.clipboard.writeText('{obj.refresh_token}')",
-      copy_icon=mark_safe('&#128203;'),
-    )
-    return html
-  copy_refresh_token.short_description = _('Refresh Token')
-
-
 class RemoteModelAdmin(RemoteSyncMixin, admin.ModelAdmin):
   """Facilitate remote saving and deleting."""
 
@@ -213,6 +183,7 @@ class CustomFieldAdmin(RemoteModelAdmin):
     'label',
     'type',
     'created_at',
+    'updated_at',
     'is_synced',
   )
 
@@ -244,13 +215,11 @@ class ContactNoteInline(admin.TabularInline):
   """Inline for adding ContactNotes to a Contact."""
 
   model = ContactNote
-  exclude = ('api_id', )
+  fields = ('content', )
 
-  extra = 1
+  extra = 0
   max_num = Contact.remote.API_MAX_NOTES
 
-  readonly_fields = ('author', 'created_at')
-
   def has_change_permission(
     self,
     request: HttpRequest,
@@ -264,7 +233,7 @@ class ContactCustomFieldInline(admin.TabularInline):
   model = ContactCustomField
   excldue = ('api_id', )
 
-  extra = 1
+  extra = 0
 
 
 class ContactAdmin(RemoteModelAdmin):
@@ -368,6 +337,22 @@ class ContactAdmin(RemoteModelAdmin):
     formset.save_m2m()
 
 
+class ContactNoteAuthorFilter(admin.SimpleListFilter):
+  """Only display Users that have authored a ContactNote."""
+
+  title = _('Author')
+  parameter_name = 'author'
+
+  def lookups(self, request, model_admin):
+    authors = get_user_model().objects.exclude(notes__isnull=True)
+    return [(obj.id, str(obj)) for obj in authors]
+
+  def queryset(self, request, queryset):
+    if self.value():
+      queryset = queryset.filter(author_id=self.value())
+    return queryset
+
+
 class ContactNoteAdmin(RemoteSyncMixin, ViewModelAdmin):
   """Admin functionality for ContactNotes."""
 
@@ -384,17 +369,27 @@ class ContactNoteAdmin(RemoteSyncMixin, ViewModelAdmin):
 
   list_display_links = None
   list_display = (
-    'contact',
+    'contact_link',
     'content',
-    'created_at',
     'author',
+    'created_at',
     'is_synced',
   )
   list_filter = (
     'created_at',
-    'author',
+    ContactNoteAuthorFilter,
   )
 
+  def contact_link(self, obj: ContactNote) -> str:
+    url = reverse(
+      'admin:django_ctct_contact_change',
+      args=[obj.contact.pk],
+    )
+    html = format_html('<a href="{}">{}</a>', url, obj.contact)
+    return html
+  contact_link.short_description = _('Contact')
+  contact_link.admin_order_field = 'contact__email'
+
   def has_delete_permission(self, request: HttpRequest, obj=None):
     """Allow superusers to delete Notes."""
     return request.user.is_superuser
@@ -446,9 +441,10 @@ class EmailCampaignAdmin(RemoteModelAdmin):
   search_fields = ('name', )
   list_display = (
     'name',
-    'updated_at',
     'current_status',
     'scheduled_datetime',
+    'created_at',
+    'updated_at',
     'is_synced',
   )
 
@@ -543,19 +539,28 @@ class CampaignSummaryAdmin(ViewModelAdmin):
     'campaign',
     'open_rate',
     'sends',
+    'opens',
     'bounces',
     'clicks',
     'optouts',
     'abuse',
   )
 
+  def get_queryset(self, request):
+    qs = super().get_queryset(request)
+    qs = qs.annotate(
+      open_rate=Case(
+        When(sends=0, then=0.0),
+        default=Cast(
+          F('opens') * 1.0 / F('sends'),  # Avoid int division
+          output_field=FloatField(),
+        ),
+      ),
+    )
+    return qs
+
   def open_rate(self, obj: EmailCampaign) -> str:
-    if obj.current_status == 'DONE':
-      r = (obj.opens / obj.sends) if obj.sends else 0
-      s = f'{r:0.2%}'
-    else:
-      s = '-'
-    return s
+    return f'{obj.open_rate:0.0%}'
   open_rate.admin_order_field = 'open_rate'
   open_rate.short_description = _('Open Rate')
 
@@ -576,7 +581,6 @@ class CampaignSummaryAdmin(ViewModelAdmin):
 
 
 if getattr(settings, 'CTCT_USE_ADMIN', False):
-  admin.site.register(Token, TokenAdmin)
   admin.site.register(ContactList, ContactListAdmin)
   admin.site.register(CustomField, CustomFieldAdmin)
   admin.site.register(Contact, ContactAdmin)

{django_ctct-0.0.1.dev2 → django_ctct-0.0.1.dev3}/django_ctct/management/commands/import_ctct.py

@@ -1,9 +1,11 @@
 from argparse import ArgumentParser
+from collections import defaultdict
 from typing import Optional, Type
 
 from tqdm import tqdm
 
 import django
+from django.utils.translation import gettext_lazy as _
 from django.core.management.base import BaseCommand
 
 from django_ctct.models import (
@@ -55,14 +57,18 @@ class Command(BaseCommand):
     update_conflicts: bool = True,
     unique_fields: list[str] = ['api_id'],
     update_fields: Optional[list[str]] = None,
-    silent: bool = False,
+    silent: Optional[bool] = None,
   ) -> list[CTCTModel]:
 
     verb = 'Imported' if (update_fields is None) else 'Updated'
+    if silent is None:
+      silent = self.noinput
 
     # Perform upsert using `bulk_create()`
     if model._meta.auto_created or (model is ContactCustomField):
-      # TODO: Should we delete existing through model instances?
+      if not issubclass(model, CTCTModel):
+        # Delete ManyToMany objects
+        model.objects.all().delete()
       update_conflicts = False
       unique_fields = update_fields = None
     elif model is CampaignSummary:
@@ -105,7 +111,7 @@ class Command(BaseCommand):
     model: Type[CTCTModel],
     instances: list[CTCTModel],
   ) -> None:
-    """Sets pk values for OneToOne and ForeignKeys defined on `model`."""
+    """Sets Django pk values for OneToOne and ForeignKeys objects."""
     for field in model._meta.get_fields():
       if field.one_to_one or field.many_to_one:
         # Convert API id to Django pk (hits db)
@@ -116,30 +122,31 @@ class Command(BaseCommand):
 
   def set_related_object_pks(
     self,
-    model: Type[CTCTModel],
-    obj_w_pk: CTCTModel,
-    related_model: Type[CTCTModel],
-    instances: list[CTCTModel],
+    model: CTCTModel,
+    objs_w_pks: list[CTCTModel],
+    related_fields: list[dict],
   ) -> None:
-    """Sets pk values for various related object."""
-    for field in related_model._meta.get_fields():
-      if field.remote_field:
-        if field.name == 'author':
-          # CTCT doesn't store Author info
-          continue
-        if field.many_to_many and (instances[0].pk is None):
-          # Can't save ManyToMany until parent object has pk
-          continue
-        elif field.remote_field.model is model:
-          # No need to hit the db, we know the pk is obj_w_pk.pk
-          converter = lambda _: obj_w_pk.pk
-        else:
-          # Convert API id to Django pk (hits db)
-          id_to_pk = self.get_id_to_pk(field.remote_field.model)
-          converter = lambda o: id_to_pk[getattr(o, field.attname)]
-
-        # Set pks on related objects
-        [setattr(o, field.attname, converter(o)) for o in instances]
+    """Sets Django pk values for ManyToMany and ReverseForeignKey objects."""
+    for obj_w_pk, related_fields in zip(objs_w_pks, related_fields):
+      for related_model, related_objs in related_fields.items():
+        for field in related_model._meta.get_fields():
+          if field.remote_field:
+            if field.name == 'author':
+              # CTCT doesn't store Author info
+              continue
+            if field.many_to_many and (related_objs[0].pk is None):
+              # Can't save ManyToMany until parent object has pk
+              continue
+            elif field.remote_field.model is model:
+              # No need to hit the db, we know the pk is obj_w_pk.pk
+              converter = lambda _: obj_w_pk.pk
+            else:
+              # Convert API id to Django pk (hits db)
+              id_to_pk = self.get_id_to_pk(field.remote_field.model)
+              converter = lambda o: id_to_pk[getattr(o, field.attname)]
+
+            # Set pks on related objects
+            [setattr(o, field.attname, converter(o)) for o in related_objs]
 
   def import_model(self, model: CTCTModel) -> None:
     """Imports objects from CTCT into Django's database."""
@@ -150,54 +157,68 @@ class Command(BaseCommand):
 
     model.remote.connect()
     try:
-      objs, related_objs = zip(*model.remote.all())
+      objs, related_fields = zip(*model.remote.all())
     except ValueError:
       # No values returned
       return
 
     if model is CampaignSummary:
-      # Convert API id to pk for the OneToOneField with EmailCampaign
+      # Convert API id to Django pk for the OneToOneField with EmailCampaign
       self.set_direct_object_pks(model, objs)
 
     # Upsert models to get Django pks
     objs_w_pks = self.upsert(model, objs)
 
-    for obj_w_pk, related_objs in zip(objs_w_pks, related_objs):
-      for related_model, instances in related_objs.items():
-        self.set_related_object_pks(model, obj_w_pk, related_model, instances)
+    # Convert API id to Django pk for related objects
+    self.set_related_object_pks(model, objs_w_pks, related_fields)
 
-        # Upsert now that pks have been set
-        self.upsert(related_model, instances, silent=True)
+    # Reshape related_fields for efficiency
+    rows, related_fields = related_fields, defaultdict(list)
+    for row in rows:
+      for related_model, related_objs in row.items():
+        related_fields[related_model].extend(related_objs)
+
+    # Upsert related_objs
+    for related_model, related_objs in related_fields.items():
+      self.upsert(related_model, related_objs)
 
   def import_campaign_activities(self) -> None:
     """CampaignActivities must be imported one at a time."""
 
     model = CampaignActivity
 
-    objs_and_related_objs = []
+    objs_and_related_fields = []
 
     model.remote.connect()
-    for activity in tqdm(model.objects.filter(role='primary_email')):
-      obj, related_objs = model.remote.get(activity.api_id)
+    activities = model.objects.filter(role='primary_email')
+    for activity in tqdm(activities, disable=self.noinput):
+      obj, related_fields = model.remote.get(activity.api_id)
       obj.pk = activity.pk
       obj.campaign_id = activity.campaign_id
 
-      objs_and_related_objs.append((obj, related_objs))
+      objs_and_related_fields.append((obj, related_fields))
 
     # Upsert objects to update fields
     self.upsert(
       model=model,
-      objs=[_[0] for _ in objs_and_related_objs],
+      objs=[o for (o, _) in objs_and_related_fields],
       unique_fields=['campaign_id', 'role'],
       update_fields=['role', 'subject', 'preheader', 'html_content']
     )
 
-    for obj_w_pk, related_objs in objs_and_related_objs:
-      for related_model, instances in related_objs.items():
-        self.set_related_object_pks(model, obj_w_pk, related_model, instances)
+    # Convert API id to Django pk for related objects
+    objs_w_pks, related_fields = zip(*objs_and_related_fields)
+    self.set_related_object_pks(model, objs_w_pks, related_fields)
+
+    # Reshape related_fields for efficiency
+    rows, related_fields = related_fields, defaultdict(list)
+    for row in rows:
+      for related_model, related_objs in row.items():
+        related_fields[related_model].extend(related_objs)
 
-        # Upsert now that pks have been set
-        self.upsert(related_model, instances, silent=True)
+    # Upsert related_objs
+    for related_model, related_objs in related_fields.items():
+      self.upsert(related_model, related_objs)
 
   def add_arguments(self, parser: ArgumentParser) -> None:
     """Allow optional keyword arguments."""
@@ -225,9 +246,14 @@ class Command(BaseCommand):
       self.CTCT_MODELS = [CampaignSummary]
 
     for model in self.CTCT_MODELS:
-      question = f'Import {model.__name__}? (y/n): '
+      if model is CampaignActivity:
+        note = "Note: This will result in 1 API request per EmailCampaign! "
+      else:
+        note = ""
+      question = _(f'Import {model.__name__}? {note}(y/n): ')
+
       if self.noinput or (input(question).lower()[0] == 'y'):
         self.import_model(model)
       else:
-        message = f'Skipping {model.__name__}'
+        message = _(f'Skipping {model.__name__}')
         self.stdout.write(self.style.NOTICE(message))

{django_ctct-0.0.1.dev2 → django_ctct-0.0.1.dev3}/django_ctct/managers.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import datetime as dt
-import logging
 from functools import partial
 from typing import TYPE_CHECKING, Literal, Optional, NoReturn
 from urllib.parse import urlencode
@@ -35,12 +34,6 @@ if TYPE_CHECKING:
   )
 
 
-# Configure logging
-logging.basicConfig(level=logging.DEBUG)
-log = logging.getLogger('urllib3')
-log.setLevel(logging.DEBUG)
-
-
 class BaseRemoteManager(models.Manager):
   """Base manager for utilizing an API."""
 
@@ -250,9 +243,12 @@ class RemoteManager(BaseRemoteManager):
     for field_name in field_names:
       try:
         value = getattr(obj, field_name, None)
-      except ValueError:
-        print('SERIALIZE ERROR', type(obj), field_name)
-        continue
+      except ValueError as e:
+        if obj._meta.get_field(field_name).many_to_many and (obj.pk is None):
+          # Can't access related field when obj.pk is None
+          continue
+        else:
+          raise e
 
       if value is None:
         # Don't include null values
@@ -399,7 +395,8 @@ class RemoteManager(BaseRemoteManager):
           related_objs[field.related_model] = objs
         elif all(isinstance(_, str) for _ in related_data):
           # ManyToManyField, make a list of "through model" instances
-          # TODO PUSH: This relies on old code where API ids were used.
+          # TODO: GH #12
+          # NOTE: This relies on old code where API ids were used
           ThroughModel = getattr(self.model, field.name).through
           model_attname = f'{field.model._meta.model_name}_id'
           other_attname = f'{field.related_model._meta.model_name}_id'
@@ -880,7 +877,7 @@ class EmailCampaignRemoteManager(RemoteManager):
     'updated_at',
   )
   API_MAX_LENGTH = {
-    'name': 80,
+    'name': 80,  # TODO: GH #2
   }
 
   def serialize(
@@ -1002,7 +999,7 @@ class CampaignActivityRemoteManager(RemoteManager):
     'html_content',
     'contact_lists',
     'format_type',                  # Must include in request
-    'physical_address_in_footer',   # Must incldue in request
+    'physical_address_in_footer',   # Must include in request
   )
   API_READONLY_FIELDS = (
     'api_id',
@@ -1013,8 +1010,8 @@ class CampaignActivityRemoteManager(RemoteManager):
     'from_name': 100,
     'from_email': 80,
     'reply_to_email': 80,
-    'subject': 200,     # Not documented
-    'preheader': 130,   # Not documented  # TODO: Can it be bigger?
+    'subject': 200,
+    'preheader': 250,
     'html_content': int(15e4),
   }
   API_GET_QUERIES = {

{django_ctct-0.0.1.dev2 → django_ctct-0.0.1.dev3}/django_ctct/models.py

@@ -71,10 +71,11 @@ class Token(Model):
     ordering = ('-created_at', )
 
   def __str__(self) -> str:
-    s = formats.date_format(
-      timezone.localtime(self.created_at),
+    expires_at = formats.date_format(
+      timezone.localtime(self.expires_at),
       settings.DATETIME_FORMAT,
     )
+    s = f"{self.token_type} Token (Expires: {expires_at})"
     return s
 
   @property
@@ -441,7 +442,7 @@ class ContactNote(CTCTModel):
     verbose_name = _('Note')
     verbose_name_plural = _('Notes')
 
-    # TODO PUSH: CheckConstraint
+    # TODO: GH #8
     # constraints = [
     #   models.CheckConstraint(
     #     check=Q(contact__notes__count__lte=ContactRemoteManager.API_MAX_NOTES),
@@ -449,6 +450,14 @@ class ContactNote(CTCTModel):
     #   ),
     # ]
 
+  def __str__(self) -> str:
+    author = self.author or _('Unknown author')
+    created_at = formats.date_format(
+      timezone.localtime(self.created_at),
+      settings.DATETIME_FORMAT,
+    )
+    return f'{author} on {created_at}'
+
 
 class ContactPhoneNumber(CTCTModel):
   """Django implementation of a CTCT Contact's PhoneNumber."""
@@ -490,12 +499,12 @@ class ContactPhoneNumber(CTCTModel):
     verbose_name_plural = _('Phone Numbers')
 
     constraints = [
-      # TODO PUSH: UniqueConstraint not enforced by CTCT?
+      # TODO: GH #7
       # models.UniqueConstraint(
       #   fields=['contact', 'kind'],
       #   name='django_ctct_unique_phone_number',
       # ),
-      # TODO PUSH: CheckConstraint
+      # TODO: GH #8
       # models.CheckConstraint(
       #   check=Q(contact__phone_numbers__count__lte=ContactRemoteManager.API_MAX_PHONE_NUMBERS),
       #   name='django_ctct_limit_phone_numbers',
@@ -573,12 +582,12 @@ class ContactStreetAddress(CTCTModel):
     verbose_name_plural = _('Street Addresses')
 
     constraints = [
-      # TODO PUSH: UniqueConstraint not enforced by CTCT?
+      # TODO: GH #7
       # models.UniqueConstraint(
       #   fields=['contact', 'kind'],
       #   name='django_ctct_unique_street_address',
       # ),
-      # TODO PUSH: CheckConstraint
+      # TODO: GH #8
       # models.CheckConstraint(
       #   check=Q(contact__street_addresses__count__lte=ContactRemoteManager.API_MAX_STREET_ADDRESSES),
       #   name='django_ctct_limit_street_addresses',
@@ -649,12 +658,12 @@ class ContactCustomField(models.Model):
     verbose_name_plural = _('Custom Fields')
 
     constraints = [
-      # TODO PUSH: UniqueConstraint not enforced by CTCT?
+      # TODO: GH #7
       # models.UniqueConstraint(
       #   fields=['contact', 'custom_field'],
       #   name='django_ctct_unique_custom_field',
       # ),
-      # TODO PUSH: CheckConstraint
+      # TODO: GH #8
       # models.CheckConstraint(
       #   check=Q(contact__custom_fields__count__lte=ContactRemoteManager.API_MAX_CUSTOM_FIELDS),
       #   name='django_ctct_limit_custom_fields',
@@ -689,7 +698,7 @@ class EmailCampaign(CTCTRemoteModel):
   # API editable fields
   name = models.CharField(
     max_length=remote.API_MAX_LENGTH['name'],
-    # unique=True,  # TODO PUSH: UniqueConstraint not enforced by CTCT?
+    # unique=True,  # TODO: GH #7
     verbose_name=_('Name'),
   )
   scheduled_datetime = models.DateTimeField(

{django_ctct-0.0.1.dev2 → django_ctct-0.0.1.dev3}/django_ctct/signals.py

@@ -47,7 +47,7 @@ def remote_update_m2m(sender, instance, action, **kwargs):
   """Updates a Contact's list membership on CTCT servers."""
 
   actions = ['post_add', 'post_remove', 'post_clear']
-  # TODO PUSH: [signals] How to implement this?
+  # TODO: GH #11
   # if (sender is ContactAndContactList) and (action in actions):
   if action in actions:
 

{django_ctct-0.0.1.dev2 → django_ctct-0.0.1.dev3}/django_ctct/utils.py

@@ -1,13 +1,9 @@
 import datetime as dt
-import logging
 
 from django.db.models import Model
 from django.utils import timezone
 
 
-logger = logging.getLogger('django_ctct')
-
-
 def to_dt(s: str, ts_format: str = '%Y-%m-%dT%H:%M:%SZ') -> dt.datetime:
   return timezone.make_aware(dt.datetime.strptime(s, ts_format))
 

{django_ctct-0.0.1.dev2 → django_ctct-0.0.1.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-ctct"
-version = "0.0.1.dev2"
+version = "0.0.1.dev3"
 description = "A Django interface for the Constant Contact API"
 authors = [
     {name = "Geoffrey Eisenbarth",email = "geoffrey.eisenbarth@gmail.com"}
@@ -32,6 +32,8 @@ requests-mock = "^1.12.1"
 flake8 = "^7.1.2"
 codecov = "^2.1.13"
 mypy = "^1.15.0"
+django-stubs = {extras = ["compatible-mypy"], version = "^5.1.3"}
+types-requests = "^2.32.0.20250306"
 
 [tool.pytest.ini_options]
 DJANGO_SETTINGS_MODULE = "project.settings"
@@ -39,8 +41,10 @@ DJANGO_SETTINGS_MODULE = "project.settings"
 [tool.coverage.report]
 show_missing = true
 
-# [tool.mypy]
-# python_version = 3.9
-# django_any_from_any = true
-# plugins = mypy_django_plugin.*
-# ignore_missing_imports = true
+[tool.mypy]
+python_version = "3.9"
+plugins = ["mypy_django_plugin.main"]
+ignore_missing_imports = true
+
+[tool.django-stubs]
+django_settings_module = "tests.project.project.settings"