Address the comments

Author: caroline-ttd

examples/sample_get_identity_buckets.py

@@ -1,35 +1,31 @@
-import datetime
 import sys
+from datetime import datetime
 
 from uid2_client import IdentityMapClient
 
 
 # this sample client takes date time as input and generates an IdentityBucketsResponse object which contains
-# a list of buckets
+# a list of buckets, the timestamp strings in the format YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]],
+# for example: UTC: 2024-07-02, 2024-07-02T14:30:15.123456+00:00 and EST: 2024-07-02T14:30:15.123456-05:00
 
 def _usage():
-    print('Usage: python3 sample_get_identity_buckets.py <base_url> <api_key> <client_secret> <year> <month> <day> <hour> <minute> <second>'
+    print('Usage: python3 sample_get_identity_buckets.py <base_url> <api_key> <client_secret> <timestamp>'
           , file=sys.stderr)
     sys.exit(1)
 
 
-if len(sys.argv) <= 9:
+if len(sys.argv) <= 4:
     _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])
+timestamp = sys.argv[4]
 
 client = IdentityMapClient(base_url, api_key, client_secret)
 
-identity_buckets_response = client.get_identity_buckets(datetime.datetime(year, month, day, hour, minute, second))
+identity_buckets_response = client.get_identity_buckets(datetime.fromisoformat(timestamp))
 
 for bucket in identity_buckets_response.buckets:
-    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())
+    print("The bucket id of the bucket: ", bucket.get_bucket_id())
+    print("The last updated timestamp of the bucket: ", bucket.get_last_updated())

tests/test_identity_map_client.py

@@ -1,10 +1,12 @@
 import datetime
 import os
 import unittest
+from datetime import datetime
 
 import requests
 
-from uid2_client import IdentityMapClient, IdentityMapInput, normalize_and_hash_email, normalize_and_hash_phone
+from uid2_client import IdentityMapClient, IdentityMapInput, normalize_and_hash_email, normalize_and_hash_phone, \
+    get_datetime_utc_iso_format
 
 
 class IdentityMapIntegrationTests(unittest.TestCase):
@@ -195,6 +197,17 @@ def test_identity_buckets_invalid_timestamp(self):
             self.assertRaises(AttributeError, self.identity_map_client.get_identity_buckets,
                               timestamp)
 
+    def test_get_datetime_utc_iso_format_timestamp(self):
+        expected_timestamp = "2024-07-02T14:30:15.123456"
+        test_cases = ["2024-07-02T14:30:15.123456+00:00", "2024-07-02 09:30:15.123456-05:00",
+                      "2024-07-02T08:30:15.123456-06:00", "2024-07-02T10:30:15.123456-04:00",
+                      "2024-07-02T06:30:15.123456-08:00", "2024-07-02T23:30:15.123456+09:00",
+                      "2024-07-03T00:30:15.123456+10:00", "2024-07-02T20:00:15.123456+05:30"]
+        for timestamp_str in test_cases:
+            timestamp = datetime.fromisoformat(timestamp_str)
+            iso_format_timestamp = get_datetime_utc_iso_format(timestamp)
+            self.assertEqual(expected_timestamp, iso_format_timestamp)
+
 
 if __name__ == '__main__':
     unittest.main()

uid2_client/identity_map_client.py

@@ -6,7 +6,7 @@
 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_utc_iso_format
 
 
 class IdentityMapClient:
@@ -44,7 +44,7 @@ def generate_identity_map(self, 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": since_timestamp.isoformat()}).encode())
+                                     json.dumps({"since_timestamp": get_datetime_utc_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)

uid2_client/input_util.py

@@ -1,6 +1,8 @@
 import hashlib
 import base64
 
+import pytz
+
 
 def is_phone_number_normalized(phone_number):
     min_phone_number_digits = 10
@@ -119,3 +121,9 @@ 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_utc_iso_format(timestamp):
+    dt_utc = timestamp.astimezone(pytz.utc)
+    dt_utc_without_tz = dt_utc.replace(tzinfo=None)
+    return dt_utc_without_tz.isoformat()