fix: login into smartschool when a security question has been asked. (#7)

* updated lockfile

* small cleanup via logprise

* WIP

* Fix login procedure

* Fix tests with new birthday introduced.

* Some more tests

* more coverage for credentials

* Mock account verification too

* reformat

* Fixing sonar issue

Author: svaningelgem

credentials.yml.example

@@ -1,5 +1,6 @@
 username: ...
 password: ...
+birthday: YYYY-mm-dd
 main_url: school.smartschool.be
 
 email_from: [email protected]

poetry.lock

@@ -23,6 +23,7 @@ bs4 = "*"
 requests = "*"
 pyyaml = "*"
 pydantic = "*"
+logprise = "*"
 
 [tool.poetry.group.dev.dependencies]
 pytest-mock = "*"
@@ -35,6 +36,20 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 
+[tool.coverage.report]
+exclude_also = [
+    'def __repr__',
+    'if self.debug:',
+    'if settings.DEBUG',
+    'raise AssertionError',
+    'raise NotImplementedError',
+    'if 0:',
+    'if __name__ == .__main__.:',
+    'if TYPE_CHECKING:',
+    'class .*\bProtocol\):',
+    '@(abc\.)?abstractmethod',
+]
+
 [tool.pytest.ini_options]
 testpaths = [
     "tests",
@@ -48,6 +63,7 @@ requests_mock_case_sensitive = true
 [tool.ruff]
 line-length = 160
 fix = true
+unsafe-fixes = true
 
 [tool.ruff.lint]
 select = [
@@ -122,4 +138,4 @@ ban-relative-imports = "all"
 strict = true
 
 [tool.ruff.lint.per-file-ignores]
-"tests/**/*.py" = ["D100", "D103", "B018", "FBT001"]
+"tests/**/*.py" = ["D100", "D103", "B018", "FBT001"]

pyproject.toml

@@ -1,12 +1,10 @@
 #!/usr/bin/env python
 
-from smartschool import PathCredentials, Results, Smartschool, logger, DownloadError
-from smartschool.common import IsSaved, capture_and_email_all_exceptions, save, send_email
+from logprise import logger
+from smartschool import PathCredentials, Results, Smartschool, DownloadError
+from smartschool.common import IsSaved, save, send_email
 from smartschool.objects import Result
-
-session = Smartschool.start(PathCredentials())
-assert 'email_from' in session.creds.other_info
-assert 'email_to' in session.creds.other_info
+from smartschool.session import session
 
 
 def is_punten_json_the_same(previous: Result, current: Result) -> bool:
@@ -125,7 +123,7 @@ def build_text(
 
 
 def process_result(result: Result) -> None:
-    logger.info("Processing %s", result.name)
+    logger.info("Processing {}", result.name)
 
     assert len(result.courses) == 1, f"Multiple courses? {result.courses}"
 
@@ -141,9 +139,12 @@ def process_result(result: Result) -> None:
     send_email(subject=subject, text=text, email_from=session.creds.other_info['email_from'], email_to=session.creds.other_info['email_to'])
 
 
-@capture_and_email_all_exceptions(email_from=session.creds.other_info['email_from'], email_to=session.creds.other_info['email_to'])
 def main():
     try:
+        Smartschool.start(PathCredentials())
+        assert 'email_from' in session.creds.other_info
+        assert 'email_to' in session.creds.other_info
+
         for result in Results():
             process_result(result)
     except DownloadError:

scripts/smartschool_report_on_results

@@ -1,10 +1,7 @@
-import logging
-
 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,
     Attachments,
@@ -25,34 +22,31 @@
 from .student_support import StudentSupportLinks
 
 __all__ = [
-    "PathCredentials",
-    "EnvCredentials",
-    "Smartschool",
-    "logger",
+    "AdjustMessageLabel",
+    "Attachments",
+    "BoxType",
     "Courses",
-    "TopNavCourses",
-    "Results",
-    "Periods",
+    "DownloadError",
+    "EnvCredentials",
     "FutureTasks",
-    "SortField",
-    "SortOrder",
-    "BoxType",
-    "MessageHeaders",
-    "StudentSupportLinks",
-    "SmartschoolHours",
-    "SmartschoolLessons",
-    "SmartschoolMomentInfos",
-    "Message",
-    "Attachments",
     "MarkMessageUnread",
-    "AdjustMessageLabel",
+    "Message",
+    "MessageHeaders",
+    "MessageLabel",
     "MessageMoveToArchive",
     "MessageMoveToTrash",
-    "MessageLabel",
+    "PathCredentials",
+    "Periods",
     "ResultDetail",
+    "Results",
     # Exceptions
     "SmartSchoolException",
-    "DownloadError",
+    "Smartschool",
+    "SmartschoolHours",
+    "SmartschoolLessons",
+    "SmartschoolMomentInfos",
+    "SortField",
+    "SortOrder",
+    "StudentSupportLinks",
+    "TopNavCourses",
 ]
-
-logger = setup_logger(logging.DEBUG)

src/smartschool/__init__.py

@@ -3,14 +3,15 @@
 import contextlib
 from abc import ABC, ABCMeta, abstractmethod
 from datetime import date
-from typing import TYPE_CHECKING, Iterator, TypeVar
+from typing import TYPE_CHECKING, TypeVar
 from xml.etree import ElementTree as ET
 from xml.sax.saxutils import quoteattr
 
 from .common import xml_to_dict
 from .session import session
 
 if TYPE_CHECKING:  # pragma: no cover
+    from collections.abc import Iterator
     from datetime import datetime
 
 _T = TypeVar("_T")

src/smartschool/_xml_interface.py

@@ -1,37 +1,35 @@
 from __future__ import annotations
 
 import contextlib
-import functools
-import inspect
 import json
 import operator
 import platform
 import re
 import smtplib
-import sys
-import traceback
 import warnings
 import xml.etree.ElementTree as ET
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 from enum import Enum, auto
 from pathlib import Path
-from typing import Any, Callable, Literal
+from typing import TYPE_CHECKING, Any, Callable, Literal
 
 from bs4 import BeautifulSoup, FeatureNotFound, GuessedAtParserWarning
 from pydantic import RootModel
 from pydantic.dataclasses import is_pydantic_dataclass
 from requests import Response
 
+if TYPE_CHECKING:
+    import bs4
+
 __all__ = [
-    "send_email",
-    "capture_and_email_all_exceptions",
-    "save",
     "IsSaved",
+    "as_float",
     "bs4_html",
     "get_all_values_from_form",
     "make_filesystem_safe",
-    "as_float",
+    "save",
+    "send_email",
     "xml_to_dict",
 ]
 
@@ -109,39 +107,6 @@ def send_email(
         )
 
 
-def capture_and_email_all_exceptions(
-    email_from: str | list[str], email_to: str | list[str], subject: str = "[⚠Smartschool parser⚠] Something went wrong"
-) -> Callable:
-    def decorator(func):
-        @functools.wraps(func)
-        def inner(*args, **kwargs):
-            frm = inspect.stack()[1]
-            module_name = Path(frm.filename)
-            function_signature = f"{module_name.stem}.{func.__name__}"
-
-            print(f"[{function_signature}] Start")
-            try:
-                result = func(*args, **kwargs)
-            except Exception as ex:
-                print(f"[{function_signature}] An exception happened: {ex}")
-
-                send_email(
-                    email_to=email_to,
-                    email_from=email_from,
-                    subject=subject,
-                    text="".join(traceback.format_exception(None, ex, ex.__traceback__)),
-                )
-
-                sys.exit(1)
-
-            print(f"[{function_signature}] Finished")
-            return result
-
-        return inner
-
-    return decorator
-
-
 def bs4_html(html: str | bytes | Response) -> BeautifulSoup:
     global _used_bs4_option
 
@@ -170,7 +135,7 @@ def bs4_html(html: str | bytes | Response) -> BeautifulSoup:
         return BeautifulSoup(html)
 
 
-def get_all_values_from_form(html, form_selector):
+def get_all_values_from_form(html: bs4.BeautifulSoup, form_selector: str):
     form = html.select(form_selector)
     assert len(form) == 1, f"We should have only 1 form. We got {len(form)}!"
     form = form[0]
@@ -211,6 +176,26 @@ def get_all_values_from_form(html, form_selector):
     return inputs
 
 
+def fill_form(response: Response, form_selector, values: dict[str, str]) -> dict[str, str]:
+    html = bs4_html(response)
+    inputs = get_all_values_from_form(html, form_selector)
+
+    data = {}
+    values = values.copy()
+
+    for input_ in inputs:
+        name = input_["name"]
+        for key, _value in values.items():
+            if key in name:
+                data[name] = values.pop(key)
+                break
+        else:
+            data[name] = input_["value"]
+
+    assert len(values) == 0, f"You didn't use: {sorted(values)}"
+    return data
+
+
 def make_filesystem_safe(name: str) -> str:
     name = re.sub("[^-_a-z0-9.]+", "_", name, flags=re.IGNORECASE)
     name = re.sub("_{2,}", "_", name)

src/smartschool/common.py

@@ -1,11 +1,14 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import Iterator
+from typing import TYPE_CHECKING
 
 from .objects import Course, CourseCondensed
 from .session import session
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
 __all__ = ["Courses", "TopNavCourses"]
 
 

src/smartschool/courses.py

@@ -11,26 +11,42 @@
 class Credentials(ABC):
     username: str
     password: str
+    birthday: str
     main_url: str
 
     other_info: dict | None = None
 
     def validate(self) -> None:
-        self.username = (self.username or "").strip()
-        self.password = (self.password or "").strip()
-        self.main_url = (self.main_url or "").strip()
+        required_fields = [
+            "username",
+            "password",
+            "birthday",
+            "main_url",
+        ]
 
         error = []
-        if not self.username:
-            error.append("username")
-        if not self.password:
-            error.append("password")
-        if not self.main_url:
-            error.append("main_url")
+        for required in required_fields:
+            value = (getattr(self, required) or "").strip()
+            setattr(self, required, value)
+            if not value:
+                error.append(required)
 
         if error:
             raise RuntimeError(f"Please verify and correct these attributes: {error}")
 
+    def as_dict(self) -> dict[str, str | dict]:
+        data: dict = {
+            "username": self.username,
+            "password": self.password,
+            "birthday": self.birthday,
+            "main_url": self.main_url,
+        }
+
+        if self.other_info:
+            data["other_info"] = self.other_info
+
+        return data
+
 
 @dataclass
 class PathCredentials(Credentials):
@@ -43,6 +59,7 @@ def __post_init__(self):
         self.username = cred_file.pop("username", None)
         self.password = cred_file.pop("password", None)
         self.main_url = cred_file.pop("main_url", None)
+        self.birthday = cred_file.pop("birthday", None)
 
         self.other_info = cred_file
 
@@ -53,3 +70,4 @@ def __post_init__(self):
         self.username = os.getenv("SMARTSCHOOL_USERNAME")
         self.password = os.getenv("SMARTSCHOOL_PASSWORD")
         self.main_url = os.getenv("SMARTSCHOOL_MAIN_URL")
+        self.birthday = os.getenv("SMARTSCHOOL_BIRTHDAY")