Merge pull request #13 from lampkicking/release/0-1-0

Initial 0-1-0 release changes

Author: rszalski

CHANGELOG.md

@@ -1 +1,10 @@
 # Change Log #
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - 2015-10-2X
+### Added
+- Initial SDK release

README.md

@@ -5,7 +5,7 @@ securely verify users' identities.
 
 ## Example ##
 
-    from yoti.client import Client
+    from yoti import Client
 
     @app.route('/callback')
     def callback():
@@ -78,6 +78,7 @@ One tool to do just this is [pyenv](https://github.com/yyuu/pyenv)
 
 1. Install `pyenv`
 1. Install Python interpreters you want to test with, e.g. `pyenv install 2.6.9`
+1. Install project dependencies: `pip install -r requirements.txt`
 1. Execute in the main project dir: `tox`
 1. In order to execute integration tests run: `tox pytest_integration.ini`
 

examples/yoti_example_django/yoti_example/views.py

@@ -1,6 +1,6 @@
 from django.views.generic import TemplateView
 
-from yoti.client import Client
+from yoti import Client
 
 from .app_settings import (
     YOTI_APPLICATION_ID,

examples/yoti_example_flask/app.py

@@ -1,6 +1,6 @@
 from flask import Flask, render_template, request
 
-from yoti.client import Client
+from yoti import Client
 
 from settings import (
     YOTI_APPLICATION_ID,

tox.ini

@@ -1,6 +1,6 @@
 [tox]
-envlist = {py26,py27,py33,py34,py35,py36}-general
-          {py26,py27,py33,py34,py35,py36}-general-{oldest,cryptography14,requests26,protobuf30}
+envlist = py26,py27,py33,py34,py35,py36
+          {py26,py27,py33,py34,py35,py36}-{oldest,cryptography14,requests26,protobuf30}
           py36-macOS
           py36-macOS-{oldest,cryptography14,requests26,protobuf30}
 skip_missing_interpreters = True
@@ -16,20 +16,20 @@ deps = future011,oldest: future==0.11.0
        future013: future>=0.13,<0.14
        requests26: requests>=2.6,<2.7
 
-[testenv:py36-general]
+[testenv:py36]
 platform  = win32|linux2|linux|cygwin
 
-[testenv:py36-general-oldest]
-platform = {[testenv:py36-general]platform}
+[testenv:py36-oldest]
+platform = {[testenv:py36]platform}
 
-[testenv:py36-general-requests26]
-platform = {[testenv:py36-general]platform}
+[testenv:py36-requests26]
+platform = {[testenv:py36]platform}
 
-[testenv:py36-general-cryptography14]
-platform = {[testenv:py36-general]platform}
+[testenv:py36-cryptography14]
+platform = {[testenv:py36]platform}
 
-[testenv:py36-general-protobuf30]
-platform = {[testenv:py36-general]platform}
+[testenv:py36-protobuf30]
+platform = {[testenv:py36]platform}
 
 [testenv:macOS]
 ; On macOS and Python versions where there aren't any binary wheels for `cryptography` yet

yoti/__init__.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 from os import environ
 
+from yoti.client import Client
+
 DEFAULTS = {
     'YOTI_API_URL': 'https://api.yoti.com',
     'YOTI_API_PORT': 443,
@@ -11,3 +13,8 @@
 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',
+]

yoti/client.py

@@ -1,19 +1,18 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
+import json
 import time
 import uuid
-import json
-import requests
-
 from os import environ
-from os.path import isfile
+from os.path import isfile, expanduser
 
+import requests
 from past.builtins import basestring
 
-from yoti import YOTI_API_ENDPOINT
-from yoti.crypto import Crypto
+import yoti
 from yoti.activity_details import ActivityDetails
+from yoti.crypto import Crypto
 from yoti.protobuf.v1 import protobuf
 
 
@@ -41,12 +40,14 @@ def __init__(self, sdk_id=None, pem_file_path=None):
     @staticmethod
     def __read_pem_file(key_file_path, error_source):
         try:
+            key_file_path = expanduser(key_file_path)
+
             if not isinstance(key_file_path, basestring) or not isfile(key_file_path):
                 raise IOError('File not found: {0}'.format(key_file_path))
             with open(key_file_path, 'rb') as pem_file:
                 return pem_file.read().strip()
-        except (IOError, TypeError, OSError) as exc:
-            error = 'Invalid private key file ' + error_source
+        except (AttributeError, IOError, TypeError, OSError) as exc:
+            error = 'Could not read private key file: "{0}", passed as: {1} '.format(key_file_path, error_source)
             exception = '{0}: {1}'.format(type(exc).__name__, exc)
             raise RuntimeError('{0}: {1}'.format(error, exception))
 
@@ -67,7 +68,7 @@ def get_activity_details(self, encrypted_request_token):
 
     def __make_request(self, encrypted_request_token):
         path = self.__get_request_path(encrypted_request_token)
-        url = YOTI_API_ENDPOINT + path
+        url = yoti.YOTI_API_ENDPOINT + path
         headers = self.__get_request_headers(path)
         response = requests.get(url=url, headers=headers)
 

yoti/crypto.py

@@ -59,4 +59,11 @@ def decipher(key, iv, cipher_text):
             mode=modes.CBC(iv),
             backend=default_backend()
         ).decryptor()
-        return decryptor.update(cipher_text) + decryptor.finalize()
+        plaintext = decryptor.update(cipher_text) + decryptor.finalize()
+
+        return Crypto.strip_pkcs5_padding(plaintext)
+
+    @staticmethod
+    def strip_pkcs5_padding(data):
+        number_of_padded_bytes = data[-1]
+        return data[:-number_of_padded_bytes]

yoti/tests/conftest.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from yoti.client import Client
+from yoti import Client
 from yoti.crypto import Crypto
 
 FIXTURES_DIR = join(dirname(abspath(__file__)), 'fixtures')

yoti/tests/test_client.py

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-import pytest
-
 from os import environ
+
+import pytest
 from past.builtins import basestring
 
 try:
@@ -12,7 +12,8 @@
     import mock
 
 from yoti import YOTI_API_ENDPOINT
-from yoti.client import Client, NO_KEY_FILE_SPECIFIED_ERROR
+from yoti import Client
+from yoti.client import NO_KEY_FILE_SPECIFIED_ERROR
 from yoti.activity_details import ActivityDetails
 from yoti.tests.conftest import YOTI_CLIENT_SDK_ID, PEM_FILE_PATH
 from yoti.tests.mocks import (
@@ -63,7 +64,7 @@ def test_creating_client_instance_without_private_key_file():
 def test_creating_client_instance_with_invalid_key_file_arg(key_file):
     with pytest.raises(RuntimeError) as exc:
         Client(YOTI_CLIENT_SDK_ID, key_file)
-    expected_error = 'Invalid private key file argument specified in Client()'
+    expected_error = 'Could not read private key file'
     assert expected_error in str(exc)
     assert str(key_file) in str(exc)
 
@@ -73,9 +74,10 @@ def test_creating_client_instance_with_invalid_key_file_env(key_file):
     environ['YOTI_KEY_FILE_PATH'] = str(key_file)
     with pytest.raises(RuntimeError) as exc:
         Client(YOTI_CLIENT_SDK_ID)
-    expected_error = 'Invalid private key file specified by the ' \
-                     'YOTI_KEY_FILE_PATH env variable'
+    expected_error = 'Could not read private key file'
+    expected_error_source = 'specified by the YOTI_KEY_FILE_PATH env variable'
     assert expected_error in str(exc)
+    assert expected_error_source in str(exc)
     assert str(key_file) in str(exc)
 
 
@@ -88,7 +90,7 @@ def test_creating_client_instance_with_valid_key_file_env_but_invalid_key_file_a
     environ['YOTI_KEY_FILE_PATH'] = PEM_FILE_PATH
     with pytest.raises(RuntimeError) as exc:
         Client(YOTI_CLIENT_SDK_ID, INVALID_KEY_FILE_PATH)
-    expected_error = 'Invalid private key file argument specified in Client()'
+    expected_error = 'Could not read private key file'
     assert expected_error in str(exc)
     assert str(INVALID_KEY_FILE_PATH) in str(exc)