Merge pull request #88 from osmlab/dev

Dev -> Master

Author: mattmanley

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.6.0](https://github.com/osmlab/maproulette-python-client/compare/v1.5.0...v1.6.0)
+
+> 26 January 2021
+
+- dev > master (version bump to 1.6.0) [`#76`](https://github.com/osmlab/maproulette-python-client/pull/76)
+- Merge dev > master [`#75`](https://github.com/osmlab/maproulette-python-client/pull/75)
+- Cooperative Work Model [`#69`](https://github.com/osmlab/maproulette-python-client/pull/69)
+- Updated changelog [`#71`](https://github.com/osmlab/maproulette-python-client/pull/71)
+- Added new endpoint for fetching tasks by bounding box [`#70`](https://github.com/osmlab/maproulette-python-client/pull/70)
+- Refactoring existing endpoint unit tests [`#67`](https://github.com/osmlab/maproulette-python-client/pull/67)
+
 #### [v1.5.0](https://github.com/osmlab/maproulette-python-client/compare/v1.4.0...v1.5.0)
 
 > 3 September 2020

README.md

@@ -41,6 +41,8 @@ that when you create your configuration. For example:
 config = maproulette.Configuration(api_key='{YOUR_API_KEY}')
 ```
 
+Your API key is listed at the bottom of https://maproulette.org/user/profile page.
+
 Once you have your configuration object we can create an API object using one of several modules depending on the
 functionality that the user is looking for. For example, creating a Project object allows the user to interact with all
 of the project-related functionality in the MapRoulette package.

maproulette/__init__.py

@@ -17,4 +17,4 @@
 from .api.task import Task
 from .api.user import User
 
-__version__ = '1.6.0'
+__version__ = '1.7.0'

maproulette/api/challenge.py

@@ -51,7 +51,7 @@ def get_challenge_by_name(self, project_id, challenge_name):
         :param challenge_name: the name corresponding to the challenge
         :returns: the API response from the GET request
         """
-        response = self.get(endpoint=f"/project/{project_id}/challenge/{challenge_name}")
+        response = self.get(endpoint=f"/project/{project_id}/challenge/{challenge_name.replace('/', '%2F')}")
         return response
 
     def get_challenges_by_tags(self, challenge_tags, limit=10, page=0):
@@ -325,6 +325,23 @@ def update_challenge(self, challenge_id, data):
             body=data)
         return response
 
+    def rebuild_challenge(self, challenge_id, remove_unmatched=False, skip_snapshot=False):
+        """Rebuild the challenge by re-creating the tasks from the task data source
+
+        :param challenge_id: the ID corresponding to the challenge
+        :param remove_unmatched: Used to remove incomplete tasks that have been addressed externally since the last
+            rebuild, assuming the source data represents all tasks outstanding. If set to true, all existing tasks in
+            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 skip_snapshot: Whether to skip recording a snapshot before proceeding. Default: False
+        """
+        response = self.put(
+            endpoint=f"/challenge/{challenge_id}/rebuild",
+            params={'removeUnmatched': str(remove_unmatched).lower(), 'skipSnapshot': str(skip_snapshot).lower()}
+        )
+        return response
+
     @staticmethod
     def is_challenge_model(input_object):
         """Method to determine whether user input is a valid challenge model

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
             }
 

maproulette/api/project.py

@@ -110,15 +110,20 @@ def remove_challenge_from_project(self, project_id, challenge_id):
         )
         return response
 
-    def delete_project(self, project_id):
+    def delete_project(self, project_id, immediate="false"):
         """
         Method to delete a project.
 
         :param project_id: the id of the project being deleted
+        :param immediate: whether or not the project should be deleted immediately
         :returns: the API response form the DELETE request
         """
+        query_params = {
+            "immediate": str(immediate)
+        }
         response = self.delete(
-            endpoint=f"/project/{project_id}"
+            endpoint=f"/project/{project_id}",
+            params=query_params
         )
         return response
 

tests/test_challenge_api.py

@@ -203,3 +203,12 @@ def test_update_challenge(self, mock_request, api_instance=api):
             f'{self.url}/challenge/{test_challenge_id}',
             json=json.loads(create_challenge_output),
             params=None)
+
+    @patch('maproulette.api.maproulette_server.requests.Session.put')
+    def test_rebuild_challenge(self, mock_request, api_instance=api):
+        test_challenge_id = '12345'
+        api_instance.rebuild_challenge(test_challenge_id, True, True)
+        mock_request.assert_called_once_with(
+            f'{self.url}/challenge/{test_challenge_id}/rebuild',
+            params={'removeUnmatched': 'true', 'skipSnapshot': 'true'},
+            json=None)

tests/test_project_api.py

@@ -90,7 +90,7 @@ def test_delete_project(self, mock_request, api_instance=api):
         api_instance.delete_project(test_project_id)
         mock_request.assert_called_once_with(
             f'{self.url}/project/{test_project_id}',
-            params=None)
+            params={'immediate': 'false'})
 
     @patch('maproulette.api.maproulette_server.requests.Session.put')
     def test_update_project(self, mock_request, api_instance=api):