Merge pull request #4 from katzuv/feature/add-solution-runner

Create solution runner

Author: katzuv

input_getter.py

@@ -0,0 +1,5 @@
+requests
+click
+pyyaml
+beautifulsoup4
+black

requirements.txt

@@ -0,0 +1,22 @@
+import click
+
+import commands
+
+
+CONTEXT = {"help_option_names": ["-h", "--help"]}
+
+
+@click.group(context_settings=CONTEXT)
+def cli() -> click.Group:
+    """
+    Main CLI holding all Advent of Code related commands.
+
+    For more information about Advent of Code, see https://adventofcode.com.
+    """
+
+
+if __name__ == "__main__":
+    cli.add_command(commands.setup)
+    cli.add_command(commands.config)
+    cli.add_command(commands.submit)
+    cli()

solution_runner/cli.py

@@ -0,0 +1,6 @@
+from .config_command import command as config
+from .setup_command import command as setup
+from .submit_command import command as submit
+
+
+__all__ = ["config", "setup", "submit"]

solution_runner/commands/__init__.py

@@ -0,0 +1,66 @@
+import urllib.parse
+from datetime import datetime
+from enum import Enum
+from typing import Any
+
+import click
+import requests
+import yaml
+
+from . import consts
+
+
+class PathType(Enum):
+    FILE = 1
+    DIRECTORY = 2
+
+
+def get_setting(key: str) -> Any:
+    """
+    :param key: key to retrieve its value
+    :return: value of `key` which is stored in the configuration file
+    """
+    configuration_file = consts.APP_DATA_DIRECTORY / consts.CONFIGURATION_FILE_NAME
+    try:
+        configuration = yaml.safe_load(configuration_file.read_text())
+    except FileNotFoundError:
+        click.secho(
+            "configuration file doesn't exist. Run config command first", fg="red"
+        )
+        raise
+
+    return configuration[key]
+
+
+def send_aoc_request(method, endpoint: str, payload=None) -> str:
+    """
+    Send a request to Advent of Code's website and return the textual response.
+    :param method: method of the request
+    :param endpoint: endpoint to append to the base URL
+    :param payload: optional payload to attach to the request
+    :return: text content of the response
+    """
+    if payload is None:
+        payload = {}
+    session_id = get_setting(consts.SESSION_ID)
+    cookies = {consts.SESSION: session_id}
+    url = urllib.parse.urljoin(consts.BASE_URL, endpoint)
+
+    request = requests.request(
+        method, url, headers=consts.USER_AGENT_HEADER, cookies=cookies, data=payload
+    )
+    if not request.ok:
+        click.secho(request.text, fg="red")
+        raise click.Abort()
+    return request.text
+
+
+def get_default_year() -> int:
+    """
+    :return: default year which is the current year if it's December, last year otherwise
+    """
+    today = datetime.today()
+    current_year = today.year
+    if today.month == consts.DECEMBER:
+        return current_year
+    return current_year - 1

solution_runner/commands/commands_utils.py

@@ -0,0 +1,80 @@
+from pathlib import Path
+from typing import Any
+
+import click
+import yaml
+
+from . import consts
+
+
+@click.command(name="config")
+@click.option(
+    "--root",
+    "root_directory",
+    type=consts.ROOT_DIRECTORY_TYPE,
+    prompt=True,
+    prompt_required=False,
+    help="root directory of Advent of Code puzzles project",
+)
+@click.option(
+    "--session-id",
+    prompt=True,
+    prompt_required=False,
+    hide_input=True,
+    help="session ID to access puzzles input",
+)
+def command(root_directory: str, session_id: str):
+    """Set options."""
+    app_data_directory = click.get_app_dir(consts.APP_DATA_DIRECTORY)
+    configuration_file = Path(app_data_directory, consts.CONFIGURATION_FILE_NAME)
+    try:
+        # Use an empty dictionary if no actual configuration is in the configuration file.
+        configuration = yaml.safe_load(configuration_file.read_text()) or {}
+    except FileNotFoundError:
+        Path(app_data_directory).mkdir(exist_ok=True)
+        configuration_file.touch()
+        configuration = {}
+    initial_configuration = configuration.copy()
+
+    root_directory = _configure_root_directory(configuration, root_directory)
+    root_directory = Path(root_directory)
+    root_directory.mkdir(exist_ok=True)
+
+    _configure_session_id(configuration, session_id)
+
+    if configuration != initial_configuration:
+        configuration_file.write_text(yaml.dump(configuration))
+
+
+def _configure_root_directory(
+    configuration: dict[str, Any], root_directory: str | None
+) -> str:
+    """
+    Edit the root directory configuration if needed.
+    :param configuration: current configuration
+    :param root_directory: root directory passed by the user, `None` if wasn't passed
+    :return: root directory after configuration if needed
+    """
+    if root_directory is not None:
+        configuration[consts.ROOT_DIRECTORY] = root_directory
+    elif consts.ROOT_DIRECTORY not in configuration:
+        configuration[consts.ROOT_DIRECTORY] = click.prompt(
+            "Enter path for Advent of Code project root directory",
+            type=consts.ROOT_DIRECTORY_TYPE,
+        )
+    return configuration[consts.ROOT_DIRECTORY]
+
+
+def _configure_session_id(configuration: dict[str, Any], session_id: str | None):
+    """
+    Configure the session ID if needed.
+    :param configuration: current configuration
+    :param session_id: session ID passed by the user, `None` if wasn't passed
+    """
+    if session_id is not None:
+        configuration[consts.SESSION_ID] = session_id
+    elif consts.SESSION_ID not in configuration:
+        configuration[consts.SESSION_ID] = click.prompt(
+            "Enter session ID to download input files (available in AoC website cookies)",
+            hide_input=True,
+        )

solution_runner/commands/config_command.py

@@ -0,0 +1,49 @@
+import string
+from datetime import datetime
+from pathlib import Path
+from zoneinfo import ZoneInfo
+
+import click
+
+
+FIRST_AOC_YEAR = 2015
+DECEMBER = 12
+ADVENT_DAYS_RANGE = click.IntRange(1, 25)
+ZERO = "0"
+BASE_URL = "https://adventofcode.com/"
+INPUT_ENDPOINT_TEMPLATE = string.Template("/$year/day/$day/input")
+SUBMIT_ENDPOINT_TEMPLATE = string.Template("/$year/day/$day/answer")
+SESSION = "session"
+# Requested by Advent of Code owner to help track requests.
+USER_AGENT_HEADER = {"User-Agent": "AoC.CLI.katzuv"}
+
+APP_DATA_DIRECTORY = click.get_app_dir("Advent of Code")
+CONFIGURATION_FILE_NAME = Path("configuration.yaml")
+ROOT_DIRECTORY_TYPE = click.Path(
+    file_okay=False, dir_okay=True, writable=True, readable=True, resolve_path=True
+)
+ROOT_DIRECTORY = "root directory"
+SOLUTION_PARTS = ("p1", "p2")
+SESSION_ID = "session ID"
+SOLUTION_FILE_TEMPLATE_PATH = Path(Path(__file__).parent, "solution_template.py")
+
+
+class Directories:
+    SOLUTIONS = Path("solutions")
+    INPUTS = Path("inputs")
+
+
+class FileExtensions:
+    TEXT = ".txt"
+    PYTHON = ".py"
+
+
+class HttpMethods:
+    GET = "GET"
+    POST = "POST"
+
+
+US_EASTERN_TIMEZONE = ZoneInfo("US/Eastern")
+AOC_UNLOCK_TIME_TEMPLATE = datetime(
+    year=1, month=12, day=1, hour=0, tzinfo=US_EASTERN_TIMEZONE
+)