Merge pull request #39 from IABTechLab/ccm-UID2-2760-implement-identity-map

caroline-ttd · web-flow · commit 3740fd40e809 · 2024-05-21T19:21:41.000-07:00
UID2-2760 Add IdentityMapClient
diff --git a/Dockerfile.dev b/Dockerfile.dev
@@ -1,3 +1,3 @@
-FROM python:3.6
+FROM python:3.8
 COPY . /build
 RUN pip install --no-cache-dir -e /build[dev]
diff --git a/README.md b/README.md
@@ -26,22 +26,12 @@ For documentation on usage, see the [UID2 SDK for Python Reference Guide](https:
 
 ## Example Usage
 
-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= \
-	DOMAIN=example.com
-```
-
-Alternatively, you can run specific examples:
+You can run specific examples:
 
 ```
-make example_client 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==
-make example_auto_refresh 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==
+python examples/sample_bidstream_client.py BASE_URL=https://operator-integ.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key
+	DOMAIN_NAME=domain-name AD_TOKEN=ad-token
 ```
 
 ## Development
@@ -52,12 +42,6 @@ First, build the Docker image with Python 3.6 and all dev dependencies. This is
 make docker
 ```
 
-Run unit tests:
-
-```
-make test
-```
-
 Build a bdist wheel:
 
 ```
@@ -69,3 +53,4 @@ Get access to an interactive shell within the Python 3.6 Docker image:
 ```
 make shell
 ```
+Run unit tests: Use PyCharm to run the test cases
diff --git a/examples/sample_identity_map_client.py b/examples/sample_identity_map_client.py
@@ -0,0 +1,38 @@
+import sys
+
+from uid2_client import IdentityMapClient, IdentityMapInput
+
+
+# this sample client takes email addresses as input and generates an IdentityMapResponse object which contains raw uid
+# 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>'
+          , file=sys.stderr)
+    sys.exit(1)
+
+
+if len(sys.argv) <= 4:
+    _usage()
+
+base_url = sys.argv[1]
+api_key = sys.argv[2]
+client_secret = sys.argv[3]
+email_list = sys.argv[4:]
+first_email = sys.argv[4]
+
+client = IdentityMapClient(base_url, api_key, client_secret)
+
+identity_map_response = client.generate_identity_map(IdentityMapInput.from_emails(email_list))
+
+mapped_identities = identity_map_response.mapped_identities
+unmapped_identities = identity_map_response.unmapped_identities
+
+mapped_identity = mapped_identities.get(first_email)
+if mapped_identity is not None:
+    raw_uid = mapped_identity.get_raw_uid()
+    print('raw_uid =', raw_uid)
+else:
+    unmapped_identity = unmapped_identities.get(first_email)
+    reason = unmapped_identity.get_reason()
+    print('reason =', reason)
diff --git a/tests/test_identity_map_client.py b/tests/test_identity_map_client.py
@@ -0,0 +1,170 @@
+import os
+import unittest
+from urllib.error import URLError, HTTPError
+
+from uid2_client import IdentityMapClient, IdentityMapInput, normalize_and_hash_email, normalize_and_hash_phone
+
+
+class IdentityMapIntegrationTests(unittest.TestCase):
+    UID2_BASE_URL = None
+    UID2_API_KEY = None
+    UID2_SECRET_KEY = None
+
+    identity_map_client = None
+
+    @classmethod
+    def setUpClass(cls):
+        cls.UID2_BASE_URL = os.getenv("UID2_BASE_URL")
+        cls.UID2_API_KEY = os.getenv("UID2_API_KEY")
+        cls.UID2_SECRET_KEY = os.getenv("UID2_SECRET_KEY")
+
+        if cls.UID2_BASE_URL and cls.UID2_API_KEY and cls.UID2_SECRET_KEY:
+            cls.identity_map_client = IdentityMapClient(cls.UID2_BASE_URL, cls.UID2_API_KEY, cls.UID2_SECRET_KEY)
+        else:
+            raise Exception("set the required UID2_BASE_URL/UID2_API_KEY/UID2_SECRET_KEY environment variables first")
+
+    def test_identity_map_emails(self):
+        identity_map_input = IdentityMapInput.from_emails(
+            ["hopefully-not-opted-out@example.com", "somethingelse@example.com", "optout@example.com"])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+        self.assert_mapped(response, "hopefully-not-opted-out@example.com")
+        self.assert_mapped(response, "somethingelse@example.com")
+
+        self.assert_unmapped(response, "optout", "optout@example.com")
+
+    def test_identity_map_nothing_unmapped(self):
+        identity_map_input = IdentityMapInput.from_emails(
+            ["hopefully-not-opted-out@example.com", "somethingelse@example.com"])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+        self.assert_mapped(response, "hopefully-not-opted-out@example.com")
+        self.assert_mapped(response, "somethingelse@example.com")
+
+    def test_identity_map_nothing_mapped(self):
+        identity_map_input = IdentityMapInput.from_emails(["optout@example.com"])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+        self.assert_unmapped(response, "optout", "optout@example.com")
+
+    def test_identity_map_invalid_email(self):
+        self.assertRaises(ValueError, IdentityMapInput.from_emails,
+                          ["email@example.com", "this is not an email"])
+
+    def test_identity_map_invalid_phone(self):
+        self.assertRaises(ValueError, IdentityMapInput.from_phones,
+                          ["+12345678901", "this is not a phone number"])
+
+    def test_identity_map_invalid_hashed_email(self):
+        identity_map_input = IdentityMapInput.from_hashed_emails(["this is not a hashed email"])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+        self.assert_unmapped(response, "invalid identifier", "this is not a hashed email")
+
+    def test_identity_map_invalid_hashed_phone(self):
+        identity_map_input = IdentityMapInput.from_hashed_emails(["this is not a hashed phone"])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+        self.assert_unmapped(response, "invalid identifier", "this is not a hashed phone")
+
+    def test_identity_map_hashed_emails(self):
+        hashed_email1 = normalize_and_hash_email("hopefully-not-opted-out@example.com")
+        hashed_email2 = normalize_and_hash_email("somethingelse@example.com")
+        hashed_opted_out_email = normalize_and_hash_email("optout@example.com")
+        identity_map_input = IdentityMapInput.from_hashed_emails([hashed_email1, hashed_email2, hashed_opted_out_email])
+
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+
+        self.assert_mapped(response, hashed_email1)
+        self.assert_mapped(response, hashed_email2)
+
+        self.assert_unmapped(response, "optout", hashed_opted_out_email)
+
+    def test_identity_map_duplicate_emails(self):
+        identity_map_input = IdentityMapInput.from_emails(
+            ["JANE.SAOIRSE@gmail.com", "Jane.Saoirse@gmail.com", "JaneSaoirse+UID2@gmail.com", "janesaoirse@gmail.com",
+             "JANE.SAOIRSE@gmail.com"])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+
+        mapped_identities = response.mapped_identities
+        self.assertEqual(4, len(mapped_identities))
+
+        raw_uid = mapped_identities.get("JANE.SAOIRSE@gmail.com").get_raw_uid()
+        self.assertEqual(raw_uid, mapped_identities.get("Jane.Saoirse@gmail.com").get_raw_uid())
+        self.assertEqual(raw_uid, mapped_identities.get("JaneSaoirse+UID2@gmail.com").get_raw_uid())
+        self.assertEqual(raw_uid, mapped_identities.get("janesaoirse@gmail.com").get_raw_uid())
+
+    def test_identity_map_duplicate_hashed_emails(self):
+        hashed_email = normalize_and_hash_email("hopefully-not-opted-out@example.com")
+        duplicate_hashed_email = hashed_email
+        hashed_opted_out_email = normalize_and_hash_email("optout@example.com")
+        duplicate_hashed_opted_out_email = hashed_opted_out_email
+
+        identity_map_input = IdentityMapInput.from_hashed_emails(
+            [hashed_email, duplicate_hashed_email, hashed_opted_out_email, duplicate_hashed_opted_out_email])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+
+        self.assert_mapped(response, hashed_email)
+        self.assert_mapped(response, duplicate_hashed_email)
+
+        self.assert_unmapped(response, "optout", hashed_opted_out_email)
+        self.assert_unmapped(response, "optout", duplicate_hashed_opted_out_email)
+
+    def test_identity_map_empty_input(self):
+        identity_map_input = IdentityMapInput.from_emails([])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+        self.assertTrue(len(response.mapped_identities) == 0)
+        self.assertTrue(len(response.unmapped_identities) == 0)
+
+    def test_identity_map_phones(self):
+        identity_map_input = IdentityMapInput.from_phones(["+12345678901", "+98765432109", "+00000000000"])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+        self.assert_mapped(response, "+12345678901")
+        self.assert_mapped(response, "+98765432109")
+
+        self.assert_unmapped(response, "optout", "+00000000000")
+
+    def test_identity_map_hashed_phones(self):
+        hashed_phone1 = normalize_and_hash_phone("+12345678901")
+        hashed_phone2 = normalize_and_hash_phone("+98765432109")
+        hashed_opted_out_phone = normalize_and_hash_phone("+00000000000")
+        identity_map_input = IdentityMapInput.from_hashed_phones([hashed_phone1, hashed_phone2, hashed_opted_out_phone])
+        response = self.identity_map_client.generate_identity_map(identity_map_input)
+        self.assert_mapped(response, hashed_phone1)
+        self.assert_mapped(response, hashed_phone2)
+
+        self.assert_unmapped(response, "optout", hashed_opted_out_phone)
+
+    def test_identity_map_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(URLError, client.generate_identity_map, identity_map_input)
+
+    def test_identity_map_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(HTTPError, client.generate_identity_map,identity_map_input)
+
+    def test_identity_map_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(HTTPError, client.generate_identity_map,
+                          identity_map_input)
+
+    def assert_mapped(self, response, dii):
+        mapped_identity = response.mapped_identities.get(dii)
+        self.assertIsNotNone(mapped_identity)
+        self.assertIsNotNone(mapped_identity.get_raw_uid())
+        self.assertIsNotNone(mapped_identity.get_bucket_id())
+
+        unmapped_identity = response.unmapped_identities.get(dii)
+        self.assertIsNone(unmapped_identity)
+
+    def assert_unmapped(self, response, reason, dii):
+        unmapped_identity = response.unmapped_identities.get(dii)
+        self.assertEqual(reason, unmapped_identity.get_reason())
+
+        mapped_identity = response.mapped_identities.get(dii)
+        self.assertIsNone(mapped_identity)
+
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/uid2_client/__init__.py b/uid2_client/__init__.py
@@ -24,5 +24,6 @@
 from .encryption_data_response import *
 from .refresh_response import *
 from .uid2_token_generator import *
-
-
+from .identity_map_client import *
+from .identity_map_input import *
+from .identity_map_response import *
diff --git a/uid2_client/identity_map_client.py b/uid2_client/identity_map_client.py
@@ -0,0 +1,40 @@
+import base64
+import datetime as dt
+from datetime import timezone
+
+from .identity_map_response import IdentityMapResponse
+
+from uid2_client import auth_headers, make_v2_request, post, parse_v2_response
+
+
+class IdentityMapClient:
+    """Client for interacting with UID Identity Map services
+
+        You will need to have the base URL of the endpoint and a client API key
+        and secret to consume web services.
+
+        Methods:
+            generate_identity_map: Generate identity map
+    """
+
+    def __init__(self, base_url, api_key, client_secret):
+        """Create a new IdentityMapClient client.
+
+        Args:
+            base_url (str): base URL for all requests to UID services (e.g. 'https://prod.uidapi.com')
+            api_key (str): api key for consuming the UID services
+            client_secret (str): client secret for consuming the UID services
+
+        Note:
+            Your authorization key will determine which UID services you are allowed to use.
+        """
+        self._base_url = base_url
+        self._api_key = api_key
+        self._client_secret = base64.b64decode(client_secret)
+
+    def generate_identity_map(self, identity_map_input):
+        req, nonce = make_v2_request(self._client_secret, dt.datetime.now(tz=timezone.utc),
+                                     identity_map_input.get_identity_map_input_as_json_string().encode())
+        resp = post(self._base_url, '/v2/identity/map', headers=auth_headers(self._api_key), data=req)
+        resp_body = parse_v2_response(self._client_secret, resp.read(), nonce)
+        return IdentityMapResponse(resp_body, identity_map_input)
diff --git a/uid2_client/identity_map_input.py b/uid2_client/identity_map_input.py
@@ -0,0 +1,62 @@
+import json
+
+from uid2_client import IdentityType, normalize_and_hash_email, normalize_and_hash_phone
+
+
+class IdentityMapInput:
+    """input for IdentityMapClient, such as email addresses or phone numbers"""
+
+    def __init__(self, identity_type, emails_or_phones, already_hashed):
+        self.hashed_dii_to_raw_diis = {}
+        self.hashed_normalized_emails = None
+        self.hashed_normalized_phones = None
+        if identity_type == IdentityType.Email:
+            if already_hashed:
+                self.hashed_normalized_emails = emails_or_phones
+            else:
+                self.hashed_normalized_emails = []
+                for email in emails_or_phones:
+                    hashed_normalized_email = normalize_and_hash_email(email)
+                    self._add_hashed_to_raw_dii_mapping(hashed_normalized_email, email)
+                    self.hashed_normalized_emails.append(hashed_normalized_email)
+        else:  # phone
+            if already_hashed:
+                self.hashed_normalized_phones = emails_or_phones
+            else:
+                self.hashed_normalized_phones = []
+                for phone in emails_or_phones:
+                    hashed_normalized_phone = normalize_and_hash_phone(phone)
+                    self._add_hashed_to_raw_dii_mapping(hashed_normalized_phone, phone)
+                    self.hashed_normalized_phones.append(hashed_normalized_phone)
+
+    @staticmethod
+    def from_emails(emails):
+        return IdentityMapInput(IdentityType.Email, emails, False)
+
+    @staticmethod
+    def from_phones(phones):
+        return IdentityMapInput(IdentityType.Phone, phones, False)
+
+    @staticmethod
+    def from_hashed_emails(hashed_emails):
+        return IdentityMapInput(IdentityType.Email, hashed_emails, True)
+
+    @staticmethod
+    def from_hashed_phones(hashed_phones):
+        return IdentityMapInput(IdentityType.Phone, hashed_phones, True)
+
+    def _add_hashed_to_raw_dii_mapping(self, hashed_dii, raw_dii):
+        self.hashed_dii_to_raw_diis.setdefault(hashed_dii, []).append(raw_dii)
+
+    def get_raw_diis(self, identifier):
+        if len(self.hashed_dii_to_raw_diis) <= 0:
+            return [identifier]
+        else:
+            return self.hashed_dii_to_raw_diis[identifier]
+
+    def get_identity_map_input_as_json_string(self):
+        json_object = {
+            "email_hash": self.hashed_normalized_emails,
+            "phone_hash": self.hashed_normalized_phones
+        }
+        return json.dumps({k: v for k, v in json_object.items() if v is not None})
diff --git a/uid2_client/identity_map_response.py b/uid2_client/identity_map_response.py
diff --git a/uid2_client/input_util.py b/uid2_client/input_util.py
