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

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

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

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

@@ -17,9 +17,10 @@ from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
 from django_ctct.models import (
-  Token, CTCTRemoteModel, ContactList,
-  Contact, CustomField, ContactStreetAddress, ContactPhoneNumber, ContactNote,
-  EmailCampaign, CampaignActivity
+  Token, CTCTRemoteModel, ContactList, CustomField,
+  Contact,
+  ContactCustomField, ContactStreetAddress, ContactPhoneNumber, ContactNote,
+  EmailCampaign, CampaignActivity, CampaignSummary,
 )
 from django_ctct.signals import remote_save, remote_delete
 from django_ctct.vendor import mute_signals
@@ -258,6 +259,14 @@ class ContactNoteInline(admin.TabularInline):
     return False
 
 
+class ContactCustomFieldInline(admin.TabularInline):
+
+  model = ContactCustomField
+  excldue = ('api_id', )
+
+  extra = 1
+
+
 class ContactAdmin(RemoteModelAdmin):
   """Admin functionality for CTCT Contacts."""
 
@@ -317,6 +326,7 @@ class ContactAdmin(RemoteModelAdmin):
   )
   filter_horizontal = ('list_memberships', )
   inlines = (
+    ContactCustomFieldInline,
     ContactPhoneNumberInline,
     ContactStreetAddressInline,
     ContactNoteInline,
@@ -439,52 +449,19 @@ class EmailCampaignAdmin(RemoteModelAdmin):
     'updated_at',
     'current_status',
     'scheduled_datetime',
-    'open_rate',
-    'sends',
-    'bounces',
-    'clicks',
-    'optouts',
-    'abuse',
     'is_synced',
   )
 
-  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
-  open_rate.admin_order_field = 'open_rate'
-  open_rate.short_description = _('Open Rate')
-
   # ChangeView
+  fieldsets = (
+    (None, {
+      'fields': (
+        'name', 'current_status', 'scheduled_datetime', 'send_preview'
+      ),
+    }),
+  )
   inlines = (CampaignActivityInline, )
 
-  def get_fieldsets(self, request: HttpRequest, obj=None):
-    if obj and (obj.current_status == 'DONE'):
-      fieldsets = (
-        (None, {
-          'fields': ('name', 'current_status', 'scheduled_datetime'),
-        }),
-        ('ANALYTICS', {
-          'fields': (
-            'sends', 'opens', 'clicks', 'forwards',
-            'optouts', 'abuse', 'bounces', 'not_opened',
-          ),
-        }),
-      )
-    else:
-      fieldsets = (
-        (None, {
-          'fields': (
-            'name', 'current_status', 'scheduled_datetime', 'send_preview'
-          ),
-        }),
-      )
-
-    return fieldsets
-
   def get_readonly_fields(self, request: HttpRequest, obj=None):
     readonly_fields = EmailCampaign.remote.API_READONLY_FIELDS
     if obj and obj.current_status == 'DONE':
@@ -557,6 +534,47 @@ class EmailCampaignAdmin(RemoteModelAdmin):
     self.message_user(request, message)
 
 
+class CampaignSummaryAdmin(ViewModelAdmin):
+  """Admin functionality for CTCT EmailCampaign Summary Report."""
+
+  # ListView
+  search_fields = ('name', )
+  list_display = (
+    'campaign',
+    'open_rate',
+    'sends',
+    'bounces',
+    'clicks',
+    'optouts',
+    'abuse',
+  )
+
+  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
+  open_rate.admin_order_field = 'open_rate'
+  open_rate.short_description = _('Open Rate')
+
+  # ChangeView
+  fieldsets = (
+    (None, {
+      'fields': (
+        'campaign',
+      ),
+    }),
+    ('ANALYTICS', {
+      'fields': (
+        'sends', 'opens', 'clicks', 'forwards',
+        'optouts', 'abuse', 'bounces', 'not_opened',
+      ),
+    }),
+  )
+
+
 if getattr(settings, 'CTCT_USE_ADMIN', False):
   admin.site.register(Token, TokenAdmin)
   admin.site.register(ContactList, ContactListAdmin)
@@ -564,3 +582,4 @@ if getattr(settings, 'CTCT_USE_ADMIN', False):
   admin.site.register(Contact, ContactAdmin)
   admin.site.register(ContactNote, ContactNoteAdmin)
   admin.site.register(EmailCampaign, EmailCampaignAdmin)
+  admin.site.register(CampaignSummary, CampaignSummaryAdmin)

{django_ctct-0.0.1.dev1 → django_ctct-0.0.1.dev2}/django_ctct/apps.py

@@ -14,7 +14,6 @@ class CTCTConfig(AppConfig):
     'CTCT_REDIRECT_URI',
     'CTCT_FROM_NAME',
     'CTCT_FROM_EMAIL',
-    'CTCT_ENQUEUE_DEFAULT',
   ]
 
   def ready(self):

django_ctct-0.0.1.dev2/django_ctct/management/commands/import_ctct.py

@@ -0,0 +1,233 @@
+from argparse import ArgumentParser
+from typing import Optional, Type
+
+from tqdm import tqdm
+
+import django
+from django.core.management.base import BaseCommand
+
+from django_ctct.models import (
+  CTCTModel, ContactList, CustomField,
+  Contact, ContactCustomField,
+  EmailCampaign, CampaignActivity, CampaignSummary,
+)
+
+
+class Command(BaseCommand):
+  """Imports django-ctct model instances from CTCT servers.
+
+  Notes
+  -----
+  CTCT does not provide an endpoint for fetching bulk CampaignActivities.
+  As a result, we must loop through the EmailCampaigns, make a request to get
+  the associated CampaignActivities, and then make a second request to get the
+  details of the CampaignActivity.
+
+  As a result, importing CampaignActivities will be slow, and running it
+  multiple times may result in exceeding CTCT's 10,000 requests per day
+  limit.
+
+  """
+
+  help = 'Imports data from ConstantContact'
+
+  CTCT_MODELS = [
+    ContactList,
+    CustomField,
+    Contact,
+    EmailCampaign,
+    CampaignActivity,
+    CampaignSummary,
+  ]
+
+  def get_id_to_pk(self, model: Type[CTCTModel]) -> dict:
+    """Returns a dictionary to convert CTCT API ids to Django pks."""
+    id_to_pk = {
+      str(api_id): int(pk)
+      for (api_id, pk) in model.objects.values_list('api_id', 'pk')
+    }
+    return id_to_pk
+
+  def upsert(
+    self,
+    model: CTCTModel,
+    objs: list[CTCTModel],
+    update_conflicts: bool = True,
+    unique_fields: list[str] = ['api_id'],
+    update_fields: Optional[list[str]] = None,
+    silent: bool = False,
+  ) -> list[CTCTModel]:
+
+    verb = 'Imported' if (update_fields is None) else 'Updated'
+
+    # Perform upsert using `bulk_create()`
+    if model._meta.auto_created or (model is ContactCustomField):
+      # TODO: Should we delete existing through model instances?
+      update_conflicts = False
+      unique_fields = update_fields = None
+    elif model is CampaignSummary:
+      update_conflicts = True
+      unique_fields = ['campaign_id']
+      update_fields = model.remote.API_READONLY_FIELDS[1:]
+    elif update_fields is None:
+      update_fields = [
+        f.name
+        for f in model._meta.fields
+        if not f.primary_key and (f.name != 'api_id')
+      ]
+
+    objs_w_pks = model.objects.bulk_create(
+      objs=objs,
+      update_conflicts=update_conflicts,
+      unique_fields=unique_fields,
+      update_fields=update_fields,
+    )
+    if update_conflicts and (django.get_version() < '5.0'):
+      # In older versions, enabling the update_conflicts parameter prevented
+      # setting the primary key on each model instance.
+      if model is not CampaignSummary:
+        # CampaignSummary doesn't have `api_id` field (or related_objs)
+        # so it's okay to skip this part
+        id_to_pk = self.get_id_to_pk(model)
+        [setattr(o, 'pk', id_to_pk[o.api_id]) for o in objs_w_pks]
+
+    # Inform the user
+    if not silent:
+      message = self.style.SUCCESS(
+        f'{verb} {len(objs)} {model.__name__} instances.'
+      )
+      self.stdout.write(message)
+
+    return objs_w_pks
+
+  def set_direct_object_pks(
+    self,
+    model: Type[CTCTModel],
+    instances: list[CTCTModel],
+  ) -> None:
+    """Sets pk values for OneToOne and ForeignKeys defined on `model`."""
+    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)
+        id_to_pk = self.get_id_to_pk(field.remote_field.model)
+        converter = lambda o: id_to_pk[getattr(o, field.attname)]
+
+        [setattr(o, field.attname, converter(o)) for o in instances]
+
+  def set_related_object_pks(
+    self,
+    model: Type[CTCTModel],
+    obj_w_pk: CTCTModel,
+    related_model: Type[CTCTModel],
+    instances: list[CTCTModel],
+  ) -> 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]
+
+  def import_model(self, model: CTCTModel) -> None:
+    """Imports objects from CTCT into Django's database."""
+
+    if model is CampaignActivity:
+      # CampaignActivities do not have a bulk API endpoint
+      return self.import_campaign_activities()
+
+    model.remote.connect()
+    try:
+      objs, related_objs = zip(*model.remote.all())
+    except ValueError:
+      # No values returned
+      return
+
+    if model is CampaignSummary:
+      # Convert API id to 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)
+
+        # Upsert now that pks have been set
+        self.upsert(related_model, instances, silent=True)
+
+  def import_campaign_activities(self) -> None:
+    """CampaignActivities must be imported one at a time."""
+
+    model = CampaignActivity
+
+    objs_and_related_objs = []
+
+    model.remote.connect()
+    for activity in tqdm(model.objects.filter(role='primary_email')):
+      obj, related_objs = model.remote.get(activity.api_id)
+      obj.pk = activity.pk
+      obj.campaign_id = activity.campaign_id
+
+      objs_and_related_objs.append((obj, related_objs))
+
+    # Upsert objects to update fields
+    self.upsert(
+      model=model,
+      objs=[_[0] for _ in objs_and_related_objs],
+      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)
+
+        # Upsert now that pks have been set
+        self.upsert(related_model, instances, silent=True)
+
+  def add_arguments(self, parser: ArgumentParser) -> None:
+    """Allow optional keyword arguments."""
+
+    parser.add_argument(
+      '--noinput',
+      action='store_true',
+      default=False,
+      help='Automatic yes to prompts',
+    )
+    parser.add_argument(
+      '--stats_only',
+      action='store_true',
+      default=False,
+      help='Only fetch EmailCampaign statistics',
+    )
+
+  def handle(self, *args, **kwargs):
+    """Primary access point for Django management command."""
+
+    self.noinput = kwargs['noinput']
+    self.stats_only = kwargs['stats_only']
+
+    if self.stats_only:
+      self.CTCT_MODELS = [CampaignSummary]
+
+    for model in self.CTCT_MODELS:
+      question = f'Import {model.__name__}? (y/n): '
+      if self.noinput or (input(question).lower()[0] == 'y'):
+        self.import_model(model)
+      else:
+        message = f'Skipping {model.__name__}'
+        self.stdout.write(self.style.NOTICE(message))

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

@@ -1,9 +1,11 @@
 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
+from uuid import UUID
 
 from jwt import ExpiredSignatureError
 from ratelimit import limits, sleep_and_retry
@@ -207,9 +209,6 @@ class RemoteManager(BaseRemoteManager):
   API_LIMIT_CALLS = 4   # four calls
   API_LIMIT_PERIOD = 1  # per second
 
-  API_ENDPOINT = ''
-  API_ID_LABEL = ''
-
   API_GET_QUERIES = {}
   API_EDITABLE_FIELDS = tuple()
   API_READONLY_FIELDS = (
@@ -249,27 +248,35 @@ class RemoteManager(BaseRemoteManager):
     }[field_types]
 
     for field_name in field_names:
+      try:
+        value = getattr(obj, field_name, None)
+      except ValueError:
+        print('SERIALIZE ERROR', type(obj), field_name)
+        continue
+
+      if value is None:
+        # Don't include null values
+        continue
+      elif isinstance(value, UUID):
+        # Convert UUID to string
+        value = str(value)
+      elif isinstance(value, dt.datetime):
+        # Convert datetime to string
+        value = value.strftime(self.TS_FORMAT)
+
+      # The field determines how the value is serialized
       try:
         field = self.model._meta.get_field(field_name)
       except FieldDoesNotExist:
-        # Check if the API field was defined as a @property
-        if value := getattr(obj, field_name, None):
-          data[field_name] = value
+        # The API field was defined as a @property
+        data[field_name] = value
         continue
 
-      if field_name.endswith('_id'):
-        # Convert related object UUID to string
-        if (value := getattr(obj, field_name)) is not None:
-          value = str(value)
-        if field_name == 'api_id':
-          field_name = self.model.remote.API_ID_LABEL
-
-      elif isinstance(field, models.DateTimeField):
-        # Convert datetime to string
-        if (value := getattr(obj, field_name)) is not None:
-          value = value.strftime(self.TS_FORMAT)
-      elif not field.is_relation:
-        value = getattr(obj, field_name)
+      if field_name == 'api_id':
+        field_name = self.model.remote.API_ID_LABEL
+      elif field_name.endswith('_id'):
+        api_id = getattr(obj, field_name[:-3]).api_id
+        value = str(api_id)
       elif field.many_to_many:
         if obj.pk:
           qs = getattr(obj, field_name).values_list('api_id', flat=True)
@@ -318,19 +325,8 @@ class RemoteManager(BaseRemoteManager):
     else:
       data = data.copy()
 
-    try:
+    if hasattr(self, 'API_ID_LABEL'):
       data['api_id'] = data.pop(self.API_ID_LABEL)
-    except AttributeError:
-      message = _(
-        f"{self} is missing the `API_ID_LABEL` attribute."
-      )
-      raise ImproperlyConfigured(message)
-    except KeyError as e:
-      if self.API_ID_LABEL is None:
-        # e.g. ContactCustomField
-        pass
-      else:
-        raise e
 
     # Clean field values, must be done before field restriction
     model_fields = self.model._meta.get_fields()
@@ -377,9 +373,10 @@ class RemoteManager(BaseRemoteManager):
 
     """
 
-    otos, _, fks, _ = get_related_fields(self.model)
-    for field in filter(lambda f: f.attname in data, otos + fks):
-      data[field.attname] = parent_pk
+    if parent_pk:
+      otos, _, fks, _ = get_related_fields(self.model)
+      for field in filter(lambda f: f.attname in data, otos + fks):
+        data[field.attname] = parent_pk
     return data
 
   def deserialize_related_objs_fields(
@@ -502,8 +499,9 @@ class RemoteManager(BaseRemoteManager):
       )
       data = self.raise_or_json(response)
 
-      # Data only contains two keys: '_links' and e.g. 'contacts' or 'lists'
+      # Data only contains two keys: '_links' and e.g. 'lists' or 'contacts'
       links = data.pop('_links', None)
+      data = next(iter(data.values()))
       objs.extend(map(self.deserialize, data))
 
       try:
@@ -856,7 +854,6 @@ class ContactStreetAddressRemoteManager(RemoteManager):
 class ContactCustomFieldRemoteManager(RemoteManager):
   """Extend RemoteManager to handle ContactCustomFields."""
 
-  API_ID_LABEL = 'custom_field_id'
   API_EDITABLE_FIELDS = (
     'custom_field_id',
     'value',
@@ -878,27 +875,25 @@ class EmailCampaignRemoteManager(RemoteManager):
   API_READONLY_FIELDS = (
     'api_id',
     'current_status',
+    'campaign_activities',
     'created_at',
     'updated_at',
-    'sends',
-    'opens',
-    'clicks',
-    'forwards',
-    'optouts',
-    'abuse',
-    'bounces',
-    'not_opened',
   )
   API_MAX_LENGTH = {
     'name': 80,
   }
 
-  def serialize(self, obj: Model) -> dict:
-    if obj.api_id:
+  def serialize(
+    self,
+    obj: Model,
+    field_types: Literal['editable', 'readonly', 'all'] = 'editable',
+  ) -> dict:
+    if obj.api_id and (field_types == 'editable'):
       # The only field that the API will update
-      return {'name': obj.name}
+      data = {'name': obj.name}
     else:
-      return super().serialize(obj)
+      data = super().serialize(obj, field_types)
+    return data
 
   # @task(queue_name='ctct')
   def create(self, obj: EmailCampaign) -> EmailCampaign:
@@ -1019,7 +1014,7 @@ class CampaignActivityRemoteManager(RemoteManager):
     'from_email': 80,
     'reply_to_email': 80,
     'subject': 200,     # Not documented
-    'preheader': 130,   # Not documentred
+    'preheader': 130,   # Not documented  # TODO: Can it be bigger?
     'html_content': int(15e4),
   }
   API_GET_QUERIES = {
@@ -1146,3 +1141,32 @@ class CampaignActivityRemoteManager(RemoteManager):
         f"Cannot unschedule CampaignActivities with role '{obj.role}'."
       )
       raise ValueError(message)
+
+
+class CampaignSummaryRemoteManager(RemoteManager):
+  """Extend RemoteManager to handle creating EmailCampaignSummarys."""
+
+  API_ENDPOINT = '/reports/summary_reports/email_campaign_summaries'
+  API_READONLY_FIELDS = (
+    'campaign_id',
+    'sends',
+    'opens',
+    'clicks',
+    'forwards',
+    'optouts',
+    'abuse',
+    'bounces',
+    'not_opened',
+  )
+
+  def serialize(
+    self,
+    obj: Model,
+    field_types: Literal['editable', 'readonly', 'all'] = 'editable',
+  ) -> dict:
+    data = super().serialize(obj, field_types)
+    data['unique_counts'] = {
+      stat_field: data.pop(stat_field)
+      for stat_field in self.API_READONLY_FIELDS[1:]
+    }
+    return data

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

@@ -19,7 +19,8 @@ from django_ctct.managers import (
   ContactRemoteManager, ContactNoteRemoteManager,
   ContactPhoneNumberRemoteManager, ContactStreetAddressRemoteManager,
   ContactCustomFieldRemoteManager,
-  EmailCampaignRemoteManager, CampaignActivityRemoteManager,
+  EmailCampaignRemoteManager,
+  CampaignActivityRemoteManager, CampaignSummaryRemoteManager,
 )
 
 
@@ -111,10 +112,6 @@ class CTCTModel(Model):
   class Meta:
     abstract = True
 
-  @classmethod
-  def clean_remote_counts(cls, field_name: str, data: dict) -> int:
-    return data.get('unique_counts', {}).get(field_name, 0)
-
   @classmethod
   def clean_remote_string(cls, field_name: str, data: dict) -> str:
     s = data.get(field_name, '')
@@ -226,6 +223,7 @@ class CustomField(CTCTRemoteModel):
   type = models.CharField(
     max_length=6,
     choices=TYPES,
+    default=TYPES[0][0],
     verbose_name=_('Type'),
     help_text=_(
       'Specifies the type of value the custom_field field accepts'
@@ -423,6 +421,7 @@ class ContactNote(CTCTModel):
     settings.AUTH_USER_MODEL,
     on_delete=models.CASCADE,
     null=True,
+    related_name='notes',
     verbose_name=_('Author'),
   )
 
@@ -446,7 +445,7 @@ class ContactNote(CTCTModel):
     # constraints = [
     #   models.CheckConstraint(
     #     check=Q(contact__notes__count__lte=ContactRemoteManager.API_MAX_NOTES),
-    #     name='limit_notes'
+    #     name='django_ctct_limit_notes'
     #   ),
     # ]
 
@@ -494,12 +493,12 @@ class ContactPhoneNumber(CTCTModel):
       # TODO PUSH: UniqueConstraint not enforced by CTCT?
       # models.UniqueConstraint(
       #   fields=['contact', 'kind'],
-      #   name='unique_phone_number',
+      #   name='django_ctct_unique_phone_number',
       # ),
       # TODO PUSH: CheckConstraint
       # models.CheckConstraint(
       #   check=Q(contact__phone_numbers__count__lte=ContactRemoteManager.API_MAX_PHONE_NUMBERS),
-      #   name='limit_phone_numbers',
+      #   name='django_ctct_limit_phone_numbers',
       # ),
     ]
 
@@ -577,12 +576,12 @@ class ContactStreetAddress(CTCTModel):
       # TODO PUSH: UniqueConstraint not enforced by CTCT?
       # models.UniqueConstraint(
       #   fields=['contact', 'kind'],
-      #   name='unique_street_address',
+      #   name='django_ctct_unique_street_address',
       # ),
       # TODO PUSH: CheckConstraint
       # models.CheckConstraint(
       #   check=Q(contact__street_addresses__count__lte=ContactRemoteManager.API_MAX_STREET_ADDRESSES),
-      #   name='limit_street_addresses',
+      #   name='django_ctct_limit_street_addresses',
       # ),
     ]
 
@@ -614,14 +613,12 @@ class ContactStreetAddress(CTCTModel):
     return cls.clean_remote_string('country', data)
 
 
-class ContactCustomField(CTCTModel):
+class ContactCustomField(models.Model):
   """Django implementation of a CTCT Contact's CustomField.
 
   Notes
   -----
-  It's important to specify `custom_field_id` in `API_EDITABLE_FIELDS` instead
-  of `custom_field`; using the latter will result in a serialized CustomField
-  instance when Contact is serialized.
+  CTCT does not provide UUIDs for these, so we do not inherit from CTCTModel.
 
   """
 
@@ -635,14 +632,13 @@ class ContactCustomField(CTCTModel):
     related_name='custom_fields',
     verbose_name=_('Contact'),
   )
-
-  # API editable fields
   custom_field = models.ForeignKey(
     CustomField,
     on_delete=models.CASCADE,
-    related_name='instances',
+    related_name='contacts',
     verbose_name=_('Field'),
   )
+
   value = models.CharField(
     max_length=remote.API_MAX_LENGTH['value'],
     verbose_name=_('Value'),
@@ -656,12 +652,12 @@ class ContactCustomField(CTCTModel):
       # TODO PUSH: UniqueConstraint not enforced by CTCT?
       # models.UniqueConstraint(
       #   fields=['contact', 'custom_field'],
-      #   name='unique_custom_field',
+      #   name='django_ctct_unique_custom_field',
       # ),
       # TODO PUSH: CheckConstraint
       # models.CheckConstraint(
       #   check=Q(contact__custom_fields__count__lte=ContactRemoteManager.API_MAX_CUSTOM_FIELDS),
-      #   name='limit_custom_fields',
+      #   name='django_ctct_limit_custom_fields',
       # ),
     ]
 
@@ -672,12 +668,7 @@ class ContactCustomField(CTCTModel):
       s = super().__str__()
     return s
 
-  @classmethod
-  def clean_remote_custom_field(cls, data: dict) -> str:
-    return data['custom_field_id']
-
 
-# TODO: EmailCampaign.current_status vs CampaignActivity.current_status
 class EmailCampaign(CTCTRemoteModel):
   """Django implementation of a CTCT EmailCampaign."""
 
@@ -721,54 +712,6 @@ class EmailCampaign(CTCTRemoteModel):
     default='DRAFT',
     verbose_name=_('Current Status'),
   )
-  sends = models.IntegerField(
-    null=True,
-    default=None,
-    verbose_name=_('Sends'),
-    help_text=_('The total number of unique sends'),
-  )
-  opens = models.IntegerField(
-    null=True,
-    default=None,
-    verbose_name=_('Opens'),
-    help_text=_('The total number of unique opens'),
-  )
-  clicks = models.IntegerField(
-    null=True,
-    default=None,
-    verbose_name=_('Clicks'),
-    help_text=_('The total number of unique clicks'),
-  )
-  forwards = models.IntegerField(
-    null=True,
-    default=None,
-    verbose_name=_('Forwards'),
-    help_text=_('The total number of unique forwards'),
-  )
-  optouts = models.IntegerField(
-    null=True,
-    default=None,
-    verbose_name=_('Opt Out'),
-    help_text=_('The total number of people who unsubscribed'),
-  )
-  abuse = models.IntegerField(
-    null=True,
-    default=None,
-    verbose_name=_('Spam'),
-    help_text=_('The total number of people who marked as spam'),
-  )
-  bounces = models.IntegerField(
-    null=True,
-    default=None,
-    verbose_name=_('Bounces'),
-    help_text=_('The total number of bounces'),
-  )
-  not_opened = models.IntegerField(
-    null=True,
-    default=None,
-    verbose_name=_('Not Opened'),
-    help_text=_('The total number of people who didn\'t open'),
-  )
 
   class Meta:
     verbose_name = _('Email Campaign')
@@ -779,46 +722,6 @@ class EmailCampaign(CTCTRemoteModel):
   def __str__(self) -> str:
     return self.name
 
-  @classmethod
-  def clean_remote_sends(cls, data: dict) -> int:
-    return cls.clean_remote_counts('sends', data)
-
-  @classmethod
-  def clean_remote_opens(cls, data: dict) -> int:
-    return cls.clean_remote_counts('opens', data)
-
-  @classmethod
-  def clean_remote_clicks(cls, data: dict) -> int:
-    return cls.clean_remote_counts('clicks', data)
-
-  @classmethod
-  def clean_remote_forwards(cls, data: dict) -> int:
-    return cls.clean_remote_counts('forwards', data)
-
-  @classmethod
-  def clean_remote_optouts(cls, data: dict) -> int:
-    return cls.clean_remote_counts('optouts', data)
-
-  @classmethod
-  def clean_remote_abuse(cls, data: dict) -> int:
-    return cls.clean_remote_counts('abuse', data)
-
-  @classmethod
-  def clean_remote_bounces(cls, data: dict) -> int:
-    return cls.clean_remote_counts('bounces', data)
-
-  @classmethod
-  def clean_remote_not_opened(cls, data: dict) -> int:
-    return cls.clean_remote_counts('not_opened', data)
-
-  @classmethod
-  def clean_remote_current_status(cls, data: dict) -> str:
-    if data.get('unique_counts'):
-      current_status = 'DONE'
-    else:
-      current_status = data.get('current_status')
-    return current_status
-
   @classmethod
   def clean_remote_scheduled_datetime(cls, data: dict) -> Optional[dt.datetime]:  # noqa: E501
     if scheduled_datetime := data.get('last_sent_date'):
@@ -941,7 +844,7 @@ class CampaignActivity(CTCTRemoteModel):
     constraints = [
       models.UniqueConstraint(
         fields=['campaign', 'role'],
-        name='unique_campaign_activity',
+        name='django_ctct_unique_campaign_activity',
       ),
     ]
 
@@ -994,3 +897,110 @@ class CampaignActivity(CTCTRemoteModel):
   @classmethod
   def clean_remote_contact_lists(cls, data: dict) -> list[str]:
     return data.pop('contact_list_ids', [])
+
+
+class CampaignSummary(models.Model):
+  """Django implementation of a CTCT EmailCampaign report."""
+
+  # Must explicitly specify both
+  objects = models.Manager()
+  remote = CampaignSummaryRemoteManager()
+
+  campaign = models.OneToOneField(
+    EmailCampaign,
+    on_delete=models.CASCADE,
+    related_name='summary',
+    verbose_name=_('Email Campaign'),
+  )
+
+  # API read-only fields
+  sends = models.IntegerField(
+    null=True,
+    default=None,
+    verbose_name=_('Sends'),
+    help_text=_('The total number of unique sends'),
+  )
+  opens = models.IntegerField(
+    null=True,
+    default=None,
+    verbose_name=_('Opens'),
+    help_text=_('The total number of unique opens'),
+  )
+  clicks = models.IntegerField(
+    null=True,
+    default=None,
+    verbose_name=_('Clicks'),
+    help_text=_('The total number of unique clicks'),
+  )
+  forwards = models.IntegerField(
+    null=True,
+    default=None,
+    verbose_name=_('Forwards'),
+    help_text=_('The total number of unique forwards'),
+  )
+  optouts = models.IntegerField(
+    null=True,
+    default=None,
+    verbose_name=_('Opt Out'),
+    help_text=_('The total number of people who unsubscribed'),
+  )
+  abuse = models.IntegerField(
+    null=True,
+    default=None,
+    verbose_name=_('Spam'),
+    help_text=_('The total number of people who marked as spam'),
+  )
+  bounces = models.IntegerField(
+    null=True,
+    default=None,
+    verbose_name=_('Bounces'),
+    help_text=_('The total number of bounces'),
+  )
+  not_opened = models.IntegerField(
+    null=True,
+    default=None,
+    verbose_name=_('Not Opened'),
+    help_text=_('The total number of people who didn\'t open'),
+  )
+
+  class Meta:
+    verbose_name = _('Email Campaign Report')
+    verbose_name_plural = _('Email Campaign Reports')
+
+    ordering = ('-campaign', )
+
+  @classmethod
+  def clean_remote_counts(cls, field_name: str, data: dict) -> int:
+    return data.get('unique_counts', {}).get(field_name, 0)
+
+  @classmethod
+  def clean_remote_sends(cls, data: dict) -> int:
+    return cls.clean_remote_counts('sends', data)
+
+  @classmethod
+  def clean_remote_opens(cls, data: dict) -> int:
+    return cls.clean_remote_counts('opens', data)
+
+  @classmethod
+  def clean_remote_clicks(cls, data: dict) -> int:
+    return cls.clean_remote_counts('clicks', data)
+
+  @classmethod
+  def clean_remote_forwards(cls, data: dict) -> int:
+    return cls.clean_remote_counts('forwards', data)
+
+  @classmethod
+  def clean_remote_optouts(cls, data: dict) -> int:
+    return cls.clean_remote_counts('optouts', data)
+
+  @classmethod
+  def clean_remote_abuse(cls, data: dict) -> int:
+    return cls.clean_remote_counts('abuse', data)
+
+  @classmethod
+  def clean_remote_bounces(cls, data: dict) -> int:
+    return cls.clean_remote_counts('bounces', data)
+
+  @classmethod
+  def clean_remote_not_opened(cls, data: dict) -> int:
+    return cls.clean_remote_counts('not_opened', data)

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

@@ -1,6 +1,6 @@
 [project]
 name = "django-ctct"
-version = "0.0.1.dev1"
+version = "0.0.1.dev2"
 description = "A Django interface for the Constant Contact API"
 authors = [
     {name = "Geoffrey Eisenbarth",email = "geoffrey.eisenbarth@gmail.com"}
@@ -31,9 +31,16 @@ factory-boy = "^3.3.3"
 requests-mock = "^1.12.1"
 flake8 = "^7.1.2"
 codecov = "^2.1.13"
+mypy = "^1.15.0"
 
 [tool.pytest.ini_options]
 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

django_ctct-0.0.1.dev1/django_ctct/management/commands/import_ctct.py

@@ -1,211 +0,0 @@
-from argparse import ArgumentParser
-from collections import defaultdict
-from operator import attrgetter
-from typing import Optional
-
-from tqdm import tqdm
-
-from django.core.management.base import BaseCommand
-
-from django_ctct.models import (
-  CTCTModel, CustomField,
-  ContactList, Contact,
-  EmailCampaign, CampaignActivity,
-)
-
-
-class Command(BaseCommand):
-  """Imports django-ctct model instances from CTCT servers.
-
-  Notes
-  -----
-  CTCT does not provide an endpoint for fetching bulk CampaignActivities.
-  As a result, we must loop through the EmailCampaigns, make a request to get
-  the associated CampaignActivities, and then make a second request to get the
-  details of the CampaignActivity.
-
-  As a result, importing CampaignActivities will be slow, and running it
-  multiple times may result in exceeding CTCT's 10,000 requests per day
-  limit.
-
-  """
-
-  help = 'Imports data from ConstantContact'
-
-  CTCT_MODELS = [
-    ContactList,
-    CustomField,
-    Contact,
-    EmailCampaign,
-    CampaignActivity,
-  ]
-
-  def upsert(
-    self,
-    model: CTCTModel,
-    objs: list[CTCTModel],
-    unique_fields: list[str] = ['api_id'],
-    update_fields: Optional[list[str]] = None,
-    silent: bool = False,
-  ) -> list[CTCTModel]:
-
-    verb = 'Imported' if (update_fields is None) else 'Updated'
-
-    # TODO: is_through_model depreciated
-    if getattr(model, 'is_through_model', False):
-      breakpoint()
-      model.objects.all().delete()
-      objs = model.objects.bulk_create(objs)
-    else:
-      # Perform upsert using `bulk_create()`
-      if update_fields is None:
-        update_fields = [
-          f.name
-          for f in model._meta.fields
-          if not f.primary_key and (f.name != 'api_id')
-        ]
-
-      objs = model.objects.bulk_create(
-        objs=objs,
-        update_conflicts=True,
-        unique_fields=unique_fields,
-        update_fields=update_fields,
-      )
-
-    # Inform the user
-    if not silent:
-      message = self.style.SUCCESS(
-        f'{verb} {len(objs)} {model.__name__} instances.'
-      )
-      self.stdout.write(message)
-
-    return objs
-
-  def import_model(self, model: CTCTModel) -> None:
-    """Imports objects from CTCT into Django's database."""
-
-    if model is CampaignActivity:
-      return self.import_campaign_activities()
-
-    model.remote.connect()
-    try:
-      objs, related_objs = zip(*model.remote.all())
-    except ValueError:
-      # No values returned
-      return
-
-    # Upsert models to get Django pks
-    objs_w_pks = self.upsert(model, objs)
-
-    for obj, related_objs in zip(objs_w_pks, related_objs):
-      for related_model, objs in related_objs.items():
-
-        # TODO:
-        if related_model.__name__ == 'Contact_list_memberships':
-          continue
-
-        # Set the parent object pk
-        for field in related_model._meta.get_fields():
-          if getattr(field.remote_field, 'model', None) is model:
-            [setattr(o, field.attname, obj.pk) for o in objs]
-
-        # Upsert now that parent object pk has been set
-        objs = self.upsert(related_model, objs, silent=True)
-
-  def import_campaign_activities(self) -> None:
-    """Imports CampaignActivities from CTCT into Django's database."""
-
-    objs, related_objs = [], defaultdict(list)
-
-    EmailCampaign.remote.connect()
-    CampaignActivity.remote.connect()
-
-    # Use the EmailCampaign detail endpoint to get CampaignActivity api_ids
-    for campaign in tqdm(EmailCampaign.objects.exclude(api_id=None)):
-      _, _related_objs = EmailCampaign.remote.get(campaign.api_id)
-
-      # Now we use the CampaignActivity detail endpoint to get remaining fields
-      primary_emails = filter(
-        lambda obj: obj.role == 'primary_email',
-        _related_objs.get(CampaignActivity, [])
-      )
-      for api_id in map(attrgetter('api_id'), primary_emails):
-        obj, _related_objs = CampaignActivity.remote.get(api_id)
-        obj.campaign_id = campaign.pk
-
-        # Store objects for later
-        # NOTE We updated `related_obj` with the values from `_related_objs`
-        for related_model, instances in _related_objs.items():
-          related_objs[related_model].extend(instances)
-        if obj is not None:
-          objs.append(obj)
-
-    # Upsert objects and related objects
-    objs = self.upsert(
-      model=CampaignActivity,
-      objs=objs,
-      unique_fields=['campaign_id', 'role'],
-      update_fields=['role', 'subject', 'preheader', 'html_content']
-    )
-
-    for related_model, objs in related_objs.items():
-      # TODO:
-      if related_model.__name__ == 'CampaignActivity_contact_lists':
-        continue
-      objs = self.upsert(related_model, objs)
-
-  def import_campaign_stats(self) -> None:
-    """"Imports EmailCampaign stats from CTCT into Django's database."""
-
-    endpoint = '/reports/summary_reports/email_campaign_summaries'
-    update_fields = [
-      'current_status', 'created_at', 'updated_at', 'scheduled_datetime',
-      'sends', 'opens', 'clicks', 'forwards',
-      'optouts', 'abuse', 'bounces', 'not_opened',
-    ]
-
-    EmailCampaign.remote.connect()
-    try:
-      objs, _ = zip(*EmailCampaign.remote.all(endpoint=endpoint))
-    except ValueError:
-      # No values returned
-      return
-    else:
-      objs = self.upsert(EmailCampaign, objs, update_fields=update_fields)
-
-  def add_arguments(self, parser: ArgumentParser) -> None:
-    """Allow optional keyword arguments."""
-
-    parser.add_argument(
-      '--noinput',
-      action='store_true',
-      default=False,
-      help='Automatic yes to prompts',
-    )
-    parser.add_argument(
-      '--stats_only',
-      action='store_true',
-      default=False,
-      help='Only fetch EmailCampaign statistics',
-    )
-
-  def handle(self, *args, **kwargs):
-    """Primary access point for Django management command."""
-
-    self.noinput = kwargs['noinput']
-    self.stats_only = kwargs['stats_only']
-
-    if self.stats_only:
-      self.CTCT_MODELS = []
-
-    for model in self.CTCT_MODELS:
-      question = f'Import {model.__name__}? (y/n): '
-      if self.noinput or (input(question).lower()[0] == 'y'):
-        self.import_model(model)
-      else:
-        message = f'Skipping {model.__name__}'
-        self.stdout.write(self.style.NOTICE(message))
-
-    question = 'Update EmailCampaign statistics? (y/n): '
-    if self.noinput or (input(question).lower()[0] == 'y'):
-      self.import_campaign_stats()