[TOOLSLIBS-442 | TOOLSLIBS-443] Email & SMS Update (#176)

* adds reg payload prop test

* adds registration payload prop, update method

* docstring

* fixes bug where opted_in param was not passed

* adds opted_in as property

* changes out False for None

* refactors register, adds registration_payload property

* adds properties for email update and reg

* adds email tests

* uses proper stringtype for py2

* unicode when

* fixes email reg payload and test

Author: aschuman0

tests/devices/test_email.py

@@ -18,6 +18,64 @@ def setUp(self):
         self.timezone = "America/Los_Angeles"
         self.channel_id = str(uuid.uuid4())
         self.opt_in_mode = "double"
+        self.email = ua.Email(
+            airship=self.airship,
+            address="[email protected]",
+            commercial_opted_in="2021-01-01T12:00:00",
+            locale_country="us",
+            locale_language="en",
+            timezone="America/Los_Angeles",
+            transactional_opted_in="2021-02-21T13:00:00",
+            opt_in_mode="double",
+        )
+
+    def test_email_full_payload_property(self):
+        self.assertEqual(
+            self.email._full_payload,
+            {
+                "type": "email",
+                "address": "[email protected]",
+                "commercial_opted_in": "2021-01-01T12:00:00",
+                "locale_country": "us",
+                "locale_language": "en",
+                "timezone": "America/Los_Angeles",
+                "transactional_opted_in": "2021-02-21T13:00:00",
+                "opt_in_mode": "double",
+            },
+        )
+
+    def test_email_reg_payload_property(self):
+        self.assertEqual(
+            self.email._registration_payload,
+            {
+                "opt_in_mode": "double",
+                "channel": {
+                    "type": "email",
+                    "address": "[email protected]",
+                    "commercial_opted_in": "2021-01-01T12:00:00",
+                    "locale_country": "us",
+                    "locale_language": "en",
+                    "timezone": "America/Los_Angeles",
+                    "transactional_opted_in": "2021-02-21T13:00:00",
+                },
+            },
+        )
+
+    def test_email_update_payload(self):
+        self.assertEqual(
+            self.email._update_payload,
+            {
+                "channel": {
+                    "type": "email",
+                    "address": "[email protected]",
+                    "commercial_opted_in": "2021-01-01T12:00:00",
+                    "locale_country": "us",
+                    "locale_language": "en",
+                    "timezone": "America/Los_Angeles",
+                    "transactional_opted_in": "2021-02-21T13:00:00",
+                }
+            },
+        )
 
     def test_email_reg(self):
         with mock.patch.object(ua.Airship, "_request") as mock_request:

tests/devices/test_sms.py

@@ -85,6 +85,29 @@ def test_sms_uninstall(self):
 
             self.assertTrue(r.ok)
 
+    def test_sms_registration_payload_property(self):
+        sms = ua.Sms(
+            airship=ua.Airship(TEST_KEY, TEST_SECRET),
+            sender="12345",
+            msisdn="15035556789",
+            opted_in="2018-02-13T11:58:59",
+            locale_country="us",
+            locale_language="en",
+            timezone="America/Los_Angeles",
+        )
+
+        self.assertEqual(
+            sms._registration_payload,
+            {
+                "sender": "12345",
+                "msisdn": "15035556789",
+                "locale_language": "en",
+                "locale_country": "us",
+                "timezone": "America/Los_Angeles",
+                "opted_in": "2018-02-13T11:58:59",
+            },
+        )
+
     def test_sms_lookup(self):
         sender = "12345"
         msisdn = "15035556789"

urbanairship/devices/email.py

@@ -149,6 +149,57 @@ def transactional_opted_out(self, value):
             raise ValueError("Must use ISO 8601 timestamp format")
         self._transactional_opted_out = value
 
+    @property
+    def _full_payload(self):
+        if self.address == None:
+            raise ValueError(
+                "address must be set to register or update an email channel"
+            )
+
+        payload = {"type": self._email_type}
+
+        reg_payload_keys = [
+            "address",
+            "commercial_opted_in",
+            "commercial_opted_out",
+            "locale_country",
+            "locale_language",
+            "opt_in_mode",
+            "properties",
+            "timezone",
+            "transactional_opted_in",
+            "transactional_opted_out",
+        ]
+
+        for key in reg_payload_keys:
+            if getattr(self, key) is not None:
+                payload[key] = getattr(self, key)
+
+        return payload
+
+    @property
+    def _registration_payload(self):
+        full_payload = self._full_payload
+        opt_in_mode = full_payload.pop("opt_in_mode", None)
+        properties = full_payload.pop("properties", None)
+
+        payload = {"channel": full_payload}
+        if opt_in_mode:
+            payload["opt_in_mode"] = opt_in_mode
+        if properties:
+            payload["properties"] = properties
+
+        return payload
+
+    @property
+    def _update_payload(self):
+        payload = self._full_payload
+
+        payload.pop("opt_in_mode", None)
+        payload.pop("properties", None)
+
+        return {"channel": payload}
+
     @property
     def create_and_send_audience(self):
         audience = {"ua_address": self.address}
@@ -170,35 +221,13 @@ def register(self):
         :return: The response object from the API.
         """
         url = self.airship.urls.get("email_url")
-        reg_payload = {"channel": {"type": self._email_type, "address": self.address}}
-
-        if self.commercial_opted_in:
-            reg_payload["channel"]["commercial_opted_in"] = self.commercial_opted_in
-        if self.commercial_opted_out:
-            reg_payload["channel"]["commercial_opted_out"] = self.commercial_opted_out
-        if self.transactional_opted_in:
-            reg_payload["channel"][
-                "transactional_opted_in"
-            ] = self.transactional_opted_in
-        if self.transactional_opted_out:
-            reg_payload["channel"][
-                "transactional_opted_out"
-            ] = self.transactional_opted_out
-
-        if self.locale_language is not None:
-            reg_payload["channel"]["locale_language"] = self.locale_language
-        if self.locale_country is not None:
-            reg_payload["channel"]["locale_country"] = self.locale_country
-        if self.timezone is not None:
-            reg_payload["channel"]["timezone"] = self.timezone
-        if self.opt_in_mode is not None:
-            reg_payload["channel"]["opt_in_mode"] = self.opt_in_mode
-        if self.properties is not None:
-            reg_payload["channel"]["properties"] = self.properties
-
-        body = json.dumps(reg_payload).encode("utf-8")
 
-        response = self.airship.request(method="POST", body=body, url=url, version=3)
+        response = self.airship.request(
+            method="POST",
+            body=json.dumps(self._registration_payload).encode("utf-8"),
+            url=url,
+            version=3,
+        )
 
         if response.status_code == 201:
             self.channel_id = response.json().get("channel_id")
@@ -213,6 +242,31 @@ def register(self):
 
         return response
 
+    def update(self, channel_id=None):
+        """
+        Updates an existing email channel.
+
+        :param channel_id Optional: An existing airship-provided channel_id UUID for an
+            email channel.
+            If this object was created with this class, the channel_id value
+            should be assigned. Otherwise, pass it here. Other values are set as
+            properties on an instance of this class before the update call.
+        """
+        if channel_id:
+            self.channel_id = channel_id
+
+        if self.channel_id is None:
+            raise ValueError("Email channel must have a channel_id to update.")
+
+        response = self.airship.request(
+            method="PUT",
+            body=json.dumps(self._update_payload),
+            url=self.airship.urls.get("email_url") + self.channel_id,
+            version=3,
+        )
+
+        return response
+
     def uninstall(self):
         """Removes an email address from Urban Airship. Use with caution.
         If the uninstalled email address opts-in again, it will generate