Merge pull request #110 from rapidpro/updates

Updates to use messages and broadcasts UUID fields

Author: rowanseymour

temba_client/v2/__init__.py

@@ -60,15 +60,15 @@ def get_boundaries(self, geometry=None):
         params = self._build_params(geometry=geometry)
         return self._get_query("boundaries", params, Boundary)
 
-    def get_broadcasts(self, id=None, before=None, after=None):
+    def get_broadcasts(self, uuid=None, before=None, after=None):
         """
         Gets all matching broadcasts
-        :param id: broadcast id
+        :param uuid: broadcast UUID
         :param datetime before: created before
         :param datetime after: created after
         :return: broadcast query
         """
-        params = self._build_params(id=id, before=before, after=after)
+        params = self._build_params(uuid=uuid, before=before, after=after)
         return self._get_query("broadcasts", params, Broadcast)
 
     def get_campaigns(self, uuid=None):
@@ -186,16 +186,16 @@ def get_labels(self, uuid=None, name=None):
         """
         return self._get_query("labels", self._build_params(uuid=uuid, name=name), Label)
 
-    def get_messages(self, id=None, folder=None, before=None, after=None):
+    def get_messages(self, uuid=None, folder=None, before=None, after=None):
         """
         Gets all matching messages
-        :param id: message id
+        :param uuid: message UUID
         :param folder: folder name
         :param datetime before: created before
         :param datetime after: created after
         :return: message query
         """
-        params = self._build_params(id=id, folder=folder, before=before, after=after)
+        params = self._build_params(uuid=uuid, folder=folder, before=before, after=after)
         return self._get_query("messages", params, Message)
 
     def get_org(self, retry_on_rate_exceed=False):

temba_client/v2/tests.py

@@ -245,7 +245,7 @@ def test_get_broadcasts(self, mock_request):
         self.assertRequest(mock_request, "get", "broadcasts")
         self.assertEqual(len(results), 2)
 
-        self.assertEqual(results[0].id, 1234)
+        self.assertEqual(results[0].uuid, "c4f3b6e1-2d3a-4f4b-8f4e-1e2d3c4b5a6f")
         self.assertEqual(results[0].urns, ["tel:+250783865665", "twitter:bobby"])
         self.assertEqual(len(results[0].contacts), 1)
         self.assertEqual(results[0].contacts[0].uuid, "5079cb96-a1d8-4f47-8c87-d8c7bb6ddab9")
@@ -258,7 +258,7 @@ def test_get_broadcasts(self, mock_request):
 
         # check with all params
         self.client.get_broadcasts(
-            id=12345,
+            uuid="c4f3b6e1-2d3a-4f4b-8f4e-1e2d3c4b5a6f",
             after=datetime(2014, 12, 12, 22, 34, 36, 978123, tzone.utc),
             before=datetime(2014, 12, 12, 22, 56, 58, 917123, tzone.utc),
         ).all()
@@ -267,7 +267,7 @@ def test_get_broadcasts(self, mock_request):
             mock_request,
             "get",
             "broadcasts",
-            params={"id": 12345, "after": "2014-12-12T22:34:36.978123Z", "before": "2014-12-12T22:56:58.917123Z"},
+            params={"uuid": "c4f3b6e1-2d3a-4f4b-8f4e-1e2d3c4b5a6f", "after": "2014-12-12T22:34:36.978123Z", "before": "2014-12-12T22:56:58.917123Z"},
         )
 
     def test_get_campaigns(self, mock_request):
@@ -601,8 +601,7 @@ def test_get_messages(self, mock_request):
         self.assertRequest(mock_request, "get", "messages")
         self.assertEqual(len(results), 2)
 
-        self.assertEqual(results[0].id, 4105423)
-        self.assertEqual(results[0].broadcast, 2690006)
+        self.assertEqual(results[0].uuid, "eb6aeae0-0433-45de-bbed-031039a1cfaa")
         self.assertEqual(results[0].contact.uuid, "d33e9ad5-5c35-414c-abd4-e7451c69ff1d")
         self.assertEqual(results[0].contact.name, "Frank McFlow")
         self.assertEqual(results[0].urn, "twitter:franky6431")
@@ -629,7 +628,7 @@ def test_get_messages(self, mock_request):
 
         # check with all params
         self.client.get_messages(
-            id=123456,
+            uuid="eb6aeae0-0433-45de-bbed-031039a1cfaa",
             folder="inbox",
             after=datetime(2014, 12, 12, 22, 34, 36, 978123, tzone.utc),
             before=datetime(2014, 12, 12, 22, 56, 58, 917123, tzone.utc),
@@ -640,7 +639,7 @@ def test_get_messages(self, mock_request):
             "get",
             "messages",
             params={
-                "id": 123456,
+                "uuid": "eb6aeae0-0433-45de-bbed-031039a1cfaa",
                 "folder": "inbox",
                 "after": "2014-12-12T22:34:36.978123Z",
                 "before": "2014-12-12T22:56:58.917123Z",
@@ -812,7 +811,7 @@ def test_create_broadcast(self, mock_request):
                 "groups": ["04a4752b-0f49-480e-ae60-3a3f2bea485c"],
             },
         )
-        self.assertEqual(broadcast.id, 1234)
+        self.assertEqual(broadcast.uuid, "c4f3b6e1-2d3a-4f4b-8f4e-1e2d3c4b5a6f")
 
     def test_create_campaign(self, mock_request):
         mock_request.return_value = MockResponse(201, self.read_json("campaigns", extract_result=0))
@@ -937,7 +936,7 @@ def test_create_message(self, mock_request):
             "messages",
             data={"contact": "5079cb96-a1d8-4f47-8c87-d8c7bb6ddab9", "text": "Hi there", "attachments": []},
         )
-        self.assertEqual(message.id, 4105423)
+        self.assertEqual(message.uuid, "eb6aeae0-0433-45de-bbed-031039a1cfaa")
 
     def test_create_resthook_subscriber(self, mock_request):
         subscriber_json = self.read_json("resthook_subscribers", extract_result=0)
@@ -1244,8 +1243,8 @@ def test_contact_actions(self, mock_request):
     def test_message_actions(self, mock_request):
         mock_request.return_value = MockResponse(204, "")
 
-        messages = [Message.create(id=1001), 1002]
-        resolved_messages = [1001, 1002]
+        messages = [Message.create(uuid="eb6aeae0-0433-45de-bbed-031039a1cfaa"), "2be38dc4-b3ae-4fdf-a3b6-7defb3c11c4c"]
+        resolved_messages = ["eb6aeae0-0433-45de-bbed-031039a1cfaa", "2be38dc4-b3ae-4fdf-a3b6-7defb3c11c4c"]
 
         self.client.bulk_label_messages(messages=messages, label="Testing", label_name="Spam")
         self.assertRequest(

temba_client/v2/types.py

@@ -57,15 +57,14 @@ class Geometry(TembaObject):
 
 
 class Broadcast(TembaObject):
-    id = IntegerField()
+    uuid = SimpleField()
     status = SimpleField()
     urns = SimpleField()
     contacts = ObjectListField(item_class=ObjectRef)
     groups = ObjectListField(item_class=ObjectRef)
     text = SimpleField()
     created_on = DatetimeField()
 
-
 class Campaign(TembaObject):
     uuid = SimpleField()
     name = SimpleField()
@@ -207,8 +206,7 @@ class AttachmentRef(TembaObject):
         content_type = SimpleField()
         url = SimpleField()
 
-    id = IntegerField()
-    broadcast = IntegerField()
+    uuid = SimpleField()
     contact = ObjectField(item_class=ObjectRef)
     urn = SimpleField()
     channel = ObjectField(item_class=ObjectRef)

test_files/v2/broadcasts.json

@@ -3,7 +3,7 @@
     "previous": null,
     "results": [
         {
-            "id": 1234,
+            "uuid": "c4f3b6e1-2d3a-4f4b-8f4e-1e2d3c4b5a6f",
             "status": "sent",
             "urns": ["tel:+250783865665", "twitter:bobby"],
             "contacts": [{"uuid": "5079cb96-a1d8-4f47-8c87-d8c7bb6ddab9", "name": "Joe"}],
@@ -12,7 +12,7 @@
             "created_on": "2015-11-11T08:30:24.922024+00:00"
         },
         {
-            "id": 2345,
+            "uuid": "d5e6f7a8-9b0c-4d1e-8f9a-0b1c2d3e4f5a",
             "urns": ["twitter:bobby"],
             "contacts": [],
             "groups": [],

test_files/v2/messages.json

@@ -3,8 +3,7 @@
     "previous": null,
     "results": [
         {
-            "id": 4105423,
-            "broadcast": 2690006,
+            "uuid": "eb6aeae0-0433-45de-bbed-031039a1cfaa",
             "contact": {
                 "uuid": "d33e9ad5-5c35-414c-abd4-e7451c69ff1d",
                 "name": "Frank McFlow"
@@ -30,8 +29,7 @@
             "modified_on": null
         },
         {
-            "id": 4088573,
-            "broadcast": null,
+            "uuid": "a0502d1b-3ea7-40e7-838e-16d55d0574f8",
             "contact": {
                 "uuid": "d33e9ad5-5c35-414c-abd4-e7451c69ff1d",
                 "name": "Frank McFlow"