summaryrefslogtreecommitdiffstats
path: root/server/src/Endpoints/V1/Entries
diff options
context:
space:
mode:
Diffstat (limited to 'server/src/Endpoints/V1/Entries')
-rw-r--r--server/src/Endpoints/V1/Entries/CreateEntryRoute.cs65
-rw-r--r--server/src/Endpoints/V1/Entries/DeleteEntryRoute.cs35
-rw-r--r--server/src/Endpoints/V1/Entries/EntryQueryPayload.cs60
-rw-r--r--server/src/Endpoints/V1/Entries/EntryQueryResponse.cs37
-rw-r--r--server/src/Endpoints/V1/Entries/EntryQueryRoute.cs186
-rw-r--r--server/src/Endpoints/V1/Entries/GetEntryRoute.cs34
-rw-r--r--server/src/Endpoints/V1/Entries/UpdateEntryRoute.cs66
7 files changed, 483 insertions, 0 deletions
diff --git a/server/src/Endpoints/V1/Entries/CreateEntryRoute.cs b/server/src/Endpoints/V1/Entries/CreateEntryRoute.cs
new file mode 100644
index 0000000..362e430
--- /dev/null
+++ b/server/src/Endpoints/V1/Entries/CreateEntryRoute.cs
@@ -0,0 +1,65 @@
+namespace IOL.GreatOffice.Api.Endpoints.V1.Entries;
+
+public class CreateEntryRoute : RouteBaseSync.WithRequest<TimeEntry.TimeEntryDto>.WithActionResult<TimeEntry.TimeEntryDto>
+{
+ private readonly AppDbContext _context;
+
+ public CreateEntryRoute(AppDbContext context) {
+ _context = context;
+ }
+
+ /// <summary>
+ /// Create a time entry.
+ /// </summary>
+ /// <param name="timeEntryTimeEntryDto"></param>
+ /// <returns></returns>
+ [ApiVersion(ApiSpecV1.VERSION_STRING)]
+ [BasicAuthentication(AppConstants.TOKEN_ALLOW_CREATE)]
+ [ProducesResponseType(200)]
+ [ProducesResponseType(400, Type = typeof(ErrorResult))]
+ [ProducesResponseType(404, Type = typeof(ErrorResult))]
+ [HttpPost("~/v{version:apiVersion}/entries/create")]
+ public override ActionResult<TimeEntry.TimeEntryDto> Handle(TimeEntry.TimeEntryDto timeEntryTimeEntryDto) {
+ if (timeEntryTimeEntryDto.Stop == default) {
+ return BadRequest(new ErrorResult("Invalid form", "A stop date is required"));
+ }
+
+ if (timeEntryTimeEntryDto.Start == default) {
+ return BadRequest(new ErrorResult("Invalid form", "A start date is required"));
+ }
+
+ if (timeEntryTimeEntryDto.Category == default) {
+ return BadRequest(new ErrorResult("Invalid form", "A category is required"));
+ }
+
+ var category = _context.TimeCategories
+ .Where(c => c.UserId == LoggedInUser.Id)
+ .SingleOrDefault(c => c.Id == timeEntryTimeEntryDto.Category.Id);
+ if (category == default) {
+ return NotFound(new ErrorResult("Not found", $"Could not find category {timeEntryTimeEntryDto.Category.Name}"));
+ }
+
+ var entry = new TimeEntry(LoggedInUser.Id) {
+ Category = category,
+ Start = timeEntryTimeEntryDto.Start.ToUniversalTime(),
+ Stop = timeEntryTimeEntryDto.Stop.ToUniversalTime(),
+ Description = timeEntryTimeEntryDto.Description,
+ };
+
+ if (timeEntryTimeEntryDto.Labels?.Count > 0) {
+ var labels = _context.TimeLabels
+ .Where(c => c.UserId == LoggedInUser.Id)
+ .Where(c => timeEntryTimeEntryDto.Labels.Select(p => p.Id).Contains(c.Id))
+ .ToList();
+ if (labels.Count != timeEntryTimeEntryDto.Labels.Count) {
+ return NotFound(new ErrorResult("Not found", "Could not find all of the specified labels"));
+ }
+
+ entry.Labels = labels;
+ }
+
+ _context.TimeEntries.Add(entry);
+ _context.SaveChanges();
+ return Ok(entry.AsDto);
+ }
+}
diff --git a/server/src/Endpoints/V1/Entries/DeleteEntryRoute.cs b/server/src/Endpoints/V1/Entries/DeleteEntryRoute.cs
new file mode 100644
index 0000000..0850af0
--- /dev/null
+++ b/server/src/Endpoints/V1/Entries/DeleteEntryRoute.cs
@@ -0,0 +1,35 @@
+namespace IOL.GreatOffice.Api.Endpoints.V1.Entries;
+
+/// <inheritdoc />
+public class DeleteEntryRoute : RouteBaseSync.WithRequest<Guid>.WithActionResult
+{
+ private readonly AppDbContext _context;
+
+ /// <inheritdoc />
+ public DeleteEntryRoute(AppDbContext context) {
+ _context = context;
+ }
+
+ /// <summary>
+ /// Delete a time entry.
+ /// </summary>
+ /// <param name="id"></param>
+ /// <returns></returns>
+ [ApiVersion(ApiSpecV1.VERSION_STRING)]
+ [BasicAuthentication(AppConstants.TOKEN_ALLOW_DELETE)]
+ [HttpDelete("~/v{version:apiVersion}/entries/{id:guid}/delete")]
+ [ProducesResponseType(404)]
+ [ProducesResponseType(200)]
+ public override ActionResult Handle(Guid id) {
+ var entry = _context.TimeEntries
+ .Where(c => c.UserId == LoggedInUser.Id)
+ .SingleOrDefault(c => c.Id == id);
+ if (entry == default) {
+ return NotFound();
+ }
+
+ _context.TimeEntries.Remove(entry);
+ _context.SaveChanges();
+ return Ok();
+ }
+}
diff --git a/server/src/Endpoints/V1/Entries/EntryQueryPayload.cs b/server/src/Endpoints/V1/Entries/EntryQueryPayload.cs
new file mode 100644
index 0000000..763ac8b
--- /dev/null
+++ b/server/src/Endpoints/V1/Entries/EntryQueryPayload.cs
@@ -0,0 +1,60 @@
+namespace IOL.GreatOffice.Api.Endpoints.V1.Entries;
+
+/// <summary>
+/// Query model for querying time entries.
+/// </summary>
+public class EntryQueryPayload
+{
+ /// <summary>
+ /// Duration to filter with.
+ /// </summary>
+ public TimeEntryQueryDuration Duration { get; set; }
+
+ /// <summary>
+ /// List of categories to filter with.
+ /// </summary>
+ public List<TimeCategory.TimeCategoryDto> Categories { get; set; }
+
+ /// <summary>
+ /// List of labels to filter with.
+ /// </summary>
+ public List<TimeLabel.TimeLabelDto> Labels { get; set; }
+
+ /// <summary>
+ /// Date range to filter with, only respected if Duration is set to TimeEntryQueryDuration.DATE_RANGE.
+ /// </summary>
+ /// <see cref="TimeEntryQueryDuration"/>
+ public QueryDateRange DateRange { get; set; }
+
+ /// <summary>
+ /// Spesific date to filter with, only respected if Duration is set to TimeEntryQueryDuration.SPECIFIC_DATE.
+ /// </summary>
+ /// <see cref="TimeEntryQueryDuration"/>
+ public DateTime SpecificDate { get; set; }
+
+ /// <summary>
+ /// Optional page number to show, goes well with PageSize.
+ /// </summary>
+ public int Page { get; set; }
+
+ /// <summary>
+ /// Optional page size to show, goes well with Page.
+ /// </summary>
+ public int PageSize { get; set; }
+
+ /// <summary>
+ /// Represents a date range.
+ /// </summary>
+ public class QueryDateRange
+ {
+ /// <summary>
+ /// Range start
+ /// </summary>
+ public DateTime From { get; set; }
+
+ /// <summary>
+ /// Range end
+ /// </summary>
+ public DateTime To { get; set; }
+ }
+}
diff --git a/server/src/Endpoints/V1/Entries/EntryQueryResponse.cs b/server/src/Endpoints/V1/Entries/EntryQueryResponse.cs
new file mode 100644
index 0000000..b1b07a3
--- /dev/null
+++ b/server/src/Endpoints/V1/Entries/EntryQueryResponse.cs
@@ -0,0 +1,37 @@
+namespace IOL.GreatOffice.Api.Endpoints.V1.Entries;
+
+/// <summary>
+/// Response given for a successful query.
+/// </summary>
+public class EntryQueryResponse
+{
+ /// <inheritdoc cref="EntryQueryResponse"/>
+ public EntryQueryResponse() {
+ Results = new List<TimeEntry.TimeEntryDto>();
+ }
+
+ /// <summary>
+ /// List of entries.
+ /// </summary>
+ public List<TimeEntry.TimeEntryDto> Results { get; set; }
+
+ /// <summary>
+ /// Current page.
+ /// </summary>
+ public int Page { get; set; }
+
+ /// <summary>
+ /// Current page size (amount of entries).
+ /// </summary>
+ public int PageSize { get; set; }
+
+ /// <summary>
+ /// Total amount of entries in query.
+ /// </summary>
+ public int TotalSize { get; set; }
+
+ /// <summary>
+ /// Total amount of page(s) in query.
+ /// </summary>
+ public int TotalPageCount { get; set; }
+}
diff --git a/server/src/Endpoints/V1/Entries/EntryQueryRoute.cs b/server/src/Endpoints/V1/Entries/EntryQueryRoute.cs
new file mode 100644
index 0000000..c037b72
--- /dev/null
+++ b/server/src/Endpoints/V1/Entries/EntryQueryRoute.cs
@@ -0,0 +1,186 @@
+namespace IOL.GreatOffice.Api.Endpoints.V1.Entries;
+
+public class EntryQueryRoute : RouteBaseSync.WithRequest<EntryQueryPayload>.WithActionResult<EntryQueryResponse>
+{
+ private readonly ILogger<EntryQueryRoute> _logger;
+ private readonly AppDbContext _context;
+
+ public EntryQueryRoute(ILogger<EntryQueryRoute> logger, AppDbContext context) {
+ _logger = logger;
+ _context = context;
+ }
+
+ /// <summary>
+ /// Get a list of entries based on a given query.
+ /// </summary>
+ /// <param name="entryQuery"></param>
+ /// <returns></returns>
+ /// <exception cref="ArgumentOutOfRangeException"></exception>
+ [ApiVersion(ApiSpecV1.VERSION_STRING)]
+ [BasicAuthentication(AppConstants.TOKEN_ALLOW_READ)]
+ [HttpPost("~/v{version:apiVersion}/entries/query")]
+ [ProducesResponseType(204)]
+ [ProducesResponseType(400, Type = typeof(ErrorResult))]
+ [ProducesResponseType(200, Type = typeof(EntryQueryResponse))]
+ public override ActionResult<EntryQueryResponse> Handle(EntryQueryPayload entryQuery) {
+ var result = new TimeQueryDto();
+
+ Request.Headers.TryGetValue(AppHeaders.BROWSER_TIME_ZONE, out var timeZoneHeader);
+ var tz = TimeZoneInfo.FindSystemTimeZoneById(timeZoneHeader.ToString().HasValue() ? timeZoneHeader.ToString() : "UTC");
+ var offsetInHours = tz.BaseUtcOffset.Hours;
+
+ // this is fine as long as the client is not connecting from Australia: Lord Howe Island
+ // according to https://en.wikipedia.org/wiki/Daylight_saving_time_by_country
+ if (tz.IsDaylightSavingTime(DateTime.UtcNow)) {
+ offsetInHours++;
+ }
+
+ _logger.LogInformation("Request time zone (" + tz.Id + ") offset is: " + offsetInHours + " hours");
+ var requestDateTime = TimeZoneInfo.ConvertTimeFromUtc(DateTime.UtcNow, tz);
+ _logger.LogInformation("Querying data with date time: " + requestDateTime.ToString("u"));
+
+ var skipCount = 0;
+ if (entryQuery.Page > 1) {
+ skipCount = entryQuery.PageSize * entryQuery.Page;
+ }
+
+ result.Page = entryQuery.Page;
+ result.PageSize = entryQuery.PageSize;
+
+ var baseQuery = _context.TimeEntries
+ .AsNoTracking()
+ .Include(c => c.Category)
+ .Include(c => c.Labels)
+ .Where(c => c.UserId == LoggedInUser.Id)
+ .ConditionalWhere(entryQuery.Categories?.Any() ?? false, c => entryQuery.Categories.Any(p => p.Id == c.Category.Id))
+ .ConditionalWhere(entryQuery.Labels?.Any() ?? false, c => c.Labels.Any(l => entryQuery.Labels.Any(p => p.Id == l.Id)))
+ .OrderByDescending(c => c.Start);
+
+ switch (entryQuery.Duration) {
+ case TimeEntryQueryDuration.TODAY:
+ var baseTodaysEntries = baseQuery
+ .Where(c => DateTime.Compare(c.Start.AddHours(offsetInHours).Date, DateTime.UtcNow.Date) == 0);
+ var baseTodaysEntriesCount = baseTodaysEntries.Count();
+
+ if (baseTodaysEntriesCount == 0) {
+ return NoContent();
+ }
+
+ result.TotalSize = baseTodaysEntriesCount;
+ result.TotalPageCount = Convert.ToInt32(Math.Round((double)baseTodaysEntriesCount / entryQuery.PageSize));
+
+ var pagedTodaysEntries = baseTodaysEntries.Skip(skipCount).Take(entryQuery.PageSize);
+
+ result.Results.AddRange(pagedTodaysEntries.Select(c => c.AsDto));
+ break;
+ case TimeEntryQueryDuration.THIS_WEEK:
+ var lastMonday = DateTime.UtcNow.StartOfWeek(DayOfWeek.Monday);
+
+ var baseEntriesThisWeek = baseQuery
+ .Where(c => c.Start.AddHours(offsetInHours).Date >= lastMonday.Date && c.Start.AddHours(offsetInHours).Date <= DateTime.UtcNow.Date);
+
+ var baseEntriesThisWeekCount = baseEntriesThisWeek.Count();
+
+ if (baseEntriesThisWeekCount == 0) {
+ return NoContent();
+ }
+
+ result.TotalSize = baseEntriesThisWeekCount;
+ result.TotalPageCount = Convert.ToInt32(Math.Round((double)baseEntriesThisWeekCount / entryQuery.PageSize));
+
+ var pagedEntriesThisWeek = baseEntriesThisWeek.Skip(skipCount).Take(entryQuery.PageSize);
+
+ result.Results.AddRange(pagedEntriesThisWeek.Select(c => c.AsDto));
+ break;
+ case TimeEntryQueryDuration.THIS_MONTH:
+ var baseEntriesThisMonth = baseQuery
+ .Where(c => c.Start.AddHours(offsetInHours).Month == DateTime.UtcNow.Month
+ && c.Start.AddHours(offsetInHours).Year == DateTime.UtcNow.Year);
+ var baseEntriesThisMonthCount = baseEntriesThisMonth.Count();
+ if (baseEntriesThisMonthCount == 0) {
+ return NoContent();
+ }
+
+ result.TotalSize = baseEntriesThisMonthCount;
+ result.TotalPageCount = Convert.ToInt32(Math.Round((double)baseEntriesThisMonthCount / entryQuery.PageSize));
+
+ var pagedEntriesThisMonth = baseEntriesThisMonth.Skip(skipCount).Take(entryQuery.PageSize);
+
+ result.Results.AddRange(pagedEntriesThisMonth.Select(c => c.AsDto));
+ break;
+ case TimeEntryQueryDuration.THIS_YEAR:
+ var baseEntriesThisYear = baseQuery
+ .Where(c => c.Start.AddHours(offsetInHours).Year == DateTime.UtcNow.Year);
+
+ var baseEntriesThisYearCount = baseEntriesThisYear.Count();
+ if (baseEntriesThisYearCount == 0) {
+ return NoContent();
+ }
+
+ result.TotalSize = baseEntriesThisYearCount;
+ result.TotalPageCount = Convert.ToInt32(Math.Round((double)baseEntriesThisYearCount / entryQuery.PageSize));
+
+ var pagedEntriesThisYear = baseEntriesThisYear.Skip(skipCount).Take(entryQuery.PageSize);
+
+ result.Results.AddRange(pagedEntriesThisYear.Select(c => c.AsDto));
+ break;
+ case TimeEntryQueryDuration.SPECIFIC_DATE:
+ var date = DateTime.SpecifyKind(entryQuery.SpecificDate, DateTimeKind.Utc);
+ var baseEntriesOnThisDate = baseQuery.Where(c => c.Start.AddHours(offsetInHours).Date == date.Date);
+ var baseEntriesOnThisDateCount = baseEntriesOnThisDate.Count();
+
+ if (baseEntriesOnThisDateCount == 0) {
+ return NoContent();
+ }
+
+ result.TotalSize = baseEntriesOnThisDateCount;
+ result.TotalPageCount = Convert.ToInt32(Math.Round((double)baseEntriesOnThisDateCount / entryQuery.PageSize));
+
+ var pagedEntriesOnThisDate = baseEntriesOnThisDate.Skip(skipCount).Take(entryQuery.PageSize);
+
+ result.Results.AddRange(pagedEntriesOnThisDate.Select(c => c.AsDto));
+ break;
+ case TimeEntryQueryDuration.DATE_RANGE:
+ if (entryQuery.DateRange.From == default) {
+ return BadRequest(new ErrorResult("Invalid query", "From date cannot be empty"));
+ }
+
+ var fromDate = DateTime.SpecifyKind(entryQuery.DateRange.From, DateTimeKind.Utc);
+
+ if (entryQuery.DateRange.To == default) {
+ return BadRequest(new ErrorResult("Invalid query", "To date cannot be empty"));
+ }
+
+ var toDate = DateTime.SpecifyKind(entryQuery.DateRange.To, DateTimeKind.Utc);
+
+ if (DateTime.Compare(fromDate, toDate) > 0) {
+ return BadRequest(new ErrorResult("Invalid query", "To date cannot be less than From date"));
+ }
+
+ var baseDateRangeEntries = baseQuery
+ .Where(c => c.Start.AddHours(offsetInHours).Date > fromDate && c.Start.AddHours(offsetInHours).Date <= toDate);
+
+ var baseDateRangeEntriesCount = baseDateRangeEntries.Count();
+ if (baseDateRangeEntriesCount == 0) {
+ return NoContent();
+ }
+
+ result.TotalSize = baseDateRangeEntriesCount;
+ result.TotalPageCount = Convert.ToInt32(Math.Round((double)baseDateRangeEntriesCount / entryQuery.PageSize));
+
+ var pagedDateRangeEntries = baseDateRangeEntries.Skip(skipCount).Take(entryQuery.PageSize);
+
+ result.Results.AddRange(pagedDateRangeEntries.Select(c => c.AsDto));
+ break;
+ default:
+ throw new ArgumentOutOfRangeException(nameof(entryQuery), "Unknown duration for query");
+ }
+
+ if (result.Results.Any() && result.Page == 0) {
+ result.Page = 1;
+ result.TotalPageCount = 1;
+ }
+
+ return Ok(result);
+ }
+}
diff --git a/server/src/Endpoints/V1/Entries/GetEntryRoute.cs b/server/src/Endpoints/V1/Entries/GetEntryRoute.cs
new file mode 100644
index 0000000..87038db
--- /dev/null
+++ b/server/src/Endpoints/V1/Entries/GetEntryRoute.cs
@@ -0,0 +1,34 @@
+namespace IOL.GreatOffice.Api.Endpoints.V1.Entries;
+
+public class GetEntryRoute : RouteBaseSync.WithRequest<Guid>.WithActionResult<TimeEntry.TimeEntryDto>
+{
+ private readonly AppDbContext _context;
+
+ public GetEntryRoute(AppDbContext context) {
+ _context = context;
+ }
+
+ /// <summary>
+ /// Get a spesific time entry.
+ /// </summary>
+ /// <param name="id"></param>
+ /// <returns></returns>
+ [ApiVersion(ApiSpecV1.VERSION_STRING)]
+ [BasicAuthentication(AppConstants.TOKEN_ALLOW_READ)]
+ [HttpGet("~/v{version:apiVersion}/entries/{id:guid}")]
+ [ProducesResponseType(404)]
+ [ProducesResponseType(200, Type = typeof(TimeEntry.TimeEntryDto))]
+ public override ActionResult<TimeEntry.TimeEntryDto> Handle(Guid id) {
+ var entry = _context.TimeEntries
+ .Where(c => c.UserId == LoggedInUser.Id)
+ .Include(c => c.Category)
+ .Include(c => c.Labels)
+ .SingleOrDefault(c => c.Id == id);
+
+ if (entry == default) {
+ return NotFound();
+ }
+
+ return Ok(entry);
+ }
+}
diff --git a/server/src/Endpoints/V1/Entries/UpdateEntryRoute.cs b/server/src/Endpoints/V1/Entries/UpdateEntryRoute.cs
new file mode 100644
index 0000000..ac233e0
--- /dev/null
+++ b/server/src/Endpoints/V1/Entries/UpdateEntryRoute.cs
@@ -0,0 +1,66 @@
+namespace IOL.GreatOffice.Api.Endpoints.V1.Entries;
+
+public class UpdateEntryRoute : RouteBaseSync.WithRequest<TimeEntry.TimeEntryDto>.WithActionResult<TimeEntry.TimeEntryDto>
+{
+ private readonly AppDbContext _context;
+
+ public UpdateEntryRoute(AppDbContext context) {
+ _context = context;
+ }
+
+ /// <summary>
+ /// Update a time entry.
+ /// </summary>
+ /// <param name="timeEntryTimeEntryDto"></param>
+ /// <returns></returns>
+ [ApiVersion(ApiSpecV1.VERSION_STRING)]
+ [BasicAuthentication(AppConstants.TOKEN_ALLOW_UPDATE)]
+ [HttpPost("~/v{version:apiVersion}/entries/update")]
+ [ProducesResponseType(404, Type = typeof(ErrorResult))]
+ [ProducesResponseType(200, Type = typeof(TimeEntry.TimeEntryDto))]
+ public override ActionResult<TimeEntry.TimeEntryDto> Handle(TimeEntry.TimeEntryDto timeEntryTimeEntryDto) {
+ var entry = _context.TimeEntries
+ .Where(c => c.UserId == LoggedInUser.Id)
+ .Include(c => c.Labels)
+ .SingleOrDefault(c => c.Id == timeEntryTimeEntryDto.Id);
+
+ if (entry == default) {
+ return NotFound();
+ }
+
+ var category = _context.TimeCategories
+ .Where(c => c.UserId == LoggedInUser.Id)
+ .SingleOrDefault(c => c.Id == timeEntryTimeEntryDto.Category.Id);
+ if (category == default) {
+ return NotFound(new ErrorResult("Not found", $"Could not find category {timeEntryTimeEntryDto.Category.Name}"));
+ }
+
+ entry.Start = timeEntryTimeEntryDto.Start.ToUniversalTime();
+ entry.Stop = timeEntryTimeEntryDto.Stop.ToUniversalTime();
+ entry.Description = timeEntryTimeEntryDto.Description;
+ entry.Category = category;
+
+ if (timeEntryTimeEntryDto.Labels?.Count > 0) {
+ var labels = new List<TimeLabel>();
+
+ foreach (var labelDto in timeEntryTimeEntryDto.Labels) {
+ var label = _context.TimeLabels
+ .Where(c => c.UserId == LoggedInUser.Id)
+ .SingleOrDefault(c => c.Id == labelDto.Id);
+
+ if (label == default) {
+ continue;
+ }
+
+ labels.Add(label);
+ }
+
+ entry.Labels = labels;
+ } else {
+ entry.Labels = default;
+ }
+
+ _context.SaveChanges();
+ return Ok(entry.AsDto);
+ }
+}