Exposes submissions url to enketo #1526

WinnyTroy · 2018-12-21T13:43:51Z

This PR contains the functionality to expose Enketo's single submission url.

onadata/libs/tests/utils/test_viewer_tools.py

onadata/libs/utils/viewer_tools.py

onadata/libs/tests/utils/test_viewer_tools.py

ukanga · 2019-01-05T13:32:41Z

onadata/libs/utils/viewer_tools.py

@@ -367,3 +366,27 @@ def get_enketo_preview_url(request, username, id_string, xform_pk=None):
            raise EnketoError(response['message'])

    return False
+
+
+def get_submission_url(request, username, id_string, xform_pk=None):


I think this function is not named properly. It is supposed to return the Enketo URL for a single submit survey, probably get_single_submit_url() would be more appropriate. The function docs should also reflect that.

ukanga · 2019-01-05T13:42:18Z

onadata/libs/utils/viewer_tools.py

+
+def get_submission_url(request, username, id_string, xform_pk=None):
+    """Return submission url of the submission instance."""
+    enketo_url = settings.ENKETO_URL + "/api/v2/survey/single/once"


Can we assign "/api/v2/survey/single/once" to a static variable or better yet a settings variable, see examples above in the enketo_url() function.

enketo_url = settings.ENKETO_URL + getattr(settings, 'ENKETO_SINGLE_SUBMIT_PATH', "/api/v2/survey/single/once")

ukanga · 2019-01-05T14:08:20Z

onadata/libs/utils/viewer_tools.py

+        data = response.json()
+        submission_url = data['single_url']
+        return submission_url
+    elif response.status_code == 400:


Since we are raising the same exception with the same error message we probably should only have only the else clause. Check enketo_url() function, could be something that might need to be refactored into a function that can be used by both.

ukanga

I see we do not have an issue for this pull request. From what I can tell in the message, we are supposed to be adding an API endpoint that will allow us to create the single submit Enketo URL. This PR only includes the functionality to make an API request to Enketo but does not expose the feature in the API. Can we:

Expose the functionality on an API endpoint
Update API docs on making use of this functionality.

ukanga · 2019-01-09T06:14:06Z

requirements/base.pip

@@ -110,6 +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


We use pip-tools to generate the pip requirements file. As such we also need to add the required modules into the setup.py under install_requires otherwise this package will not be included next time we regenerate the pip files.

noted. will include the packages there as well.

ukanga · 2019-01-09T06:16:40Z

onadata/libs/tests/utils/test_viewer_tools.py

+
+        with self.assertRaises(EnketoError):
+            get_single_submit_url(
+                request, username='Milly', id_string="tag_team", xform_pk=1)


The request is not being mocked as was done in test_get_single_submit_url(), what EnketoError exception is being tested exactly? Can we apply a mock to the request object for very specific EnketoError exception? We could also check the exception message.

Signed-off-by: Lincoln Simba <[email protected]>

WinnyTroy changed the title ~~[WIP]Exposes submissions url to enketo~~ Exposes submissions url to enketo Dec 21, 2018

WinnyTroy requested a review from ukanga December 21, 2018 16:26

lincmba requested changes Dec 27, 2018

View reviewed changes

WinnyTroy force-pushed the Expose_submissions_endpoint branch from e4dbef2 to 2abc635 Compare January 4, 2019 14:11

ukanga requested changes Jan 5, 2019

View reviewed changes

WinnyTroy force-pushed the Expose_submissions_endpoint branch from 6287c41 to bc70f2a Compare January 8, 2019 06:51

lincmba approved these changes Jan 8, 2019

View reviewed changes

ukanga requested changes Jan 9, 2019

View reviewed changes

WinnyTroy force-pushed the Expose_submissions_endpoint branch 2 times, most recently from 7ab7184 to 402b4a3 Compare January 13, 2019 13:41

WinnyTroy force-pushed the Expose_submissions_endpoint branch 5 times, most recently from b93828a to 3c110a8 Compare January 23, 2019 11:26

lincmba force-pushed the Expose_submissions_endpoint branch 2 times, most recently from 941511c to a758205 Compare January 23, 2019 12:38

WinnyTroy force-pushed the Expose_submissions_endpoint branch 2 times, most recently from 4e9f3b6 to 7ba2cdf Compare January 24, 2019 14:30

WinnyTroy force-pushed the Expose_submissions_endpoint branch from f16b2da to cf95655 Compare February 18, 2019 07:31

lincmba force-pushed the Expose_submissions_endpoint branch from 6b91f9e to de8f115 Compare February 18, 2019 11:47

WinnyTroy force-pushed the Expose_submissions_endpoint branch from de8f115 to 12eb9b3 Compare February 18, 2019 12:45

lincmba force-pushed the Expose_submissions_endpoint branch 2 times, most recently from c73721b to 391b09f Compare February 19, 2019 08:30

WinnyTroy force-pushed the Expose_submissions_endpoint branch from 391b09f to 9d18048 Compare February 25, 2019 15:04

lincmba force-pushed the Expose_submissions_endpoint branch from 9d18048 to 391b09f Compare March 1, 2019 12:28

WinnyTroy force-pushed the Expose_submissions_endpoint branch 3 times, most recently from 0b7559b to 73c46b1 Compare March 1, 2019 12:52

Exposes submissions url to enketo

b196a23

WinnyTroy and others added 24 commits March 1, 2019 15:59

Improve code

8cdb4b4

Include request_mock package to requirements file

2d8f7bd

Fix Flake8 errors

2084407

Fix flake8 errors.

651e5d1

Fix error handling.

bcf0ae3

Include viewset to expose single submit url.

bf543d8

Include required packages in setup file

5dcac53

Specifies exact error being raised.

6ab1bec

Included Test for single submit url

c743fec

Fix failing tests.

7458679

Fixes TypeError

176c5d3

Code refactor

1c3c0c5

Fix failing test

57f8768

Fix TypeError caused due to refactoring of the code.

65cbefc

Cleaned up enketo viewset

871847d

Fix failing tests

d1628d0

Include API docs and required packages

f8e81be

Improve logic

8bd5ad1

Signed-off-by: Lincoln Simba <[email protected]>

Minor Corrections

54ef91f

Include constant in settings file

b3a24e2

Use correct mock

f4b93bc

Signed-off-by: Lincoln Simba <[email protected]>

Improve mock data

82ca47a

Signed-off-by: Lincoln Simba <[email protected]>

Restore imports

792da5c

Signed-off-by: Lincoln Simba <[email protected]>

code cleanup

ec457c2

Signed-off-by: Lincoln Simba <[email protected]>

lincmba force-pushed the Expose_submissions_endpoint branch from 73c46b1 to ec457c2 Compare March 1, 2019 13:04

WinnyTroy and others added 2 commits March 1, 2019 16:16

Change Naming convections for certain variables

e97aacc

flake8 cleanup

d607c11

ukanga merged commit 9f57942 into master Mar 11, 2019

ukanga deleted the Expose_submissions_endpoint branch March 11, 2019 19:16

WinnyTroy mentioned this pull request Nov 22, 2019

Add functionality to create single submission enketo links #1169

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exposes submissions url to enketo #1526

Exposes submissions url to enketo #1526

WinnyTroy commented Dec 21, 2018 •

edited

Loading

ukanga Jan 5, 2019

ukanga Jan 5, 2019

ukanga Jan 5, 2019

ukanga left a comment •

edited by lincmba

Loading

ukanga Jan 9, 2019

WinnyTroy Jan 9, 2019

ukanga Jan 9, 2019

Exposes submissions url to enketo #1526

Exposes submissions url to enketo #1526

Conversation

WinnyTroy commented Dec 21, 2018 • edited Loading

ukanga Jan 5, 2019

Choose a reason for hiding this comment

ukanga Jan 5, 2019

Choose a reason for hiding this comment

ukanga Jan 5, 2019

Choose a reason for hiding this comment

ukanga left a comment • edited by lincmba Loading

Choose a reason for hiding this comment

ukanga Jan 9, 2019

Choose a reason for hiding this comment

WinnyTroy Jan 9, 2019

Choose a reason for hiding this comment

ukanga Jan 9, 2019

Choose a reason for hiding this comment

WinnyTroy commented Dec 21, 2018 •

edited

Loading

ukanga left a comment •

edited by lincmba

Loading