Merge pull request #56 from crupest/dev

Refactor API to be RESTful.

9 files changed, 437 insertions, 116 deletions

diff --git a/Timeline/Models/Http/Common.cs b/Timeline/Models/Http/Common.cs
index d1e95397..a9fc8a79 100644
--- a/Timeline/Models/Http/Common.cs
+++ b/Timeline/Models/Http/Common.cs
@@ -1,15 +1,9 @@
-using System.Globalization;

 using static Timeline.Resources.Models.Http.Common;

 

 namespace Timeline.Models.Http

 {

     public class CommonResponse

     {

-        internal static CommonResponse InvalidModel(string message)

-        {

-            return new CommonResponse(ErrorCodes.Http.Common.InvalidModel, message);

-        }

-

         public CommonResponse()

         {

 

@@ -25,33 +19,6 @@ namespace Timeline.Models.Http
         public string? Message { get; set; }

     }

 

-    internal static class HeaderErrorResponse

-    {

-        internal static CommonResponse BadIfNonMatch()

-        {

-            return new CommonResponse(ErrorCodes.Http.Common.Header.IfNonMatch.BadFormat, MessageHeaderIfNonMatchBad);

-        }

-    }

-

-    internal static class ContentErrorResponse

-    {

-        internal static CommonResponse TooBig(string maxLength)

-        {

-            return new CommonResponse(ErrorCodes.Http.Common.Content.TooBig,

-                string.Format(CultureInfo.CurrentCulture, MessageContentTooBig, maxLength));

-        }

-

-        internal static CommonResponse UnmatchedLength_Smaller()

-        {

-            return new CommonResponse(ErrorCodes.Http.Common.Content.UnmatchedLength_Smaller, MessageContentUnmatchedLengthSmaller);

-        }

-        internal static CommonResponse UnmatchedLength_Bigger()

-        {

-            return new CommonResponse(ErrorCodes.Http.Common.Content.UnmatchedLength_Bigger, MessageContentUnmatchedLengthBigger);

-        }

-    }

-

-

     public class CommonDataResponse<T> : CommonResponse

     {

         public CommonDataResponse()

diff --git a/Timeline/Models/Http/ErrorResponse.cs b/Timeline/Models/Http/ErrorResponse.cs
new file mode 100644
index 00000000..87516638
--- /dev/null
+++ b/Timeline/Models/Http/ErrorResponse.cs
@@ -0,0 +1,261 @@
+using static Timeline.Resources.Messages;

+

+namespace Timeline.Models.Http

+{

+

+    public static class ErrorResponse

+    {

+

+        public static class Common

+        {

+

+            public static CommonResponse InvalidModel(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.Common.InvalidModel, string.Format(Common_InvalidModel, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_InvalidModel(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.Common.InvalidModel, string.Format(message, formatArgs));

+            }

+

+            public static CommonResponse Forbid(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.Common.Forbid, string.Format(Common_Forbid, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_Forbid(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.Common.Forbid, string.Format(message, formatArgs));

+            }

+

+            public static class Header

+            {

+

+                public static CommonResponse IfNonMatch_BadFormat(params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Header.IfNonMatch_BadFormat, string.Format(Common_Header_IfNonMatch_BadFormat, formatArgs));

+                }

+

+                public static CommonResponse CustomMessage_IfNonMatch_BadFormat(string message, params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Header.IfNonMatch_BadFormat, string.Format(message, formatArgs));

+                }

+

+                public static CommonResponse ContentType_Missing(params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Header.ContentType_Missing, string.Format(Common_Header_ContentType_Missing, formatArgs));

+                }

+

+                public static CommonResponse CustomMessage_ContentType_Missing(string message, params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Header.ContentType_Missing, string.Format(message, formatArgs));

+                }

+

+                public static CommonResponse ContentLength_Missing(params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Header.ContentLength_Missing, string.Format(Common_Header_ContentLength_Missing, formatArgs));

+                }

+

+                public static CommonResponse CustomMessage_ContentLength_Missing(string message, params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Header.ContentLength_Missing, string.Format(message, formatArgs));

+                }

+

+                public static CommonResponse ContentLength_Zero(params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Header.ContentLength_Zero, string.Format(Common_Header_ContentLength_Zero, formatArgs));

+                }

+

+                public static CommonResponse CustomMessage_ContentLength_Zero(string message, params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Header.ContentLength_Zero, string.Format(message, formatArgs));

+                }

+

+            }

+

+            public static class Content

+            {

+

+                public static CommonResponse TooBig(params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Content.TooBig, string.Format(Common_Content_TooBig, formatArgs));

+                }

+

+                public static CommonResponse CustomMessage_TooBig(string message, params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Content.TooBig, string.Format(message, formatArgs));

+                }

+

+                public static CommonResponse UnmatchedLength_Smaller(params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Content.UnmatchedLength_Smaller, string.Format(Common_Content_UnmatchedLength_Smaller, formatArgs));

+                }

+

+                public static CommonResponse CustomMessage_UnmatchedLength_Smaller(string message, params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Content.UnmatchedLength_Smaller, string.Format(message, formatArgs));

+                }

+

+                public static CommonResponse UnmatchedLength_Bigger(params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Content.UnmatchedLength_Bigger, string.Format(Common_Content_UnmatchedLength_Bigger, formatArgs));

+                }

+

+                public static CommonResponse CustomMessage_UnmatchedLength_Bigger(string message, params object?[] formatArgs)

+                {

+                    return new CommonResponse(ErrorCodes.Common.Content.UnmatchedLength_Bigger, string.Format(message, formatArgs));

+                }

+

+            }

+

+        }

+

+        public static class UserCommon

+        {

+

+            public static CommonResponse NotExist(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserCommon.NotExist, string.Format(UserCommon_NotExist, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_NotExist(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserCommon.NotExist, string.Format(message, formatArgs));

+            }

+

+        }

+

+        public static class TokenController

+        {

+

+            public static CommonResponse Create_BadCredential(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Create_BadCredential, string.Format(TokenController_Create_BadCredential, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_Create_BadCredential(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Create_BadCredential, string.Format(message, formatArgs));

+            }

+

+            public static CommonResponse Verify_BadFormat(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Verify_BadFormat, string.Format(TokenController_Verify_BadFormat, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_Verify_BadFormat(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Verify_BadFormat, string.Format(message, formatArgs));

+            }

+

+            public static CommonResponse Verify_UserNotExist(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Verify_UserNotExist, string.Format(TokenController_Verify_UserNotExist, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_Verify_UserNotExist(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Verify_UserNotExist, string.Format(message, formatArgs));

+            }

+

+            public static CommonResponse Verify_OldVersion(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Verify_OldVersion, string.Format(TokenController_Verify_OldVersion, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_Verify_OldVersion(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Verify_OldVersion, string.Format(message, formatArgs));

+            }

+

+            public static CommonResponse Verify_TimeExpired(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Verify_TimeExpired, string.Format(TokenController_Verify_TimeExpired, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_Verify_TimeExpired(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TokenController.Verify_TimeExpired, string.Format(message, formatArgs));

+            }

+

+        }

+

+        public static class UserController

+        {

+

+            public static CommonResponse UsernameConflict(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserController.UsernameConflict, string.Format(UserController_UsernameConflict, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_UsernameConflict(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserController.UsernameConflict, string.Format(message, formatArgs));

+            }

+

+            public static CommonResponse ChangePassword_BadOldPassword(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserController.ChangePassword_BadOldPassword, string.Format(UserController_ChangePassword_BadOldPassword, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_ChangePassword_BadOldPassword(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserController.ChangePassword_BadOldPassword, string.Format(message, formatArgs));

+            }

+

+        }

+

+        public static class UserAvatar

+        {

+

+            public static CommonResponse BadFormat_CantDecode(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserAvatar.BadFormat_CantDecode, string.Format(UserAvatar_BadFormat_CantDecode, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_BadFormat_CantDecode(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserAvatar.BadFormat_CantDecode, string.Format(message, formatArgs));

+            }

+

+            public static CommonResponse BadFormat_UnmatchedFormat(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserAvatar.BadFormat_UnmatchedFormat, string.Format(UserAvatar_BadFormat_UnmatchedFormat, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_BadFormat_UnmatchedFormat(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserAvatar.BadFormat_UnmatchedFormat, string.Format(message, formatArgs));

+            }

+

+            public static CommonResponse BadFormat_BadSize(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserAvatar.BadFormat_BadSize, string.Format(UserAvatar_BadFormat_BadSize, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_BadFormat_BadSize(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.UserAvatar.BadFormat_BadSize, string.Format(message, formatArgs));

+            }

+

+        }

+

+        public static class TimelineController

+        {

+

+            public static CommonResponse MemberPut_NotExist(params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TimelineController.MemberPut_NotExist, string.Format(TimelineController_MemberPut_NotExist, formatArgs));

+            }

+

+            public static CommonResponse CustomMessage_MemberPut_NotExist(string message, params object?[] formatArgs)

+            {

+                return new CommonResponse(ErrorCodes.TimelineController.MemberPut_NotExist, string.Format(message, formatArgs));

+            }

+

+        }

+

+    }

+

+}
\ No newline at end of file
diff --git a/Timeline/Models/Http/Timeline.cs b/Timeline/Models/Http/Timeline.cs
deleted file mode 100644
index 06b88ad1..00000000
--- a/Timeline/Models/Http/Timeline.cs
+++ /dev/null
@@ -1,45 +0,0 @@
-using System;

-using System.Collections.Generic;

-using System.ComponentModel.DataAnnotations;

-using System.Linq;

-using System.Threading.Tasks;

-using Timeline.Entities;

-

-namespace Timeline.Models.Http

-{

-    public class TimelinePostCreateRequest

-    {

-        [Required(AllowEmptyStrings = true)]

-        public string Content { get; set; } = default!;

-

-        public DateTime? Time { get; set; }

-    }

-

-    public class TimelinePostCreateResponse

-    {

-        public long Id { get; set; }

-

-        public DateTime Time { get; set; }

-    }

-

-    public class TimelinePostDeleteRequest

-    {

-        [Required]

-        public long? Id { get; set; }

-    }

-

-    public class TimelinePropertyChangeRequest

-    {

-        public string? Description { get; set; }

-

-        public TimelineVisibility? Visibility { get; set; }

-    }

-

-    [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "This is a DTO class.")]

-    public class TimelineMemberChangeRequest

-    {

-        public List<string>? Add { get; set; }

-

-        public List<string>? Remove { get; set; }

-    }

-}

diff --git a/Timeline/Models/Http/TimelineCommon.cs b/Timeline/Models/Http/TimelineCommon.cs
new file mode 100644
index 00000000..febb8186
--- /dev/null
+++ b/Timeline/Models/Http/TimelineCommon.cs
@@ -0,0 +1,44 @@
+using System;

+using System.Collections.Generic;

+

+namespace Timeline.Models.Http

+{

+    public enum TimelineVisibility

+    {

+        /// <summary>

+        /// All people including those without accounts.

+        /// </summary>

+        Public,

+        /// <summary>

+        /// Only people signed in.

+        /// </summary>

+        Register,

+        /// <summary>

+        /// Only member.

+        /// </summary>

+        Private

+    }

+

+    public class TimelinePostInfo

+    {

+        public long Id { get; set; }

+        public string Content { get; set; } = default!;

+        public DateTime Time { get; set; }

+        public UserInfo Author { get; set; } = default!;

+        public DateTime LastUpdated { get; set; } = default!;

+    }

+

+    [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "This is a DTO class.")]

+    public class BaseTimelineInfo

+    {

+        public string Description { get; set; } = default!;

+        public UserInfo Owner { get; set; } = default!;

+        public TimelineVisibility Visibility { get; set; }

+        public List<UserInfo> Members { get; set; } = default!;

+    }

+

+    public class TimelineInfo : BaseTimelineInfo

+    {

+        public string Name { get; set; } = default!;

+    }

+}

diff --git a/Timeline/Models/Http/TimelineController.cs b/Timeline/Models/Http/TimelineController.cs
new file mode 100644
index 00000000..f9a4d3e5
--- /dev/null
+++ b/Timeline/Models/Http/TimelineController.cs
@@ -0,0 +1,20 @@
+using System;

+using System.ComponentModel.DataAnnotations;

+

+namespace Timeline.Models.Http

+{

+    public class TimelinePostCreateRequest

+    {

+        [Required(AllowEmptyStrings = true)]

+        public string Content { get; set; } = default!;

+

+        public DateTime? Time { get; set; }

+    }

+

+    public class TimelinePatchRequest

+    {

+        public string? Description { get; set; }

+

+        public TimelineVisibility? Visibility { get; set; }

+    }

+}

diff --git a/Timeline/Models/Http/Token.cs b/Timeline/Models/Http/TokenController.cs
index ea8b59ed..ea8b59ed 100644
--- a/Timeline/Models/Http/Token.cs
+++ b/Timeline/Models/Http/TokenController.cs
diff --git a/Timeline/Models/Http/User.cs b/Timeline/Models/Http/User.cs
deleted file mode 100644
index 516c1329..00000000
--- a/Timeline/Models/Http/User.cs
+++ /dev/null
@@ -1,38 +0,0 @@
-using System.ComponentModel.DataAnnotations;

-using Timeline.Models.Validation;

-

-namespace Timeline.Models.Http

-{

-    public class UserPutRequest

-    {

-        [Required]

-        public string Password { get; set; } = default!;

-        [Required]

-        public bool? Administrator { get; set; }

-    }

-

-    public class UserPatchRequest

-    {

-        public string? Password { get; set; }

-        public bool? Administrator { get; set; }

-    }

-

-    public class ChangeUsernameRequest

-    {

-        [Required]

-        [Username]

-        public string OldUsername { get; set; } = default!;

-

-        [Required]

-        [Username]

-        public string NewUsername { get; set; } = default!;

-    }

-

-    public class ChangePasswordRequest

-    {

-        [Required]

-        public string OldPassword { get; set; } = default!;

-        [Required]

-        public string NewPassword { get; set; } = default!;

-    }

-}

diff --git a/Timeline/Models/Http/UserController.cs b/Timeline/Models/Http/UserController.cs
new file mode 100644
index 00000000..e4c95cbd
--- /dev/null
+++ b/Timeline/Models/Http/UserController.cs
@@ -0,0 +1,53 @@
+using AutoMapper;

+using System.ComponentModel.DataAnnotations;

+using Timeline.Models.Validation;

+using Timeline.Services;

+

+namespace Timeline.Models.Http

+{

+    public class UserPatchRequest

+    {

+        [Username]

+        public string? Username { get; set; }

+

+        [MinLength(1)]

+        public string? Password { get; set; }

+

+        [Nickname]

+        public string? Nickname { get; set; }

+

+        public bool? Administrator { get; set; }

+    }

+

+    public class CreateUserRequest

+    {

+        [Required, Username]

+        public string Username { get; set; } = default!;

+

+        [Required, MinLength(1)]

+        public string Password { get; set; } = default!;

+

+        [Required]

+        public bool? Administrator { get; set; }

+

+        [Nickname]

+        public string? Nickname { get; set; }

+    }

+

+    public class ChangePasswordRequest

+    {

+        [Required(AllowEmptyStrings = false)]

+        public string OldPassword { get; set; } = default!;

+        [Required(AllowEmptyStrings = false)]

+        public string NewPassword { get; set; } = default!;

+    }

+

+    public class UserControllerAutoMapperProfile : Profile

+    {

+        public UserControllerAutoMapperProfile()

+        {

+            CreateMap<UserPatchRequest, User>(MemberList.Source);

+            CreateMap<CreateUserRequest, User>(MemberList.Source);

+        }

+    }

+}

diff --git a/Timeline/Models/Http/UserInfo.cs b/Timeline/Models/Http/UserInfo.cs
new file mode 100644
index 00000000..0d1d702b
--- /dev/null
+++ b/Timeline/Models/Http/UserInfo.cs
@@ -0,0 +1,59 @@
+using AutoMapper;

+using Microsoft.AspNetCore.Mvc;

+using Microsoft.AspNetCore.Mvc.Infrastructure;

+using Microsoft.AspNetCore.Mvc.Routing;

+using Timeline.Controllers;

+using Timeline.Services;

+

+namespace Timeline.Models.Http

+{

+    public class UserInfo

+    {

+        public string Username { get; set; } = default!;

+        public string Nickname { get; set; } = default!;

+        public bool? Administrator { get; set; } = default!;

+#pragma warning disable CA1707 

+        public UserInfoLinks? _links { get; set; }

+#pragma warning restore CA1707

+    }

+

+    public class UserInfoLinks

+    {

+        public string Avatar { get; set; } = default!;

+        public string Timeline { get; set; } = default!;

+    }

+

+    public class UserInfoLinksValueResolver : IValueResolver<User, UserInfo, UserInfoLinks?>

+    {

+        private readonly IActionContextAccessor _actionContextAccessor;

+        private readonly IUrlHelperFactory _urlHelperFactory;

+

+        public UserInfoLinksValueResolver(IActionContextAccessor actionContextAccessor, IUrlHelperFactory urlHelperFactory)

+        {

+            _actionContextAccessor = actionContextAccessor;

+            _urlHelperFactory = urlHelperFactory;

+        }

+

+        public UserInfoLinks? Resolve(User source, UserInfo destination, UserInfoLinks? destMember, ResolutionContext context)

+        {

+            if (_actionContextAccessor.ActionContext == null)

+                return null;

+

+            var urlHelper = _urlHelperFactory.GetUrlHelper(_actionContextAccessor.ActionContext);

+            var result = new UserInfoLinks

+            {

+                Avatar = urlHelper.ActionLink(nameof(UserAvatarController.Get), nameof(UserAvatarController)[0..^nameof(Controller).Length], new { destination.Username }),

+                Timeline = urlHelper.ActionLink(nameof(PersonalTimelineController.TimelineGet), nameof(PersonalTimelineController)[0..^nameof(Controller).Length], new { destination.Username })

+            };

+            return result;

+        }

+    }

+

+    public class UserInfoAutoMapperProfile : Profile

+    {

+        public UserInfoAutoMapperProfile()

+        {

+            CreateMap<User, UserInfo>().ForMember(u => u._links, opt => opt.MapFrom<UserInfoLinksValueResolver>());

+        }

+    }

+}