Postmark: support "clicked" tracking events

Handle Postmark's new click webhook.

Closes #78

Author: medmunds

anymail/webhooks/postmark.py

@@ -49,7 +49,7 @@ class PostmarkTrackingWebhookView(PostmarkBaseWebhookView):
         'DMARCPolicy': (EventType.REJECTED, RejectReason.BLOCKED),
         'TemplateRenderingFailed': (EventType.FAILED, None),
         # DELIVERED doesn't have a Type field; detected separately below
-        # CLICKED doesn't have a Postmark webhook (yet?)
+        # CLICKED doesn't have a Type field; detected separately below
         # OPENED doesn't have a Type field; detected separately below
         # INBOUND doesn't have a Type field; should come in through different webhook
     }
@@ -62,6 +62,8 @@ def esp_to_anymail_event(self, esp_event):
         except KeyError:
             if 'FirstOpen' in esp_event:
                 event_type = EventType.OPENED
+            elif 'OriginalLink' in esp_event:
+                event_type = EventType.CLICKED
             elif 'DeliveredAt' in esp_event:
                 event_type = EventType.DELIVERED
             elif 'From' in esp_event:
@@ -103,4 +105,5 @@ def esp_to_anymail_event(self, esp_event):
             tags=tags,
             timestamp=timestamp,
             user_agent=esp_event.get('UserAgent', None),
+            click_url=esp_event.get('OriginalLink', None),
         )

docs/esps/postmark.rst

@@ -191,8 +191,9 @@ If you use multiple Postmark servers, you'll need to repeat entering the webhook
 settings for each of them.
 
 Postmark will report these Anymail :attr:`~anymail.signals.AnymailTrackingEvent.event_type`\s:
-rejected, failed, bounced, deferred, delivered, autoresponded, opened, complained,
-unsubscribed, subscribed. (Postmark does not support sent or clicked events.)
+rejected, failed, bounced, deferred, delivered, autoresponded, opened, clicked, complained,
+unsubscribed, subscribed. (Postmark does not support sent--what it calls "processed"--events
+through webhooks.)
 
 The event's :attr:`~anymail.signals.AnymailTrackingEvent.esp_event` field will be
 a `dict` of Postmark `delivery <http://developer.postmarkapp.com/developer-delivery-webhook.html>`_,

tests/test_postmark_webhooks.py

@@ -1,7 +1,7 @@
 import json
 from datetime import datetime
 
-from django.utils.timezone import get_fixed_timezone
+from django.utils.timezone import get_fixed_timezone, utc
 from mock import ANY
 
 from anymail.signals import AnymailTrackingEvent
@@ -109,3 +109,52 @@ def test_open_event(self):
         self.assertEqual(event.user_agent, "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0")
         self.assertEqual(event.tags, [])
         self.assertEqual(event.metadata, {})
+
+    def test_click_event(self):
+        raw_event = {
+            "ClickLocation": "HTML",
+            "Client": {
+                "Name": "Chrome 35.0.1916.153",
+                "Company": "Google",
+                "Family": "Chrome"
+            },
+            "OS": {
+                "Name": "OS X 10.7 Lion",
+                "Company": "Apple Computer, Inc.",
+                "Family": "OS X 10"
+            },
+            "Platform": "Desktop",
+            "UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) etc.",
+            "OriginalLink": "https://example.com/click/me",
+            "Geo": {
+                "CountryISOCode": "RS",
+                "Country": "Serbia",
+                "RegionISOCode": "VO",
+                "Region": "Autonomna Pokrajina Vojvodina",
+                "City": "Novi Sad",
+                "Zip": "21000",
+                "Coords": "45.2517,19.8369",
+                "IP": "8.8.8.8"
+            },
+            "MessageID": "f4830d10-9c35-4f0c-bca3-3d9b459821f8",
+            "ReceivedAt": "2017-10-25T15:21:11.9065619Z",
+            "Tag": "welcome-email",
+            "Recipient": "[email protected]"
+        }
+        response = self.client.post('/anymail/postmark/tracking/',
+                                    content_type='application/json', data=json.dumps(raw_event))
+        self.assertEqual(response.status_code, 200)
+        kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=PostmarkTrackingWebhookView,
+                                                      event=ANY, esp_name='Postmark')
+        event = kwargs['event']
+        self.assertIsInstance(event, AnymailTrackingEvent)
+        self.assertEqual(event.event_type, "clicked")
+        self.assertEqual(event.esp_event, raw_event)
+        self.assertEqual(event.timestamp, datetime(2017, 10, 25, 15, 21, 11, microsecond=906561,
+                                                   tzinfo=utc))
+        self.assertEqual(event.message_id, "f4830d10-9c35-4f0c-bca3-3d9b459821f8")
+        self.assertEqual(event.recipient, "[email protected]")
+        self.assertEqual(event.user_agent, "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) etc.")
+        self.assertEqual(event.click_url, "https://example.com/click/me")
+        self.assertEqual(event.tags, ["welcome-email"])
+        self.assertEqual(event.metadata, {})