Merge pull request #90 from osmlab/dev

Merging Dev -> Master

Author: mattmanley

CHANGELOG.md

@@ -4,6 +4,21 @@ 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.7.0](https://github.com/osmlab/maproulette-python-client/compare/v1.6.0...v1.7.0)
+
+> 7 September 2021
+
+- Dev -> Master [`#88`](https://github.com/osmlab/maproulette-python-client/pull/88)
+- Updated changelog and version bump [`#87`](https://github.com/osmlab/maproulette-python-client/pull/87)
+- Encode slashes in challenge_name [`#82`](https://github.com/osmlab/maproulette-python-client/pull/82)
+- Add support for parameter "immediate" for delete_project(), closes #85 [`#86`](https://github.com/osmlab/maproulette-python-client/pull/86)
+- Changed response handling in case of JSON deserializing error [`#80`](https://github.com/osmlab/maproulette-python-client/pull/80)
+- Add endpoint to rebuild challenge [`#79`](https://github.com/osmlab/maproulette-python-client/pull/79)
+- add info where API KEY can be found [`#77`](https://github.com/osmlab/maproulette-python-client/pull/77)
+- Merge pull request #86 from rYR79435/deleteProjectImmediate [`#85`](https://github.com/osmlab/maproulette-python-client/issues/85)
+- Add support for parameter "immediate" for delete_project(), closes #85 [`#85`](https://github.com/osmlab/maproulette-python-client/issues/85)
+- Encode slashes in challenge_name, closes #81 [`#81`](https://github.com/osmlab/maproulette-python-client/issues/81)
+
 #### [v1.6.0](https://github.com/osmlab/maproulette-python-client/compare/v1.5.0...v1.6.0)
 
 > 26 January 2021

maproulette/__init__.py

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

maproulette/api/challenge.py

@@ -278,6 +278,32 @@ def add_tasks_to_challenge(self, data, challenge_id):
             body=data)
         return response
 
+    def add_file_tasks_to_challenge(self, data, challenge_id, line_by_line="true", remove_unmatched="false",
+                                    data_origin_date="", skip_snapshot="false"):
+        """Method to add tasks to an existing challenge with tasks as GeoJSON
+
+        :param data: a GeoJSON containing geometry of tasks to be added to a challenge
+        :param challenge_id: the ID corresponding to the challenge that tasks will be added to
+        :param line_by_line: whether or not the provided data is in line-by-line GeoJSON format
+        :param remove_unmatched: whether or not the JSON provided includes seperate GeoJSON on each line
+        :param data_origin_date: the date the data was sourced on
+        :param skip_snapshot: whether or not to skip recording a snapshot before proceeding
+        :returns: the API response from the PUT request
+        """
+        query_params = {
+            "lineByLine": str(line_by_line),
+            "removeUnmatched": str(remove_unmatched),
+            "dataOriginDate": str(data_origin_date),
+            "skipSnapshot": str(skip_snapshot)
+        }
+        body = {'json': ('data', data)} # server only accepts dict with key 'json'
+
+        response = self.put_file(
+            endpoint=f"/challenge/{challenge_id}/addFileTasks",
+            body=body,
+            params=query_params)
+        return response
+
     def delete_challenge(self, challenge_id, immediate="false"):
         """Method to delete a challenge by using the corresponding challenge ID
 

maproulette/api/maproulette_server.py

@@ -180,6 +180,51 @@ def put(self, endpoint, body=None, params=None):
                 "status": response.status_code
             }
 
+    def put_file(self, endpoint, body=None, params=None):
+        """Method that completes a multipart PUT request to the MapRoulette API
+
+        :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 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,
+            params=params,
+            files=body
+        )
+        try:
+            response.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            if e.response.status_code == 400:
+                raise InvalidJsonError(
+                    message=self.parse_response_message(e.response),
+                    status=e.response.status_code
+                ) from None
+            elif e.response.status_code == 401:
+                raise UnauthorizedError(
+                    message=self.parse_response_message(e.response),
+                    status=e.response.status_code
+                ) from None
+            else:
+                raise HttpError(
+                    message=self.parse_response_message(e.response),
+                    status=e.response.status_code
+                ) from None
+        except (requests.ConnectionError, requests.Timeout) as e:
+            raise ConnectionUnavailableError(e) from None
+        try:
+            return {
+                "data": response.json(),
+                "status": response.status_code
+            }
+        except ValueError:
+            return {
+                "data": response.text,
+                "status": response.status_code
+            }
+
     def delete(self, endpoint, params=None):
         """Method that completes a DELETE request to the MapRoulette API
 

maproulette/api/task.py

@@ -36,6 +36,8 @@ def create_task(self, data):
         :param data: a JSON input containing task details
         :returns: the API response from the POST request
         """
+        if self.is_task_model(data):
+            data = TaskModel.to_dict(data)
         response = self.post(
             endpoint="/task",
             body=data)

tests/test_challenge_api.py

@@ -57,6 +57,22 @@ def test_add_tasks_to_challenge(self, mock_request, api_instance=api):
             json=test_geojson,
             params=None)
 
+    @patch('maproulette.api.maproulette_server.requests.Session.put')
+    def test_add_file_tasks_to_challenge(self, mock_request, api_instance=api):
+        test_challenge_id = '12978'
+        data = {'json': ('data', test_geojson)}
+        query_params = {
+            "lineByLine": "true",
+            "removeUnmatched": "false",
+            "dataOriginDate": "",
+            "skipSnapshot": "false"
+        }
+        api_instance.add_file_tasks_to_challenge(test_geojson, test_challenge_id)
+        mock_request.assert_called_once_with(
+            f'{self.url}/challenge/12978/addFileTasks',
+            files=data,
+            params=query_params)
+
     @patch('maproulette.api.maproulette_server.requests.Session.post')
     def test_create_virtual_challenge(self, mock_request, api_instance=api):
         # TODO: add model for virtual challenge to aid in posting

tests/test_task_api.py

@@ -26,6 +26,18 @@ def test_get_task_history(self, mock_request, api_instance=api):
             f'{self.url}/task/{test_task_id}/history',
             params=None)
 
+    @patch('maproulette.api.maproulette_server.requests.Session.post')
+    def test_create_task(self, mock_request, api_instance=api):
+        geometries = test_geojson['features'][0]['geometry']
+        test_task_model = maproulette.TaskModel(name='test_task',
+                                                parent='12345',
+                                                geometries=geometries)
+        api_instance.create_task(test_task_model)
+        mock_request.assert_called_once_with(
+            f'{self.url}/task',
+            json=test_task_model.to_dict(),
+            params=None)
+
     @patch('maproulette.api.maproulette_server.requests.Session.post')
     def test_create_tasks(self, mock_request, api_instance=api):
         test_tasks = []
@@ -77,7 +89,7 @@ def test_create_cooperative_task(self, mock_request, api_instance=api):
         api_instance.create_task(test_task)
         mock_request.assert_called_once_with(
             f'{self.url}/task',
-            json=test_task,
+            json=test_task.to_dict(),
             params=None)
 
     @patch('maproulette.api.maproulette_server.requests.Session.put')

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py36
+minversion = 3.6.0
 
 [testenv]
 deps =