feat(time): additional filter args for report download

Author: thekaveman

README.md

@@ -79,13 +79,18 @@ 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]
+usage: compiler-admin time download [-h] [--start YYYY-MM-DD] [--end YYYY-MM-DD] [--output OUTPUT] [--client CLIENT_ID] [--project PROJECT_ID]
+                                    [--task TASK_ID] [--user USER_ID]
 
 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.
+  -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.
+  --client CLIENT_ID    An ID for a Toggl Client to filter for in reports. Can be supplied more than once.
+  --project PROJECT_ID  An ID for a Toggl Project to filter for in reports. Can be supplied more than once.
+  --task TASK_ID        An ID for a Toggl Project Task to filter for in reports. Can be supplied more than once.
+  --user USER_ID        An ID for a Toggl User to filter for in reports. Can be supplied more than once.
 ```
 
 ### Converting an hours report

compiler_admin/commands/time/download.py

@@ -5,6 +5,17 @@
 
 
 def download(args: Namespace, *extras):
-    download_time_entries(args.start, args.end, args.output, TOGGL_COLUMNS)
+    params = dict(start_date=args.start, end_date=args.end, output_path=args.output, output_cols=TOGGL_COLUMNS)
+
+    if args.client_ids:
+        params.update(dict(client_ids=args.client_ids))
+    if args.project_ids:
+        params.update(dict(project_ids=args.project_ids))
+    if args.task_ids:
+        params.update(dict(task_ids=args.task_ids))
+    if args.user_ids:
+        params.update(dict(user_ids=args.user_ids))
+
+    download_time_entries(**params)
 
     return RESULT_SUCCESS

compiler_admin/main.py

@@ -94,6 +94,38 @@ def setup_time_command(cmd_parsers: _SubParsersAction):
     time_download.add_argument(
         "--output", default=sys.stdout, help="The path to the file where converted data should be written. Defaults to stdout."
     )
+    time_download.add_argument(
+        "--client",
+        dest="client_ids",
+        metavar="CLIENT_ID",
+        action="append",
+        type=int,
+        help="An ID for a Toggl Client to filter for in reports. Can be supplied more than once.",
+    )
+    time_download.add_argument(
+        "--project",
+        dest="project_ids",
+        metavar="PROJECT_ID",
+        action="append",
+        type=int,
+        help="An ID for a Toggl Project to filter for in reports. Can be supplied more than once.",
+    )
+    time_download.add_argument(
+        "--task",
+        dest="task_ids",
+        metavar="TASK_ID",
+        action="append",
+        type=int,
+        help="An ID for a Toggl Project Task to filter for in reports. Can be supplied more than once.",
+    )
+    time_download.add_argument(
+        "--user",
+        dest="user_ids",
+        metavar="USER_ID",
+        action="append",
+        type=int,
+        help="An ID for a Toggl User to filter for in reports. Can be supplied more than once.",
+    )
 
 
 def setup_user_command(cmd_parsers: _SubParsersAction):

tests/commands/time/test_download.py

@@ -13,9 +13,42 @@ def mock_download_time_entries(mocker):
 
 def test_download_default(mock_download_time_entries):
     date = datetime.now()
-    args = Namespace(start=date, end=date, output="output")
+    args = Namespace(
+        start=date,
+        end=date,
+        output="output",
+        client_ids=None,
+        project_ids=None,
+        task_ids=None,
+        user_ids=None,
+    )
 
     res = download(args)
 
     assert res == RESULT_SUCCESS
-    mock_download_time_entries.assert_called_once_with(args.start, args.end, args.output, TOGGL_COLUMNS)
+    mock_download_time_entries.assert_called_once_with(
+        start_date=args.start,
+        end_date=args.end,
+        output_path=args.output,
+        output_cols=TOGGL_COLUMNS,
+    )
+
+
+def test_download_ids(mock_download_time_entries):
+    date = datetime.now()
+    ids = [1, 2, 3]
+    args = Namespace(start=date, end=date, output="output", client_ids=ids, project_ids=ids, task_ids=ids, user_ids=ids)
+
+    res = download(args)
+
+    assert res == RESULT_SUCCESS
+    mock_download_time_entries.assert_called_once_with(
+        start_date=args.start,
+        end_date=args.end,
+        output_path=args.output,
+        output_cols=TOGGL_COLUMNS,
+        client_ids=ids,
+        project_ids=ids,
+        task_ids=ids,
+        user_ids=ids,
+    )

tests/test_main.py

@@ -122,17 +122,62 @@ def test_main_time_download_default(mock_commands_time, mock_start, mock_end):
     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
+            func=mock_commands_time,
+            command="time",
+            subcommand="download",
+            start=mock_start,
+            end=mock_end,
+            output=sys.stdout,
+            client_ids=None,
+            project_ids=None,
+            task_ids=None,
+            user_ids=None,
         )
         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"])
+    main(
+        argv=[
+            "time",
+            "download",
+            "--start",
+            "2024-01-01",
+            "--end",
+            "2024-01-31",
+            "--output",
+            "file.csv",
+            "--client",
+            "1",
+            "--client",
+            "2",
+            "--client",
+            "3",
+            "--project",
+            "1",
+            "--project",
+            "2",
+            "--project",
+            "3",
+            "--task",
+            "1",
+            "--task",
+            "2",
+            "--task",
+            "3",
+            "--user",
+            "1",
+            "--user",
+            "2",
+            "--user",
+            "3",
+        ]
+    )
 
     expected_start = TZINFO.localize(datetime(2024, 1, 1))
     expected_end = TZINFO.localize(datetime(2024, 1, 31))
+    ids = [1, 2, 3]
 
     mock_commands_time.assert_called_once()
     call_args = mock_commands_time.call_args.args
@@ -144,6 +189,10 @@ def test_main_time_download_args(mock_commands_time):
             start=expected_start,
             end=expected_end,
             output="file.csv",
+            client_ids=ids,
+            project_ids=ids,
+            task_ids=ids,
+            user_ids=ids,
         )
         in call_args
     )