Merge pull request #294 from peopledoc/allow-post-method-validation-endpoint

Allow post method validation endpoint

Author: Sylvain Delabye

CHANGELOG.rst

@@ -5,6 +5,7 @@ ChangeLog
 master (unreleased)
 ===================
 
+- Allow POST method for form validation endpoint. This version is the last to support the GET verb for the validation endpoint. We'll drop it in the next version.
 - [Documentation] Fixed a missing ``cd`` in docs. You can't run pytest from project root (#293).
 
 Release 1.2.1 (2018-01-12)

demo/tests/test_integration.py

@@ -391,11 +391,15 @@ class MyForm(FormidableForm):
 class TestValidationEndPoint(FormidableAPITestCase):
 
     url = 'formidable:form_validation'
+    method = 'get'
 
     def setUp(self):
         super(TestValidationEndPoint, self).setUp()
         self.formidable = MyForm.to_formidable(label='title')
 
+    def get_method(self):
+        return getattr(self.client, self.method)
+
     def test_validate_data_ok(self):
         parameters = {
             'first_name': 'Guillaume',
@@ -404,7 +408,8 @@ def test_validate_data_ok(self):
         session = self.client.session
         session['role'] = 'padawan'
         session.save()
-        res = self.client.get(
+        func = self.get_method()
+        res = func(
             reverse(self.url, args=[self.formidable.pk]),
             parameters, format='json'
         )
@@ -419,7 +424,8 @@ def test_formidable_does_not_exist(self):
         session = self.client.session
         session['role'] = 'padawan'
         session.save()
-        res = self.client.get(
+        func = self.get_method()
+        res = func(
             reverse(self.url, args=[9999]),
             parameters, format='json'
         )
@@ -432,7 +438,8 @@ def test_validate_data_ko(self):
         session = self.client.session
         session['role'] = 'padawan'
         session.save()
-        res = self.client.get(
+        func = self.get_method()
+        res = func(
             reverse(self.url, args=[self.formidable.pk]),
             parameters, format='json'
         )
@@ -452,7 +459,8 @@ class WithFile(FormidableForm):
         session = self.client.session
         session['role'] = 'padawan'
         session.save()
-        res = self.client.get(
+        func = self.get_method()
+        res = func(
             reverse(self.url, args=[formidable.pk]),
             parameters, format='json'
         )
@@ -493,7 +501,8 @@ class WithFile(FormidableForm):
 
         # The checkbox is checked.
         parameters = {'checkbox': True}
-        res = self.client.get(
+        func = self.get_method()
+        res = func(
             reverse(self.url, args=[formidable.pk]),
             parameters, format='json'
         )
@@ -503,7 +512,8 @@ class WithFile(FormidableForm):
 
         # The checkbox is NOT checked.
         parameters = {'checkbox': False}
-        res = self.client.get(
+        func = self.get_method()
+        res = func(
             reverse(self.url, args=[formidable.pk]),
             parameters, format='json'
         )
@@ -514,3 +524,8 @@ class WithFile(FormidableForm):
 class TestValidationFromSchemaEndPoint(TestValidationEndPoint):
 
     url = 'form_validation_schema'
+
+
+class TestValidationWithPostMethod(TestValidationEndPoint):
+
+    method = 'post'

docs/package-lock.json

@@ -482,7 +482,29 @@ var spec = {
                         }
                     }
                 },
-                "summary": "Validate a form"
+                "summary": "Validate a form (GET method). GET and POST are equivalent, but GET is deprecated."
+            },
+            "post": {
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "id",
+                        "required": true,
+                        "type": "integer"
+                    }
+                ],
+                "responses": {
+                    "204": {
+                        "description": "Validation OK"
+                    },
+                    "400": {
+                        "description": "Validation KO",
+                        "schema": {
+                            "$ref": "#/definitions/InputError"
+                        }
+                    }
+                },
+                "summary": "Validate a form (POST method). GET and POST are equivalent."
             }
         }
     },

docs/source/_static/specs/formidable.js

@@ -133,7 +133,21 @@ paths:
 
   /forms/{id}/validate/:
     get:
-      summary: Validate a form
+      summary: Validate a form (GET method). GET and POST are equivalent, but GET is deprecated.
+      parameters:
+        - name: id
+          in: path
+          type: integer
+          required: true
+      responses:
+        204:
+          description:  Validation OK
+        400:
+          description: Validation KO
+          schema:
+            $ref: '#/definitions/InputError'
+    post:
+      summary: Validate a form (POST method). GET and POST are equivalent.
       parameters:
         - name: id
           in: path

docs/swagger/formidable.yml

@@ -3,6 +3,7 @@
 from __future__ import unicode_literals
 
 import logging
+import warnings
 
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
@@ -239,19 +240,29 @@ def build(self, role):
     def get_formidable_object(self, kwargs):
         return Formidable.objects.get(pk=kwargs['pk'])
 
-    def get(self, request, **kwargs):
+    def post(self, request, **kwargs):
         try:
             formidable = self.get_formidable_object(kwargs)
         except Formidable.DoesNotExist:
             raise exceptions.NotFound()
 
         form_class = self.get_form_class(formidable)
-        form = self.get_form(form_class)
+        form = self.get_form(form_class, request)
         if form.is_valid():
             return self.form_valid(form)
         else:
             return self.form_invalid(form)
 
+    def get(self, request, **kwargs):
+        """
+        GET method is deprecated in favor of POST
+
+        """
+        warnings.warn('GET method for form validation has been deprecated in '
+                      'favor of POST. Please use POST instead of GET.',
+                      category=DeprecationWarning)
+        return self.post(request, **kwargs)
+
     def get_form_class(self, formidable):
         return formidable.get_django_form_class(
             **self.get_form_class_kwargs()
@@ -275,11 +286,17 @@ def form_invalid(self, form):
         # return Response(data, status=400)
         return Response(form.errors, status=status.HTTP_400_BAD_REQUEST)
 
-    def get_form(self, form_class):
-        return form_class(**self.get_form_kwargs())
+    def get_form(self, form_class, request):
+        return form_class(**self.get_form_kwargs(request))
+
+    def get_form_kwargs(self, request):
+        """
+        Return form_data.
 
-    def get_form_kwargs(self):
-        return {'data': self.request.GET}
+        """
+        if request.method == 'GET':
+            return {'data': request.GET}
+        return {'data': request.data}
 
 
 class ValidateViewFromSchema(ValidateView):