Support sending transactional push messages (#95)

Author: clabland

.github/workflows/main.yml

@@ -4,22 +4,16 @@ on: [ push ]
 
 jobs:
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python: [ '3.7', '3.6', '3.9','3.8' ]
+        python: [ '3.6', '3.7', '3.8','3.9' ]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python }}
-    # - uses: actions/cache@v2
-    #   with:
-    #     path: ./venv
-    #     key: customerio-python-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}
-    #     restore-keys: |
-    #       customerio-python-${{ matrix.python }}-
     - name: install dependencies for the minor version
       run: |
         python -m venv venv

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.1]
+### Added
+- Add support for sending [transactional push messages](https://customer.io/docs/transactional-api/#transactional-push-notifications) ([#95](https://github.com/customerio/customerio-python/pull/95))
+
 ## [2.0]
 ### Changed
 - Updated transactional email request optional argument `amp_body` to `body_amp` for consistency across APIs ([#93](https://github.com/customerio/customerio-python/pull/93))
@@ -34,4 +38,4 @@
 
 ### Changed
 - ID fields in request path are url escaped
-- Sanitize event data ([#32](https://github.com/customerio/customerio-python/pull/32))
+- Sanitize event data ([#32](https://github.com/customerio/customerio-python/pull/32))

README.md

@@ -188,8 +188,11 @@ See REST documentation [here](https://learn.customer.io/api/#apisuppress_delete)
 
 ### Send Transactional Messages
 
-To use the [Transactional API](https://customer.io/docs/transactional-api), instantiate the Customer.io object using an [app key](https://customer.io/docs/managing-credentials#app-api-keys) and create a request object containing:
+To use the [Transactional API](https://customer.io/docs/transactional-api), instantiate the Customer.io object using an [app key](https://customer.io/docs/managing-credentials#app-api-keys) and create a request object for your message type.
 
+## Email
+
+SendEmailRequest requires:
 * `transactional_message_id`: the ID of the transactional message you want to send, or the `body`, `from`, and `subject` of a new message.
 * `to`: the email address of your recipients 
 * an `identifiers` object containing the `id` of your recipient. If the `id` does not exist, Customer.io will create it.
@@ -226,6 +229,38 @@ response = client.send_email(request)
 print(response)
 ```
 
+## Push
+
+SendPushRequest requires:
+* `transactional_message_id`: the ID of the transactional push message you want to send.
+* an `identifiers` object containing the `id` or `email` of your recipient. If the profile does not exist, Customer.io will create it.
+
+Use `send_push` referencing your request to send a transactional message. [Learn more about transactional messages and `SendPushRequest` properties](https://customer.io/docs/transactional-api).
+
+```python
+from customerio import APIClient, Regions, SendPushRequest
+client = APIClient("your API key", region=Regions.US)
+
+request = SendPushRequest(
+  transactional_message_id="3",
+  message_data={
+    "name": "person",
+    "items": [
+      {
+        "name": "shoes",
+        "price": "59.99",
+      },
+    ]
+  },
+  identifiers={
+    "id": "2",
+  }
+)
+
+response = client.send_push(request)
+print(response)
+```
+
 ## Notes
 - The Customer.io Python SDK depends on the [`Requests`](https://pypi.org/project/requests/) library which includes [`urllib3`](https://pypi.org/project/urllib3/) as a transitive dependency.  The [`Requests`](https://pypi.org/project/requests/) library leverages connection pooling defined in [`urllib3`](https://pypi.org/project/urllib3/).  [`urllib3`](https://pypi.org/project/urllib3/) only attempts to retry invocations of `HTTP` methods which are understood to be idempotent (See: [`Retry.DEFAULT_ALLOWED_METHODS`](https://github.com/urllib3/urllib3/blob/main/src/urllib3/util/retry.py#L184)).  Since the `POST` method is not considered to be idempotent, any invocations which require `POST` are not retried.
 

customerio/__init__.py

@@ -2,5 +2,5 @@
 
 from customerio.client_base import CustomerIOException
 from customerio.track import CustomerIO
-from customerio.api import APIClient, SendEmailRequest
+from customerio.api import APIClient, SendEmailRequest, SendPushRequest
 from customerio.regions import Regions

customerio/__version__.py

@@ -1,4 +1,4 @@
-VERSION = (2, 0, 0, 'final', 0)
+VERSION = (2, 1, 0, 'final', 0)
 
 def get_version():
     version = '%s.%s' % (VERSION[0], VERSION[1])

customerio/api.py

@@ -22,6 +22,12 @@ def send_email(self, request):
         resp = self.send_request('POST', self.url + "/v1/send/email", request)
         return json.loads(resp)
 
+    def send_push(self, request):
+        if isinstance(request, SendPushRequest):
+            request = request._to_dict()
+        resp = self.send_request('POST', self.url + "/v1/send/push", request)
+        return json.loads(resp)
+
     # builds the session.
     def _build_session(self):
         session = super()._build_session()
@@ -30,7 +36,7 @@ def _build_session(self):
         return session
 
 class SendEmailRequest(object):
-    '''An object with all the options avaiable for triggering a transactional message'''
+    '''An object with all the options avaiable for triggering a transactional email message'''
     def __init__(self,
             transactional_message_id=None,
             to=None,
@@ -96,7 +102,7 @@ def attach(self, name, content, encode=True):
         self.attachments[name] = content
 
     def _to_dict(self):
-        '''Build a request payload fromt the object'''
+        '''Build a request payload from the object'''
         field_map = dict(
             # from is reservered keyword hence the object has the field
             # `_from` but in the request payload we map it to `from`
@@ -132,3 +138,76 @@ def _to_dict(self):
                 data[name] = value
 
         return data
+
+class SendPushRequest(object):
+    '''An object with all the options avaiable for triggering a transactional push message'''
+    def __init__(self,
+            transactional_message_id=None,
+            to=None,
+            identifiers=None,
+            title=None,
+            message=None,
+            disable_message_retention=None,
+            send_to_unsubscribed=None,
+            queue_draft=None,
+            message_data=None,
+            send_at=None,
+            language=None,
+            image_url=None,
+            link=None,
+            custom_data=None,
+            custom_payload=None,
+            device=None,
+            sound=None
+        ):
+
+        self.transactional_message_id = transactional_message_id
+        self.to = to
+        self.identifiers = identifiers
+        self.disable_message_retention = disable_message_retention
+        self.send_to_unsubscribed = send_to_unsubscribed
+        self.queue_draft = queue_draft
+        self.message_data = message_data
+        self.send_at = send_at
+        self.language = language
+
+        self.title = title
+        self.message = message
+        self.image_url = image_url
+        self.link = link
+        self.custom_data = custom_data
+        self.custom_payload = custom_payload
+        self.device = device
+        self.sound = sound
+
+    def _to_dict(self):
+        '''Build a request payload from the object'''
+        field_map = dict(
+            # field name is the same as the payload field name
+            transactional_message_id="transactional_message_id",
+            to="to",
+            identifiers="identifiers",
+            disable_message_retention="disable_message_retention",
+            send_to_unsubscribed="send_to_unsubscribed",
+            queue_draft="queue_draft",
+            message_data="message_data",
+            send_at="send_at",
+            language="language",
+
+            title="title",
+            message="message",
+            image_url="image_url",
+            link="link",
+            custom_data="custom_data",
+            custom_payload="custom_payload",
+            device="custom_device",
+            sound="sound"
+        )
+
+        data = {}
+        for field, name in field_map.items():
+            value = getattr(self, field, None)
+            if value is not None:
+                data[name] = value
+
+        return data

tests/test_api.py

@@ -5,7 +5,7 @@
 import sys
 import unittest
 
-from customerio import APIClient, SendEmailRequest, Regions, CustomerIOException
+from customerio import APIClient, SendEmailRequest, SendPushRequest, Regions, CustomerIOException
 from customerio.__version__ import __version__ as ClientVersion
 from tests.server import HTTPSTestCase
 
@@ -77,5 +77,23 @@ def test_send_email(self):
 
         self.client.send_email(email)
 
+    def test_send_push(self):
+        self.client.http.hooks = dict(response=partial(self._check_request, rq={
+            'method': 'POST',
+            'authorization': "Bearer app_api_key",
+            'content_type': 'application/json',
+            'url_suffix': '/v1/send/push',
+            'body': {"identifiers": {"id":"customer_1"}, "transactional_message_id": 100, "title": "transactional push message", "message": "push message content"}
+        }))
+
+        push = SendPushRequest(
+            identifiers={"id":"customer_1"},
+            transactional_message_id=100,
+            title="transactional push message",
+            message="push message content"
+        )
+
+        self.client.send_push(push)
+
 if __name__ == '__main__':
     unittest.main()