feat(time): wire up download command

compiler-admin time download --start YYYY-MM-DD --end YYYY-MM-DD --output path/to/file.csv

small fix on convert test assertion

Author: thekaveman

README.md

@@ -62,14 +62,30 @@ The `time` command provides an interface for working with time entries from Comp
 
 ```bash
 $ compiler-admin time -h
-usage: compiler-admin time [-h] {convert} ...
+usage: compiler-admin time [-h] {convert,download} ...
 
 positional arguments:
-  {convert}   The time command to run.
-    convert   Convert a time report from one format into another.
+  {convert,download}  The time command to run.
+    convert           Convert a time report from one format into another.
+    download          Download a Toggl report in CSV format.
 
 options:
-  -h, --help  show this help message and exit
+  -h, --help          show this help message and exit
+```
+
+### Downloading a Toggl report
+
+Use this command to download a time report from Toggl in CSV format:
+
+```bash
+$ compiler-admin time download -h
+usage: compiler-admin time download [-h] [--start YYYY-MM-DD] [--end YYYY-MM-DD] [--output OUTPUT]
+
+options:
+  -h, --help          show this help message and exit
+  --start YYYY-MM-DD  The start date of the reporting period. Defaults to the beginning of the prior month.
+  --end YYYY-MM-DD    The end date of the reporting period. Defaults to the end of the prior month.
+  --output OUTPUT     The path to the file where converted data should be written. Defaults to stdout.
 ```
 
 ### Converting an hours report

compiler_admin/commands/time/__init__.py

@@ -1,6 +1,7 @@
 from argparse import Namespace
 
 from compiler_admin.commands.time.convert import convert  # noqa: F401
+from compiler_admin.commands.time.download import download  # noqa: F401
 
 
 def time(args: Namespace, *extra):

compiler_admin/commands/time/download.py

@@ -0,0 +1,10 @@
+from argparse import Namespace
+
+from compiler_admin import RESULT_SUCCESS
+from compiler_admin.services.toggl import INPUT_COLUMNS as TOGGL_COLUMNS, download_time_entries
+
+
+def download(args: Namespace, *extras):
+    download_time_entries(args.start, args.end, args.output, TOGGL_COLUMNS)
+
+    return RESULT_SUCCESS

compiler_admin/main.py

@@ -76,6 +76,25 @@ def setup_time_command(cmd_parsers: _SubParsersAction):
     )
     time_convert.add_argument("--client", default=None, help="The name of the client to use in converted data.")
 
+    time_download = add_sub_cmd(time_subcmds, "download", help="Download a Toggl report in CSV format.")
+    time_download.add_argument(
+        "--start",
+        metavar="YYYY-MM-DD",
+        default=prior_month_start(),
+        type=lambda s: TZINFO.localize(datetime.strptime(s, "%Y-%m-%d")),
+        help="The start date of the reporting period. Defaults to the beginning of the prior month.",
+    )
+    time_download.add_argument(
+        "--end",
+        metavar="YYYY-MM-DD",
+        default=prior_month_end(),
+        type=lambda s: TZINFO.localize(datetime.strptime(s, "%Y-%m-%d")),
+        help="The end date of the reporting period. Defaults to the end of the prior month.",
+    )
+    time_download.add_argument(
+        "--output", default=sys.stdout, help="The path to the file where converted data should be written. Defaults to stdout."
+    )
+
 
 def setup_user_command(cmd_parsers: _SubParsersAction):
     user_cmd = add_sub_cmd(cmd_parsers, "user", help="Work with users in the Compiler org.")

tests/commands/time/test_download.py

@@ -0,0 +1,21 @@
+from argparse import Namespace
+from datetime import datetime
+import pytest
+
+from compiler_admin import RESULT_SUCCESS
+from compiler_admin.commands.time.download import __name__ as MODULE, download, TOGGL_COLUMNS
+
+
+@pytest.fixture
+def mock_download_time_entries(mocker):
+    return mocker.patch(f"{MODULE}.download_time_entries")
+
+
+def test_download_default(mock_download_time_entries):
+    date = datetime.now()
+    args = Namespace(start=date, end=date, output="output")
+
+    res = download(args)
+
+    assert res == RESULT_SUCCESS
+    mock_download_time_entries.assert_called_once_with(args.start, args.end, args.output, TOGGL_COLUMNS)

tests/commands/user/test_convert.py

@@ -172,7 +172,7 @@ def test_convert_partner(mock_google_add_user_to_group, mock_google_move_user_ou
     res = convert(args)
 
     assert res == RESULT_SUCCESS
-    mock_google_add_user_to_group.call_count == 2
+    assert mock_google_add_user_to_group.call_count == 2
     mock_google_move_user_ou.assert_called_once()
 
 

tests/test_main.py

@@ -114,6 +114,41 @@ def test_main_time_convert_default(mock_commands_time):
     )
 
 
+@pytest.mark.usefixtures("mock_local_now")
+def test_main_time_download_default(mock_commands_time, mock_start, mock_end):
+    main(argv=["time", "download"])
+
+    mock_commands_time.assert_called_once()
+    call_args = mock_commands_time.call_args.args
+    assert (
+        Namespace(
+            func=mock_commands_time, command="time", subcommand="download", start=mock_start, end=mock_end, output=sys.stdout
+        )
+        in call_args
+    )
+
+
+def test_main_time_download_args(mock_commands_time):
+    main(argv=["time", "download", "--start", "2024-01-01", "--end", "2024-01-31", "--output", "file.csv"])
+
+    expected_start = TZINFO.localize(datetime(2024, 1, 1))
+    expected_end = TZINFO.localize(datetime(2024, 1, 31))
+
+    mock_commands_time.assert_called_once()
+    call_args = mock_commands_time.call_args.args
+    assert (
+        Namespace(
+            func=mock_commands_time,
+            command="time",
+            subcommand="download",
+            start=expected_start,
+            end=expected_end,
+            output="file.csv",
+        )
+        in call_args
+    )
+
+
 def test_main_time_convert_client(mock_commands_time):
     main(argv=["time", "convert", "--client", "client123"])