SDK-508: Change is_age_verified to be age_verified

Author: echarrod

README.md

@@ -127,7 +127,7 @@ family_name = profile.family_name.value
 full_name = profile.full_name.value
 phone_number = profile.phone_number.value
 date_of_birth = profile.date_of_birth.value
-is_age_verified = profile.is_age_verified.value
+age_verified = profile.age_verified.value
 postal_address = profile.postal_address.value
 gender = profile.gender.value
 nationality = profile.nationality.value
@@ -273,6 +273,7 @@ For information on testing with multiple Python versions, see [VERSION-SUPPORT.m
 
 * Activity Details
     * [X] User ID `user_id`
+    * [X] User Profile `user_profile` - **deprecated**, use `profile` instead
     * [X] Profile `profile`
         * [X] Photo `selfie`
         * [X] Given Names `given_names`
@@ -281,7 +282,7 @@ For information on testing with multiple Python versions, see [VERSION-SUPPORT.m
         * [X] Mobile Number `phone_number`
         * [X] Email Address `email_address`
         * [X] Age / Date of Birth `date_of_birth`
-        * [X] Age / Is Age Verified `is_age_verified`
+        * [X] Age / Age Verified `age_verified`
         * [X] Address `postal_address`
         * [X] Gender `gender`
         * [X] Nationality `nationality`
@@ -305,4 +306,4 @@ If you're using Windows and you haven't installed Cryptography before, you might
 set LIB=C:\OpenSSL-Win64\lib;%LIB%
 set INCLUDE=C:\OpenSSL-Win64\include;%INCLUDE%
 ```
-Where `OpenSSL-Win64` is the location that you have installed OpenSSL to. See [here](https://cryptography.io/en/latest/installation/#building-cryptography-on-windows) for more information.
+Where `OpenSSL-Win64` is the location that you have installed OpenSSL to. See [here](https://cryptography.io/en/latest/installation/#building-cryptography-on-windows) for more information.

examples/yoti_example_django/yoti_example/templates/profile.html

@@ -212,21 +212,21 @@ <h3>Yoti Profile</h3>
             </td>
         </tr>
         {% endif %}
-        {% if profile.is_age_verified is not None %}
+        {% if profile.age_verified is not None %}
         <tr>
             <th scope="row">Age verified</th>
-            <td>{{profile.is_age_verified.value }}</td>
+            <td>{{profile.age_verified.value }}</td>
             <td colspan="3">
                 <table class="table">
                     <tbody>
-                    {% for source in profile.is_age_verified.sources %}
+                    {% for source in profile.age_verified.sources %}
                     <tr class="row no-gutters">
                         <td class="col-md-3">Source</td>
                         <td class="col-md-6">{{ source.value }}</td>
                         <td class="col-md-3">{{ source.sub_type }}</td>
                     </tr>
                     {% endfor %}
-                    {% for verifier in profile.is_age_verified.verifiers %}
+                    {% for verifier in profile.age_verified.verifiers %}
                     <tr class="row no-gutters">
                         <td class="col-md-3">Verifier</td>
                         <td class="col-md-6">{{ verifier.value }}</td>

examples/yoti_example_flask/templates/profile.html

@@ -212,21 +212,21 @@ <h3>Yoti Profile</h3>
             </td>
         </tr>
         {% endif %}
-        {% if profile.is_age_verified is defined%}
+        {% if profile.age_verified is defined%}
         <tr>
             <th scope="row">Age verified</th>
-            <td>{{ profile.is_age_verified.value }}</td>
+            <td>{{ profile.age_verified.value }}</td>
             <td colspan="3">
                 <table class="table">
                     <tbody>
-                    {% for source in profile.is_age_verified.sources %}
+                    {% for source in profile.age_verified.sources %}
                     <tr class="row no-gutters">
                         <td class="col-md-3">Source</td>
                         <td class="col-md-6">{{ source.value }}</td>
                         <td class="col-md-3">{{ source.sub_type }}</td>
                     </tr>
                     {% endfor %}
-                    {% for verifier in profile.is_age_verified.verifiers %}
+                    {% for verifier in profile.age_verified.verifiers %}
                     <tr class="row no-gutters">
                         <td class="col-md-3">Verifier</td>
                         <td class="col-md-6">{{ verifier.value }}</td>

yoti_python_sdk/activity_details.py

@@ -48,18 +48,19 @@ def try_parse_selfie_field(self, field):
 
     def try_parse_age_verified_field(self, field):
         if field is not None:
-            is_age_verified = Protobuf().value_based_on_content_type(
+            age_verified = Protobuf().value_based_on_content_type(
                 field.value,
                 field.content_type
             )
-            if is_age_verified == 'true':
-                self.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = True
+            if age_verified == 'true':
+                self.user_profile[config.ATTRIBUTE_AGE_VERIFIED] = True
                 return
-            if is_age_verified == 'false':
-                self.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = False
+            if age_verified == 'false':
+                self.user_profile[config.ATTRIBUTE_AGE_VERIFIED] = False
                 return
 
-            print("age_verified_field value: '{0}' was unable to be parsed into a boolean value".format(is_age_verified))
+            print(
+                "age_verified_field value: '{0}' was unable to be parsed into a boolean value".format(age_verified))
 
     def try_convert_structured_postal_address_to_dict(self, field):
         decoder = json.JSONDecoder(object_pairs_hook=collections.OrderedDict, strict=False)

yoti_python_sdk/config.py

@@ -8,7 +8,7 @@
 ATTRIBUTE_FULL_NAME = "full_name"
 ATTRIBUTE_GENDER = "gender"
 ATTRIBUTE_GIVEN_NAMES = "given_names"
-ATTRIBUTE_IS_AGE_VERIFIED = "is_age_verified"
+ATTRIBUTE_AGE_VERIFIED = "age_verified"
 ATTRIBUTE_NATIONALITY = "nationality"
 ATTRIBUTE_PHONE_NUMBER = "phone_number"
 ATTRIBUTE_POSTAL_ADDRESS = "postal_address"

yoti_python_sdk/profile.py

@@ -52,8 +52,8 @@ def given_names(self):
         return self.get_attribute(config.ATTRIBUTE_GIVEN_NAMES)
 
     @property
-    def is_age_verified(self):
-        return self.get_attribute(config.ATTRIBUTE_IS_AGE_VERIFIED)
+    def age_verified(self):
+        return self.get_attribute(config.ATTRIBUTE_AGE_VERIFIED)
 
     @property
     def nationality(self):
@@ -83,18 +83,19 @@ def get_attribute(self, attribute_name):
 
     def try_parse_age_verified_field(self, field, anchors):
         if field is not None:
-            is_age_verified = Protobuf().value_based_on_content_type(
+            age_verified = Protobuf().value_based_on_content_type(
                 field.value,
                 field.content_type
             )
-            if is_age_verified == 'true':
-                self.profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = Attribute(is_age_verified, True, anchors)
+            if age_verified == 'true':
+                self.profile[config.ATTRIBUTE_AGE_VERIFIED] = Attribute(age_verified, True, anchors)
                 return
-            if is_age_verified == 'false':
-                self.profile[config.ATTRIBUTE_IS_AGE_VERIFIED] = Attribute(is_age_verified, False, anchors)
+            if age_verified == 'false':
+                self.profile[config.ATTRIBUTE_AGE_VERIFIED] = Attribute(age_verified, False, anchors)
                 return
 
-        raise TypeError("age_verified_field unable to be parsed")
+            print(
+                "age_verified_field value: '{0}' was unable to be parsed into a boolean value".format(age_verified))
 
     def try_convert_structured_postal_address_to_dict(self, field, anchors):
         decoder = json.JSONDecoder(object_pairs_hook=collections.OrderedDict, strict=False)

yoti_python_sdk/tests/test_activity_details.py

@@ -2,8 +2,6 @@
 import collections
 import json
 
-import pytest
-
 from yoti_python_sdk import config
 from yoti_python_sdk.activity_details import ActivityDetails
 from yoti_python_sdk.protobuf.v1.protobuf import Protobuf
@@ -99,31 +97,31 @@ def test_try_parse_age_verified_both_missing_not_parsed():
     field = None
 
     ActivityDetails.try_parse_age_verified_field(activity_details, field)
-    assert not isinstance(activity_details.user_profile.get(config.ATTRIBUTE_IS_AGE_VERIFIED), bool)
+    assert not isinstance(activity_details.user_profile.get(config.ATTRIBUTE_AGE_VERIFIED), bool)
 
 
 def test_try_parse_age_verified_field_age_over():
     activity_details = ActivityDetails(successful_receipt())
     create_age_verified_field(activity_details, True, "true".encode(), 18)
 
     ActivityDetails.try_parse_age_verified_field(activity_details, activity_details.field)
-    assert activity_details.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] is True
+    assert activity_details.user_profile[config.ATTRIBUTE_AGE_VERIFIED] is True
 
 
 def test_try_parse_age_verified_field_age_under():
     activity_details = ActivityDetails(successful_receipt())
     create_age_verified_field(activity_details, False, "false".encode(), 55)
 
     ActivityDetails.try_parse_age_verified_field(activity_details, activity_details.field)
-    assert activity_details.user_profile[config.ATTRIBUTE_IS_AGE_VERIFIED] is False
+    assert activity_details.user_profile[config.ATTRIBUTE_AGE_VERIFIED] is False
 
 
 def test_try_parse_age_verified_field_non_bool_value_not_parsed():
     activity_details = ActivityDetails(successful_receipt())
     create_age_verified_field(activity_details, True, "18".encode(), 18)
 
     ActivityDetails.try_parse_age_verified_field(activity_details, activity_details.field)
-    assert not isinstance(activity_details.user_profile.get(config.ATTRIBUTE_IS_AGE_VERIFIED), bool)
+    assert not isinstance(activity_details.user_profile.get(config.ATTRIBUTE_AGE_VERIFIED), bool)
 
 
 def test_try_parse_structured_postal_address_uk():

yoti_python_sdk/tests/test_profile.py

@@ -107,22 +107,23 @@ def test_try_parse_age_verified_field_age_over():
         create_attribute_list_with_age_verified_field(
             True, "true".encode(), 18))
 
-    assert profile.profile[config.ATTRIBUTE_IS_AGE_VERIFIED].value is True
+    assert profile.age_verified.value is True
 
 
 def test_try_parse_age_verified_field_age_under():
     profile = Profile(
         create_attribute_list_with_age_verified_field(
             False, "false".encode(), 55))
 
-    assert profile.profile[config.ATTRIBUTE_IS_AGE_VERIFIED].value is False
+    assert profile.age_verified.value is False
 
 
-def test_try_parse_age_verified_field_non_bool_value_throws_error():
-    with pytest.raises(TypeError):
-        Profile(create_attribute_list_with_age_verified_field(
+def test_try_parse_age_verified_field_non_bool_value_not_parsed():
+    profile = Profile(create_attribute_list_with_age_verified_field(
             True, "18".encode(), 18))
 
+    assert not isinstance(profile.age_verified, bool)
+
 
 def test_try_parse_structured_postal_address_uk():
     structured_postal_address = {ADDRESS_FORMAT_KEY: ADDRESS_FORMAT_VALUE,
@@ -138,8 +139,7 @@ def test_try_parse_structured_postal_address_uk():
 
     profile = Profile(create_attribute_list_with_structured_postal_address_field(structured_postal_address_json))
 
-    actual_structured_postal_address_profile = profile.profile[
-        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value
+    actual_structured_postal_address_profile = profile.structured_postal_address.value
 
     assert type(actual_structured_postal_address_profile) is collections.OrderedDict
     assert actual_structured_postal_address_profile[ADDRESS_FORMAT_KEY] == ADDRESS_FORMAT_VALUE
@@ -171,8 +171,7 @@ def test_try_parse_structured_postal_address_india():
 
     profile = Profile(create_attribute_list_with_structured_postal_address_field(structured_postal_address_bytes))
 
-    actual_structured_postal_address_profile = profile.profile[
-        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value
+    actual_structured_postal_address_profile = profile.structured_postal_address.value
 
     assert type(actual_structured_postal_address_profile) is collections.OrderedDict
     assert actual_structured_postal_address_profile[ADDRESS_FORMAT_KEY] == INDIA_FORMAT_VALUE
@@ -204,8 +203,7 @@ def test_try_parse_structured_postal_address_usa():
 
     profile = Profile(create_attribute_list_with_structured_postal_address_field(structured_postal_address_bytes))
 
-    actual_structured_postal_address_profile = profile.profile[
-        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value
+    actual_structured_postal_address_profile = profile.structured_postal_address.value
 
     assert type(actual_structured_postal_address_profile) is collections.OrderedDict
     assert actual_structured_postal_address_profile[ADDRESS_FORMAT_KEY] == USA_FORMAT_VALUE
@@ -243,8 +241,7 @@ def test_try_parse_structured_postal_address_nested_json():
 
     profile = Profile(create_attribute_list_with_structured_postal_address_field(structured_postal_address_bytes))
 
-    actual_structured_postal_address_profile = profile.profile[
-        config.ATTRIBUTE_STRUCTURED_POSTAL_ADDRESS].value
+    actual_structured_postal_address_profile = profile.structured_postal_address.value
 
     assert type(actual_structured_postal_address_profile) is collections.OrderedDict
     assert actual_structured_postal_address_profile[ADDRESS_FORMAT_KEY] == ADDRESS_FORMAT_VALUE
@@ -264,7 +261,7 @@ def test_set_address_to_be_formatted_address():
 
     profile = Profile(create_attribute_list_with_structured_postal_address_field(structured_postal_address_bytes))
 
-    assert profile.profile[config.ATTRIBUTE_POSTAL_ADDRESS].value == FORMATTED_ADDRESS_VALUE
+    assert profile.postal_address.value == FORMATTED_ADDRESS_VALUE
 
 
 def test_get_attribute():