add a func to create a respondent url from the required parameters

Author: dy-waltergrantward

README.md

@@ -53,6 +53,20 @@ data = registry.download_collection(cell.collection_id)
 from dynata_rex import RespondentGateway
 gateway = RespondentGateway('rex_access_key', 'rex_secret_key')
 ```
+
+### Create a survey link for your respondent
+```
+url = 'https://respondent.fake.rex.dynata.com/start?ctx=XXXX&language=en'
+
+signed_link = gateway.create_respondent_url(url,
+                                            '1990-01-01',
+                                            'male',
+                                            '90210',
+                                            'very-unique-respondent-id',
+                                            ttl=60)
+# https://respondent.fake.rex.dynata.com/start?ctx=XXXX&language=en&birth_date=1990-01-01&gender=male&postal_code=90210&respondent_id=very-unique-respondent-id&access_key=rex_access_key&expiration=2021-11-29T15:35:12.993Z&signature=4353e8c4ca8f8fb75530214ac78139b55ca3f090438c639476b8584afe1396e6
+```
+
 ### Sign an inbound /start link with your credentials
 ```
 url = 'https://respondent.fake.rex.dynata.com/start?ctx=XXXX&language=en'

dynata_rex/opportunity_registry.py

@@ -41,7 +41,7 @@ def __init__(self,
         self.signature_ttl = signature_ttl
         self.make_request = RexRequest(access_key,
                                        secret_key,
-                                       ttl=signature_ttl)
+                                       default_ttl=signature_ttl)
         self.base_url = self._format_base_url(base_url)
 
         if current_shard > shard_count:

dynata_rex/respondent_gateway.py

@@ -6,7 +6,7 @@
 Description: Respondent Gateway interactions
 """
 # Python Import
-from urllib.parse import urlparse, parse_qsl, unquote
+from urllib.parse import urlparse, parse_qsl, unquote, urlencode
 from typing import Union
 from copy import copy
 
@@ -39,6 +39,37 @@ def __init__(self,
         self.default_ttl = default_ttl
         self.signer = Signer(access_key, secret_key, default_ttl=default_ttl)
 
+    def create_respondent_url(self,
+                              url: str,
+                              birth_date: str,
+                              gender: str,
+                              postal_code: str,
+                              respondent_id: str,
+                              ttl: Union[int, None] = None,
+                              url_quoting: bool = False) -> str:
+        """
+        Creates a url from the url of an opportunity + the required
+        parameters for entry into the respondent gateway.
+
+        @url: live/test url of an opportunity
+        @birth_date: birth date in ISO8601 (YYYY-MM-DD) format
+        @gender: 'male' / 'female'
+        @postal: postal code as string
+        @respondent_id : unique identifier for the respondent
+        """
+        parsed = urlparse(url)
+        base_params = dict(parse_qsl(parsed.query))
+        required_params = {
+            'birth_date': birth_date,
+            'gender': gender,
+            'postal_code': postal_code,
+            'respondent_id': respondent_id
+        }
+        final_params = dict(base_params, **required_params)
+        updated_query = urlencode(final_params, doseq=True)
+        parsed = parsed._replace(query=updated_query)
+        return self.sign_url(parsed.geturl(), ttl=ttl, url_quoting=url_quoting)
+
     def sign_url(self,
                  url,
                  ttl: Union[int, None] = None,