Merge pull request #32 from mishaschwartz/0.2.1

v0.2.1

Author: mishaschwartz

Changelog.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [v0.2.1]
+- Added new methods for managing starter files (#29)
+
 ## [v0.2.0]
 - Added new methods for adding and removing extra marks (#15)
 - Rewrite everything to use the requests library (#26)

markusapi/markusapi.py

@@ -475,3 +475,143 @@ def get_test_files(self, assignment_id: int) -> requests.Response:
         the assignment with id <assignment_id>.
         """
         return requests.get(self._url(f"assignments/{assignment_id}/test_files"), headers=self._auth_header)
+
+    @parse_response("json")
+    def get_starter_file_entries(self, assignment_id: int, starter_file_group_id: int) -> requests.Response:
+        """
+        Return the name of all entries for a given starter file group. Entries are file or directory names.
+        """
+        return requests.get(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}/entries"),
+            headers=self._auth_header,
+        )
+
+    @parse_response("json")
+    def create_starter_file(
+        self, assignment_id: int, starter_file_group_id: int, file_path: str, contents: Union[str, bytes]
+    ) -> requests.Response:
+        """
+        Upload a starter file to the starter file group with id=<starter_file_group_id> for assignment with
+        id=<assignment_id>. The file_path should be a relative path from the starter file group's root directory.
+        """
+        files = {"file_content": (file_path, contents)}
+        params = {"filename": file_path}
+        return requests.post(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}/create_file"),
+            params=params,
+            files=files,
+            headers=self._auth_header,
+        )
+
+    @parse_response("json")
+    def create_starter_folder(
+        self, assignment_id: int, starter_file_group_id: int, folder_path: str
+    ) -> requests.Response:
+        """
+        Create a folder for the the starter file group with id=<starter_file_group_id> for assignment with
+        id=<assignment_id>. The file_path should be a relative path from the starter file group's root directory.
+        """
+        params = {"folder_path": folder_path}
+        return requests.post(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}/create_folder"),
+            params=params,
+            headers=self._auth_header,
+        )
+
+    @parse_response("json")
+    def remove_starter_file(self, assignment_id: int, starter_file_group_id: int, file_path: str) -> requests.Response:
+        """
+        Remove a starter file from the starter file group with id=<starter_file_group_id> for assignment with
+        id=<assignment_id>. The file_path should be a relative path from the starter file group's root directory.
+        """
+        params = {"filename": file_path}
+        return requests.delete(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}/remove_file"),
+            params=params,
+            headers=self._auth_header,
+        )
+
+    @parse_response("json")
+    def remove_starter_folder(
+        self, assignment_id: int, starter_file_group_id: int, folder_path: str
+    ) -> requests.Response:
+        """
+        Remove a folder from the starter file group with id=<starter_file_group_id> for assignment with
+        id=<assignment_id>. The file_path should be a relative path from the starter file group's root directory.
+        """
+        params = {"folder_path": folder_path}
+        return requests.delete(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}/remove_folder"),
+            params=params,
+            headers=self._auth_header,
+        )
+
+    @parse_response("content")
+    def download_starter_file_entries(self, assignment_id: int, starter_file_group_id: int) -> requests.Response:
+        """
+        Return the content of a zipfile containing the content of all starter files from the starter file group with
+        id=<starter_file_group_id>.
+        """
+        return requests.get(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}/download_entries"),
+            headers=self._auth_header,
+        )
+
+    @parse_response("json")
+    def get_starter_file_groups(self, assignment_id: int) -> requests.Response:
+        """
+        Return all starter file groups for the assignment with id=<assignment_id>
+        """
+        return requests.get(self._url(f"assignments/{assignment_id}/starter_file_groups"), headers=self._auth_header)
+
+    @parse_response("json")
+    def create_starter_file_group(self, assignment_id: int) -> requests.Response:
+        """
+        Create a starter file groups for the assignment with id=<assignment_id>
+        """
+        return requests.post(self._url(f"assignments/{assignment_id}/starter_file_groups"), headers=self._auth_header)
+
+    @parse_response("json")
+    def get_starter_file_group(self, assignment_id: int, starter_file_group_id: int) -> requests.Response:
+        """
+        Return the starter file group with id=<starter_file_group_id> for the assignment with id=<assignment_id>
+        """
+        return requests.get(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}"),
+            headers=self._auth_header,
+        )
+
+    @parse_response("json")
+    def update_starter_file_group(
+        self,
+        assignment_id: int,
+        starter_file_group_id: int,
+        name: Optional[str] = None,
+        entry_rename: Optional[str] = None,
+        use_rename: Optional[bool] = None,
+    ) -> requests.Response:
+        """
+        Update the starter file group with id=<starter_file_group_id> for the assignment with id=<assignment_id>
+        """
+        params = {}
+        if name is not None:
+            params["name"] = name
+        if entry_rename is not None:
+            params["entry_rename"] = entry_rename
+        if use_rename is not None:
+            params["use_rename"] = use_rename
+        return requests.put(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}"),
+            params=params,
+            headers=self._auth_header,
+        )
+
+    @parse_response("json")
+    def delete_starter_file_group(self, assignment_id: int, starter_file_group_id: int) -> requests.Response:
+        """
+        Delete the starter file group with id=<starter_file_group_id> for the assignment with id=<assignment_id>
+        """
+        return requests.delete(
+            self._url(f"assignments/{assignment_id}/starter_file_groups/{starter_file_group_id}"),
+            headers=self._auth_header,
+        )

markusapi/tests/test_markusapi.py

@@ -679,3 +679,160 @@ class TestGetTestFiles(AbstractTestClass):
     @pytest.fixture
     def basic_call(api):
         yield api.get_test_files(1)
+
+
+class TestGetStarterFileEntries(AbstractTestClass):
+    request_verb = "get"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups/1/entries"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.get_starter_file_entries(1, 1)
+
+
+class TestCreateStarterFile(AbstractTestClass):
+    request_verb = "post"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups/1/create_file"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.create_starter_file(1, 1, "test.txt", "content")
+
+    def test_called_with_filename_and_content(self, api, response_mock):
+        api.create_starter_file(1, 1, file_path="test.txt", contents="content")
+        _, kwargs = response_mock.call_args
+        assert kwargs["params"] == {"filename": "test.txt"}
+        assert kwargs["files"] == {"file_content": ("test.txt", "content")}
+
+
+class TestCreateStarterFolder(AbstractTestClass):
+    request_verb = "post"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups/1/create_folder"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.create_starter_folder(1, 1, "subdir")
+
+    def test_called_with_filename_and_content(self, api, response_mock):
+        api.create_starter_folder(1, 1, folder_path="subdir")
+        _, kwargs = response_mock.call_args
+        assert kwargs["params"] == {"folder_path": "subdir"}
+
+
+class TestRemoveStarterFile(AbstractTestClass):
+    request_verb = "delete"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups/1/remove_file"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.remove_starter_file(1, 1, "test.txt")
+
+    def test_called_with_filename(self, api, response_mock):
+        api.remove_starter_file(1, 1, file_path="test.txt")
+        _, kwargs = response_mock.call_args
+        assert kwargs["params"] == {"filename": "test.txt"}
+
+
+class TestRemoveStarterFolder(AbstractTestClass):
+    request_verb = "delete"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups/1/remove_folder"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.remove_starter_folder(1, 1, "subdir")
+
+    def test_called_with_filename_and_content(self, api, response_mock):
+        api.remove_starter_folder(1, 1, folder_path="subdir")
+        _, kwargs = response_mock.call_args
+        assert kwargs["params"] == {"folder_path": "subdir"}
+
+
+class TestDownloadStarterFileEntries(AbstractTestClass):
+    request_verb = "get"
+    response_format = "content"
+    url = "assignments/1/starter_file_groups/1/download_entries"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.download_starter_file_entries(1, 1)
+
+
+class TestDownloadStarterFileGroups(AbstractTestClass):
+    request_verb = "get"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.get_starter_file_groups(1)
+
+
+class TestCreateStarterFileGroup(AbstractTestClass):
+    request_verb = "post"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.create_starter_file_group(1)
+
+
+class TestGetStarterFileGroup(AbstractTestClass):
+    request_verb = "get"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups/1"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.get_starter_file_group(1, 1)
+
+
+class TestUpdateStarterFileGroup(AbstractTestClass):
+    request_verb = "put"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups/1"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.update_starter_file_group(1, 1)
+
+    def test_called_with_name(self, api, response_mock):
+        api.update_starter_file_group(1, 1, name="some_name")
+        _, kwargs = response_mock.call_args
+        assert kwargs["params"] == {"name": "some_name"}
+
+    def test_called_with_entry_name(self, api, response_mock):
+        api.update_starter_file_group(1, 1, entry_rename="some_entry_name")
+        _, kwargs = response_mock.call_args
+        assert kwargs["params"] == {"entry_rename": "some_entry_name"}
+
+    def test_called_with_use_rename(self, api, response_mock):
+        api.update_starter_file_group(1, 1, use_rename=True)
+        _, kwargs = response_mock.call_args
+        assert kwargs["params"] == {"use_rename": True}
+
+
+class TestDeleteStarterFileGroup(AbstractTestClass):
+    request_verb = "delete"
+    response_format = "json"
+    url = "assignments/1/starter_file_groups/1"
+
+    @staticmethod
+    @pytest.fixture
+    def basic_call(api):
+        yield api.delete_starter_file_group(1, 1)

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="markusapi",
-    version="0.2.0",
+    version="0.2.1",
     author="Alessio Di Sandro, Misha Schwartz",
     author_email="[email protected]",
     description="Interface to interact with MarkUs API",