Merge pull request #79 from hfs/challenge-rebuild

Add endpoint to rebuild challenge

Author: mattmanley

maproulette/api/challenge.py

@@ -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 skipSnapshot: 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

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)