[TOOLSLIBS-434] SMS Custom Response (#191)

* wires up SmsCustomResponse

* adds custom response url

* adds custom response class

* adds SmsCustomResponse class

* typo fix

Author: aschuman0

tests/devices/test_sms.py

@@ -6,7 +6,7 @@
 import requests
 
 import urbanairship as ua
-from tests import TEST_KEY, TEST_SECRET
+from tests import TEST_KEY, TEST_SECRET, TEST_TOKEN
 
 
 class TestSMS(unittest.TestCase):
@@ -173,3 +173,70 @@ def test_url(self):
             self.interaction.url,
             "https://go.urbanairship.com/api/sms/15035556789/keywords",
         )
+
+
+class TestSmsCustomResponse(unittest.TestCase):
+    def setUp(self) -> None:
+        self.maxDiff = 2000
+        airship = ua.Airship(key=TEST_KEY, token=TEST_TOKEN)
+        self.mo_id = "886f53d4-3e0f-46d7-930e-c2792dac6e0a"
+        self.custom_response = ua.SmsCustomResponse(
+            airship=airship,
+            mobile_originated_id=self.mo_id,
+        )
+
+    def test_mms_payload(self):
+        self.custom_response.mms = ua.mms(
+            fallback_text="mms alert",
+            url="http://www.airship.com",
+            content_type="image/gif",
+            content_length=12345,
+            shorten_links=True,
+        )
+
+        self.assertEqual(
+            self.custom_response._payload,
+            {
+                "mobile_originated_id": self.mo_id,
+                "mms": {
+                    "fallback_text": "mms alert",
+                    "slides": [
+                        {
+                            "media": {
+                                "content_type": "image/gif",
+                                "url": "http://www.airship.com",
+                                "content_length": 12345,
+                            }
+                        }
+                    ],
+                    "shorten_links": True,
+                },
+            },
+        )
+
+    def test_sms_payload(self):
+        self.custom_response.sms = ua.sms(alert="sms alert", shorten_links=False)
+
+        self.assertEqual(
+            self.custom_response._payload,
+            {
+                "sms": {"alert": "sms alert", "shorten_links": False},
+                "mobile_originated_id": self.mo_id,
+            },
+        )
+
+    def test_neither_payload_raises(self):
+        with self.assertRaises(ValueError, msg="One of mms or sms must be set."):
+            self.custom_response._payload
+
+    def test_both_payloads_raises(self):
+        self.custom_response.sms = ua.sms(alert="test_alert")
+        self.custom_response.mms = ua.mms(
+            content_length=12345,
+            content_type="image/png",
+            fallback_text="test mms",
+            url="url",
+        )
+
+        with self.assertRaises(ValueError, msg="Cannot use both mms and sms."):
+            self.custom_response._payload

urbanairship/__init__.py

@@ -29,6 +29,7 @@
     Segment,
     SegmentList,
     Sms,
+    SmsCustomResponse,
     StaticList,
     StaticLists,
     SubscriptionList,

urbanairship/core.py

@@ -45,6 +45,7 @@ def __init__(self, location=None):
         self.sms_url = self.channel_url + "sms/"
         self.sms_opt_out_url = self.sms_url + "opt-out/"
         self.sms_uninstall_url = self.sms_url + "uninstall/"
+        self.sms_custom_response_url = self.base_url + "sms/custom-response/"
         self.email_url = self.channel_url + "email/"
         self.email_tags_url = self.email_url + "tags/"
         self.email_uninstall_url = self.email_url + "uninstall/"

urbanairship/devices/__init__.py

@@ -6,6 +6,6 @@
 from .named_users import NamedUser, NamedUserList, NamedUserTags
 from .open_channel import OpenChannel
 from .segment import Segment, SegmentList
-from .sms import Sms, KeywordInteraction
+from .sms import Sms, KeywordInteraction, SmsCustomResponse
 from .static_lists import StaticList, StaticLists
 from .subscription_lists import SubscriptionList

urbanairship/devices/sms.py

@@ -3,6 +3,7 @@
 import logging
 import re
 import sys
+from typing import Dict, Optional
 
 logger = logging.getLogger("urbanairship")
 
@@ -347,3 +348,82 @@ def post(self):
         )
 
         return response
+
+
+class SmsCustomResponse:
+    """Respond to a mobile originated message based on a keyword consumed by your
+    custom response webhook, using a mobile-originated ID. Please see the documentation
+    at https://docs.airship.com/api/ua/?http#operation-api-sms-custom-response-post for
+    details on use of this feature.
+
+    One of `mms` or `sms` is required.
+
+    :param airship: [required] An urbanairship.Airship instance, created with
+        bearer token authentication.
+    :param mobile_originated_id: [required] The identifier that you received through
+        your SMS webhook corresponding to the mobile-originated message that you're
+        issuing a custom response to.
+    :param sms: [optional] An SMS platform override object, created using
+        `ua.sms()`. This defines the message sent in response.
+    :param mms: [optional] An MMS platform override object, created using
+        `us.mms()`. The defines the message sent in response.
+    """
+
+    def __init__(
+        self,
+        airship,
+        mobile_originated_id: str,
+        sms: Optional[Dict] = None,
+        mms: Optional[Dict] = None,
+    ) -> None:
+        self.airship = airship
+        self.mobile_originated_id = mobile_originated_id
+        self.sms = sms
+        self.mms = mms
+
+    @property
+    def sms(self) -> Optional[Dict]:
+        return self._sms
+
+    @sms.setter
+    def sms(self, value: Optional[Dict]) -> None:
+        self._sms = value
+
+    @property
+    def mms(self) -> Optional[Dict]:
+        return self._mms
+
+    @mms.setter
+    def mms(self, value: Optional[Dict]) -> None:
+        self._mms = value
+
+    @property
+    def _payload(self) -> Dict:
+        if all((self.mms, self.sms)):
+            raise ValueError("Cannot use both mms and sms.")
+        if all((self.sms is None, self.mms is None)):
+            raise ValueError("One of mms or sms must be set.")
+
+        payload = {"mobile_originated_id": self.mobile_originated_id}
+
+        if self.sms is not None:
+            payload["sms"] = self.sms
+        if self.mms is not None:
+            payload.update(self.mms)
+
+        return payload
+
+    def send(self) -> Dict:
+        """Sends the response using the mobile_originated_id value
+
+        :return: An API response dictionary
+        """
+        response = self.airship.request(
+            method="POST",
+            body=json.dumps(self._payload),
+            url=self.airship.urls.get("sms_custom_response_url"),
+            content_type="application/json",
+            version=3,
+        )
+
+        return response.json()