SDK-668: Add version to request headers, extract version to separate file

Author: echarrod

setup.py

@@ -1,22 +1,22 @@
 # -*- coding: utf-8 -*-
 from setuptools import setup, find_packages
+from yoti_python_sdk import __version__
 
-VERSION = '2.5.0'
 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={

yoti_python_sdk/__init__.py

@@ -2,18 +2,26 @@
 from os import environ
 
 from yoti_python_sdk.client import Client
+from distutils.util import convert_path
 
 DEFAULTS = {
     'YOTI_API_URL': 'https://api.yoti.com',
     'YOTI_API_PORT': 443,
     'YOTI_API_VERSION': 'v1',
 }
 
+main_ns = {}
+ver_path = convert_path('yoti_python_sdk/version.py')
+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__
 ]

yoti_python_sdk/client.py

@@ -15,7 +15,8 @@
 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 +113,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

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'

yoti_python_sdk/tests/test_client.py

@@ -16,10 +16,11 @@
 except ImportError:
     import mock
 
+import yoti_python_sdk
 from yoti_python_sdk import YOTI_API_ENDPOINT
 from yoti_python_sdk import Client
 from yoti_python_sdk import aml
-from yoti_python_sdk.config import SDK_IDENTIFIER
+from yoti_python_sdk.config import *
 from yoti_python_sdk.client import NO_KEY_FILE_SPECIFIED_ERROR
 from yoti_python_sdk.activity_details import ActivityDetails
 from yoti_python_sdk.tests.conftest import YOTI_CLIENT_SDK_ID, PEM_FILE_PATH
@@ -41,23 +42,29 @@
 
 @pytest.fixture(scope='module')
 def expected_get_headers(x_yoti_auth_key, x_yoti_auth_digest_get):
+    sdk_version = yoti_python_sdk.__version__
+
     return {
-        'Content-Type': 'application/json',
-        'Accept': 'application/json',
-        'X-Yoti-Auth-Key': x_yoti_auth_key,
-        'X-Yoti-Auth-Digest': x_yoti_auth_digest_get,
-        'X-Yoti-SDK': SDK_IDENTIFIER
+        'Content-Type': JSON_CONTENT_TYPE,
+        'Accept': JSON_CONTENT_TYPE,
+        X_YOTI_AUTH_KEY: x_yoti_auth_key,
+        X_YOTI_AUTH_DIGEST: x_yoti_auth_digest_get,
+        X_YOTI_SDK: SDK_IDENTIFIER,
+        X_YOTI_SDK_VERSION: sdk_version
     }
 
 
 @pytest.fixture(scope='module')
 def expected_post_headers(x_yoti_auth_key, x_yoti_auth_digest_post):
+    sdk_version = yoti_python_sdk.__version__
+
     return {
-        'X-Yoti-Auth-Key': x_yoti_auth_key,
-        'X-Yoti-Auth-Digest': x_yoti_auth_digest_post,
-        'X-Yoti-SDK': SDK_IDENTIFIER,
-        'Content-Type': 'application/json',
-        'Accept': 'application/json'
+        X_YOTI_AUTH_KEY: x_yoti_auth_key,
+        X_YOTI_AUTH_DIGEST: x_yoti_auth_digest_post,
+        X_YOTI_SDK: SDK_IDENTIFIER,
+        X_YOTI_SDK_VERSION: sdk_version,
+        'Content-Type': JSON_CONTENT_TYPE,
+        'Accept': JSON_CONTENT_TYPE
     }
 
 

yoti_python_sdk/version.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+__version__ = "2.6.0"