Merge branch 'development'

echarrod · echarrod · commit b610d169fb2f · 2019-02-12T07:18:59.000-07:00
diff --git a/README.md b/README.md
@@ -120,7 +120,7 @@ client = Client(YOTI_CLIENT_SDK_ID, YOTI_KEY_FILE_PATH)
 activity_details = client.get_activity_details(token)
 
 profile = activity_details.profile
-		
+        
 selfie = profile.selfie.value
 given_names = profile.given_names.value
 family_name = profile.family_name.value
@@ -131,8 +131,9 @@ postal_address = profile.postal_address.value
 gender = profile.gender.value
 nationality = profile.nationality.value
 email_address = profile.email_address.value
-		
+        
 remember_me_id = activity_details.user_id
+parent_remember_me_id = activity_details.parent_remember_me_id
 receipt_id = activity_details.receipt_id
 timestamp = activity_details.timestamp
 base64_selfie_uri = activity_details.base64_selfie_uri
@@ -281,6 +282,7 @@ For information on testing with multiple Python versions, see [VERSION-SUPPORT.m
 
 * Activity Details
     * [X] Remember Me ID `user_id`
+    * [X] Parent Remember Me ID `parent_remember_me_id`
     * [X] ReceiptID `receipt_id`
     * [X] Timestamp `timestamp`
     * [X] Profile `profile`
diff --git a/examples/yoti_example_django/Dockerfile b/examples/yoti_example_django/Dockerfile
@@ -1,4 +1,4 @@
-FROM python:3
+FROM python:3.6.3
 ARG YOTI_APPLICATION_ID
 ARG YOTI_CLIENT_SDK_ID
 ARG YOTI_KEY_FILE_PATH
diff --git a/examples/yoti_example_django/docker-compose.yml b/examples/yoti_example_django/docker-compose.yml
@@ -8,4 +8,4 @@ services:
         YOTI_CLIENT_SDK_ID: "${YOTI_CLIENT_SDK_ID}"
         YOTI_KEY_FILE_PATH: "${YOTI_KEY_FILE_PATH}"
     ports:
-    - "5000:5000"
+      - "5000:5000"
diff --git a/examples/yoti_example_django/requirements.in b/examples/yoti_example_django/requirements.in
@@ -1,4 +1,4 @@
 yoti>=2.5.0
-Django==1.11
+Django>1.11.16
 python-dotenv>=0.7.1
 django-sslserver
diff --git a/examples/yoti_example_django/requirements.txt b/examples/yoti_example_django/requirements.txt
@@ -11,7 +11,7 @@ cffi==1.11.5              # via cryptography
 chardet==3.0.4            # via requests
 cryptography==2.2.2       # via pyopenssl, yoti
 django-sslserver==0.20
-django==1.11
+django==2.1.7
 future==0.16.0            # via yoti
 idna==2.7                 # via cryptography, requests
 protobuf==3.6.0           # via yoti
diff --git a/examples/yoti_example_django/yoti_example/templates/profile.html b/examples/yoti_example_django/yoti_example/templates/profile.html
@@ -46,6 +46,12 @@ <h3>Yoti Profile</h3>
             <td>{{user_id}}</td>
         </tr>
         {% endif %}
+        {% if parent_remember_me_id %}
+        <tr>
+            <th scope="row">Parent Remember Me ID</th>
+            <td>{{parent_remember_me_id}}</td>
+        </tr>
+        {% endif %}
         {% if given_names %}
         <tr>
             <th scope="row">Given Name(s)</th>
diff --git a/examples/yoti_example_django/yoti_example/views.py b/examples/yoti_example_django/yoti_example/views.py
@@ -30,6 +30,7 @@ def get(self, request, *args, **kwargs):
         context = profile_dict.get('attributes')
         context['base64_selfie_uri'] = getattr(activity_details, 'base64_selfie_uri')
         context['user_id'] = getattr(activity_details, 'user_id')
+        context['parent_remember_me_id'] = getattr(activity_details, 'parent_remember_me_id')
         context['receipt_id'] = getattr(activity_details, 'receipt_id')
         context['timestamp'] = getattr(activity_details, 'timestamp')
 
diff --git a/examples/yoti_example_flask/Dockerfile b/examples/yoti_example_flask/Dockerfile
@@ -1,4 +1,4 @@
-FROM python:3
+FROM python:3.6.3
 ARG YOTI_APPLICATION_ID
 ARG YOTI_CLIENT_SDK_ID
 ARG YOTI_KEY_FILE_PATH
diff --git a/examples/yoti_example_flask/app.py b/examples/yoti_example_flask/app.py
@@ -41,6 +41,7 @@ def auth():
     context = profile_dict.get('attributes')
     context['base64_selfie_uri'] = getattr(activity_details, 'base64_selfie_uri')
     context['user_id'] = getattr(activity_details, 'user_id')
+    context['parent_remember_me_id'] = getattr(activity_details, 'parent_remember_me_id')
     context['receipt_id'] = getattr(activity_details, 'receipt_id')
     context['timestamp'] = getattr(activity_details, 'timestamp')
 
diff --git a/examples/yoti_example_flask/docker-compose.yml b/examples/yoti_example_flask/docker-compose.yml
@@ -8,4 +8,4 @@ services:
         YOTI_CLIENT_SDK_ID: "${YOTI_CLIENT_SDK_ID}"
         YOTI_KEY_FILE_PATH: "${YOTI_KEY_FILE_PATH}"
     ports:
-    - "5000:5000"
+      - "5000:5000"
diff --git a/examples/yoti_example_flask/templates/profile.html b/examples/yoti_example_flask/templates/profile.html
@@ -46,6 +46,12 @@ <h3>Yoti Profile</h3>
             <td>{{user_id}}</td>
         </tr>
         {% endif %}
+        {% if parent_remember_me_id %}
+        <tr>
+            <th scope="row">Parent Remember Me ID</th>
+            <td>{{parent_remember_me_id}}</td>
+        </tr>
+        {% endif %}
         {% if given_names %}
         <tr>
             <th scope="row">Given Name(s)</th>
diff --git a/setup.py b/setup.py
@@ -1,26 +1,28 @@
 # -*- coding: utf-8 -*-
 from setuptools import setup, find_packages
 
-VERSION = '2.5.0'
+from yoti_python_sdk import __version__
+
 long_description = 'This package contains the tools you need to quickly ' \
                    'integrate your Python back-end with Yoti, so that your ' \
                    'users can share their identity details with your ' \
                    'application in a secure and trusted way.'
 
 setup(
     name='yoti',
-    version=VERSION,
+    version=__version__,
     packages=find_packages(),
     license='MIT',
     description='The Yoti Python SDK, providing API support for Login, Verify (2FA) and Age Verification.',
     long_description=long_description,
     url='https://github.com/getyoti/yoti-python-sdk',
     author='Yoti',
-    author_email='tech@yoti.com',
+    author_email='websdk@yoti.com',
     install_requires=['cryptography>=2.2.1', 'protobuf>=3.1.0',
                       'requests>=2.11.1', 'future>=0.11.0', 'asn1==2.2.0', 'pyopenssl>=18.0.0'],
     extras_require={
-        'examples': ['Django>=1.8', 'Flask>=0.10', 'python-dotenv>=0.7.1', 'django-sslserver>=0.2', 'Werkzeug==0.11.15'],
+        'examples': ['Django>1.11.16', 'Flask>=0.10', 'python-dotenv>=0.7.1', 'django-sslserver>=0.2',
+                     'Werkzeug==0.11.15'],
     },
     classifiers=[
         'Development Status :: 5 - Production/Stable',
diff --git a/yoti_python_sdk/__init__.py b/yoti_python_sdk/__init__.py
@@ -1,4 +1,7 @@
 # -*- coding: utf-8 -*-
+import os
+
+from distutils.util import convert_path
 from os import environ
 
 from yoti_python_sdk.client import Client
@@ -9,11 +12,22 @@
     'YOTI_API_VERSION': 'v1',
 }
 
+main_ns = {}
+
+directory_name = os.path.dirname(__file__)
+version_path = os.path.join(directory_name, 'version.py')
+
+ver_path = convert_path(version_path)
+with open(ver_path) as ver_file:
+    exec(ver_file.read(), main_ns)
+
+__version__ = main_ns['__version__']
 YOTI_API_URL = environ.get('YOTI_API_URL', DEFAULTS['YOTI_API_URL'])
 YOTI_API_PORT = environ.get('YOTI_API_PORT', DEFAULTS['YOTI_API_PORT'])
 YOTI_API_VERSION = environ.get('YOTI_API_VERSION', DEFAULTS['YOTI_API_VERSION'])
 YOTI_API_ENDPOINT = '{0}:{1}/api/{2}'.format(YOTI_API_URL, YOTI_API_PORT, YOTI_API_VERSION)
 
 __all__ = [
     'Client',
+    __version__
 ]
diff --git a/yoti_python_sdk/activity_details.py b/yoti_python_sdk/activity_details.py
@@ -39,6 +39,7 @@ def __init__(self, receipt, decrypted_profile=None):
             self.ensure_postal_address()
 
         self.user_id = receipt.get('remember_me_id')
+        self.parent_remember_me_id = receipt.get('parent_remember_me_id')
         self.outcome = receipt.get('sharing_outcome')
         self.receipt_id = receipt.get('receipt_id')
         timestamp = receipt.get('timestamp')
@@ -86,6 +87,7 @@ def ensure_postal_address(self):
 
     def __iter__(self):
         yield 'user_id', self.user_id
+        yield 'parent_remember_me_id', self.parent_remember_me_id
         yield 'outcome', self.outcome
         yield 'receipt_id', self.receipt_id
         yield 'user_profile', self.user_profile
diff --git a/yoti_python_sdk/attribute.py b/yoti_python_sdk/attribute.py
@@ -2,7 +2,9 @@
 
 
 class Attribute:
-    def __init__(self, name="", value="", anchors={}):
+    def __init__(self, name="", value="", anchors=None):
+        if anchors is None:
+            anchors = {}
         self.__name = name
         self.__value = value
         self.__anchors = anchors
diff --git a/yoti_python_sdk/client.py b/yoti_python_sdk/client.py
@@ -15,7 +15,7 @@
 from yoti_python_sdk.crypto import Crypto
 from yoti_python_sdk.endpoint import Endpoint
 from yoti_python_sdk.protobuf.v1 import protobuf
-from .config import SDK_IDENTIFIER
+from .config import *
 
 NO_KEY_FILE_SPECIFIED_ERROR = 'Please specify the correct private key file ' \
                               'in Client(pem_file_path=...)\nor by setting ' \
@@ -112,13 +112,15 @@ def __make_aml_check_request(self, http_method, aml_profile):
 
     def __get_request_headers(self, path, http_method, content):
         request = self.__create_request(http_method, path, content)
+        sdk_version = yoti_python_sdk.__version__
 
         return {
-            'X-Yoti-Auth-Key': self.__crypto.get_public_key(),
-            'X-Yoti-Auth-Digest': self.__crypto.sign(request),
-            'X-Yoti-SDK': SDK_IDENTIFIER,
-            'Content-Type': 'application/json',
-            'Accept': 'application/json'
+            X_YOTI_AUTH_KEY: self.__crypto.get_public_key(),
+            X_YOTI_AUTH_DIGEST: self.__crypto.sign(request),
+            X_YOTI_SDK: SDK_IDENTIFIER,
+            X_YOTI_SDK_VERSION: sdk_version,
+            'Content-Type': JSON_CONTENT_TYPE,
+            'Accept': JSON_CONTENT_TYPE
         }
 
     @staticmethod
diff --git a/yoti_python_sdk/config.py b/yoti_python_sdk/config.py
@@ -18,3 +18,8 @@
 KEY_AGE_VERIFIED = "is_age_verified"
 KEY_BASE64_SELFIE = "base64_selfie_uri"
 KEY_FORMATTED_ADDRESS = "formatted_address"
+X_YOTI_AUTH_KEY = "X-Yoti-Auth-Key"
+X_YOTI_AUTH_DIGEST = "X-Yoti-Auth-Digest"
+X_YOTI_SDK = "X-Yoti-SDK"
+X_YOTI_SDK_VERSION = X_YOTI_SDK + "-Version"
+JSON_CONTENT_TYPE = 'application/json'
diff --git a/yoti_python_sdk/profile.py b/yoti_python_sdk/profile.py
@@ -26,7 +26,7 @@ def __init__(self, profile_attributes):
                 if field.name == config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS:
                     self.try_convert_structured_postal_address_to_dict(field, anchors)
 
-            self.ensure_postal_address(anchors)
+            self.ensure_postal_address()
 
     @property
     def date_of_birth(self):
@@ -78,7 +78,6 @@ def get_attribute(self, attribute_name):
         else:
             return None
 
-
     def try_convert_structured_postal_address_to_dict(self, field, anchors):
         decoder = json.JSONDecoder(object_pairs_hook=collections.OrderedDict, strict=False)
         value_to_decode = field.value.decode()
@@ -88,12 +87,14 @@ def try_convert_structured_postal_address_to_dict(self, field, anchors):
             decoder.decode(value_to_decode),
             anchors)
 
-    def ensure_postal_address(self, anchors):
+    def ensure_postal_address(self):
         if config.ATTRIBUTE_POSTAL_ADDRESS not in self.attributes and config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS in self.attributes:
-            if config.KEY_FORMATTED_ADDRESS in self.attributes[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value:
-                formatted_address = self.attributes[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value[
+            structured_postal_address = self.attributes[config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS]
+
+            if config.KEY_FORMATTED_ADDRESS in structured_postal_address.value:
+                formatted_address = structured_postal_address.value[
                     config.KEY_FORMATTED_ADDRESS]
                 self.attributes[config.ATTRIBUTE_POSTAL_ADDRESS] = Attribute(
                     config.ATTRIBUTE_POSTAL_ADDRESS,
                     formatted_address,
-                    anchors)
+                    structured_postal_address.anchors)
diff --git a/yoti_python_sdk/protobuf/v1/protobuf.py b/yoti_python_sdk/protobuf/v1/protobuf.py
@@ -2,9 +2,9 @@
 from __future__ import unicode_literals
 
 from cryptography.fernet import base64
-from yoti_python_sdk.protobuf.v1.attribute_public_api import attribute_pb2, list_pb2
 
 import yoti_python_sdk.protobuf.v1.common_public_api.encrypted_data_pb2 as compubapi
+from yoti_python_sdk.protobuf.v1.attribute_public_api import attribute_pb2, list_pb2
 
 
 class Protobuf(object):
diff --git a/yoti_python_sdk/tests/conftest.py b/yoti_python_sdk/tests/conftest.py
@@ -45,6 +45,11 @@ def user_id():
     return 'ijH4kkqMKTG0FSNUgQIvd2Z3Nx1j8f5RjVQMyoKOvO/hkv43Ik+t6d6mGfP2tdrN'
 
 
+@pytest.fixture(scope='module')
+def parent_remember_me_id():
+    return 'f5RjVQMyoKOvO/hkv43Ik+t6d6mGfP2tdrNijH4k4qafTG0FSNUgQIvd2Z3Nx1j8'
+
+
 @pytest.fixture(scope='module')
 def receipt_id():
     return 'Eq3+P8qjAlxr4d2mXKCUvzKdJTchI53ghwYPZXyA/cF5T+m/HCP1bK5LOmudZASN'
@@ -58,6 +63,7 @@ def timestamp():
 @pytest.fixture(scope='module')
 def successful_receipt():
     return {'remember_me_id': user_id(),
+            'parent_remember_me_id': parent_remember_me_id(),
             'receipt_id': receipt_id(),
             'timestamp': timestamp(),
             'sharing_outcome': 'SUCCESS'}
@@ -70,6 +76,13 @@ def failure_receipt():
             'timestamp': timestamp()}
 
 
+@pytest.fixture(scope='module')
+def empty_strings():
+    return {'remember_me_id': '',
+            'parent_remember_me_id': '',
+            'sharing_outcome': ''}
+
+
 @pytest.fixture(scope='module')
 def no_values_receipt():
     return {}
diff --git a/yoti_python_sdk/tests/test_activity_details.py b/yoti_python_sdk/tests/test_activity_details.py
@@ -8,7 +8,8 @@
 from yoti_python_sdk import config
 from yoti_python_sdk.activity_details import ActivityDetails
 from yoti_python_sdk.protobuf.v1.protobuf import Protobuf
-from yoti_python_sdk.tests.conftest import successful_receipt, failure_receipt, no_values_receipt, user_id
+from yoti_python_sdk.tests.conftest import successful_receipt, failure_receipt, \
+    no_values_receipt, user_id, parent_remember_me_id, empty_strings
 
 ADDRESS_FORMAT_KEY = "address_format"
 ADDRESS_FORMAT_VALUE = 1
@@ -117,6 +118,32 @@ def test_missing_values_handled():
     assert isinstance(activity_details, ActivityDetails)
 
 
+def test_remember_me_id_empty():
+    activity_details = ActivityDetails(empty_strings())
+
+    assert activity_details.user_id == ''
+    assert isinstance(activity_details, ActivityDetails)
+
+
+def test_remember_me_id_valid():
+    activity_details = ActivityDetails(successful_receipt())
+
+    assert activity_details.user_id == user_id()
+
+
+def test_parent_remember_me_id_empty():
+    activity_details = ActivityDetails(empty_strings())
+
+    assert activity_details.user_id == ''
+    assert isinstance(activity_details, ActivityDetails)
+
+
+def test_parent_remember_me_id_valid():
+    activity_details = ActivityDetails(successful_receipt())
+
+    assert activity_details.parent_remember_me_id == parent_remember_me_id()
+
+
 def test_try_parse_age_verified_field_age_over():
     activity_details = ActivityDetails(successful_receipt())
     create_age_verified_field(activity_details, True, "true".encode(), 18)
diff --git a/yoti_python_sdk/tests/test_client.py b/yoti_python_sdk/tests/test_client.py
diff --git a/yoti_python_sdk/version.py b/yoti_python_sdk/version.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM python:3`
	`1`	`+FROM python:3.6.3`
`2`	`2`	`ARG YOTI_APPLICATION_ID`
`3`	`3`	`ARG YOTI_CLIENT_SDK_ID`
`4`	`4`	`ARG YOTI_KEY_FILE_PATH`