Add: Additional tests

Author: fsbraun

.travis.yml

@@ -3,15 +3,15 @@
 language: python
 
 python:
-  - "3.5"
+  - "3.7"
 
 env:
-  - TOX_ENV=py35-django-19
-  - TOX_ENV=py34-django-19
-  - TOX_ENV=py35-django-110
-  - TOX_ENV=py34-django-110
-  - TOX_ENV=py35-django-111
-  - TOX_ENV=py34-django-111
+  - TOX_ENV=py36-django-111
+  - TOX_ENV=py37-django-111
+  - TOX_ENV=py36-django-20
+  - TOX_ENV=py37-django-20
+  - TOX_ENV=py36-django-21
+  - TOX_ENV=py37-django-21
 
 matrix:
   fast_finish: true

django_typeform/views.py

@@ -4,7 +4,6 @@
 from django.views import View
 from django.views.generic.edit import FormMixin
 from django.views.generic.base import TemplateResponseMixin
-from .forms import TypeformMixin
 
 
 class BaseTypeformView(FormMixin, View):

docs/typeformmixin.rst

@@ -2,8 +2,11 @@
 TypeformMixin
 =============
 
-The ``TypeformMixin`` is a mixin for Django's form class. To turn
-Typeform features on for a Django form just use the Mixin:
+To process a typeform in Django just the way you would process a Django form,
+use the ``TypeformMixin``. It requires the typeform to be mirrored by a corresponding
+Django form, question by question, but can also contain processing logic.
+To turn Typeform features on for a Django form just use the Mixin and specify
+the ``typeform_url``:
 
 .. code-block:: python
 
@@ -14,7 +17,7 @@ Typeform features on for a Django form just use the Mixin:
     class MyTypeForm(TypeformMixin, MyForm)
         typeform_url = 'https://xxxx.typeform.com/to/xxxxxx'
 
-``MyTypeForm`` will be a fully fledge Django form and at the same
+``MyTypeForm`` will be a fully fledged Django form and at the same
 time be linked to the Typeform with given url.
 
 For this link to work, the ``Question reference`` for each Typeform

docs/typeformview.rst

@@ -0,0 +1,45 @@
+============
+TypeformView
+============
+
+The ``TypeformView`` replaces the ``FormView`` class and is the default view
+for typeforms.
+
+Upon get requests it displays the typeform using the ``template_name`` property
+just like a ``FormView``. Upon completion of the typeform the rendered
+typeform posts the typeform's unique id to the view.
+
+``TypeformView`` intercepts this post request, uses the Typeform Results
+API and retrieves the answers the user has just entered. These answers are
+encoded as a ``QueryDict`` and forwarded for form processing.
+
+This way the use of ``TypeformView`` becomes transparent for Django.
+
+See this example, taken from ``urls.py``:
+
+.. code-block:: python
+
+    from django.urls import path
+    from django_typeform.views import TypeformView
+
+    from .forms import MyTypeForm
+
+    urlpatterns = [
+        ...,
+        path('my-typeform/', TypeformView.as_view(
+            form_class=MyTypeForm,
+            template_name='mytypeform.html',
+        )),
+        ...,
+    ]
+
+where a simple template might look like this (``mytypeform.html``):
+
+.. code-block:: html
+
+    {% extends 'base.html' %}
+    {% block content %}
+    <form method="post">
+      {% include form with height='100vh' %}
+    </form>
+    {% endblock %}

tests/settings.py

@@ -1,8 +1,12 @@
 # -*- coding: utf-8
 from __future__ import unicode_literals, absolute_import
 
+import os
+
 import django
 
+BASE_DIR = os.path.dirname(os.path.dirname(__file__))
+
 DEBUG = True
 USE_TZ = True
 
@@ -23,8 +27,18 @@
     "django.contrib.contenttypes",
     "django.contrib.sites",
     "django_typeform",
+    "sekizai",
 ]
 
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [os.path.join(BASE_DIR, "tests/templates")],
+        'APP_DIRS': True,
+    },
+]
+
+
 SITE_ID = 1
 
 if django.VERSION >= (1, 10):

tests/templates/typeform_test.html

@@ -0,0 +1,3 @@
+<form method="post">
+  {% include form with height='100vh' %}
+</form>

tests/test_forms.py

@@ -8,8 +8,19 @@
 class MyForm(TypeformMixin, Form):
     pass
 
+
 class TypeformMixinTest(SimpleTestCase):
     def test_mixin(self):
         form = MyForm(typeform_url='https://whatever.typeform.com/to/xxxxxx')
         self.assertEqual(form.typeform_id, 'xxxxxx')
 
+    def test_mixin_rendering(self):
+        class Request(object):
+            session = {}
+
+        request = Request()
+        form = MyForm(typeform_url='https://whatever.typeform.com/to/xxxxxx')
+
+        form.get_uid(Request())
+        self.assertFalse(not request.session, 'typeformuid not stored in session')
+        form.render(Context({'request': Request()}))

tests/test_views.py

@@ -0,0 +1,8 @@
+from django.test import SimpleTestCase
+from django.test import Client
+
+class TypeformViewTest(SimpleTestCase):
+    def test_view(self):
+        c = Client()
+        response = c.get('/testform/')
+        self.assertEqual(response.status_code, 200)

tests/urls.py

@@ -1,8 +1,14 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals, absolute_import
 
-from django.conf.urls import url, include
+from django.conf.urls import include, url
+from django_typeform.views import TypeformView
+from tests.test_forms import MyForm
 
 
 urlpatterns = [
+    url(r'^testform/', TypeformView.as_view(
+        template_name='typeform_test.html',
+        form_class=MyForm,
+    ))
 ]