[TOOLSLIBS-441] Subscription lists (#182)

* wires up SubscriptionList

* adds SubscriptionList and url

* wires up new audience types

* adds subscription_list and static_list audience

* adds subscription_list tests

Author: aschuman0

tests/devices/test_subscription_list.py

@@ -0,0 +1,40 @@
+import datetime
+import mock
+import unittest
+import json
+
+import requests
+
+import urbanairship as ua
+from tests import TEST_KEY, TEST_SECRET
+from urbanairship.push import audience
+
+
+class TestSubscriptionList(unittest.TestCase):
+    def setUp(self):
+        self.airship = ua.Airship(TEST_KEY, TEST_SECRET)
+        self.ios_channel = ua.ios_channel("b8f9b663-0a3b-cf45-587a-be880946e881")
+
+    def test_list_subscribe(self):
+        with mock.patch.object(ua.Airship, "_request") as mock_request:
+            response = requests.Response()
+            response._content = json.dumps({"ok": True}).encode("utf-8")
+            mock_request.return_value = response
+
+            sub_list = ua.SubscriptionList(airship=self.airship, list_id="test_list")
+
+            results = sub_list.subscribe(audience=self.ios_channel)
+
+            self.assertEqual(results.json(), {"ok": True})
+
+    def test_list_unsubscribe(self):
+        with mock.patch.object(ua.Airship, "_request") as mock_request:
+            response = requests.Response()
+            response._content = json.dumps({"ok": True}).encode("utf-8")
+            mock_request.return_value = response
+
+            sub_list = ua.SubscriptionList(airship=self.airship, list_id="test_list")
+
+            results = sub_list.unsubscribe(audience=self.ios_channel)
+
+            self.assertEqual(results.json(), {"ok": True})

urbanairship/__init__.py

@@ -30,6 +30,7 @@
     Sms,
     StaticList,
     StaticLists,
+    SubscriptionList,
 )
 from .experiments import ABTest, Experiment, Variant
 from .push import (
@@ -78,6 +79,8 @@
     recent_date,
     recurring_schedule,
     schedule_exclusion,
+    static_list,
+    subscription_list,
     scheduled_time,
     segment,
     sms,
@@ -160,6 +163,10 @@
     best_time,
     named_user,
     merge_data,
+    recurring_schedule,
+    schedule_exclusion,
+    static_list,
+    subscription_list,
     ChannelList,
     ChannelInfo,
     OpenChannel,
@@ -206,6 +213,7 @@
     WebResponseReport,
     ExperimentReport,
     KeywordInteraction,
+    SubscriptionList,
 ]
 
 

urbanairship/core.py

@@ -35,6 +35,7 @@ def __init__(self, location=None):
         self.location_url = self.base_url + "location/"
         self.attributes_url = self.channel_url + "attributes/"
         self.message_center_delete_url = self.base_url + "user/messages/"
+        self.subscription_lists_url = self.channel_url + "subscription_lists/"
 
         self.templates_url = self.base_url + "templates/"
         self.schedule_template_url = self.templates_url + "schedules/"

urbanairship/devices/__init__.py

@@ -9,3 +9,4 @@
 from .segment import Segment, SegmentList
 from .sms import Sms, KeywordInteraction
 from .static_lists import StaticList, StaticLists
+from .subscription_lists import SubscriptionList

urbanairship/devices/subscription_lists.py

@@ -0,0 +1,59 @@
+import json
+
+
+class SubscriptionList(object):
+    """
+    Subscribe or unsubscribe channels to/from Subscription lists. These lists must
+        be created in the Airship web dashboard prior to making these calls. The
+        value for list_id can be found after creating these lists.
+
+    :param airship: Required. An urbanairship.Airship instance.
+    :param list_id: Required. The list_id from the Airship web dashboard.
+    """
+
+    def __init__(self, airship, list_id):
+        self.airship = airship
+        self.list_id = list_id
+
+    def unsubscribe(self, audience):
+        """
+        Unsubscribe an audience from a subscription list.
+
+        :param audience: Required. A single audience selector (ex:
+            urbanairship.ios_channel) to unsubscribe.
+        """
+        payload = {
+            "subscription_lists": {"action": "unsubscribe", "list_id": self.list_id},
+            "audience": audience,
+        }
+
+        response = self.airship.request(
+            method="POST",
+            body=json.dumps(payload).encode("utf-8"),
+            url=self.airship.urls.get("subscription_lists_url"),
+            version=3,
+        )
+
+        return response
+
+    def subscribe(self, audience):
+        """
+        Subscribe an audience from a subscription list.
+
+        :param list_id: Required. The list_id from the Airship web dashboard.
+        :param audience: Required. A single audience selector (ex:
+            urbanairship.ios_channel) to subscribe.
+        """
+        payload = {
+            "subscription_lists": {"action": "subscribe", "list_id": self.list_id},
+            "audience": audience,
+        }
+
+        response = self.airship.request(
+            method="POST",
+            body=json.dumps(payload).encode("utf-8"),
+            url=self.airship.urls.get("subscription_lists_url"),
+            version=3,
+        )
+
+        return response

urbanairship/push/__init__.py

@@ -19,6 +19,8 @@
     segment,
     sms_id,
     sms_sender,
+    subscription_list,
+    static_list,
     tag,
     tag_group,
     text_attribute,
@@ -123,4 +125,6 @@
     merge_data,
     text_attribute,
     number_attribute,
+    static_list,
+    subscription_list,
 ]

urbanairship/push/audience.py

@@ -117,6 +117,14 @@ def named_user(name):
     return {"named_user": name}
 
 
+def subscription_list(list_id):
+    return {"subscription_lists": list_id}
+
+
+def static_list(list_id):
+    return {"static_list": list_id}
+
+
 # Attribute selectors
 def date_attribute(attribute, operator, precision=None, value=None):
     """