"Fix" download errors to show a nicer exception. (#4)

Author: svaningelgem

poetry.lock

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-from smartschool import PathCredentials, Results, Smartschool, logger
+from smartschool import PathCredentials, Results, Smartschool, logger, DownloadError
 from smartschool.common import IsSaved, capture_and_email_all_exceptions, save, send_email
 from smartschool.objects import Result
 
@@ -143,8 +143,11 @@ def process_result(result: Result) -> None:
 
 @capture_and_email_all_exceptions(email_from=session.creds.other_info['email_from'], email_to=session.creds.other_info['email_to'])
 def main():
-    for result in Results():
-        process_result(result)
+    try:
+        for result in Results():
+            process_result(result)
+    except DownloadError:
+        ...
 
 
 if __name__ == '__main__':

scripts/smartschool_report_on_results

@@ -3,6 +3,7 @@
 from .agenda import SmartschoolHours, SmartschoolLessons, SmartschoolMomentInfos
 from .courses import Courses, TopNavCourses
 from .credentials import EnvCredentials, PathCredentials
+from .exceptions import DownloadError, SmartSchoolException
 from .logger import setup_logger
 from .messages import (
     AdjustMessageLabel,
@@ -49,6 +50,9 @@
     "MessageMoveToTrash",
     "MessageLabel",
     "ResultDetail",
+    # Exceptions
+    "SmartSchoolException",
+    "DownloadError",
 ]
 
 logger = setup_logger(logging.DEBUG)

src/smartschool/__init__.py

@@ -0,0 +1,4 @@
+class SmartSchoolException(Exception): ...
+
+
+class DownloadError(SmartSchoolException): ...

src/smartschool/exceptions.py

@@ -1,6 +1,7 @@
 from itertools import count
 from typing import Iterator
 
+from .exceptions import DownloadError
 from .objects import Result, ResultWithDetails
 from .session import session
 
@@ -26,7 +27,11 @@ class Results:
 
     def __iter__(self) -> Iterator[Result]:
         for page_nr in count(start=1):  # pragma: no branch
-            json = session.json(f"/results/api/v1/evaluations/?pageNumber={page_nr}&itemsOnPage={RESULTS_PER_PAGE}")
+            downloaded_webpage = session.get(f"/results/api/v1/evaluations/?pageNumber={page_nr}&itemsOnPage={RESULTS_PER_PAGE}")
+            if not downloaded_webpage or not downloaded_webpage.content:
+                raise DownloadError("No JSON was returned for the results?!")
+
+            json = downloaded_webpage.json()
             for result in json:
                 yield Result(**result)
 
@@ -39,5 +44,9 @@ def __init__(self, result_id: str):
         self.result_id = result_id
 
     def get(self) -> ResultWithDetails:
-        json = session.json(f"/results/api/v1/evaluations/{self.result_id}")
+        downloaded_webpage = session.get(f"/results/api/v1/evaluations/{self.result_id}")
+        if not downloaded_webpage or not downloaded_webpage.content:
+            raise DownloadError("No JSON was returned for the details?!")
+
+        json = downloaded_webpage.json()
         return ResultWithDetails(**json)

src/smartschool/results.py

@@ -1,4 +1,6 @@
-from smartschool import ResultDetail, Results
+import pytest
+from requests_mock import ANY
+from smartschool import DownloadError, ResultDetail, Results
 
 
 def test_results_normal_flow(mocker):
@@ -19,3 +21,29 @@ def test_result_detail_normal_flow():
     assert sut.name == "Repetitie hoofdstuk 1"
     assert sut.graphic.achieved_points == 13.5
     assert sut.details.teachers[0].name.startingWithFirstName == "Gert Segers"
+
+
+def test_result_detail_with_empty_return_value():
+    with pytest.raises(DownloadError):
+        ResultDetail(result_id="empty_return_value").get()
+
+
+def test_result_detail_with_faulty_session_get(requests_mock):
+    requests_mock.register_uri(ANY, ANY, status_code=404)
+
+    with pytest.raises(DownloadError):
+        ResultDetail(result_id="abc_normal_123").get()
+
+
+def test_result_with_empty_return_value(requests_mock):
+    requests_mock.register_uri(ANY, ANY, text="")
+
+    with pytest.raises(DownloadError):
+        next(iter(Results()))
+
+
+def test_result_with_faulty_session_get(requests_mock):
+    requests_mock.register_uri(ANY, ANY, status_code=404)
+
+    with pytest.raises(DownloadError):
+        next(iter(Results()))