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

Release/0-1-0

Author: rszalski

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit=yoti/tests/*

.gitignore

@@ -23,6 +23,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+MANIFEST
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -87,3 +88,7 @@ ENV/
 
 # Rope project settings
 .ropeproject
+
+# IDE
+.idea/
+*.un~

CHANGELOG.md

@@ -0,0 +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

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yoti Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,2 @@
+include yoti/tests/fixtures/*
+recursive-include yoti/protobuf/v1/definitions *.proto

README.md

@@ -0,0 +1,128 @@
+# Yoti Python SDK #
+
+This package integrates your Python back-end with [Yoti](https://www.yoti.com/) allowing you to
+securely verify users' identities.
+
+## Example ##
+
+    from yoti import Client
+
+    @app.route('/callback')
+    def callback():
+        client = Client(YOTI_CLIENT_SDK_ID, YOTI_KEY_FILE_PATH)
+        activity_details = client.get_activity_details(request.args['token'])
+        return activity_details.user_profile
+
+For more details and working [Flask](http://flask.pocoo.org/) and [Django](https://www.djangoproject.com/)
+applications see [examples/](https://github.com/lampkicking/yoti-sdk-server-python/tree/development/examples).
+
+
+## The Flow ##
+
+Assuming you created an application and chose `/callback` as your application's callback on [Yoti Dashboard](https://www.yoti.com/dashboard/),
+this endpoint will receive a `token` from Yoti API each time user wishes to share information with you (see the example above).
+This token, encrypted with the private key from `.PEM` container, will be used to send a request to Yoti
+for user's profile details. That's all folks!
+
+For details see [Yoti Developers Docs](https://www.yoti.com/developers/).
+
+## Installation ##
+
+    $ pip install yoti
+
+This SDK works with Python 2.6+ and Python 3.3+ .
+
+## Configuration ##
+
+After creating your application on the [Yoti Dashboard](https://www.yoti.com/dashboard/), you need to download
+the `.PEM` key and save it *outside* the repo (keep it private).
+
+The following env variables are then required for the SDK to work:
+
+* `YOTI_CLIENT_SDK_ID` - found on the Integrations settings page
+* `YOTI_KEY_FILE_PATH` - the full path to your private key downloaded from the Keys settings page (e.g. /home/user/.ssh/access-security.pem)
+
+The following env variables are additionally used to configure your backend:
+
+* `YOTI_APPLICATION_ID` - found on the Integrations settings page, used to configure the [Yoti Login Button](https://www.yoti.com/developers/#login-button-setup)
+* `YOTI_VERIFICATION_KEY` - found on the Integrations settings page -> Callback URL -> VERIFY, used to verify your back-end callback
+
+## Examples ##
+
+Both example applications utilise the env variables described above, make sure they are accessible.
+* Installing dependencies: `pip install -e .[examples]`
+
+
+### Flask ###
+
+* Run `python examples/yoti_example_flask/app.py`
+
+### Django ###
+
+1. Apply migrations before the first start by running:<br>
+    `python examples/yoti_example_django/manage.py migrate`
+1. Run: `python examples/yoti_example_django/manage.py runserver 0.0.0.0:5000`
+
+## Executing tests ##
+
+1. Install dependencies: `pip install -r requirements.txt`
+1. Install the SDK: `python setup.py develop`
+1. Execute in the main project dir: `py.test`
+1. To execute integration tests run: `py.test -c pytest_integration.ini`
+
+### Testing on multiple Python versions ###
+
+Tests executed using [py.test](http://doc.pytest.org/en/latest/) use your default/virtualenv's Python interpreter.
+Testing multiple versions of Python requires them to be installed and accessible on your system.
+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`
+
+You can choose a subset of interpreters to test with by running `tox -e <testenv_version>`.
+For a list of `<testenv_versions>` see `tox.ini`. Example: `tox -e py26` would run the 
+test suite on Python 2.6 (2.6.9 in our case, as installed with `pyenv`).
+
+To install all the Python versions this SDK has been tested against run:
+
+    $ for version in 2.6.9 2.7.12 3.3.6 3.4.5 3.5.2 3.6.0b1; do pyenv install $version; done
+
+activate the installed interpreters (execute in this directory):
+
+    $ pyenv local 2.6.9 2.7.12 3.3.6 3.4.5 3.5.2 3.6.0b1
+
+run the tests:
+
+    $ tox
+
+#### Tox Common Issues ####
+
+Supporting multiple Python versions with dependencies, often requiring compilation, is not without issues.
+
+For Python versions that do not provide binary wheels for `cryptography`, it
+will have to be compiled. This will be done automatically, however you may
+need to install development headers of `openssl`.
+
+##### On Debian-based systems #####
+ 
+Install `openssl` headers with `apt-get install openssl-dev`
+
+##### On macOS #####
+ 
+Install `openssl` headers using [homebrew](http://brew.sh/): `brew install openssl`
+
+Install xcode command line tools so we have access to a C compiler and common libs:
+
+    xcode-select --install
+
+See [building cryptography on OS X](https://cryptography.io/en/latest/installation/#building-cryptography-on-os-x)
+
+
+For Python 2.6 and 2.7 you *might* have to install them via `pyenv` with specific unicode code point settings:
+
+    PYTHON_CONFIGURE_OPTS="--enable-unicode=ucs2" pyenv install <python version>
+
+to avoid `cffi` errors related to unicode see: [cffi ucs2 vs ucs4](http://cffi.readthedocs.io/en/latest/installation.html#linux-and-os-x-ucs2-versus-ucs4)

examples/yoti_example_django/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "yoti_example.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError:
+        # The above import may fail for some other reason. Ensure that the
+        # issue is really that Django is missing to avoid masking other
+        # exceptions on Python 2.
+        try:
+            import django
+        except ImportError:
+            raise ImportError(
+                "Couldn't import Django. Are you sure it's installed and "
+                "available on your PYTHONPATH environment variable? Did you "
+                "forget to activate a virtual environment?"
+            )
+        raise
+    execute_from_command_line(sys.argv)

examples/yoti_example_django/yoti_example/__init__.py

@@ -0,0 +1,6 @@
+from os import environ
+
+YOTI_APPLICATION_ID = environ.get('YOTI_APPLICATION_ID')
+YOTI_CLIENT_SDK_ID = environ.get('YOTI_CLIENT_SDK_ID')
+YOTI_FULL_KEY_FILE_PATH = environ.get('YOTI_KEY_FILE_PATH')
+YOTI_VERIFICATION_KEY = environ.get('YOTI_VERIFICATION_KEY')

examples/yoti_example_django/yoti_example/app_settings.py

@@ -0,0 +1,122 @@
+"""
+Django settings for yoti_example project.
+
+Generated by 'django-admin startproject' using Django 1.10.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.10/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.10/ref/settings/
+"""
+
+import os
+
+from os.path import join
+
+# Build paths inside the project like this: join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.10/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'p3dh1cx&ey8oesy-nj_md-ouo75xi548m22j^zrv((d1@k%%3!'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'yoti_example.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [join(BASE_DIR, 'yoti_example/templates')],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'yoti_example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.10/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/1.10/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.10/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.10/howto/static-files/
+
+STATIC_URL = '/static/'