Support for /identity/buckets

Author: caroline-ttd

examples/sample_identity_map_client.py examples/sample_generate_identity_map.pyexamples/sample_identity_map_client.py renamed to examples/sample_generate_identity_map.py

@@ -7,7 +7,7 @@
 # or the reason why it is unmapped
 
 def _usage():
-    print('Usage: python3 sample_identity_map_client.py <base_url> <api_key> <client_secret> <email_1> <email_2> ... <email_n>'
+    print('Usage: python3 sample_generate_identity_map.py <base_url> <api_key> <client_secret> <email_1> <email_2> ... <email_n>'
           , file=sys.stderr)
     sys.exit(1)
 

examples/sample_get_identity_buckets.py

@@ -0,0 +1,35 @@
+import datetime
+import sys
+
+from uid2_client import IdentityMapClient
+
+
+# this sample client takes date time as input and generates an IdentityBucketsResponse object which contains
+# a list of buckets
+
+def _usage():
+    print('Usage: python3 sample_get_identity_buckets.py <base_url> <api_key> <client_secret> <year> <month> <day> <hour> <minute> <second>'
+          , file=sys.stderr)
+    sys.exit(1)
+
+
+if len(sys.argv) <= 9:
+    _usage()
+
+base_url = sys.argv[1]
+api_key = sys.argv[2]
+client_secret = sys.argv[3]
+year = int(sys.argv[4])
+month = int(sys.argv[5])
+day = int(sys.argv[6])
+hour = int(sys.argv[7])
+minute = int(sys.argv[8])
+second = int(sys.argv[9])
+
+client = IdentityMapClient(base_url, api_key, client_secret)
+
+identity_buckets_response = client.get_identity_buckets(datetime.datetime(year, month, day, hour, minute, second))
+
+bucket = identity_buckets_response.buckets[0]
+print("The bucket id of the first bucket: ", bucket.get_bucket_id())
+print("The last updated timestamp of the first bucket: ", bucket.get_last_updated())

tests/test_identity_map_client.py

@@ -1,3 +1,4 @@
+import datetime
 import os
 import unittest
 
@@ -131,24 +132,28 @@ def test_identity_map_hashed_phones(self):
 
         self.assert_unmapped(response, "optout", hashed_opted_out_phone)
 
-    def test_identity_map_bad_url(self):
+    def test_identity_map_client_bad_url(self):
         identity_map_input = IdentityMapInput.from_emails(
             ["hopefully-not-opted-out@example.com", "somethingelse@example.com", "optout@example.com"])
         client = IdentityMapClient("https://operator-bad-url.uidapi.com", os.getenv("UID2_API_KEY"), os.getenv("UID2_SECRET_KEY"))
         self.assertRaises(requests.exceptions.ConnectionError, client.generate_identity_map, identity_map_input)
+        self.assertRaises(requests.exceptions.ConnectionError, client.get_identity_buckets, datetime.datetime.now())
 
-    def test_identity_map_bad_api_key(self):
+    def test_identity_map_client_bad_api_key(self):
         identity_map_input = IdentityMapInput.from_emails(
             ["hopefully-not-opted-out@example.com", "somethingelse@example.com", "optout@example.com"])
         client = IdentityMapClient(os.getenv("UID2_BASE_URL"), "bad-api-key", os.getenv("UID2_SECRET_KEY"))
         self.assertRaises(requests.exceptions.HTTPError, client.generate_identity_map,identity_map_input)
+        self.assertRaises(requests.exceptions.HTTPError, client.get_identity_buckets, datetime.datetime.now())
 
-    def test_identity_map_bad_secret(self):
+    def test_identity_map_client_bad_secret(self):
         identity_map_input = IdentityMapInput.from_emails(
             ["hopefully-not-opted-out@example.com", "somethingelse@example.com", "optout@example.com"])
         client = IdentityMapClient(os.getenv("UID2_BASE_URL"), os.getenv("UID2_API_KEY"), "wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=")
         self.assertRaises(requests.exceptions.HTTPError, client.generate_identity_map,
                           identity_map_input)
+        self.assertRaises(requests.exceptions.HTTPError, client.get_identity_buckets,
+                          datetime.datetime.now())
 
     def assert_mapped(self, response, dii):
         mapped_identity = response.mapped_identities.get(dii)
@@ -166,6 +171,20 @@ def assert_unmapped(self, response, reason, dii):
         mapped_identity = response.mapped_identities.get(dii)
         self.assertIsNone(mapped_identity)
 
+    def test_identity_buckets(self):
+        response = self.identity_map_client.get_identity_buckets(datetime.datetime.now() - datetime.timedelta(days=2))
+        self.assertTrue(len(response.buckets) > 0)
+        self.assertTrue(response.is_success)
+
+    def test_identity_buckets_empty_response(self):
+        response = self.identity_map_client.get_identity_buckets(datetime.datetime.now() + datetime.timedelta(days=1))
+        self.assertTrue(len(response.buckets) == 0)
+        self.assertTrue(response.is_success)
+
+    def test_identity_buckets_invalid_timestamp(self):
+        self.assertRaises(TypeError, self.identity_map_client.get_identity_buckets,
+                          "1234567890")
+
 
 if __name__ == '__main__':
     unittest.main()

uid2_client/Identity_buckets_response.py

@@ -0,0 +1,46 @@
+import json
+
+
+class IdentityBucketsResponse:
+    def __init__(self, response):
+        self._buckets = []
+        response_json = json.loads(response)
+        self._status = response_json["status"]
+
+        if not self.is_success():
+            raise ValueError("Got unexpected identity buckets status: " + self._status)
+
+        body = response_json["body"]
+
+        for bucket in body:
+            self._buckets.append(Bucket.from_json(bucket))
+
+    def is_success(self):
+        return self._status == "success"
+
+    @property
+    def buckets(self):
+        return self._buckets
+
+    @property
+    def status(self):
+        return self._status
+
+
+class Bucket:
+    def __init__(self, bucket_id, last_updated):
+        self._bucket_id = bucket_id
+        self._last_updated = last_updated
+
+    def get_bucket_id(self):
+        return self._bucket_id
+
+    def get_last_updated(self):
+        return self._last_updated
+
+    @staticmethod
+    def from_json(json_obj):
+        return Bucket(
+            json_obj.get("bucket_id"),
+            json_obj.get("last_updated")
+        )

uid2_client/identity_map_client.py

@@ -1,10 +1,12 @@
 import base64
 import datetime as dt
+import json
 from datetime import timezone
 
+from .Identity_buckets_response import IdentityBucketsResponse
 from .identity_map_response import IdentityMapResponse
 
-from uid2_client import auth_headers, make_v2_request, post, parse_v2_response
+from uid2_client import auth_headers, make_v2_request, post, parse_v2_response, get_datetime_iso_format
 
 
 class IdentityMapClient:
@@ -39,3 +41,11 @@ def generate_identity_map(self, identity_map_input):
         resp.raise_for_status()
         resp_body = parse_v2_response(self._client_secret, resp.text, nonce)
         return IdentityMapResponse(resp_body, identity_map_input)
+
+    def get_identity_buckets(self, since_timestamp):
+        req, nonce = make_v2_request(self._client_secret, dt.datetime.now(tz=timezone.utc),
+                                     json.dumps({"since_timestamp": get_datetime_iso_format(since_timestamp)}).encode())
+        resp = post(self._base_url, '/v2/identity/buckets', headers=auth_headers(self._api_key), data=req)
+        resp.raise_for_status()
+        resp_body = parse_v2_response(self._client_secret, resp.text, nonce)
+        return IdentityBucketsResponse(resp_body)

uid2_client/input_util.py

@@ -1,3 +1,4 @@
+import datetime
 import hashlib
 import base64
 
@@ -119,3 +120,11 @@ def normalize_and_hash_phone(phone):
     if not is_phone_number_normalized(phone):
         raise ValueError("phone number is not normalized: " + phone)
     return get_base64_encoded_hash(phone)
+
+
+def get_datetime_iso_format(timestamp):
+    if isinstance(timestamp, datetime.datetime):
+        return timestamp.isoformat()
+    else:
+        raise TypeError("timestamp is not in datetime format")
+