feat(time): flag allows downloading all time entries

not just billable time entries

Author: thekaveman

compiler_admin/api/toggl.py

@@ -60,7 +60,6 @@ def detailed_time_entries(self, start_date: datetime, end_date: datetime, **kwar
         Extra `kwargs` are passed through as a POST json body.
 
         By default, requests a report with the following configuration:
-            * `billable=True`
             * `rounding=1` (True, but this is an int param)
             * `rounding_minutes=15`
 
@@ -82,7 +81,6 @@ def detailed_time_entries(self, start_date: datetime, end_date: datetime, **kwar
         self.timeout = max(current_timeout, dynamic_timeout)
 
         params = dict(
-            billable=True,
             start_date=start,
             end_date=end,
             rounding=1,

compiler_admin/commands/time/download.py

@@ -5,7 +5,9 @@
 
 
 def download(args: Namespace, *extras):
-    params = dict(start_date=args.start, end_date=args.end, output_path=args.output, output_cols=TOGGL_COLUMNS)
+    params = dict(
+        start_date=args.start, end_date=args.end, output_path=args.output, output_cols=TOGGL_COLUMNS, billable=args.billable
+    )
 
     if args.client_ids:
         params.update(dict(client_ids=args.client_ids))

compiler_admin/main.py

@@ -115,6 +115,13 @@ def setup_time_command(cmd_parsers: _SubParsersAction):
         default=os.environ.get("TOGGL_DATA", sys.stdout),
         help="The path to the file where downloaded data should be written. Defaults to $TOGGL_DATA or stdout.",
     )
+    time_download.add_argument(
+        "--all",
+        default=True,
+        action="store_false",
+        dest="billable",
+        help="Download all time entries. The default is to download only billable time entries.",
+    )
     time_download.add_argument(
         "--client",
         dest="client_ids",

tests/api/test_toggl.py

@@ -72,7 +72,6 @@ def test_toggl_detailed_time_entries(toggl_mock_post_reports):
 
     toggl_mock_post_reports.post_reports.assert_called_once_with(
         "search/time_entries.csv",
-        billable=True,
         start_date="2024-09-25",
         end_date="2024-09-25",
         rounding=1,

tests/commands/time/test_download.py

@@ -11,16 +11,18 @@ def mock_download_time_entries(mocker):
     return mocker.patch(f"{MODULE}.download_time_entries")
 
 
-def test_download_default(mock_download_time_entries):
+@pytest.mark.parametrize("billable", [True, False])
+def test_download(mock_download_time_entries, billable):
     date = datetime.now()
     args = Namespace(
         start=date,
         end=date,
         output="output",
-        client_ids=None,
-        project_ids=None,
-        task_ids=None,
-        user_ids=None,
+        billable=billable,
+        client_ids=["c1", "c2"],
+        project_ids=["p1", "p2"],
+        task_ids=["t1", "t2"],
+        user_ids=["u1", "u2"],
     )
 
     res = download(args)
@@ -31,24 +33,9 @@ def test_download_default(mock_download_time_entries):
         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,
+        billable=args.billable,
+        client_ids=args.client_ids,
+        project_ids=args.project_ids,
+        task_ids=args.task_ids,
+        user_ids=args.user_ids,
     )

tests/test_main.py

@@ -164,6 +164,7 @@ def test_main_time_download_default(mock_commands_time, mock_start, mock_end):
             start=mock_start,
             end=mock_end,
             output=sys.stdout,
+            billable=True,
             client_ids=None,
             project_ids=None,
             task_ids=None,
@@ -184,6 +185,7 @@ def test_main_time_download_args(mock_commands_time):
             "2024-01-31",
             "--output",
             "file.csv",
+            "--all",
             "--client",
             "1",
             "--client",
@@ -225,6 +227,7 @@ def test_main_time_download_args(mock_commands_time):
             start=expected_start,
             end=expected_end,
             output="file.csv",
+            billable=False,
             client_ids=ids,
             project_ids=ids,
             task_ids=ids,