Add: First test

fsbraun · fsbraun · commit 61dd95da9f0b · 2019-07-18T00:58:58.000+02:00
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -10,4 +10,5 @@ Development Lead
 Contributors
 ------------
 
-None yet. Why not be the first?
+* Fabian Braun <fsbraun@gmx.de>
+
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -3,6 +3,11 @@
 History
 -------
 
+0.2.0 (2019-07-18)
+++++++++++++++++++
+
+* Add TypeformMixin and TypeformView
+
 0.1.0 (2017-10-05)
 ++++++++++++++++++
 
diff --git a/README.rst b/README.rst
@@ -36,26 +36,21 @@ Add it to your `INSTALLED_APPS`:
         ...
     )
 
-Add Django Typeform's static files to your template:
-
-.. code-block:: html
-
-    <script src="{% static 'django_typeform/embed.js' %}"></script>
-
-Usage:
+Usage as template tag:
 
 .. code-block:: html
 
     {% load django_typeform %}
     <html>
         <body>
-            <div class="my-typeform"></div>
-            <script src="{% static 'django_typeform/embed.js' %}"></script>
-            {% typeforms_embed 'https://xxxx.typeform.com/to/xxxxxx' '.my-typeform' '{"hideHeaders": true, "hideFooter": true}' %}
+            {% typeforms_embed 'https://xxxx.typeform.com/to/xxxxxx' 'my-typeform' '{"hideHeaders": true, "hideFooter": true}' %}
         </body>
     </html>
 
 Features
 --------
 
 * Embed SDK Support
+* Results API support
+* TypeformMixin to use Django forms to process typeform results
+* TypeformView to transparently integrate typeforms into the Django framework
diff --git a/django_typeform/__init__.py b/django_typeform/__init__.py
@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = '0.2.0'
diff --git a/django_typeform/static/django_typeform/embed.js b/django_typeform/static/django_typeform/embed.js
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -0,0 +1,22 @@
+=============
+Configuration
+=============
+
+``django_typeform`` interacts with the Typeform Responses API. To use the
+API you need to get a **Personal token** from typeform.
+
+
+TYPEFORM_TOKEN
+..............
+
+The ``TYPEFORM_TOKEN`` setting is **required**. It carries the
+personal token of the typeform account. Example:
+
+.. code-block:: python
+
+    TYPEFORM_TOKEN = 'heregoesthereallylongtokenstringgiventoyoubytypeform'
+
+Without the token the Responses API will not work and type ``TypeformMixin`` will
+not be able to retrieve responses. The template tags are unaffected.
+
+
diff --git a/docs/django_typeform.templatetags.rst b/docs/django_typeform.templatetags.rst
@@ -13,10 +13,27 @@ django\_typeform\.templatetags\.django\_typeform module
     :show-inheritance:
 
 
-Module contents
----------------
+Template tags
+-------------
 
 .. automodule:: django_typeform.templatetags
     :members:
     :undoc-members:
     :show-inheritance:
+
+TypeformMixin
+-------------
+
+.. automodule:: django_typeform.forms
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+TypeformView
+------------
+
+.. automodule:: django_typeform.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,7 +13,10 @@ Contents:
 
    readme
    installation
+   configuration
    usage
+   typeformmixin
+   typeformview
    contributing
    authors
    history
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -10,3 +10,6 @@ Or, if you have virtualenvwrapper installed::
 
     $ mkvirtualenv django-typeform
     $ pip install django-typeform
+
+``django_typeform`` requires ``django-sekizai`` to be installed (should happen automatically in the
+above instructions). Sekizai is used to position javascript elements at the ebnd of the HTML body.
diff --git a/docs/typeformmixin.rst b/docs/typeformmixin.rst
@@ -0,0 +1,78 @@
+=============
+TypeformMixin
+=============
+
+The ``TypeformMixin`` is a mixin for Django's form class. To turn
+Typeform features on for a Django form just use the Mixin:
+
+.. code-block:: python
+
+    from django_typeforms.forms import TypeformMixin
+
+    from forms import MyForm
+
+    class MyTypeForm(TypeformMixin, MyForm)
+        typeform_url = 'https://xxxx.typeform.com/to/xxxxxx'
+
+``MyTypeForm`` will be a fully fledge 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
+question must be set to the matching Django field name, e.g. ``first_name`` for a
+field ``first_name = forms.CharField(max_length=40, blank=True)``. **This requires editiing
+all questions of a typeform and as Typeform warns might break
+other integrations.**
+
+Additionally, the typeform needs a **hidden field** "typeformuid" which
+the ``TypeformMixin`` uses to identify the relevant answer sent to the
+Typeform servers. Hidden fields currently are only available to
+users of the Typeform PRO and PRO+ plans.
+
+Rendering a typeform
+--------------------
+
+Once, a form is turned into a typeform using the mixin, it still can
+used and rendered as a Django form using, e.g., ``{{ form }}`` or any
+other of your preferred rendering methods.
+
+Additionally, it can be rendered as a typeform using include:
+
+.. code-block:: html
+
+    <form method="post">
+      {% include form with mode='popup' %}
+    </form>
+
+This will render a hidden input field with a unique id passed to the
+typeform's hidden ``typeformuid`` field. Upon completion of
+the typeform the above HTML form is posted to the server and
+the server can retrieve the answers given by querying the response
+with the unique id.
+
+Additional context can be given to the typeform using the ``with`` clause.
+
+Currently, valid context parameters are:
+
+mode
+....
+``mode`` (default: None) describes the emed mede to be used: ``None`` or ``widget``
+for a widget. In widget mode the additional parameter ``height`` is
+needed for proper display. Example:
+
+.. code-block:: html
+
+    <form method="post">
+      {% include form with mode='widget' height='100vh' %}
+    </form>
+
+Other values of ``mode`` can be ``popup``, ``drawer_left``, or
+``drawer_right`` which are the three modes for typeform popup modes.
+
+
+Form validation
+---------------
+
+Both Django and Typeform provide form validation. This is prone for conflicts
+since both validations need not agree. When turning a Django form into a typeform
+we recommend to leave out any validation on the Django side, since for now
+there is no way of returning validation errors to typeform.
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -12,11 +12,9 @@ To use Django Typeform in a project, add it to your `INSTALLED_APPS`:
         ...
     )
 
-Add Django Typeform's static files to your template:
+The ``typeform_embed`` template tag includes a ``<div>`` at its position. It carries
+a class
 
-.. code-block:: html
-
-    <script src="{% static 'django_typeform/embed.js' %}"></script>
 
 Example:
 
@@ -25,20 +23,7 @@ Example:
     {% load django_typeform %}
     <html>
         <body>
-            <div class="my-typeform"></div>
-            <script src="{% static 'django_typeform/embed.js' %}"></script>
-            {% typeforms_embed 'https://xxxx.typeform.com/to/xxxxxx' '.my-typeform' '{"hideHeaders": true, "hideFooter": true}' %}
+             {% typeforms_embed 'https://xxxx.typeform.com/to/xxxxxx' '.my-typeform' '{"hideHeaders": true, "hideFooter": true}' %}
         </body>
     </html>
 
-
-... code-block:: html
-
-    {% load django_typeform %}
-    <html>
-        <body>
-            <div id="my-css-selector"></div>
-            <script src="{% static 'django_typeform/embed.js' %}"></script>
-            {% typeforms_embed 'https://xxxx.typeform.com/to/xxxxxx' '#my-css-selector' options_as_dict_var %}
-        </body>
-    </html>
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,5 @@
 
 # Additional requirements go here
+django-sekizai
+python-dateutil
+
diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -1,3 +1,6 @@
+django-sekizai
+python-dateutil
+
 bumpversion==0.5.3
 wheel==0.30.0
 
diff --git a/requirements_test.txt b/requirements_test.txt
@@ -1,3 +1,6 @@
+django-sekizai
+python-dateutil
+
 coverage==4.4.1
 mock>=1.0.1
 flake8>=2.1.0
diff --git a/setup.py b/setup.py
@@ -63,15 +63,16 @@ def get_version(*file_paths):
     classifiers=[
         'Development Status :: 3 - Alpha',
         'Framework :: Django',
-        'Framework :: Django :: 1.9',
-        'Framework :: Django :: 1.10',
         'Framework :: Django :: 1.11',
+        'Framework :: Django :: 2.0',
+        'Framework :: Django :: 2.1',
+        'Framework :: Django :: 2.2',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: MIT License',
         'Natural Language :: English',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
     ],
 )
diff --git a/tests/test_forms.py b/tests/test_forms.py
@@ -0,0 +1,15 @@
+from django.forms import Form
+from django.template import Context
+
+from django_typeform.forms import TypeformMixin
+from django.test import SimpleTestCase
+
+
+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')
+
diff --git a/tox.ini b/tox.ini
@@ -1,19 +1,21 @@
 [tox]
 envlist =
-    {py34,py35,py36}-django-19
-    {py34,py35,py36}-django-110
-    {py34,py35,py36}-django-111
+    {py35,py36,py37}-django-111
+    {py35,py36,py37}-django-20
+    {py35,py36,py37}-django-21
+    {py35,py36,py37}-django-22
 
 [testenv]
 setenv =
     PYTHONPATH = {toxinidir}:{toxinidir}/django_typeform
 commands = coverage run --source django_typeform runtests.py
 deps =
-    django-19: Django>=1.9,<1.10
-    django-110: Django>=1.10,<1.11
-    django-111: Django>=1.11
+    django-111: Django>=1.11,<2.0
+    django-20: Django>=2.0,<2.1
+    django-21: Django>=2.1,<2.2
+    django-22: Django>=2.2,<2.3
     -r{toxinidir}/requirements_test.txt
 basepython =
+    py37: python3.7
     py36: python3.6
     py35: python3.5
-    py34: python3.4

-Original file line number
+Diff line change
 Contributors
 ------------
 -None yet. Why not be the first?
 +* Fabian Braun <[email protected]>
++
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '0.1.0'`
	`1`	`+__version__ = '0.2.0'`