Merge pull request #31 from IABTechLab/aaq-UID2-2877-dsp-check-client-refactor

Add BidStreamClient and SharingClient

Author: asloobq

Makefile

@@ -6,7 +6,7 @@ test:
 shell:
 	docker run -it -w $(PWD) -v $(PWD):$(PWD) -u `id -u`:`id -g` $(DOCKERIMAGE) /bin/bash
 
-examples: example_client example_auto_refresh example_sharing example_publisher
+examples: example_client example_auto_refresh example_sharing example_publisher example_bidstream_client example_sharing_client
 
 example_client:
 	docker run -w $(PWD) -v $(PWD):$(PWD) -u `id -u`:`id -g` -e PYTHONPATH=$(PWD) $(DOCKERIMAGE) python3 examples/sample_client.py "$(BASE_URL)" "$(AUTH_KEY)" "$(SECRET_KEY)" "$(AD_TOKEN)"
@@ -23,6 +23,12 @@ example_sharing:
 example_publisher:
 	docker run -w $(PWD) -v $(PWD):$(PWD) -u `id -u`:`id -g` -e PYTHONPATH=$(PWD) $(DOCKERIMAGE) python3 examples/sample_token_generate_refresh.py "$(BASE_URL)" "$(AUTH_KEY)" "$(SECRET_KEY)"
 
+example_bidstream_client:
+	docker run -w $(PWD) -v $(PWD):$(PWD) -u `id -u`:`id -g` -e PYTHONPATH=$(PWD) $(DOCKERIMAGE) python3 examples/sample_bidstream_client.py "$(BASE_URL)" "$(AUTH_KEY)" "$(SECRET_KEY)" "$(DOMAIN)" "$(AD_TOKEN)"
+
+example_sharing_client:
+	docker run -w $(PWD) -v $(PWD):$(PWD) -u `id -u`:`id -g` -e PYTHONPATH=$(PWD) $(DOCKERIMAGE) python3 examples/sample_sharing_client.py "$(BASE_URL)" "$(AUTH_KEY)" "$(SECRET_KEY)" "$(RAW_UID)"
+
 docker:
 	docker build -t $(DOCKERIMAGE) -f Dockerfile.dev .
 

README.md

@@ -67,7 +67,8 @@ To run all the example applications:
 ```
 make examples BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
 	AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A== \
-	RAW_UID=JCqmlLXpbbu/jTdpB2a1cNAVs8O72eMXPaQzC9Ic9mE=
+	RAW_UID=JCqmlLXpbbu/jTdpB2a1cNAVs8O72eMXPaQzC9Ic9mE= \
+	DOMAIN=example.com
 ```
 
 Alternatively, you can run specific examples:

examples/sample_auto_refresh.py

@@ -30,7 +30,7 @@ def _usage():
         if refresh_result.ready:
             print('Keys are ready, last refreshed (UTC):', refresh_result.last_success_time, flush=True)
             result = client.decrypt(ad_token)
-            print('UID2 =', result.uid2, flush=True)
+            print('UID =', result.uid, flush=True)
         else:
             print('Keys are not ready yet, last error:', refresh_result.last_error[1], flush=True)
         time.sleep(1)

examples/sample_bidstream_client.py

@@ -0,0 +1,37 @@
+import sys
+
+from uid2_client import BidstreamClient
+
+
+# this sample client decrypts an advertising token into a raw UID2
+# to demonstrate decryption for DSPs
+
+def _usage():
+    print('Usage: python3 sample_bidstream_client.py <base_url> <auth_key> <secret_key> <domain_name> <ad_token>', file=sys.stderr)
+    sys.exit(1)
+
+
+if len(sys.argv) < 6:
+    _usage()
+
+base_url = sys.argv[1]
+auth_key = sys.argv[2]
+secret_key = sys.argv[3]
+domain_name = sys.argv[4]
+ad_token = sys.argv[5]
+
+client = BidstreamClient(base_url, auth_key, secret_key)
+refresh_response = client.refresh()
+if not refresh_response.success:
+    print('Failed to refresh keys due to =', refresh_response.reason)
+    sys.exit(1)
+
+decrypt_result = client.decrypt_token_into_raw_uid(ad_token, domain_name)
+
+print('Status =', decrypt_result.status)
+print('UID =', decrypt_result.uid)
+print('Established =', decrypt_result.established)
+print('Site ID =', decrypt_result.site_id)
+print('Identity Type =', decrypt_result.identity_type)
+print('Advertising Token Version =', decrypt_result.advertising_token_version)
+print('Is Client Side Generated =', decrypt_result.is_client_side_generated)

examples/sample_client.py

@@ -1,3 +1,6 @@
+# THIS FILE IS DEPRECATED!
+# To learn how to decrypt a UID2 advertising token for DSPs, see sample_bidstream_client.py
+
 import sys
 
 from uid2_client.euid_client_factory import EuidClientFactory

examples/sample_encryption.py

@@ -5,13 +5,12 @@
 from uid2_client import encrypt_data, decrypt_data
 
 # THIS FILE IS DEPRECATED!
-# To learn how to encrypt and decrypt a UID2 advertising token, see sample_sharing.py (For sharers. See sample_client.py for DSPs)
+# To learn how to encrypt and decrypt a UID2 sharing token, see sample_sharing_client.py (For sharers. See sample_bidstream_client.py for DSPs)
 
 def _usage():
     print('Usage: python3 sample_encryption.py <base_url> <auth_key> <secret_key> <ad_token> <data>', file=sys.stderr)
     sys.exit(1)
 
-
 if len(sys.argv) <= 5:
     _usage()
 

examples/sample_sharing.py

@@ -1,3 +1,6 @@
+# THIS FILE IS DEPRECATED!
+# To learn how to encrypt and decrypt a UID2 sharing token, see sample_sharing_client.py (For sharers. See sample_bidstream_client.py for DSPs)
+
 import sys
 
 from uid2_client import EuidClientFactory
@@ -31,7 +34,7 @@ def _usage():
 
 decrypt_result = client.decrypt(new_ad_token)
 
-print('Decrypted UID2 =', decrypt_result.uid2)
+print('Decrypted UID =', decrypt_result.uid)
 print('Established =', decrypt_result.established)
 print('Site ID =', decrypt_result.site_id)
 print('Site Key Site ID =', decrypt_result.site_key_site_id)

examples/sample_sharing_client.py

@@ -0,0 +1,40 @@
+import sys
+
+from uid2_client import SharingClient
+
+
+# this sample client encrypts and decrypts a raw uid to a sharing token
+# to demonstrate encryption and decryption for sharers
+
+def _usage():
+    print('Usage: python3 sample_sharing_client.py <base_url> <auth_key> <secret_key> <raw_uid>', file=sys.stderr)
+    sys.exit(1)
+
+
+if len(sys.argv) <= 4:
+    _usage()
+
+base_url = sys.argv[1]
+auth_key = sys.argv[2]
+secret_key = sys.argv[3]
+raw_uid = sys.argv[4]
+
+client = SharingClient(base_url, auth_key, secret_key)
+refresh_response = client.refresh()
+if not refresh_response.success:
+    print('Failed to refresh keys due to =', refresh_response.reason)
+    sys.exit(1)
+
+encryption_data_response = client.encrypt_raw_uid_into_token(raw_uid)
+
+print('New Sharing Token =', encryption_data_response.encrypted_data)
+
+decrypt_result = client.decrypt_token_into_raw_uid(encryption_data_response.encrypted_data)
+
+print('Status =', decrypt_result.status)
+print('Decrypted UID =', decrypt_result.uid)
+print('UID =', decrypt_result.uid)
+print('Established =', decrypt_result.established)
+print('Site ID =', decrypt_result.site_id)
+print('Identity Type =', decrypt_result.identity_type)
+print('Advertising Token Version =', decrypt_result.advertising_token_version)