Skip to content

Commit 4c7a471

Browse files
asloobqasloobq
committed
Address some review comments
1 parent f17901c commit 4c7a471

16 files changed

Lines changed: 74 additions & 76 deletions

‎examples/sample_auto_refresh.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def _usage():
3030
if refresh_result.ready:
3131
print('Keys are ready, last refreshed (UTC):', refresh_result.last_success_time, flush=True)
3232
result = client.decrypt(ad_token)
33-
print('UID2 =', result.uid2, flush=True)
33+
print('UID =', result.uid, flush=True)
3434
else:
3535
print('Keys are not ready yet, last error:', refresh_result.last_error[1], flush=True)
3636
time.sleep(1)

‎examples/sample_bidstream_client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ def _usage():
2121
ad_token = sys.argv[5]
2222

2323
client = BidstreamClient(base_url, auth_key, secret_key)
24-
client.refresh_keys()
24+
client.refresh()
2525
decrypt_result = client.decrypt_token_into_raw_uid(ad_token, domain_name)
2626

27-
print('UID2 =', decrypt_result.uid2)
27+
print('UID =', decrypt_result.uid)
2828
print('Established =', decrypt_result.established)
2929
print('Site ID =', decrypt_result.site_id)
3030
print('Site Key Site ID =', decrypt_result.site_key_site_id)

‎examples/sample_client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ def _usage():
2727
# client = EuidClientFactory.create(base_url, auth_key, secret_key)
2828
# for UID2 use:
2929
client = Uid2ClientFactory.create(base_url, auth_key, secret_key)
30-
client.refresh_keys()
30+
client.refresh()
3131
decrypt_result = client.decrypt(ad_token)
3232

33-
print('UID2 =', decrypt_result.uid2)
33+
print('UID =', decrypt_result.uid)
3434
print('Established =', decrypt_result.established)
3535
print('Site ID =', decrypt_result.site_id)
3636
print('Site Key Site ID =', decrypt_result.site_key_site_id)

‎examples/sample_sharing.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ def _usage():
2727
# client = EuidClientFactory.create(base_url, auth_key, secret_key)
2828
# for UID2 use:
2929
client = Uid2ClientFactory.create(base_url, auth_key, secret_key)
30-
client.refresh_keys()
30+
client.refresh()
3131
new_ad_token = client.encrypt(raw_uid)
3232

3333
print('New Ad Token =', new_ad_token)
3434

3535
decrypt_result = client.decrypt(new_ad_token)
3636

37-
print('Decrypted UID2 =', decrypt_result.uid2)
37+
print('Decrypted UID =', decrypt_result.uid)
3838
print('Established =', decrypt_result.established)
3939
print('Site ID =', decrypt_result.site_id)
4040
print('Site Key Site ID =', decrypt_result.site_key_site_id)

‎examples/sample_sharing_client.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,13 @@ def _usage():
2020
raw_uid = sys.argv[4]
2121

2222
client = SharingClient(base_url, auth_key, secret_key)
23-
client.refresh_keys()
23+
client.refresh()
2424
new_sharing_token = client.encrypt_raw_uid_into_token(raw_uid)
2525

2626
print('New Sharing Token =', new_sharing_token)
2727

2828
decrypt_result = client.decrypt_token_into_raw_uid(new_sharing_token)
2929

30-
print('Decrypted UID2 =', decrypt_result.uid2)
30+
print('Decrypted UID =', decrypt_result.uid)
3131
print('Established =', decrypt_result.established)
3232
print('Site ID =', decrypt_result.site_id)
33-
print('Site Key Site ID =', decrypt_result.site_key_site_id)

‎tests/test_bidstream_client.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def test_smoke_test(self, mock_refresh_bidstream_keys): # SmokeTest
1919
with self.subTest(expected_scope=expected_scope, expected_version=expected_version):
2020
token = generate_uid_token(expected_scope, expected_version)
2121
mock_refresh_bidstream_keys.return_value = create_key_collection(expected_scope)
22-
self._client.refresh_keys()
22+
self._client.refresh()
2323
decrypted = self._client.decrypt_token_into_raw_uid(token, None)
2424
self.assertEqual(decrypted.identity_scope, expected_scope)
2525
self.assertEqual(decrypted.advertising_token_version, expected_version)
@@ -31,12 +31,12 @@ def test_phone_uids(self, mock_refresh_bidstream_keys): # PhoneTest
3131
mock_refresh_bidstream_keys.return_value = EncryptionKeysCollection([master_key, site_key],
3232
expected_scope, site_id, 1,
3333
99999, 86400)
34-
self._client.refresh_keys()
34+
self._client.refresh()
3535
token = generate_uid_token(expected_scope, expected_version, phone_uid)
3636
self.assertEqual(IdentityType.Phone, get_identity_type(token))
3737
result = self._client.decrypt_token_into_raw_uid(token, None)
3838
self.assertIsNotNone(result)
39-
self.assertEqual(result.uid2, phone_uid)
39+
self.assertEqual(result.uid, phone_uid)
4040
self.assertEqual(result.identity_scope, expected_scope)
4141
self.assertEqual(result.advertising_token_version, expected_version)
4242

@@ -50,7 +50,7 @@ def test_token_lifetime_too_long_for_bidstream(self, mock_refresh_bidstream_keys
5050
expected_scope, site_id, 1,
5151
99999, 86400,
5252
max_bidstream_lifetime_seconds=max_bidstream_lifetime)
53-
self._client.refresh_keys()
53+
self._client.refresh()
5454
with self.assertRaises(EncryptionError) as context:
5555
self._client.decrypt_token_into_raw_uid(token, None)
5656
self.assertEqual('invalid token lifetime', str(context.exception))
@@ -63,7 +63,7 @@ def test_token_generated_in_the_future_to_simulate_clock_skew(self, mock_refresh
6363
mock_refresh_bidstream_keys.return_value = EncryptionKeysCollection([master_key, site_key],
6464
expected_scope, site_id, 1,
6565
99999, 86400)
66-
self._client.refresh_keys()
66+
self._client.refresh()
6767
with self.assertRaises(EncryptionError) as context:
6868
self._client.decrypt_token_into_raw_uid(token, None)
6969
self.assertEqual('invalid token lifetime', str(context.exception))
@@ -76,7 +76,7 @@ def test_token_generated_in_the_future_within_allowed_clock_skew(self, mock_refr
7676
mock_refresh_bidstream_keys.return_value = EncryptionKeysCollection([master_key, site_key],
7777
expected_scope, site_id, 1,
7878
99999, 86400)
79-
self._client.refresh_keys()
79+
self._client.refresh()
8080
result = self._client.decrypt_token_into_raw_uid(token, None)
8181
self.assertIsNotNone(result)
8282
self.assertEqual(result.identity_scope, expected_scope)
@@ -85,7 +85,7 @@ def test_token_generated_in_the_future_within_allowed_clock_skew(self, mock_refr
8585
def test_empty_keys(self, mock_refresh_bidstream_keys): # EmptyKeyContainer
8686
token = generate_uid_token(IdentityScope.UID2, AdvertisingTokenVersion.ADVERTISING_TOKEN_V3)
8787
mock_refresh_bidstream_keys.return_value = None
88-
self._client.refresh_keys()
88+
self._client.refresh()
8989
with self.assertRaises(EncryptionError) as context:
9090
self._client.decrypt_token_into_raw_uid(token, None)
9191
self.assertEqual('keys not initialized', str(context.exception))
@@ -99,7 +99,7 @@ def get_post_refresh_keys_response_with_key_expired():
9999
return create_default_key_collection([master_key_expired, site_key_expired])
100100

101101
mock_refresh_bidstream_keys.return_value = get_post_refresh_keys_response_with_key_expired()
102-
self._client.refresh_keys()
102+
self._client.refresh()
103103

104104
with self.assertRaises(EncryptionError) as context:
105105
self._client.decrypt_token_into_raw_uid(example_uid, None)
@@ -113,7 +113,7 @@ def get_post_refresh_keys_response_with_key_expired():
113113
return create_default_key_collection([another_master_key, another_site_key])
114114

115115
mock_refresh_bidstream_keys.return_value = get_post_refresh_keys_response_with_key_expired()
116-
self._client.refresh_keys()
116+
self._client.refresh()
117117
token = generate_uid_token(IdentityScope.UID2, AdvertisingTokenVersion.ADVERTISING_TOKEN_V4)
118118

119119
with self.assertRaises(EncryptionError) as context:
@@ -123,7 +123,7 @@ def get_post_refresh_keys_response_with_key_expired():
123123

124124
def test_invalid_payload(self, mock_refresh_bidstream_keys): #InvalidPayload
125125
mock_refresh_bidstream_keys.return_value = create_default_key_collection([master_key, site_key])
126-
self._client.refresh_keys()
126+
self._client.refresh()
127127
token = generate_uid_token(IdentityScope.UID2, AdvertisingTokenVersion.ADVERTISING_TOKEN_V4)
128128
payload = Uid2Base64UrlCoder.decode(token)
129129
bad_token = base64.urlsafe_b64encode(payload[:0])
@@ -134,7 +134,7 @@ def test_invalid_payload(self, mock_refresh_bidstream_keys): #InvalidPayload
134134

135135
def test_token_expiry_custom_decryption_time(self, mock_refresh_bidstream_keys):
136136
mock_refresh_bidstream_keys.return_value = create_default_key_collection([master_key, site_key])
137-
self._client.refresh_keys()
137+
self._client.refresh()
138138

139139
expires_at = now - dt.timedelta(days=60)
140140
created_at = expires_at - dt.timedelta(minutes=1)
@@ -151,7 +151,7 @@ def test_token_expiry_custom_decryption_time(self, mock_refresh_bidstream_keys):
151151

152152
def test_refresh_keys(self, mock_refresh_bidstream_keys):
153153
mock_refresh_bidstream_keys.return_value = create_default_key_collection([master_key])
154-
self._client.refresh_keys()
154+
self._client.refresh()
155155
mock_refresh_bidstream_keys.assert_called_once_with(self._CONST_BASE_URL, self._CONST_API_KEY,
156156
client_secret_bytes)
157157

‎tests/test_client.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def test_encrypt_decrypt(self, mock_refresh_keys_util):
4242
self.assertIsInstance(ad_token, str)
4343

4444
result = client.decrypt(ad_token)
45-
self.assertEqual(example_uid, result.uid2)
45+
self.assertEqual(example_uid, result.uid)
4646

4747
def test_can_decrypt_another_clients_encrypted_token(self, mock_refresh_keys_util):
4848
mock_refresh_keys_util.return_value = self._key_collection
@@ -55,7 +55,7 @@ def test_can_decrypt_another_clients_encrypted_token(self, mock_refresh_keys_uti
5555
receiving_client.refresh_keys()
5656

5757
result = receiving_client.decrypt(ad_token)
58-
self.assertEqual(example_uid, result.uid2)
58+
self.assertEqual(example_uid, result.uid)
5959

6060
def test_sharing_token_is_v4(self, mock_refresh_keys_util):
6161
mock_refresh_keys_util.return_value = self._key_collection
@@ -111,7 +111,7 @@ def get_post_refresh_keys_response_with_multiple_keys():
111111
ad_token = client.encrypt(example_uid)
112112

113113
result = client.decrypt(ad_token)
114-
self.assertEqual(example_uid, result.uid2)
114+
self.assertEqual(example_uid, result.uid)
115115

116116
def test_cannot_encrypt_if_no_key_from_default_keyset(self, mock_refresh_keys_util):
117117
def get_post_refresh_keys_response_with_no_default_keyset_key():
@@ -150,7 +150,7 @@ def get_post_refresh_keys_response_with_token_expiry():
150150
ad_token = client.encrypt(example_uid)
151151

152152
result = client.decrypt(ad_token)
153-
self.assertEqual(example_uid, result.uid2)
153+
self.assertEqual(example_uid, result.uid)
154154

155155
real_decrypt_v3 = encryption._decrypt_token_v3
156156

‎tests/test_encryption.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,11 @@ def test_cross_platform_consistency_decrypt(self):
103103
self.assertEqual(-1, runtime_advertising_token.find('/'))
104104

105105
result = decrypt(runtime_advertising_token, EncryptionKeysCollection([_master_key, _site_key]))
106-
self.assertEqual(_example_id, result.uid2)
106+
self.assertEqual(_example_id, result.uid)
107107

108108
# can also decrypt a known token generated from other SDK
109109
result = decrypt(crossPlatformAdvertisingToken, EncryptionKeysCollection([_master_key, _site_key]))
110-
self.assertEqual(_example_id, result.uid2)
110+
self.assertEqual(_example_id, result.uid)
111111

112112

113113
def test_decrypt_token_v4(self):
@@ -116,7 +116,7 @@ def test_decrypt_token_v4(self):
116116
keys = EncryptionKeysCollection([_master_key, _site_key])
117117
result = decrypt(token, keys)
118118

119-
self.assertEqual(_example_id, result.uid2)
119+
self.assertEqual(_example_id, result.uid)
120120

121121

122122
def test_decrypt_token_v4_empty_keys(self):
@@ -242,7 +242,7 @@ def test_decrypt_token_v4_custom_now(self):
242242
result = decrypt(token, keys, now=expiry + dt.timedelta(seconds=1))
243243

244244
result = decrypt(token, keys, now=expiry - dt.timedelta(seconds=1))
245-
self.assertEqual(_example_id, result.uid2)
245+
self.assertEqual(_example_id, result.uid)
246246

247247

248248
def test_decrypt_token_v4_invalid_payload(self):
@@ -261,7 +261,7 @@ def test_decrypt_token_v3(self):
261261
keys = EncryptionKeysCollection([_master_key, _site_key])
262262
result = decrypt(token, keys)
263263

264-
self.assertEqual(_example_id, result.uid2)
264+
self.assertEqual(_example_id, result.uid)
265265

266266

267267
def test_decrypt_token_v3_empty_keys(self):
@@ -321,7 +321,7 @@ def test_decrypt_token_v3_custom_now(self):
321321
result = decrypt(token, keys, now=expiry + dt.timedelta(seconds=1))
322322

323323
result = decrypt(token, keys, now=expiry - dt.timedelta(seconds=1))
324-
self.assertEqual(_example_id, result.uid2)
324+
self.assertEqual(_example_id, result.uid)
325325

326326

327327
def test_decrypt_token_v3_invalid_payload(self):
@@ -340,7 +340,7 @@ def test_decrypt_token_v2(self):
340340
keys = EncryptionKeysCollection([_master_key, _site_key])
341341
result = decrypt(token, keys)
342342

343-
self.assertEqual(_example_id, result.uid2)
343+
self.assertEqual(_example_id, result.uid)
344344

345345

346346
def test_decrypt_token_v2_empty_keys(self):
@@ -400,7 +400,7 @@ def test_decrypt_token_v2_custom_now(self):
400400
result = decrypt(token, keys, now=expiry + dt.timedelta(seconds=1))
401401

402402
result = decrypt(token, keys, now=expiry - dt.timedelta(seconds=1))
403-
self.assertEqual(_example_id, result.uid2)
403+
self.assertEqual(_example_id, result.uid)
404404

405405
def test_smoke_token_v3(self):
406406
uid2 = _example_id
@@ -416,7 +416,7 @@ def test_smoke_token_v3(self):
416416
ad_token_version=AdvertisingTokenVersion.ADVERTISING_TOKEN_V3)
417417
final = decrypt(result, keys, now=now)
418418

419-
self.assertEqual(uid2, final.uid2)
419+
self.assertEqual(uid2, final.uid)
420420

421421
def test_smoke_token_v4(self):
422422
uid2 = _example_id
@@ -429,7 +429,7 @@ def test_smoke_token_v4(self):
429429
result = encrypt(uid2, identity_scope, keys, now=now)
430430
final = decrypt(result, keys, now=now)
431431

432-
self.assertEqual(uid2, final.uid2)
432+
self.assertEqual(uid2, final.uid)
433433

434434
def test_decrypt_token_v2_invalid_payload(self):
435435
params = Params(dt.datetime.now(tz=timezone.utc) + dt.timedelta(seconds=-1))
@@ -702,7 +702,7 @@ def verify_identity_type(self, raw_uid, expected_identity_type):
702702
token = self.generate_uid2_token_v4(raw_uid, _master_key, _site_id, _site_key, Params(), expected_identity_type)
703703
keys = EncryptionKeysCollection([_master_key, _site_key])
704704
result = decrypt(token, keys)
705-
self.assertEqual(raw_uid, result.uid2)
705+
self.assertEqual(raw_uid, result.uid)
706706
self.assertEqual(expected_identity_type, get_identity_type(token))
707707

708708

‎tests/test_sharing.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def setup_sharing_and_encrypt(self, id_scope=IdentityScope.UID2):
1919
def test_can_encrypt_and_decrypt_for_sharing(self):
2020
ad_token, keys = self.setup_sharing_and_encrypt()
2121
results = decrypt(ad_token, keys)
22-
self.assertEqual(example_uid, results.uid2)
22+
self.assertEqual(example_uid, results.uid)
2323

2424
def test_can_decrypt_another_clients_encrypted_token(self):
2525
ad_token, keys = self.setup_sharing_and_encrypt()
@@ -29,7 +29,7 @@ def test_can_decrypt_another_clients_encrypted_token(self):
2929
receiving_keys = receiving_client.refresh_json(keys_json)
3030

3131
result = decrypt(ad_token, receiving_keys)
32-
self.assertEqual(example_uid, result.uid2)
32+
self.assertEqual(example_uid, result.uid)
3333

3434
def test_sharing_token_is_v4(self):
3535
ad_token, keys = self.setup_sharing_and_encrypt()
@@ -62,7 +62,7 @@ def test_multiple_keys_per_keyset(self):
6262

6363
result = decrypt(ad_token, keys)
6464

65-
self.assertEqual(example_uid, result.uid2)
65+
self.assertEqual(example_uid, result.uid)
6666

6767
def test_cannot_encrypt_if_no_key_from_default_keyset(self):
6868
client = Uid2Client("endpoint", "authkey", client_secret)
@@ -87,7 +87,7 @@ def test_expiry_in_token_matches_expiry_in_reponse(self):
8787
ad_token = encrypt(example_uid, IdentityScope.UID2, keys)
8888

8989
result = decrypt(ad_token, keys, now=now + dt.timedelta(seconds=1))
90-
self.assertEqual(example_uid, result.uid2)
90+
self.assertEqual(example_uid, result.uid)
9191

9292
self.assertRaises(EncryptionError, decrypt, ad_token, keys, now=now + dt.timedelta(seconds=3))
9393

0 commit comments

Comments
 (0)