Added custom error class and removed/refactored endpoints affected by new MR release (#20)

* Added tests for existing methods

* Updated tests

* Added custom error class, refactored endpoints that changed in new release

* Updated examples

* Fixed example

* Removed extra line

* Added new error handling

* Addressed comments, changed method name

* First pass at new test

* Added tests for exceptions

* Added new tests and separated into two files

Author: mattmanley

examples/create_challenge_from_model.py

@@ -22,4 +22,4 @@
 print(challenge_data.overpassQL)
 
 # Create challenge
-print(json.dumps(api.create_challenge_from_model(challenge_data)))
+print(json.dumps(api.create_challenge(challenge_data)))

examples/get_project_children.py

@@ -35,45 +35,23 @@ def get_project_by_name(self, project_name):
         )
         return response
 
-    def find_project(self, matcher="", parent=-1, limit=10, page=0, only_enabled="true"):
+    def find_project(self, matcher="", limit=10, page=0, only_enabled="true"):
         """Method to search for projects based on a specific search criteria
 
         :param matcher: the search string used to match the project names. Default is empty string
-        :param parent: the parent ID. This field is ignored for this request. Default is -1.
         :param limit: the limit to the number of results returned in the response. Default is 10
         :param page: used in conjunction with the limit parameter to page through X number of responses. Default is 0.
         :param only_enabled: flag to set if only wanting enabled projects returned. Default is True.
         :returns: the API response from the GET request
         """
         query_params = {
-            "q": matcher,
-            "parentId": str(parent),
+            "search": matcher,
             "limit": str(limit),
             "page": str(page),
             "onlyEnabled": only_enabled
         }
         response = self.server.get(
-            endpoint="/projects/find",
-            params=query_params
-        )
-        return response
-
-    def get_project_children(self, project_id, limit=10, page=0):
-        """Method to fetch a project's children in an expanded list. Unlike the GET request /project/{id}/challenges,
-        this function will wrap the JSON array list inside of the parent project object, showing the full hierarchy. It
-        will not include the children tasks of the challenges
-
-        :param project_id: the id of the parent project
-        :param limit: the limit to the number of results returned in the response. Default is 10
-        :param page: used in conjunction with the limit parameter to page through X number of responses. Default is 0.
-        :returns: the API response from the GET request
-        """
-        query_params = {
-            "limit": str(limit),
-            "page": str(page)
-        }
-        response = self.server.get(
-            endpoint=f"/project/{project_id}/children",
+            endpoint="/projects",
             params=query_params
         )
         return response
@@ -109,7 +87,7 @@ def create_project(self, data):
             body=data)
         return response
 
-    def create_challenge_from_model(self, data):
+    def create_challenge(self, data):
         """Method to create a new challenge
 
         :param data: a JSON input containing challenge details

maproulette/api/api.py

@@ -0,0 +1,37 @@
+import json
+"""This module contains the set of MapRoulette's exceptions"""
+
+
+class MapRouletteBaseException(Exception):
+    """MapRoulette Base Exception"""
+    def __init__(self, message, status=None, payload=None):
+        self.message = message
+        self.status = status
+        self.payload = payload
+
+    def __str__(self):
+        return repr({
+                "status": self.status,
+                "message": self.message,
+                "payload": self.payload
+                })
+
+
+class NotFoundError(MapRouletteBaseException):
+    """Resource cannot be found"""
+
+
+class ConnectionUnavailableError(MapRouletteBaseException):
+    """A connection error occurred"""
+
+
+class UnauthorizedError(MapRouletteBaseException):
+    """The user is not authorized to make this request"""
+
+
+class HttpError(MapRouletteBaseException):
+    """An HTTP error occurred"""
+
+
+class InvalidJsonError(MapRouletteBaseException):
+    """Errors produced from an invalid JSON object"""

maproulette/api/errors.py

@@ -1,9 +1,9 @@
 """This module contains the basic methods that handle API calls to the MapRoulette API. It uses the requests library to
 accomplish this."""
 
-import logging
 import requests
 import json
+from .errors import HttpError, InvalidJsonError, ConnectionUnavailableError, UnauthorizedError, NotFoundError
 
 
 class MapRouletteServer:
@@ -27,7 +27,24 @@ def get(self, endpoint, params=None):
         try:
             response.raise_for_status()
         except requests.exceptions.HTTPError as e:
-            logging.critical(str(e))
+            if e.response.status_code == 404:
+                raise NotFoundError(
+                    message='Resource not found',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+            else:
+                raise HttpError(
+                    message='An HTTP error occurred',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+        except (requests.ConnectionError, requests.Timeout) as e:
+            raise ConnectionUnavailableError(
+                message="Connection Unavailable",
+                status=e.response.status_code,
+                payload=response
+            ) from None
         try:
             return {
                 "data": response.json(),
@@ -53,7 +70,26 @@ def post(self, endpoint, body=None):
         try:
             response.raise_for_status()
         except requests.exceptions.HTTPError as e:
-            logging.critical(str(e))
+            if e.response.status_code == 400:
+                raise InvalidJsonError(
+                    message='Invalid JSON payload',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+            elif e.response.status_code == 401:
+                raise UnauthorizedError(
+                    message='The user is not authorized to make this request',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+            else:
+                raise HttpError(
+                    message='An HTTP error occurred',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+        except (requests.ConnectionError, requests.Timeout) as e:
+            raise ConnectionUnavailableError(e) from None
         try:
             return {
                 "data": response.json(),
@@ -79,7 +115,26 @@ def put(self, endpoint, body=None):
         try:
             response.raise_for_status()
         except requests.exceptions.HTTPError as e:
-            logging.critical(str(e))
+            if e.response.status_code == 400:
+                raise InvalidJsonError(
+                    message='Invalid JSON payload',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+            elif e.response.status_code == 401:
+                raise UnauthorizedError(
+                    message='The user is not authorized to make this request',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+            else:
+                raise HttpError(
+                    message='An HTTP error occurred',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+        except (requests.ConnectionError, requests.Timeout) as e:
+            raise ConnectionUnavailableError(e) from None
         try:
             return {
                 "data": response.json(),
@@ -102,7 +157,26 @@ def delete(self, endpoint):
         try:
             response.raise_for_status()
         except requests.exceptions.HTTPError as e:
-            logging.critical(str(e))
+            if e.response.status_code == 401:
+                raise UnauthorizedError(
+                    message='The user is not authorized to make this request',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+            elif e.response.status_code == 404:
+                raise NotFoundError(
+                    message='Resource not found',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+            else:
+                raise HttpError(
+                    message='An HTTP error occurred',
+                    status=e.response.status_code,
+                    payload=e.response
+                ) from None
+        except (requests.ConnectionError, requests.Timeout) as e:
+            raise ConnectionUnavailableError(e) from None
         try:
             return {
                 "data": response.json(),

maproulette/api/maproulette_server.py

@@ -1,7 +1,6 @@
 import maproulette
 import unittest
 from tests.sample_data import test_geojson, test_overpassQL_query
-import pytest
 from unittest.mock import patch
 
 
@@ -31,13 +30,6 @@ def test_find_project(self, mock_request, api_instance=api):
         response = api_instance.find_project(test_search)
         self.assertEqual(response['status'], '200')
 
-    @patch('maproulette.api.maproulette_server.requests.get')
-    def test_get_project_children(self, mock_request, api_instance=api):
-        test_project_id = '32922'
-        mock_request.return_value.status_code = '200'
-        response = api_instance.get_project_children(test_project_id)
-        self.assertEqual(response['status'], '200')
-
     @patch('maproulette.api.maproulette_server.requests.get')
     def test_get_project_challenges(self, mock_request, api_instance=api):
         test_project_id = '12974'
@@ -82,13 +74,13 @@ def test_get_challenge_tasks(self, mock_request, api_instance=api):
         self.assertEqual(response['status'], '200')
 
     @patch('maproulette.api.maproulette_server.requests.post')
-    def test_create_challenge_from_model(self, mock_request, api_instance=api):
+    def test_create_challenge(self, mock_request, api_instance=api):
         test_challenge_model = maproulette.ChallengeModel(name='Test_Challenge_Name',
                                                           instruction='Do something',
                                                           description='This is a test challenge',
                                                           overpassQL=test_overpassQL_query)
         mock_request.return_value.status_code = '200'
-        response = api_instance.create_challenge_from_model(test_challenge_model)
+        response = api_instance.create_challenge(test_challenge_model)
         self.assertEqual(response['status'], '200')
 
     @patch('maproulette.api.maproulette_server.requests.put')