Migrates students from helper_scripts to core.

Author: filiplajszczak

docs/api/index.rst

@@ -9,4 +9,5 @@ Programming Interface
    base
    files
    schedule
+   students
    webapp

docs/api/students.rst

@@ -0,0 +1,5 @@
+Students
+========
+
+.. automodule:: students
+   :members:

pythonanywhere_core/students.py

@@ -0,0 +1,49 @@
+import getpass
+from typing import Optional
+
+from pythonanywhere_core.base import call_api, get_api_endpoint
+
+
+class StudentsAPI:
+    """Interface for PythonAnywhere students API.
+
+    Uses `pythonanywhere.api.base` :method: `get_api_endpoint` to
+    create url, which is stored in a class variable `StudentsAPI.base_url`,
+    then calls `call_api` with appropriate arguments to execute student
+    action.
+
+    Covers:
+    - GET
+    - DELETE
+
+    Methods:
+    - use :method: `StudentsAPI.get` to get list of students
+    - use :method: `StudentsAPI.delete` to remove a student
+    """
+
+    base_url: str = get_api_endpoint().format(username=getpass.getuser(), flavor="students")
+
+    def get(self) -> Optional[dict]:
+        """Returns list of PythonAnywhere students related with user's account."""
+
+        result = call_api(self.base_url, "GET")
+
+        if result.status_code == 200:
+            return result.json()
+
+        raise Exception(f"GET to list students failed, got {result.text}")
+
+    def delete(self, student_username: str) -> Optional[int]:
+        """Returns 204 if student has been successfully removed, raises otherwise."""
+
+        url = f"{self.base_url}{student_username}"
+
+        result = call_api(url, "DELETE")
+
+        if result.status_code == 204:
+            return result.status_code
+
+        detail = f": {result.text}" if result.text else ""
+        raise Exception(
+            f"DELETE to remove student {student_username!r} failed, got {result}{detail}"
+        )

tests/test_students.py

@@ -0,0 +1,65 @@
+import getpass
+import json
+
+import pytest
+import responses
+
+from pythonanywhere_core.base import get_api_endpoint
+from pythonanywhere_core.students import StudentsAPI
+
+
+@pytest.fixture
+def students_base_url():
+    return get_api_endpoint().format(username=getpass.getuser(), flavor="students")
+
+
+@pytest.mark.students
+class TestStudentsAPIGet:
+    def test_gets_list_of_students_when_there_are_some(
+        self, api_token, api_responses, students_base_url
+    ):
+        students = {
+            "students": [{"username": "student1"}, {"username": "student2"}]
+        }
+        api_responses.add(
+            responses.GET, url=students_base_url, status=200, body=json.dumps(students)
+        )
+
+        assert StudentsAPI().get() == students
+
+    def test_gets_empty_list_of_students_when_there_none(
+        self, api_token, api_responses, students_base_url
+    ):
+        students = {"students": []}
+        api_responses.add(
+            responses.GET, url=students_base_url, status=200, body=json.dumps(students)
+        )
+
+        assert StudentsAPI().get() == students
+
+
+@pytest.mark.students
+class TestStudentsAPIDelete:
+    def test_returns_204_when_student_deleted(
+        self, api_token, api_responses, students_base_url
+    ):
+        username = "byebye"
+        url = f"{students_base_url}{username}"
+        api_responses.add(responses.DELETE, url=url, status=204)
+
+        assert StudentsAPI().delete("byebye") == 204
+
+    def test_raises_with_404_when_no_student_to_delete_found(
+        self, api_token, api_responses, students_base_url
+    ):
+        username = "notyourstudent"
+        url = f"{students_base_url}{username}"
+        api_responses.add(responses.DELETE, url=url, status=404)
+
+        with pytest.raises(Exception) as e:
+            StudentsAPI().delete("notyourstudent")
+
+        expected_error_msg = (
+            f"DELETE to remove student {username!r} failed, got <Response [404]>"
+        )
+        assert str(e.value) == expected_error_msg