Merge pull request #80 from mattmanley/refactor_response_text

Changed response handling in case of JSON deserializing error

Author: mattmanley

maproulette/api/challenge.py

@@ -334,7 +334,7 @@ def rebuild_challenge(self, challenge_id, remove_unmatched=False, skip_snapshot=
             CREATED or SKIPPED status (only) will be removed prior to rebuilding with the assumption that they will be
             recreated if they still appear in the updated source data. If set to false, unmatched existing tasks are
             simply left as-is. Default: False
-        :param skipSnapshot: Whether to skip recording a snapshot before proceeding. Default: False
+        :param skip_snapshot: Whether to skip recording a snapshot before proceeding. Default: False
         """
         response = self.put(
             endpoint=f"/challenge/{challenge_id}/rebuild",

maproulette/api/maproulette_server.py

@@ -54,7 +54,8 @@ def get(self, endpoint, params=None):
 
         :param endpoint: the server endpoint to use for the GET request
         :param params: the parameters that pertain to the request (optional)
-        :returns: a JSON object containing the API response
+        :returns: a dictionary containing the API response status code as well as the decoded JSON response if decoding
+            was successful. If not, the response text is returned.
         """
         response = self.session.get(
             self.url + endpoint,
@@ -85,6 +86,7 @@ def get(self, endpoint, params=None):
             }
         except ValueError:
             return {
+                "data": response.text,
                 "status": response.status_code
             }
 
@@ -94,7 +96,8 @@ def post(self, endpoint, body=None, params=None):
         :param endpoint: the server endpoint to use for the POST request
         :param body: the body of the request (optional)
         :param params: the parameters that pertain to the request (optional)
-        :returns: a JSON object containing the API response
+        :returns: a dictionary containing the API response status code as well as the decoded JSON response if decoding
+            was successful. If not, the response text is returned.
         """
         response = self.session.post(
             self.url + endpoint,
@@ -128,6 +131,7 @@ def post(self, endpoint, body=None, params=None):
             }
         except ValueError:
             return {
+                "data": response.text,
                 "status": response.status_code
             }
 
@@ -137,7 +141,8 @@ def put(self, endpoint, body=None, params=None):
         :param endpoint: the server endpoint to use for the PUT request
         :param body: the body of the request (optional)
         :param params: the parameters that pertain to the request (optional)
-        :returns: a JSON object containing the response code and the API response if
+        :returns: a dictionary containing the API response status code as well as the decoded JSON response if decoding
+            was successful. If not, the response text is returned.
         """
         response = self.session.put(
             self.url + endpoint,
@@ -171,6 +176,7 @@ def put(self, endpoint, body=None, params=None):
             }
         except ValueError:
             return {
+                "data": response.text,
                 "status": response.status_code
             }
 
@@ -179,7 +185,8 @@ def delete(self, endpoint, params=None):
 
         :param endpoint: the server endpoint to use for the DELETE request
         :param params: the parameters that pertain to the request (optional)
-        :returns: a JSON object containing the API response
+        :returns: a dictionary containing the API response status code as well as the decoded JSON response if decoding
+            was successful. If not, the response text is returned.
         """
         response = self.session.delete(
             self.url + endpoint,
@@ -212,6 +219,7 @@ def delete(self, endpoint, params=None):
             }
         except ValueError:
             return {
+                "data": response.text,
                 "status": response.status_code
             }