aboutsummaryrefslogtreecommitdiffstats
path: root/code/api/src/Endpoints/V1
diff options
context:
space:
mode:
authorivarlovlie <git@ivarlovlie.no>2022-10-24 06:29:23 +0200
committerivarlovlie <git@ivarlovlie.no>2022-10-24 06:29:23 +0200
commit585c5c8537eb21dfc9f16108548e63d9ced3d971 (patch)
tree1582bc45dcab585ec7204f1570019b2ca8de36c5 /code/api/src/Endpoints/V1
parent4b42c5235482fe0d3811b4e2936614c79e20d970 (diff)
downloadgreatoffice-585c5c8537eb21dfc9f16108548e63d9ced3d971.tar.xz
greatoffice-585c5c8537eb21dfc9f16108548e63d9ced3d971.zip
feat: Before move to FastEndpoints
Diffstat (limited to 'code/api/src/Endpoints/V1')
-rw-r--r--code/api/src/Endpoints/V1/ApiTokens/CreateTokenRoute.cs4
-rw-r--r--code/api/src/Endpoints/V1/BaseRoute.cs39
-rw-r--r--code/api/src/Endpoints/V1/Entries/CreateEntryRoute.cs15
-rw-r--r--code/api/src/Endpoints/V1/Entries/EntryQueryRoute.cs8
-rw-r--r--code/api/src/Endpoints/V1/Entries/TimeQueryDto.cs34
-rw-r--r--code/api/src/Endpoints/V1/Entries/UpdateEntryRoute.cs4
-rw-r--r--code/api/src/Endpoints/V1/RouteBaseAsync.cs16
-rw-r--r--code/api/src/Endpoints/V1/RouteBaseSync.cs16
-rw-r--r--code/api/src/Endpoints/V1/V1_EndpointBase.cs29
9 files changed, 95 insertions, 70 deletions
diff --git a/code/api/src/Endpoints/V1/ApiTokens/CreateTokenRoute.cs b/code/api/src/Endpoints/V1/ApiTokens/CreateTokenRoute.cs
index 2086619..60b00ff 100644
--- a/code/api/src/Endpoints/V1/ApiTokens/CreateTokenRoute.cs
+++ b/code/api/src/Endpoints/V1/ApiTokens/CreateTokenRoute.cs
@@ -23,13 +23,13 @@ public class CreateTokenRoute : RouteBaseSync.WithRequest<ApiAccessToken.ApiAcce
[ApiVersion(ApiSpecV1.VERSION_STRING)]
[HttpPost("~/v{version:apiVersion}/api-tokens/create")]
[ProducesResponseType(200, Type = typeof(string))]
- [ProducesResponseType(404, Type = typeof(ErrorResult))]
+ [ProducesResponseType(404, Type = typeof(KnownProblemModel))]
public override ActionResult Handle(ApiAccessToken.ApiAccessTokenDto request)
{
var user = _context.Users.SingleOrDefault(c => c.Id == LoggedInUser.Id);
if (user == default)
{
- return NotFound(new ErrorResult("User does not exist"));
+ return NotFound(new KnownProblemModel("User does not exist"));
}
var token_entropy = _configuration.APP_AES_KEY;
diff --git a/code/api/src/Endpoints/V1/BaseRoute.cs b/code/api/src/Endpoints/V1/BaseRoute.cs
deleted file mode 100644
index e7d72ac..0000000
--- a/code/api/src/Endpoints/V1/BaseRoute.cs
+++ /dev/null
@@ -1,39 +0,0 @@
-using System.Net.Http.Headers;
-
-namespace IOL.GreatOffice.Api.Endpoints.V1;
-
-/// <inheritdoc />
-[ApiVersion(ApiSpecV1.VERSION_STRING)]
-[Authorize(AuthenticationSchemes = AuthSchemes)]
-[ApiController]
-public class BaseRoute : ControllerBase
-{
- private const string AuthSchemes = CookieAuthenticationDefaults.AuthenticationScheme + "," + AppConstants.BASIC_AUTH_SCHEME;
-
- /// <summary>
- /// User data for the currently logged on user.
- /// </summary>
- protected LoggedInUserModel LoggedInUser => new() {
- Username = User.FindFirstValue(AppClaims.NAME),
- Id = User.FindFirstValue(AppClaims.USER_ID).AsGuid(),
- };
-
- protected bool IsApiCall() {
- if (!Request.Headers.ContainsKey("Authorization")) return false;
- try {
- var authHeader = AuthenticationHeaderValue.Parse(Request.Headers["Authorization"]);
- if (authHeader.Parameter == null) return false;
- } catch {
- return false;
- }
-
- return true;
- }
-
- protected bool HasApiPermission(string permission_key) {
- var permission_claim = User.Claims.SingleOrDefault(c => c.Type == permission_key);
- return permission_claim is {
- Value: "True"
- };
- }
-}
diff --git a/code/api/src/Endpoints/V1/Entries/CreateEntryRoute.cs b/code/api/src/Endpoints/V1/Entries/CreateEntryRoute.cs
index 362e430..854ff59 100644
--- a/code/api/src/Endpoints/V1/Entries/CreateEntryRoute.cs
+++ b/code/api/src/Endpoints/V1/Entries/CreateEntryRoute.cs
@@ -16,27 +16,28 @@ public class CreateEntryRoute : RouteBaseSync.WithRequest<TimeEntry.TimeEntryDto
[ApiVersion(ApiSpecV1.VERSION_STRING)]
[BasicAuthentication(AppConstants.TOKEN_ALLOW_CREATE)]
[ProducesResponseType(200)]
- [ProducesResponseType(400, Type = typeof(ErrorResult))]
- [ProducesResponseType(404, Type = typeof(ErrorResult))]
+ [ProducesResponseType(400, Type = typeof(KnownProblemModel))]
+ [ProducesResponseType(404, Type = typeof(KnownProblemModel))]
[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"));
+ return BadRequest(new KnownProblemModel("Invalid form", "A stop date is required"));
}
if (timeEntryTimeEntryDto.Start == default) {
- return BadRequest(new ErrorResult("Invalid form", "A start date is required"));
+ return BadRequest(new KnownProblemModel("Invalid form", "A start date is required"));
}
if (timeEntryTimeEntryDto.Category == default) {
- return BadRequest(new ErrorResult("Invalid form", "A category is required"));
+ return BadRequest(new KnownProblemModel("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}"));
+ return NotFound(new KnownProblemModel("Not found", $"Could not find category {timeEntryTimeEntryDto.Category.Name}"));
}
var entry = new TimeEntry(LoggedInUser.Id) {
@@ -52,7 +53,7 @@ public class CreateEntryRoute : RouteBaseSync.WithRequest<TimeEntry.TimeEntryDto
.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"));
+ return NotFound(new KnownProblemModel("Not found", "Could not find all of the specified labels"));
}
entry.Labels = labels;
diff --git a/code/api/src/Endpoints/V1/Entries/EntryQueryRoute.cs b/code/api/src/Endpoints/V1/Entries/EntryQueryRoute.cs
index d431ac5..ec6003c 100644
--- a/code/api/src/Endpoints/V1/Entries/EntryQueryRoute.cs
+++ b/code/api/src/Endpoints/V1/Entries/EntryQueryRoute.cs
@@ -20,7 +20,7 @@ public class EntryQueryRoute : RouteBaseSync.WithRequest<EntryQueryPayload>.With
[BasicAuthentication(AppConstants.TOKEN_ALLOW_READ)]
[HttpPost("~/v{version:apiVersion}/entries/query")]
[ProducesResponseType(204)]
- [ProducesResponseType(400, Type = typeof(ErrorResult))]
+ [ProducesResponseType(400, Type = typeof(KnownProblemModel))]
[ProducesResponseType(200, Type = typeof(EntryQueryResponse))]
public override ActionResult<EntryQueryResponse> Handle(EntryQueryPayload entryQuery) {
var result = new TimeQueryDto();
@@ -142,19 +142,19 @@ public class EntryQueryRoute : RouteBaseSync.WithRequest<EntryQueryPayload>.With
break;
case TimeEntryQueryDuration.DATE_RANGE:
if (entryQuery.DateRange.From == default) {
- return BadRequest(new ErrorResult("Invalid query", "From date cannot be empty"));
+ return BadRequest(new KnownProblemModel("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"));
+ return BadRequest(new KnownProblemModel("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"));
+ return BadRequest(new KnownProblemModel("Invalid query", "To date cannot be less than From date"));
}
var baseDateRangeEntries = baseQuery
diff --git a/code/api/src/Endpoints/V1/Entries/TimeQueryDto.cs b/code/api/src/Endpoints/V1/Entries/TimeQueryDto.cs
new file mode 100644
index 0000000..6c199d8
--- /dev/null
+++ b/code/api/src/Endpoints/V1/Entries/TimeQueryDto.cs
@@ -0,0 +1,34 @@
+
+namespace IOL.GreatOffice.Api.Endpoints.V1.Entries;
+
+public class TimeQueryDto
+{
+ public TimeQueryDto() {
+ Results = new List<TimeEntry.TimeEntryDto>();
+ }
+
+ /// <summary>
+ /// List of entries.
+ /// </summary>
+ public List<TimeEntry.TimeEntryDto> Results { get; set; }
+
+ /// <summary>
+ /// Curren page.
+ /// </summary>
+ public int Page { get; set; }
+
+ /// <summary>
+ /// Maximum count of entries in a page.
+ /// </summary>
+ public int PageSize { get; set; }
+
+ /// <summary>
+ /// Total count of entries.
+ /// </summary>
+ public int TotalSize { get; set; }
+
+ /// <summary>
+ /// Total count of pages.
+ /// </summary>
+ public int TotalPageCount { get; set; }
+}
diff --git a/code/api/src/Endpoints/V1/Entries/UpdateEntryRoute.cs b/code/api/src/Endpoints/V1/Entries/UpdateEntryRoute.cs
index ac233e0..09e3b9c 100644
--- a/code/api/src/Endpoints/V1/Entries/UpdateEntryRoute.cs
+++ b/code/api/src/Endpoints/V1/Entries/UpdateEntryRoute.cs
@@ -16,7 +16,7 @@ public class UpdateEntryRoute : RouteBaseSync.WithRequest<TimeEntry.TimeEntryDto
[ApiVersion(ApiSpecV1.VERSION_STRING)]
[BasicAuthentication(AppConstants.TOKEN_ALLOW_UPDATE)]
[HttpPost("~/v{version:apiVersion}/entries/update")]
- [ProducesResponseType(404, Type = typeof(ErrorResult))]
+ [ProducesResponseType(404, Type = typeof(KnownProblemModel))]
[ProducesResponseType(200, Type = typeof(TimeEntry.TimeEntryDto))]
public override ActionResult<TimeEntry.TimeEntryDto> Handle(TimeEntry.TimeEntryDto timeEntryTimeEntryDto) {
var entry = _context.TimeEntries
@@ -32,7 +32,7 @@ public class UpdateEntryRoute : RouteBaseSync.WithRequest<TimeEntry.TimeEntryDto
.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}"));
+ return NotFound(new KnownProblemModel("Not found", $"Could not find category {timeEntryTimeEntryDto.Category.Name}"));
}
entry.Start = timeEntryTimeEntryDto.Start.ToUniversalTime();
diff --git a/code/api/src/Endpoints/V1/RouteBaseAsync.cs b/code/api/src/Endpoints/V1/RouteBaseAsync.cs
index 1d179f7..a75e9da 100644
--- a/code/api/src/Endpoints/V1/RouteBaseAsync.cs
+++ b/code/api/src/Endpoints/V1/RouteBaseAsync.cs
@@ -7,7 +7,7 @@ public static class RouteBaseAsync
{
public static class WithRequest<TRequest>
{
- public abstract class WithResult<TResponse> : BaseRoute
+ public abstract class WithResult<TResponse> : V1_EndpointBase
{
public abstract Task<TResponse> HandleAsync(
TRequest request,
@@ -15,7 +15,7 @@ public static class RouteBaseAsync
);
}
- public abstract class WithoutResult : BaseRoute
+ public abstract class WithoutResult : V1_EndpointBase
{
public abstract Task HandleAsync(
TRequest request,
@@ -23,7 +23,7 @@ public static class RouteBaseAsync
);
}
- public abstract class WithActionResult<TResponse> : BaseRoute
+ public abstract class WithActionResult<TResponse> : V1_EndpointBase
{
public abstract Task<ActionResult<TResponse>> HandleAsync(
TRequest request,
@@ -31,7 +31,7 @@ public static class RouteBaseAsync
);
}
- public abstract class WithActionResult : BaseRoute
+ public abstract class WithActionResult : V1_EndpointBase
{
public abstract Task<ActionResult> HandleAsync(
TRequest request,
@@ -42,28 +42,28 @@ public static class RouteBaseAsync
public static class WithoutRequest
{
- public abstract class WithResult<TResponse> : BaseRoute
+ public abstract class WithResult<TResponse> : V1_EndpointBase
{
public abstract Task<TResponse> HandleAsync(
CancellationToken cancellationToken = default
);
}
- public abstract class WithoutResult : BaseRoute
+ public abstract class WithoutResult : V1_EndpointBase
{
public abstract Task HandleAsync(
CancellationToken cancellationToken = default
);
}
- public abstract class WithActionResult<TResponse> : BaseRoute
+ public abstract class WithActionResult<TResponse> : V1_EndpointBase
{
public abstract Task<ActionResult<TResponse>> HandleAsync(
CancellationToken cancellationToken = default
);
}
- public abstract class WithActionResult : BaseRoute
+ public abstract class WithActionResult : V1_EndpointBase
{
public abstract Task<ActionResult> HandleAsync(
CancellationToken cancellationToken = default
diff --git a/code/api/src/Endpoints/V1/RouteBaseSync.cs b/code/api/src/Endpoints/V1/RouteBaseSync.cs
index cb27c14..6a86074 100644
--- a/code/api/src/Endpoints/V1/RouteBaseSync.cs
+++ b/code/api/src/Endpoints/V1/RouteBaseSync.cs
@@ -7,22 +7,22 @@ public static class RouteBaseSync
{
public static class WithRequest<TRequest>
{
- public abstract class WithResult<TResponse> : BaseRoute
+ public abstract class WithResult<TResponse> : V1_EndpointBase
{
public abstract TResponse Handle(TRequest request);
}
- public abstract class WithoutResult : BaseRoute
+ public abstract class WithoutResult : V1_EndpointBase
{
public abstract void Handle(TRequest request);
}
- public abstract class WithActionResult<TResponse> : BaseRoute
+ public abstract class WithActionResult<TResponse> : V1_EndpointBase
{
public abstract ActionResult<TResponse> Handle(TRequest request);
}
- public abstract class WithActionResult : BaseRoute
+ public abstract class WithActionResult : V1_EndpointBase
{
public abstract ActionResult Handle(TRequest request);
}
@@ -30,22 +30,22 @@ public static class RouteBaseSync
public static class WithoutRequest
{
- public abstract class WithResult<TResponse> : BaseRoute
+ public abstract class WithResult<TResponse> : V1_EndpointBase
{
public abstract TResponse Handle();
}
- public abstract class WithoutResult : BaseRoute
+ public abstract class WithoutResult : V1_EndpointBase
{
public abstract void Handle();
}
- public abstract class WithActionResult<TResponse> : BaseRoute
+ public abstract class WithActionResult<TResponse> : V1_EndpointBase
{
public abstract ActionResult<TResponse> Handle();
}
- public abstract class WithActionResult : BaseRoute
+ public abstract class WithActionResult : V1_EndpointBase
{
public abstract ActionResult Handle();
}
diff --git a/code/api/src/Endpoints/V1/V1_EndpointBase.cs b/code/api/src/Endpoints/V1/V1_EndpointBase.cs
new file mode 100644
index 0000000..08ce4ab
--- /dev/null
+++ b/code/api/src/Endpoints/V1/V1_EndpointBase.cs
@@ -0,0 +1,29 @@
+using System.Net.Http.Headers;
+
+namespace IOL.GreatOffice.Api.Endpoints.V1;
+
+[ApiVersion(ApiSpecV1.VERSION_STRING)]
+[Authorize(AuthenticationSchemes = AuthSchemes)]
+public class V1_EndpointBase : EndpointBase
+{
+ private const string AuthSchemes = CookieAuthenticationDefaults.AuthenticationScheme + "," + AppConstants.BASIC_AUTH_SCHEME;
+
+ protected bool IsApiCall() {
+ if (!Request.Headers.ContainsKey("Authorization")) return false;
+ try {
+ var authHeader = AuthenticationHeaderValue.Parse(Request.Headers["Authorization"]);
+ if (authHeader.Parameter == null) return false;
+ } catch {
+ return false;
+ }
+
+ return true;
+ }
+
+ protected bool HasApiPermission(string permission_key) {
+ var permission_claim = User.Claims.SingleOrDefault(c => c.Type == permission_key);
+ return permission_claim is {
+ Value: "True"
+ };
+ }
+} \ No newline at end of file