splitting branch

Author: Ian-Nara

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
+examples: example_client example_auto_refresh example_sharing
 
 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)"
@@ -17,6 +17,10 @@ example_auto_refresh:
 example_encryption:
 	docker run -w $(PWD) -v $(PWD):$(PWD) -u `id -u`:`id -g` -e PYTHONPATH=$(PWD) $(DOCKERIMAGE) python3 examples/sample_encryption.py "$(BASE_URL)" "$(AUTH_KEY)" "$(SECRET_KEY)" "$(AD_TOKEN)" "Hello World!"
 
+example_sharing:
+	docker run -w $(PWD) -v $(PWD):$(PWD) -u `id -u`:`id -g` -e PYTHONPATH=$(PWD) $(DOCKERIMAGE) python3 examples/sample_sharing.py "$(BASE_URL)" "$(AUTH_KEY)" "$(SECRET_KEY)" "$(RAW_UID)"
+
+
 docker:
 	docker build -t $(DOCKERIMAGE) -f Dockerfile.dev .
 

README.md

@@ -15,17 +15,19 @@ Connect to the UID2 service, refresh the encryption keys, and then use the keys
 ```
 from uid2_client import Uid2Client, decrypt
 
-client = Uid2Client('https://prod.uidapi.com', 'my-auth-token', 'my-secret-key')
+client = Uid2Client('https://prod.uidapi.com', 'my-auth-token', 'my-secret-key', IdentityScope.UID2)
 keys = client.refresh_keys()
 advertising_token = 'AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A=='
-decrypted_token = decrypt(advertising_token, keys)
+decrypted_token = client.decrypt(advertising_token, keys)
 print(decrypted_token.uid2)
 ```
 
 Additional examples are in the [examples] directory:
 * [sample_auto_refresh.py](examples/sample_auto_refresh.py)
 * [sample_client.py](examples/sample_client.py)
-  * Includes an example to encrypt a raw UID2 into an advertising token for UID2 sharing.
+  * Example for DSPs (decryption of tokens)
+* [sample_sharing.py](examples/sample_sharing.py)
+  * Example for Sharers (decryption/encryption of tokens/uids)
 
 ## Development
 
@@ -59,7 +61,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==
+	AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A== \
+	RAW_UID=JCqmlLXpbbu/jTdpB2a1cNAVs8O72eMXPaQzC9Ic9mE=
 ```
 
 Alternatively, you can run specific examples:

examples/sample_client.py

@@ -6,8 +6,7 @@
 from uid2_client.identity_scope import IdentityScope
 
 # this sample client decrypts an advertising token into a raw UID2
-# and then encrypts it into a new advertising token
-# to demonstrate decryption (for DSPs and sharers) and encryption (sharers only).
+# to demonstrate decryption for DSPs
 
 def _usage():
     print('Usage: python3 sample_client.py <base_url> <auth_key> <secret_key> <ad_token>', file=sys.stderr)

examples/sample_sharing.py

@@ -5,6 +5,9 @@
 from uid2_client import encrypt
 from uid2_client.identity_scope import IdentityScope
 
+# this sample client encrypts and decrypts a uid2 to a sharing token
+# to demonstrate encryption and decryption for sharers
+
 def _usage():
     print('Usage: python3 sample_encryption.py <base_url> <auth_key> <secret_key> <raw_uid>', file=sys.stderr)
     sys.exit(1)
@@ -20,11 +23,13 @@ def _usage():
 
 client = Uid2Client(base_url, auth_key, secret_key, IdentityScope.UID2)
 keys = client.refresh_keys()
-
 new_ad_token = client.encrypt(raw_uid, keys)
+
 print('New Ad Token =', new_ad_token)
+
 decrypt_result = client.decrypt(new_ad_token, keys)
+
 print('Decrypted UID2 =', decrypt_result.uid2)
 print('Established =', decrypt_result.established)
 print('Site ID =', decrypt_result.site_id)
-print('Site Key Site ID =', decrypt_result.site_key_site_id)
+print('Site Key Site ID =', decrypt_result.site_key_site_id)

examples/sample_token_generate_refresh.py

@@ -12,7 +12,5 @@
 from .client import *
 from .encryption import *
 from .keys import *
-from .publisher_client import *
-from .token_generate_input import *