[TOOLSLIBS-408] sms & mms updates (#175)

* rm isort for real

* adds mms override and test

* deurban

* adds sms keyword interaction

* rm unneeded var

* adds shorten_links to sms override

Author: aschuman0

.pre-commit-config.yaml

@@ -11,10 +11,6 @@ repos:
     rev: 19.3b0
     hooks:
     -   id: black
--   repo: https://github.com/timothycrosley/isort
-    rev: 4.3.21
-    hooks:
-      - id: isort
 -   repo: https://github.com/codespell-project/codespell
     rev: v1.16.0
     hooks:

tests/devices/test_sms.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 import json
 import mock
 import unittest
@@ -56,11 +57,7 @@ def test_sms_opt_out(self):
 
         with mock.patch.object(ua.Airship, "_request") as mock_request:
             response = requests.Response()
-            response._content = json.dumps(
-                {
-                    "ok": True,
-                }
-            ).encode("utf-8")
+            response._content = json.dumps({"ok": True}).encode("utf-8")
             response.status_code = 202
             mock_request.return_value = response
 
@@ -77,11 +74,7 @@ def test_sms_uninstall(self):
 
         with mock.patch.object(ua.Airship, "_request") as mock_request:
             response = requests.Response()
-            response._content = json.dumps(
-                {
-                    "ok": True,
-                }
-            ).encode("utf-8")
+            response._content = json.dumps({"ok": True}).encode("utf-8")
             response.status_code = 202
             mock_request.return_value = response
 
@@ -129,3 +122,31 @@ def test_sms_lookup(self):
             r = sms_obj.lookup()
 
             self.assertTrue(r.ok)
+
+
+class TestSmsKeywordInteraction(unittest.TestCase):
+    def setUp(self):
+        self.airship = ua.Airship(TEST_KEY, TEST_SECRET)
+        self.sender_ids = ["12345", "09876"]
+        self.msisdn = "15035556789"
+        self.keyword = "from_a_motel_six"
+        self.timestamp = datetime(2014, 10, 8, 12, 0, 0)
+        self.interaction = ua.KeywordInteraction(
+            airship=self.airship,
+            keyword=self.keyword,
+            msisdn=self.msisdn,
+            sender_ids=self.sender_ids,
+            timestamp=self.timestamp,
+        )
+
+    def test_payload(self):
+        self.assertEqual(
+            self.interaction.payload,
+            {"keyword": self.keyword, "sender_ids": self.sender_ids},
+        )
+
+    def test_url(self):
+        self.assertEqual(
+            self.interaction.url,
+            "https://go.urbanairship.com/api/sms/15035556789/keywords",
+        )

tests/push/test_push.py

@@ -349,7 +349,11 @@ def test_sms_overrides(self):
         p.audience = ua.all_
         p.notification = ua.notification(
             alert="top level alert",
-            sms=ua.sms(alert="sms override alert", expiry="2018-04-01T12:00:00"),
+            sms=ua.sms(
+                alert="sms override alert",
+                expiry="2018-04-01T12:00:00",
+                shorten_links=True,
+            ),
         )
         p.device_types = ua.device_types("sms")
 
@@ -363,11 +367,44 @@ def test_sms_overrides(self):
                     "sms": {
                         "alert": "sms override alert",
                         "expiry": "2018-04-01T12:00:00",
+                        "shorten_links": True,
                     },
                 },
             },
         )
 
+    def test_mms_overrides(self):
+        mms_payload = ua.mms(
+            fallback_text="an airbag saved my life",
+            content_type="image/gif",
+            url="https://c.tenor.com/ZhKMg4_yCTgAAAAC/surprised-pikachu.gif",
+            shorten_links=True,
+            content_length=1000,
+            text="hey man slow down",
+            subject="this is what you get",
+        )
+
+        self.assertEqual(
+            mms_payload,
+            {
+                "mms": {
+                    "subject": "this is what you get",
+                    "fallback_text": "an airbag saved my life",
+                    "shorten_links": True,
+                    "slides": [
+                        {
+                            "text": "hey man slow down",
+                            "media": {
+                                "url": "https://c.tenor.com/ZhKMg4_yCTgAAAAC/surprised-pikachu.gif",
+                                "content_type": "image/gif",
+                                "content_length": 1000,
+                            },
+                        }
+                    ],
+                }
+            },
+        )
+
     def test_email_overrides(self):
         p = ua.Push(None)
         p.audience = ua.all_

urbanairship/__init__.py

@@ -1,33 +1,109 @@
-"""Python package for using the Urban Airship API"""
+"""Python package for using the Airship API"""
 import logging
 
 from .automation import Automation, Pipeline
 from .common import AirshipFailure, Unauthorized
 from .core import Airship
-from .devices import (APIDList, Attribute, AttributeResponse, ChannelInfo,
-                      ChannelList, ChannelTags, ChannelUninstall, DeviceInfo,
-                      DeviceTokenList, Email, EmailAttachment, EmailTags,
-                      LocationFinder, ModifyAttributes, NamedUser,
-                      NamedUserList, NamedUserTags, OpenChannel,
-                      OpenChannelTags, Segment, SegmentList, Sms, StaticList,
-                      StaticLists)
+from .devices import (
+    APIDList,
+    Attribute,
+    AttributeResponse,
+    ChannelInfo,
+    ChannelList,
+    ChannelTags,
+    ChannelUninstall,
+    DeviceInfo,
+    DeviceTokenList,
+    Email,
+    EmailAttachment,
+    EmailTags,
+    KeywordInteraction,
+    LocationFinder,
+    ModifyAttributes,
+    NamedUser,
+    NamedUserList,
+    NamedUserTags,
+    OpenChannel,
+    OpenChannelTags,
+    Segment,
+    SegmentList,
+    Sms,
+    StaticList,
+    StaticLists,
+)
 from .experiments import ABTest, Experiment, Variant
-from .push import (CreateAndSendPush, Push, ScheduledList, ScheduledPush,
-                   Template, TemplateList, TemplatePush, absolute_date,
-                   actions, alias, all_, amazon, amazon_channel, and_, android,
-                   android_channel, apid, best_time, campaigns, channel,
-                   date_attribute, device_token, device_types, email, in_app,
-                   interactive, ios, ios_channel, local_scheduled_time,
-                   location, merge_data, message, named_user, not_,
-                   notification, number_attribute, open_channel, open_platform,
-                   options, or_, public_notification, recent_date,
-                   scheduled_time, segment, sms, sms_id, sms_sender, style,
-                   tag, tag_group, text_attribute, wearable, web, wns,
-                   wns_payload)
-from .reports import (AppOpensList, CustomEventsList, DevicesReport,
-                      ExperimentReport, IndividualResponseStats, OptInList,
-                      OptOutList, PushList, ResponseList, ResponseReportList,
-                      TimeInAppList, WebResponseReport)
+from .push import (
+    CreateAndSendPush,
+    Push,
+    ScheduledList,
+    ScheduledPush,
+    Template,
+    TemplateList,
+    TemplatePush,
+    absolute_date,
+    actions,
+    alias,
+    all_,
+    amazon,
+    amazon_channel,
+    and_,
+    android,
+    android_channel,
+    apid,
+    best_time,
+    campaigns,
+    channel,
+    date_attribute,
+    device_token,
+    device_types,
+    email,
+    in_app,
+    interactive,
+    ios,
+    ios_channel,
+    local_scheduled_time,
+    location,
+    merge_data,
+    message,
+    mms,
+    named_user,
+    not_,
+    notification,
+    number_attribute,
+    open_channel,
+    open_platform,
+    options,
+    or_,
+    public_notification,
+    recent_date,
+    scheduled_time,
+    segment,
+    sms,
+    sms_id,
+    sms_sender,
+    style,
+    tag,
+    tag_group,
+    text_attribute,
+    wearable,
+    web,
+    wns,
+    wns_payload,
+)
+from .reports import (
+    AppOpensList,
+    CustomEventsList,
+    DevicesReport,
+    ExperimentReport,
+    IndividualResponseStats,
+    OptInList,
+    OptOutList,
+    PushList,
+    ResponseList,
+    ResponseReportList,
+    TimeInAppList,
+    WebResponseReport,
+)
 
 __all__ = [
     Airship,
@@ -51,6 +127,7 @@
     segment,
     sms_id,
     sms_sender,
+    mms,
     and_,
     or_,
     not_,
@@ -126,6 +203,7 @@
     ModifyAttributes,
     WebResponseReport,
     ExperimentReport,
+    KeywordInteraction,
 ]
 
 

urbanairship/devices/__init__.py

@@ -7,5 +7,5 @@
 from .named_users import NamedUser, NamedUserList, NamedUserTags
 from .open_channel import OpenChannel
 from .segment import Segment, SegmentList
-from .sms import Sms
+from .sms import Sms, KeywordInteraction
 from .static_lists import StaticList, StaticLists

urbanairship/devices/sms.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 import json
 import logging
 import re
@@ -14,7 +15,7 @@ class Sms(object):
 
     :param airship: Required. An urbanairship.Airship object instantiated with
         master authentication.
-    :param sender: Required. The a number that recipients will recieve SMS
+    :param sender: Required. The a number that recipients will receive SMS
         notifications from. This must match your Urban Airship configuration.
     :param msisdn: Required. The mobile phone number you want to register as
         an SMS channel (or send a request to opt-in).
@@ -66,17 +67,11 @@ def msisdn(self, value):
 
     @property
     def common_payload(self):
-        return {
-            "sender": self.sender,
-            "msisdn": self.msisdn,
-        }
+        return {"sender": self.sender, "msisdn": self.msisdn}
 
     @property
     def create_and_send_audience(self):
-        audience = {
-            "ua_sender": self.sender,
-            "ua_msisdn": self.msisdn,
-        }
+        audience = {"ua_sender": self.sender, "ua_msisdn": self.msisdn}
 
         if self.template_fields:
             audience.update(self.template_fields)
@@ -181,3 +176,43 @@ def lookup(self):
         response = self.airship.request(method="GET", body=None, url=url, version=3)
 
         return response
+
+
+class KeywordInteraction(object):
+    def __init__(self, airship, keyword, msisdn, sender_ids, timestamp=None):
+        self.airship = airship
+        self.keyword = keyword
+        self.msisdn = msisdn
+        self.sender_ids = sender_ids
+        self.timestamp = timestamp
+
+        if type(sender_ids) is not list:
+            raise ValueError("sender_ids must be a list")
+
+    @property
+    def timestamp(self):
+        return self._timestamp.replace(microsecond=0).isoformat()
+
+    @timestamp.setter
+    def timestamp(self, value):
+        if type(value) is not datetime and value is not None:
+            raise ValueError("timestamp must be a datetime object")
+
+        self._timestamp = value
+
+    @property
+    def payload(self):
+        return {"keyword": self.keyword, "sender_ids": self.sender_ids}
+
+    @property
+    def url(self):
+        return "{base_url}sms/{msisdn}/keywords".format(
+            base_url=self.airship.urls.get("base_url"), msisdn=self.msisdn
+        )
+
+    def post(self):
+        response = self.airship.request(
+            method="POST", url=self.url, body=self.payload, version=3
+        )
+
+        return response

urbanairship/push/__init__.py

@@ -36,6 +36,7 @@
     interactive,
     ios,
     message,
+    mms,
     notification,
     open_platform,
     options,
@@ -92,6 +93,7 @@
     amazon,
     web,
     sms,
+    mms,
     wns_payload,
     open_platform,
     message,