Release 0-1-1 (#19)

* Flask plugin

* Adds Readme

* Fixes padding stripping in Python2

* Fixes tox dependancies and adds tests for stripping the pkcs5 padding

* Feature/django plugin (#15)

* Creates a 0.1.1 Release

Author: rszalski

CHANGELOG.md

@@ -5,6 +5,15 @@ 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
+## [0.1.1] - 2015-11-15
+
+### Added
+- Flask plugin.
+- Django plugin.
+
+### Fixed
+- Stripping the PKCS5 padding works correctly on Python2 now.
+
+## [0.1.0] - 2015-10-23
 ### Added
 - Initial SDK release

README.md

@@ -63,6 +63,13 @@ Both example applications utilise the env variables described above, make sure t
     `python examples/yoti_example_django/manage.py migrate`
 1. Run: `python examples/yoti_example_django/manage.py runserver 0.0.0.0:5000`
 
+
+### Plugins ###
+
+Plugins for both Django and Flask are in the `plugins/` dir. Their purpose is to make it as easy as possible to use
+Yoti SDK with those frameworks. See their respective `README`'s for details.
+
+
 ## Executing tests ##
 
 1. Install dependencies: `pip install -r requirements.txt`
@@ -88,11 +95,11 @@ 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
+    $ for version in 2.6.9 2.7.12 3.3.6 3.4.5 3.5.2 3.6.0b3; 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
+    $ pyenv local 2.6.9 2.7.12 3.3.6 3.4.5 3.5.2 3.6.0b3
 
 run the tests:
 

plugins/django_yoti/LICENSE

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+recursive-include django_yoti/templates *.html
+recursive-include example/yoti_example/templates *.html

plugins/django_yoti/MANIFEST.in

@@ -0,0 +1,194 @@
+# Django Yoti #
+
+Description
+
+## Plugin configuration ##
+### General settings ###
+
+* First you need to add `django_yoti` plugin to your INSTALLED_APPS setting like this:
+```python
+# your_django_project/settings.py
+ 
+...
+ 
+INSTALLED_APPS = [
+    ...
+    'django_yoti',
+]
+```
+
+* In order to use context tags inside your template (`{{ yoti_site_verification }}`, `{{ yoti_login_button_*}}`), 
+you should include `django_yoti`'s context processors into your templates configuration like this:
+```python
+# your_django_project/settings.py
+ 
+...
+ 
+TEMPLATES = [
+    {
+        ...
+        'OPTIONS': {
+            'context_processors': [
+                ...
+                'django_yoti.context_processors.yoti_context',
+            ],
+        },
+    },
+]
+```
+
+* And then use the following settings to configure the plugin:
+
+
+```python
+# your_django_project/settings.py
+ 
+...
+ 
+YOTI = {
+    'YOTI_APPLICATION_ID': '...',
+    'YOTI_CLIENT_SDK_ID': '...',
+    'YOTI_KEY_FILE_PATH': '...',
+    'YOTI_VERIFICATION_KEY': '...',
+    ...
+}
+```
+* **`YOTI_APPLICATION_ID`** - **required**, *can be also set by env variable with the same name*<br>
+Your Yoti application's ID, found under the `INTEGRATIONS` tab of your 
+Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
+It is used to configure the [Yoti Login Button](https://www.yoti.com/developers/#login-button-setup).<br>
+Example: `ca84f68b-1b48-458b-96bf-963868edc8b6`
+
+* **`YOTI_CLIENT_SDK_ID`** - **required**, *can be also set by env variable with the same name*<br>
+Your Yoti application's SDK ID, found under the `INTEGRATIONS` tab of your 
+Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
+Example: `39aef70a-89d6-4644-a687-b3e891613da6`
+
+* **`YOTI_KEY_FILE_PATH`** - **required**, *can be also set by env variable with the same name*<br>
+The full path to your private key downloaded from your Yoti application's 
+settings page under the `KEYS` tab ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
+Example: `/home/user/.ssh/access-security.pem`
+
+* **`YOTI_VERIFICATION_KEY`** - *can be also set by env variable with the same name*<br>
+A key, used to verify your callback URL. Can be found under the 
+`INTEGRATIONS` tab of your Yoti application's settings page (Callback URL -> VERIFY).<br>
+Example: `b14886f972d0c717`
+
+
+### Endpoints configuration ###
+
+`django_yoti` plugin provides some default endpoints:
+```python
+# django_yoti/urls.py
+ 
+urlpatterns = [
+    url(r'^auth/', views.auth, name='yoti_auth'),
+    url(r'^login/', views.login, name='yoti_login'),
+    url(r'^profile/', views.profile, name='yoti_profile')
+]
+```
+`yoti_auth` url is used for receiving token via callback and should'nt be changed.<br>
+The last two URLs are examples and can be overridden by the following settings:
+
+```python
+# your_django_project/settings.py
+ 
+...
+ 
+YOTI = {
+    ...
+    'YOTI_LOGIN_VIEW': '...',
+    'YOTI_REDIRECT_TO': '...',
+    'YOTI_LOGIN_BUTTON_LABEL': '...',
+}
+```
+* **`YOTI_LOGIN_VIEW`**<br>
+If *not* authenticated user is trying to access a view with 
+`@yoti_authenticated` decorator, he/she will be redirected to this view.
+Example: `login`<br>
+In this case you should have something like this in your project's `urls.py` file:
+```python
+urlpatterns = [
+    ...
+    url(r'^login/', views.login, name='login'),
+    ...
+]
+```
+Default value: `yoti_login` (with `/yoti/login/` URL)
+
+* **`YOTI_REDIRECT_TO`**<br>
+View name to which user is redirected after successful authentication.<br>
+Example: `profile`<br>
+In this case you should have something like this in your project's `urls.py` file:
+```python
+urlpatterns = [
+    ...
+    url(r'^profile/', views.profile, name='profile'),
+    ...
+]
+```
+Default value: `yoti_profile`  (with `/yoti/profile/` URL
+
+<br>
+
+In order to use `django_yoti` plugin in your project, you should include 
+the plugin's endpoints in your project's `urls.py` file:
+```python
+# your_django_project/urls.py
+ 
+ ...
+ 
+urlpatterns = [
+    ...
+    url(r'^yoti/', include('django_yoti.urls')),
+    ...
+]
+```
+
+### Yoti application configuration ###
+
+Your Yoti application's callback URL should point to `your_site.com/yoti/auth`.<br>
+If you want to add a verification tag into any page (other than `/yoti/auth/`), 
+you can use a `{{ yoti_site_verification }}` tag inside 'head' tag of that page.
+
+## Using plugin ##
+
+1. First you need to add a login button to some of your view's templates.
+- You can do it by using one of the predefined login buttons:
+```
+{{ yoti_login_button_sm }}
+{{ yoti_login_button_md }}
+{{ yoti_login_button_lg }}
+```
+- or with a default one `{{ yoti_login_button }}`, in case you're using DTL 
+as a template language)
+- or with `{{ yoti_login_button(size='small', text='Log In with Yoti')`, in 
+case you're using Jinja2 as your template language<br>
+Available button sizes: `small`, `medium`, `large`
+
+By clicking this button, user will be redirected to the Yoti Authentication page.
+
+*Remember to add an appropriate script to your page with login 
+button in order for it to work. See: [Yoti Developers Documentation](https://www.yoti.com/developers/#login-button-setup)*
+
+2. After successful authentication, user will be redirected to a view,
+provided by the `YOTI_REDIRECT_TO` setting.
+3. In order to have an access to an authenticated user's information inside a view,
+you should use a `@yoti_authenticated` decorator.
+Example:
+```python
+from django_yoti import yoti_authenticated
+ 
+@yoti_authenticated
+def profile_view(request):
+    user_id = request.yoti_user_id
+    user_profile = request.yoti_user_profile
+    return render(request, 'profile.html', user_profile)
+```
+
+4. All *not authenticated* users trying to access endpoint with this decorator, 
+will be redirected to an endpoint, provided by the `YOTI_LOGIN_VIEW` setting.
+
+## Tests ##
+
+To run unit tests just type: `python django_yoti/runtests.py`

plugins/django_yoti/README.md

@@ -0,0 +1 @@
+from .decorators import yoti_authenticated

plugins/django_yoti/django_yoti/__init__.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class DjangoYotiConfig(AppConfig):
+    name = 'django_yoti'

plugins/django_yoti/django_yoti/apps.py

@@ -0,0 +1,31 @@
+from django.utils.html import format_html
+
+from .login_button import get_login_button_html
+from .settings import YOTI_VERIFICATION_KEY, YOTI_APPLICATION_ID
+
+
+def yoti_context(request):
+    context = login_button_context(request)
+    context.update(site_verification_context(request))
+    context.update(application_context(request))
+    return context
+
+
+def login_button_context(request):
+    return {
+        'yoti_login_button': get_login_button_html,
+        'yoti_login_button_sm': get_login_button_html('small'),
+        'yoti_login_button_md': get_login_button_html('medium'),
+        'yoti_login_button_lg': get_login_button_html('large')
+    }
+
+
+def site_verification_context(request):
+    raw_text = '<meta name="yoti-site-verification" content="{0}">'.format(
+        YOTI_VERIFICATION_KEY
+    )
+    return {'yoti_site_verification': format_html(raw_text)}
+
+
+def application_context(request):
+    return {'yoti_application_id': YOTI_APPLICATION_ID}

plugins/django_yoti/django_yoti/context_processors.py

@@ -0,0 +1,20 @@
+from functools import wraps
+from django.shortcuts import redirect
+from .settings import YOTI_LOGIN_VIEW
+
+
+def yoti_authenticated(view_func):
+    @wraps(view_func)
+    def _decorated(request, *args, **kwargs):
+        activity_details = request.session.get('activity_details')
+        if not activity_details or activity_details.get('outcome') != 'SUCCESS':
+            return redirect(YOTI_LOGIN_VIEW)
+
+        yoti_user_id = activity_details.get('user_id')
+        yoti_user_profile = activity_details.get('user_profile')
+        setattr(request, 'yoti_user_id', yoti_user_id)
+        setattr(request, 'yoti_user_profile', yoti_user_profile)
+
+        return view_func(request, *args, **kwargs)
+
+    return _decorated

plugins/django_yoti/django_yoti/decorators.py

@@ -0,0 +1,13 @@
+from django.utils.html import format_html
+from .settings import YOTI_APPLICATION_ID, YOTI_LOGIN_BUTTON_LABEL
+
+LOGIN_BUTTON_SIZES = ('small', 'medium', 'large')
+
+
+def get_login_button_html(size=None, text=YOTI_LOGIN_BUTTON_LABEL):
+    if size and size not in LOGIN_BUTTON_SIZES:
+        size = None
+    data_size = 'data-size="{0}"'.format(size) if size else ''
+    raw_text = '<span data-yoti-application-id="{0}" {1}>' \
+               '{2}</span>'.format(YOTI_APPLICATION_ID, data_size, text)
+    return format_html(raw_text)