Merge pull request #36 from dcastrowa/addRemoveChallenge

Add new project api functionality

Author: mattmanley

maproulette/api/project.py

@@ -85,6 +85,96 @@ def create_project(self, data):
             body=data)
         return response
 
+    def add_challenge_to_project(self, project_id, challenge_id):
+        """
+        Method to add a challenge to a virtual project.
+
+        :param project_id: the id of the virtual project
+        :param challenge_id: the id of the challenge being added
+        :return: the API response from the POST request
+        """
+        response = self.post(
+            endpoint=f"/project/{project_id}/challenge/{challenge_id}/add"
+        )
+        return response
+
+    def remove_challenge_from_project(self, project_id, challenge_id):
+        """
+        Method to remove a challenge from a virtual project.
+
+        :param project_id: the id of the virtual project
+        :param challenge_id: the id of the challenge being removed
+        :return: the API response from the POST request
+        """
+        response = self.post(
+            endpoint=f"/project/{project_id}/challenge/{challenge_id}/remove"
+        )
+        return response
+
+    def delete_project(self, project_id):
+        """
+        Method to delete a project.
+
+        :param project_id: the id of the project being deleted
+        :return: the API response form the DELETE request
+        """
+        response = self.delete(
+            endpoint=f"/project/{project_id}"
+        )
+        return response
+
+    def update_project(self, project_id, data):
+        """
+        Method to update an existing project
+
+        :param project_id: the id of the project being updated
+        :param data: the data to use to update the project
+        :return: the API response from the PUT request
+        """
+        if self.is_project_model(data):
+            data = ProjectModel.to_dict(data)
+        response = self.put(
+            endpoint=f"/project/{project_id}",
+            body=data)
+        return response
+
+    def get_projects_by_ids(self, project_ids):
+        """
+        Method to retrieve projects from comma separated list of ids
+
+        :param project_ids: comma separated list of project ids to be retrieved
+        :return: the API response from the GET request
+        """
+        query_params = {
+            "projectIds": project_ids
+        }
+        response = self.get(
+            endpoint=f"/projectsById",
+            params=query_params
+        )
+        return response
+
+    def get_random_tasks(self, project_id, limit=1, proximity=-1, search=''):
+        """
+        Method to retrieve random tasks from a project.
+
+        :param project_id: the id of the parent project of tasks
+        :param limit: limit amount of results returned
+        :param proximity: task to find based on proximity of that task
+        :param search: a search parameter object stored in a cookie
+        :return: the API response form the GET request
+        """
+        query_params = {
+            "limit": str(limit),
+            "proximity": str(proximity),
+            "search": str(search)
+        }
+        response = self.get(
+            endpoint=f"/project/{project_id}/tasks",
+            params=query_params
+        )
+        return response
+
     @staticmethod
     def is_project_model(input_object):
         """Method to determine whether user input is a valid project model

tests/test_project_api.py

@@ -44,3 +44,61 @@ def test_create_project(self, mock_request, api_instance=api):
         mock_request.return_value.status_code = '200'
         response = api_instance.create_project(test_project_model)
         self.assertEqual(response['status'], '200')
+
+    @patch('maproulette.api.maproulette_server.requests.Session.post')
+    def test_add_challenge_to_project(self, mock_request, api_instance=api):
+        test_virtual_project_model = maproulette.ProjectModel(name='Test Virtual Project Name',
+                                                              id=1234,
+                                                              is_virtual=True)
+        test_challenge_model = maproulette.ChallengeModel(name='Test Challenge Name',
+                                                          id=246)
+        test_virtual_project_id = test_virtual_project_model.id
+        test_challenge_id = test_challenge_model.id
+        mock_request.return_value.status_code = '200'
+        response = api_instance.add_challenge_to_project(test_virtual_project_id, test_challenge_id)
+        self.assertEqual(response['status'], '200')
+
+    @patch('maproulette.api.maproulette_server.requests.Session.post')
+    def test_remove_challenge_from_project(self, mock_request, api_instance=api):
+        test_virtual_project_model = maproulette.ProjectModel(name='Test Virtual Project Name',
+                                                              id=1234,
+                                                              is_virtual=True)
+        test_challenge_model = maproulette.ChallengeModel(name='Test Challenge Name', id=246)
+        test_virtual_project_id = test_virtual_project_model.id
+        test_challenge_id = test_challenge_model.id
+        mock_request.return_value.status_code = '200'
+        response = api_instance.remove_challenge_from_project(test_virtual_project_id, test_challenge_id)
+        self.assertEqual(response['status'], '200')
+
+    @patch('maproulette.api.maproulette_server.requests.Session.delete')
+    def test_delete_project(self, mock_request, api_instance=api):
+        test_project_model = maproulette.ProjectModel(name='Test Project Name', id=1234)
+        test_project_id = test_project_model.id
+        mock_request.return_value.status_code = '200'
+        response = api_instance.delete_project(test_project_id)
+        self.assertEqual(response['status'], '200')
+
+    @patch('maproulette.api.maproulette_server.requests.Session.put')
+    def test_update_project(self, mock_request, api_instance=api):
+        test_project_model = maproulette.ProjectModel(name='Test Project Name', id=1234)
+        test_updated_project_model = maproulette.ProjectModel(name='Test Updated Project Name')
+        test_project_model_id = test_project_model.id
+        mock_request.return_value.status_code = '200'
+        response = api_instance.update_project(test_project_model_id, test_updated_project_model)
+        self.assertEqual(response['status'], '200')
+
+    @patch('maproulette.api.maproulette_server.requests.Session.get')
+    def test_get_project_by_ids(self, mock_request, api_instance=api):
+        test_project_ids = '1234,2468,1356'
+        mock_request.return_value.status_code = '200'
+        response = api_instance.get_projects_by_ids(test_project_ids)
+        self.assertEqual(response['status'], '200')
+
+    @patch('maproulette.api.maproulette_server.requests.Session.get')
+    def test_get_random_tasks(self, mock_request, api_instance=api):
+        test_project_model = maproulette.ProjectModel(name='Test Project Name',
+                                                      id=1234)
+        test_project_id = test_project_model.id
+        mock_request.return_value.status_code = '200'
+        response = api_instance.get_random_tasks(test_project_id)
+        self.assertEqual(response['status'], '200')