[TOOLSLIBS-447] Attribute lists (#183)

* wires up AttributeList class

* adds attr list class

* adds attr list url

* adds test data and test class stub

* adds attribute list tests

* adds static list download classmethod

* rm name

Author: aschuman0

tests/data/attribute_list.csv

@@ -0,0 +1,5 @@
+channel_id,MISC_02,storeName
+c543f3a3-bc1d-4830-8dee-7532c6a23b9a,100,Basketball
+6ba360a0-1f73-4ee7-861e-95f6c1ed6410,,Basketball
+15410d17-687c-46fa-bbd9-f255741a1523,2,Football
+c2c64ef7-8f5c-470e-915f-f5e3da04e1df,22.1,Rugby

tests/devices/test_attributes.py

@@ -1,10 +1,14 @@
 import datetime
-from time import time
 import unittest
+import mock
+import json
+
+import requests
 
 import urbanairship as ua
 from tests import TEST_KEY, TEST_SECRET
 
+
 class TestAttribute(unittest.TestCase):
     def setUp(self):
         self.test_time = datetime.datetime.utcnow()
@@ -136,8 +140,7 @@ def test_attribute_alone(self):
     def test_no_devices(self):
         with self.assertRaises(ValueError) as err_ctx:
             ua.ModifyAttributes(
-                airship=self.test_airship,
-                attributes=[self.set_attribute],
+                airship=self.test_airship, attributes=[self.set_attribute]
             )
 
             self.assertEqual(
@@ -157,3 +160,48 @@ def test_both_devices(self):
                 err_ctx.message,
                 "Either channel or named_user must be included, not both",
             )
+
+
+class TestAttributeList(unittest.TestCase):
+    def setUp(self):
+        self.airship = ua.Airship(TEST_KEY, TEST_SECRET)
+        self.list_name = "my_test_list"
+        self.description = "this is my cool list"
+        self.extra = {"key": "value"}
+        self.file_path = "tests/data/attribute_list.csv"
+        self.attr_list = ua.AttributeList(
+            airship=self.airship,
+            list_name=self.list_name,
+            description=self.description,
+            extra=self.extra,
+        )
+
+    def test_create(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
+
+            result = self.attr_list.create()
+
+            self.assertEqual(result.json(), {"ok": True})
+
+    def test_upload(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
+
+            result = self.attr_list.upload(file_path=self.file_path)
+
+            self.assertEqual(result.json(), {"ok": True})
+
+    def test_create_payload_property(self):
+        self.assertEqual(
+            self.attr_list._create_payload,
+            {
+                "name": self.list_name,
+                "description": self.description,
+                "extra": self.extra,
+            },
+        )

urbanairship/__init__.py

@@ -8,6 +8,7 @@
     APIDList,
     Attribute,
     AttributeResponse,
+    AttributeList,
     ChannelInfo,
     ChannelList,
     ChannelTags,
@@ -210,6 +211,7 @@
     OpenChannelTags,
     Attribute,
     AttributeResponse,
+    AttributeList,
     ModifyAttributes,
     WebResponseReport,
     ExperimentReport,

urbanairship/core.py

@@ -34,6 +34,7 @@ def __init__(self, location=None):
         self.lists_url = self.base_url + "lists/"
         self.location_url = self.base_url + "location/"
         self.attributes_url = self.channel_url + "attributes/"
+        self.attributes_list_url = self.base_url + "attribute-lists/"
         self.message_center_delete_url = self.base_url + "user/messages/"
         self.subscription_lists_url = self.channel_url + "subscription_lists/"
 
@@ -131,8 +132,17 @@ def secret(self, value):
             raise ValueError("secrets must be 22 characters")
         self._secret = value
 
-    def request(self, method, body, url, content_type=None, version=None, params=None):
-        return self._request(method, body, url, content_type, version, params)
+    def request(
+        self,
+        method,
+        body,
+        url,
+        content_type=None,
+        version=None,
+        params=None,
+        encoding=None,
+    ):
+        return self._request(method, body, url, content_type, version, params, encoding)
 
     def _request(
         self,

urbanairship/devices/__init__.py

@@ -1,5 +1,5 @@
 from .tag import ChannelTags, OpenChannelTags
-from .attributes import Attribute, AttributeResponse, ModifyAttributes
+from .attributes import Attribute, AttributeResponse, ModifyAttributes, AttributeList
 from .channel_uninstall import ChannelUninstall
 from .devicelist import APIDList, ChannelInfo, ChannelList, DeviceInfo, DeviceTokenList
 from .email import Email, EmailAttachment, EmailTags

urbanairship/devices/attributes.py

@@ -3,6 +3,8 @@
 from datetime import datetime
 import re
 
+from .static_lists import GzipCompressReadStream
+
 logger = logging.getLogger("urbanairship")
 
 
@@ -146,6 +148,96 @@ def send(self):
         return AttributeResponse(response=response)
 
 
+class AttributeList(object):
+    """
+    Define and manage attribute lists; upload corresponding attribute data in CSV format.
+
+    :param airship: Required. An unbanairship.Airship instance.
+    :param list_name: Required. The name of your list. Must be prefixed
+        with "ua_attributes_"
+    :param description: Required. A description of your list.
+    :param extra: Optional. An optional dict of up to 100 key-value (string-to-string)
+        pairs associated with the list.
+    """
+
+    def __init__(self, airship, list_name, description, extra=None):
+        self.airship = airship
+        self.list_name = list_name
+        self.description = description
+        self.extra = extra
+
+    @property
+    def _create_payload(self):
+        payload = {"name": self.list_name, "description": self.description}
+
+        if self.extra:
+            payload["extra"] = self.extra
+
+        return payload
+
+    def create(self):
+        response = self.airship.request(
+            method="POST",
+            url=self.airship.urls.get("attributes_list_url"),
+            body=json.dumps(self._create_payload),
+            content_type="application/json",
+            version=3,
+        )
+
+        return response
+
+    def upload(self, file_path):
+        """
+        Upload a CSV that will set attribute values on the specified channels or
+            named users. Please see the documentation at
+            https://docs.airship.com/api/ua/#operation-api-attribute-lists-list_name-csv-put
+            for details about list formatting, size limits, and error responses.
+
+        :param file_path: Required. Local path to the csv file to be uploaded.
+        """
+        with open(file_path, "rb") as open_file:
+            response = self.airship._request(
+                method="PUT",
+                body=GzipCompressReadStream(open_file),
+                url=self.airship.urls.get("attributes_list_url")
+                + self.list_name
+                + "/csv/",
+                content_type="text/csv",
+                version=3,
+                encoding="gzip",
+            )
+
+        return response
+
+    def get_errors(self):
+        """
+        Returns csv of attribute list processing errors. During processing, after a
+            list is uploaded, errors can occur. Depending on the type of list
+            processing, an error file may be created, showing a user exactly what
+            went wrong.
+        """
+        response = self.airship.request(
+            method="GET",
+            body={},
+            url=self.airship.urls.get("attributes_list_url")
+            + self.list_name
+            + "/errors/",
+        )
+
+        return response
+
+    @classmethod
+    def list(cls, airship):
+        response = airship._request(
+            method="GET",
+            url=airship.urls.get("attributes_list_url"),
+            body={},
+            version=3,
+        )
+
+        return response
+
+
 class AttributeResponse(object):
     def __init__(self, response):
         self.response = response

urbanairship/devices/static_lists.py

@@ -76,6 +76,25 @@ def update(self):
 
         return response.json()
 
+    @classmethod
+    def download(cls, airship, list_name):
+        """
+        Allows you to download the contents of a static list. Alias and named_user
+            values are resolved to channels.
+
+        :param airship: Required. An urbanairship.Airship instance.
+        :param list_name: Required. Name of an existing list to download.
+
+        :return: csv list data
+        """
+        response = airship._request(
+            method="GET",
+            url=airship.urls.get("lists_url") + list_name + "/csv/",
+            body={},
+        )
+
+        return response
+
     @classmethod
     def from_payload(cls, payload, airship):
         obj = cls(airship, payload["name"])