Include API docs and required packages

onaio · Jan 23, 2019 · 24dde26 · 24dde26
1 parent 97354f1
commit 24dde26
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 6 deletions.
diff --git a/docs/forms.rst b/docs/forms.rst
@@ -929,6 +929,33 @@ Response
         "enketo_preview_url": "https://H6Ic6.enketo.org/webform/preview?server=https://api.ona.io/geoffreymuchai/&id=form_id"
     }
 
+Get single submission url
+-------------------------
+.. raw:: html
+
+  <pre class="prettyprint">
+  <b>GET</b> /api/v1/forms/<code>{pk}</code>/enketo?url=single_submit</pre>
+
+Request
+^^^^^^^
+::
+
+    curl -X GET https://api.ona.io/api/v1/forms/28058/enketo?url=single_submit
+
+Response
+^^^^^^^^
+::
+
+    HTTP 200 OK
+
+Response
+^^^^^^^^^
+::
+
+    {
+        "single_submit_url": "https://enke.to/single/::abcd"
+    }
+
 
 Get form data in xls, csv format.
 ---------------------------------

diff --git a/onadata/apps/api/tests/viewsets/test_xform_viewset.py b/onadata/apps/api/tests/viewsets/test_xform_viewset.py
@@ -748,9 +748,22 @@ def test_enketo_url(self):
             response = view(request, pk=formid)
             url = "https://enketo.ona.io/::YY8M"
             preview_url = "https://enketo.ona.io/preview/::YY8M"
+            data = {"enketo_url": url, "enketo_preview_url": preview_url}
+            self.assertEqual(response.data, data)
+
+    def test_get_single_submit_url(self):
+        with HTTMock(enketo_preview_url_mock, enketo_mock_with_form_defaults,
+                     enketo_single_submission_mock):
+            self._publish_xls_form_to_project()
+            view = XFormViewSet.as_view({
+                'get': 'enketo'
+            })
+            formid = self.xform.pk
+            get_data = {'url': 'single_submit'}
+            request = self.factory.get('/', data=get_data, **self.extra)
+            response = view(request, pk=formid)
             submit_url = "https://enketo.ona.io/single/::XZqoZ94y"
-            data = {"enketo_url": url, "enketo_preview_url": preview_url,
-                    "single_url": submit_url}
+            data = {"single_submit_url": submit_url}
             self.assertEqual(response.data, data)
 
     def test_enketo_url_with_default_form_params(self):

diff --git a/onadata/apps/api/viewsets/xform_viewset.py b/onadata/apps/api/viewsets/xform_viewset.py
@@ -389,7 +389,7 @@ def login(self, request, **kwargs):
     @action(methods=['GET'], detail=True)
     def enketo(self, request, **kwargs):
         """Expose enketo urls."""
-        url_type = self.kwargs.get('url')
+        url_type = self.kwargs.get('url') or request.GET.get('url')
         self.object = self.get_object()
         form_url = get_form_url(
             request, self.object.user.username, settings.ENKETO_PROTOCOL,

diff --git a/requirements/base.pip b/requirements/base.pip
@@ -110,7 +110,7 @@ pyxform==0.12.2
 raven==6.9.0
 recaptcha-client==1.0.6
 requests==2.20.1          # via datapackage, django-oauth-toolkit, httmock, sphinx, tableschema, tabulator
-requests-mock==1.5.2
+requests_mock==1.5.2
 rfc3986==1.2.0            # via tableschema
 rsa==4.0                  # via google-auth, oauth2client
 savreaderwriter==3.4.2

diff --git a/requirements/dev.pip b/requirements/dev.pip
@@ -130,7 +130,7 @@ pyxform==0.12.2
 raven==6.9.0
 recaptcha-client==1.0.6
 requests==2.20.1          # via datapackage, django-oauth-toolkit, httmock, sphinx, tableschema, tabulator
-requests-mock==1.5.2
+requests_mock==1.5.2
 rfc3986==1.2.0            # via tableschema
 rsa==4.0                  # via google-auth, oauth2client
 savreaderwriter==3.4.2

diff --git a/setup.py b/setup.py
@@ -100,7 +100,7 @@
         "python-dateutil",
         "pytz",
         "requests",
-        "requests-mock==1.5.2",
+        "requests-mock",
         "simplejson",
         "google-api-python-client",
         "uwsgi",