feat(ux): ✨ implement reports command (#2)

src/Main.cs

@@ -1,5 +1,6 @@
 using System.Windows.Controls;
 using System.Collections.Generic;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Flow.Launcher.Plugin.TogglTrack.ViewModels;
@@ -18,6 +19,14 @@ public class Main : IAsyncPlugin, ISettingProvider
 
 		internal TogglTrack? _togglTrack;
 
+		public static string ExtractFromQuery(Query query, int index)
+		{
+			return (index == 1)
+				// Expect slight performance improvement by using query.SecondToEndSearch directly
+				? query.SecondToEndSearch
+				: string.Join(" ", query.SearchTerms.Skip(index));
+		}
+
 		/// <summary>
 		/// Runs on plugin initialisation.
 		/// Expensive operations should be performed here.
@@ -72,13 +81,14 @@ public async Task<List<Result>> QueryAsync(Query query, CancellationToken token)
 				return await this._togglTrack.GetDefaultHotKeys();
 			}
 
-			return query.FirstSearch.ToLower() switch
+			return (query.FirstSearch.ToLower()) switch
 			{
 				Settings.StartCommand => await this._togglTrack.RequestStartEntry(token, query),
 				Settings.EditCommand => await this._togglTrack.RequestEditEntry(token, query),
 				Settings.StopCommand => await this._togglTrack.RequestStopEntry(token, query),
 				Settings.DeleteCommand => await this._togglTrack.RequestDeleteEntry(token),
 				Settings.ContinueCommand => await this._togglTrack.RequestContinueEntry(token, query),
+				Settings.ReportsCommand => await this._togglTrack.RequestViewReports(token, query),
 				_ => (await this._togglTrack.GetDefaultHotKeys())
 					.FindAll(result =>
 					{

src/Settings.cs

@@ -1,3 +1,7 @@
+using System;
+using System.Text.RegularExpressions;
+using System.Collections.Generic;
+
 namespace Flow.Launcher.Plugin.TogglTrack
 {
 	/// <Summary>
@@ -10,15 +14,198 @@ public class Settings
 		internal const string StopCommand = "stop";
 		internal const string DeleteCommand = "delete";
 		internal const string ContinueCommand = "continue";
+		internal const string ReportsCommand = "reports";
 		internal const string BrowserCommand = "browser";
 		internal const string RefreshCommand = "refresh";
 
 		internal const string EditProjectFlag = "-p";
 		internal const string TimeSpanFlag = "-t";
 
+		internal enum ReportsSpanKeys
+		{
+			Day,
+			Week,
+			Month,
+			Year,
+		}
+		internal static readonly Regex ReportsSpanOffsetRegex = new Regex(@"-(\d+)");
+		internal static readonly List<ReportsSpanCommandArgument> ReportsSpanArguments = new List<ReportsSpanCommandArgument>
+		{
+			new ReportsSpanCommandArgument
+			{
+				Argument = "day",
+				Interpolation = offset => 
+				{
+					switch (offset)
+					{
+						case (0):
+						{
+							return "today";
+						}
+						case (1):
+						{
+							return "yesterday";
+						}
+						default:
+						{
+							return $"{offset} days ago";
+						}
+					}
+				},
+				Score = 400,
+				// Offsetted day
+				Start = (referenceDate, offset) => referenceDate.AddDays(-offset),
+				End = (referenceDate, offset) => referenceDate.AddDays(-offset),
+			},
+			new ReportsSpanCommandArgument
+			{
+				Argument = "week",
+				Interpolation = offset => 
+				{
+					switch (offset)
+					{
+						case (0):
+						{
+							return "this week";
+						}
+						case (1):
+						{
+							return "last week";
+						}
+						default:
+						{
+							return $"{offset} weeks ago";
+						}
+					}
+				},
+				Score = 300,
+				// Monday of the offsetted week
+				Start = (referenceDate, offset) => referenceDate.AddDays((-(int)referenceDate.DayOfWeek + 1) - (7 * offset)),
+				// Sunday of the offsetted week
+				End = (referenceDate, offset) => referenceDate.AddDays((-(int)referenceDate.DayOfWeek + 7) - (7 * offset)),
+			},
+			new ReportsSpanCommandArgument
+			{
+				Argument = "month",
+				Interpolation = offset => 
+				{
+					switch (offset)
+					{
+						case (0):
+						{
+							return "this month";
+						}
+						case (1):
+						{
+							return "last month";
+						}
+						default:
+						{
+							return $"{offset} months ago";
+						}
+					}
+				},
+				Score = 200,
+				// First day of the offsetted month
+				Start = (referenceDate, offset) => new DateTimeOffset(referenceDate.Year, referenceDate.Month, 1, 0, 0, 0, referenceDate.Offset).AddMonths(-offset),
+				// Last day of the offsetted month
+				End = (referenceDate, offset) => new DateTimeOffset(referenceDate.Year, referenceDate.Month, DateTime.DaysInMonth(referenceDate.Year, referenceDate.Month), 0, 0, 0, referenceDate.Offset).AddMonths(-offset),
+			},
+			new ReportsSpanCommandArgument
+			{
+				Argument = "year",
+				Interpolation = offset => 
+				{
+					switch (offset)
+					{
+						case (0):
+						{
+							return "this year";
+						}
+						case (1):
+						{
+							return "last year";
+						}
+						default:
+						{
+							return $"{offset} years ago";
+						}
+					}
+				},
+				Score = 100,
+				// First day of the offsetted year
+				Start = (referenceDate, offset) => new DateTimeOffset(referenceDate.Year - offset, 1, 1, 0, 0, 0, referenceDate.Offset),
+				// Last day of the offsetted year
+				End = (referenceDate, offset) => new DateTimeOffset(referenceDate.Year - offset, 1, 1, 0, 0, 0, referenceDate.Offset),
+			},
+		};
+
+		public enum ReportsGroupingKeys
+		{
+			Projects,
+			Clients,
+			Entries,
+		}
+		private const string ReportsGroupingProjectsArgument = "projects";
+		private const string ReportsGroupingClientsArgument = "clients";
+		private const string ReportsGroupingEntriesArgument = "entries";
+		internal static readonly List<ReportsGroupingCommandArgument> ReportsGroupingArguments = new List<ReportsGroupingCommandArgument>
+		{
+			new ReportsGroupingCommandArgument
+			{
+				Argument = Settings.ReportsGroupingProjectsArgument,
+				Interpolation = "View tracked time grouped by project",
+				Score = 300,
+				Grouping = Settings.ReportsGroupingKeys.Projects,
+				SubArgument = null,
+			},
+			new ReportsGroupingCommandArgument
+			{
+				Argument = Settings.ReportsGroupingClientsArgument,
+				Interpolation = "View tracked time grouped by client",
+				Score = 200,
+				Grouping = Settings.ReportsGroupingKeys.Clients,
+				SubArgument = Settings.ReportsGroupingProjectsArgument,
+			},
+			new ReportsGroupingCommandArgument
+			{
+				Argument = Settings.ReportsGroupingEntriesArgument,
+				Interpolation = "View tracked time entries",
+				Score = 100,
+				Grouping = Settings.ReportsGroupingKeys.Entries,
+				SubArgument = null,
+			},
+		};
+
 		/// <Summary>
 		/// Toggl Track API Token.
 		/// </Summary>
 		public string ApiToken { get; set; } = string.Empty;
 	}
+
+	public class CommandArgument
+	{
+		#nullable disable
+		public string Argument { get; init; }
+		public string Interpolation { get; init; }
+		public int Score { get; init; }
+		#nullable enable
+	}
+
+	public class ReportsSpanCommandArgument : CommandArgument
+	{
+		#nullable disable
+		public new Func<int, string> Interpolation { get; init; }
+		public Func<DateTimeOffset, int, DateTimeOffset> Start { get; init; }
+		public Func<DateTimeOffset, int, DateTimeOffset> End { get; init; }
+		#nullable enable
+	}
+
+	public class ReportsGroupingCommandArgument : CommandArgument
+	{
+		#nullable disable
+		public Settings.ReportsGroupingKeys Grouping { get; init; }
+		public string SubArgument { get; init; }
+		#nullable enable
+	}
 }

src/Toggl/Client.cs

@@ -8,18 +8,26 @@ namespace Flow.Launcher.Plugin.TogglTrack.TogglApi
 	public class TogglClient
 	{
 		private readonly static string _baseUrl = "https://api.track.toggl.com/api/v9/";
+		private readonly static string _reportsUrl = "https://api.track.toggl.com/reports/api/v3/";
 		private readonly AuthenticatedFetch _api;
+		private readonly AuthenticatedFetch _reportsApi;
 
 		public TogglClient(string token)
 		{
 			this._api = new AuthenticatedFetch(token, TogglClient._baseUrl);
+			this._reportsApi = new AuthenticatedFetch(token, TogglClient._reportsUrl);
 		}
 
 		public void UpdateToken(string token)
 		{
 			this._api.UpdateToken(token);
+			this._reportsApi.UpdateToken(token);
 		}
 
+		/* 
+	     * Standard API
+		 */
+
 		public async Task<Me?> GetMe()
 		{
 			return await this._api.Get<Me>("me?with_related_data=true");
@@ -42,16 +50,16 @@ public void UpdateToken(string token)
 				: DateTimeOffset.UtcNow;
 
 			return await this._api.Post<TimeEntry>($"workspaces/{workspaceId}/time_entries", new
-				{
-					billable,
-					created_with = "flow-toggl-plugin",
-					description,
-					duration = -1 * dateTimeOffset.ToUnixTimeSeconds(),
-					project_id = projectId ?? default(long?),
-					start = dateTimeOffset.ToString("yyyy-MM-ddTHH:mm:ssZ"),
-					tags,
-					workspace_id = workspaceId,
-				});
+			{
+				billable,
+				created_with = "flow-toggl-plugin",
+				description,
+				duration = -1 * dateTimeOffset.ToUnixTimeSeconds(),
+				project_id = projectId ?? default(long?),
+				start = dateTimeOffset.ToString("yyyy-MM-ddTHH:mm:ssZ"),
+				tags,
+				workspace_id = workspaceId,
+			});
 		}
 
 		public async Task<TimeEntry?> EditTimeEntry(TimeEntry timeEntry, long? projectId, string? description, DateTimeOffset? start, DateTimeOffset? stop)
@@ -67,17 +75,17 @@ public void UpdateToken(string token)
 			}
 
 			return await this._api.Put<TimeEntry>($"workspaces/{timeEntry.workspace_id}/time_entries/{timeEntry.id}", new
-				{
-					timeEntry.billable,
-					created_with = "flow-toggl-plugin",
-					description,
-					duration,
-					project_id = projectId,
-					start = start?.ToString("yyyy-MM-ddTHH:mm:ssZ"),
-					stop = stop?.ToString("yyyy-MM-ddTHH:mm:ssZ"),
-					timeEntry.tags,
-					timeEntry.workspace_id,
-				});
+			{
+				timeEntry.billable,
+				created_with = "flow-toggl-plugin",
+				description,
+				duration,
+				project_id = projectId,
+				start = start?.ToString("yyyy-MM-ddTHH:mm:ssZ"),
+				stop = stop?.ToString("yyyy-MM-ddTHH:mm:ssZ"),
+				timeEntry.tags,
+				timeEntry.workspace_id,
+			});
 		}
 
 		public async Task<TimeEntry?> GetRunningTimeEntry()
@@ -109,5 +117,29 @@ public void UpdateToken(string token)
 		{
 			return await this._api.Get<List<TimeEntry>>($"me/time_entries");
 		}
+
+		/* 
+		 * Reports API
+		 */
+
+		public async Task<SummaryTimeEntry?> GetSummaryTimeEntries(long workspaceId, long userId, Settings.ReportsGroupingKeys reportGrouping, DateTimeOffset start, DateTimeOffset? end)
+		{
+			(string grouping, string sub_grouping) = (reportGrouping) switch
+			{
+				Settings.ReportsGroupingKeys.Projects => ("projects", "time_entries"),
+				Settings.ReportsGroupingKeys.Clients => ("clients", "projects"),
+				Settings.ReportsGroupingKeys.Entries => ("projects", "time_entries"),
+				_ => ("projects", "time_entries"),
+			};
+
+			return await this._reportsApi.Post<SummaryTimeEntry>($"workspace/{workspaceId}/summary/time_entries", new
+			{
+				user_ids = new long[] { userId },
+				start_date = start.ToString("yyyy-MM-dd"),
+				end_date = end?.ToString("yyyy-MM-dd"),
+				grouping,
+				sub_grouping,
+			});
+		}
 	}
 }