Merge pull request #3 from Transcom-DT/develop

2.1 - Bugfixes and Improvements

Transcom.SocialGuard.Api/Controllers/EmitterController.cs

@@ -9,7 +9,7 @@
 
 namespace Transcom.SocialGuard.Api.Controllers
 {
-	[ApiController, Route("api/[controller]"), Authorize(Roles = UserRole.Emitter)]
+	[ApiController, Route("api/[controller]"), Authorize]
 	public class EmitterController : ControllerBase
 	{
 		private readonly EmitterService emitterService;
@@ -29,8 +29,26 @@ public EmitterController(EmitterService emitterService)
 		public async Task<IActionResult> GetEmitterProfile()
 		{
 			Emitter emitter = await emitterService.GetEmitterAsync(HttpContext);
-			return emitter is null 
-				? StatusCode(204) 
+
+			return emitter is null
+				? StatusCode(204)
+				: StatusCode(200, emitter);
+		}
+
+		/// <summary>
+		/// Fetches specified user's Emitter profile.
+		/// </summary>
+		/// <response code="200">Returns Emitter profile</response>
+		/// <response code="404">If user's Emitter profile is not found.</response>    
+		/// <returns>Emitter profile</returns>
+		[HttpGet("{id}"), AllowAnonymous] 
+		[ProducesResponseType(typeof(Emitter), 200), ProducesResponseType(404)]
+		public async Task<IActionResult> GetEmitterProfile(string id)
+		{
+			Emitter emitter = await emitterService.GetEmitterAsync(id);
+
+			return emitter is null
+				? StatusCode(404)
 				: StatusCode(200, emitter);
 		}
 

Transcom.SocialGuard.Api/Controllers/UserController.cs

@@ -64,7 +64,7 @@ public async Task<IActionResult> FetchUser(ulong id)
 		[ProducesResponseType(201), ProducesResponseType(409)]
 		public async Task<IActionResult> InsertUserRecord([FromBody] TrustlistUser userRecord) 
 		{
-			Emitter emitter = await GetEmitterAsync();
+			Emitter emitter = await emitterService.GetEmitterAsync(HttpContext);
 
 			if (emitter is null)
 			{
@@ -93,7 +93,7 @@ public async Task<IActionResult> InsertUserRecord([FromBody] TrustlistUser userR
 		[ProducesResponseType(202), ProducesResponseType(404)]
 		public async Task<IActionResult> EscalateUserRecord([FromBody] TrustlistUser userRecord) 
 		{
-			Emitter emitter = await GetEmitterAsync();
+			Emitter emitter = await emitterService.GetEmitterAsync(HttpContext);
 
 			if (emitter is null)
 			{
@@ -124,8 +124,5 @@ public async Task<IActionResult> DeleteUserRecord(ulong id)
 			await trustlistService.DeleteUserRecordAsync(id);
 			return StatusCode(200);
 		}
-
-
-		private async Task<Emitter> GetEmitterAsync() => await emitterService.GetEmitterAsync(HttpContext);
 	}
 }

Transcom.SocialGuard.Api/Services/EmitterService.cs

@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.Http;
 using MongoDB.Driver;
+using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
 using Transcom.SocialGuard.Api.Data.Models;
 
@@ -18,9 +19,20 @@ public EmitterService(IMongoDatabase database)
 
 		public async Task<Emitter> GetEmitterAsync(HttpContext context) => (await emitters.FindAsync(e => e.Login == context.User.Identity.Name)).FirstOrDefault();
 
+		public async Task<Emitter> GetEmitterAsync(string login) => (await emitters.FindAsync(e => e.Login == login)).FirstOrDefault();
+
 		public async Task CreateOrUpdateEmitterSelfAsync(Emitter emitter, HttpContext context)
 		{
-			await emitters.InsertOneAsync(emitter with { Login = context.User.Identity.Name });
+			emitter = emitter with { Login = context.User.Identity.Name };
+
+			if ((await emitters.FindAsync(e => e.Login == emitter.Login)).Any())
+			{
+				await emitters.ReplaceOneAsync(e => e.Login == emitter.Login, emitter);
+			}
+			else
+			{
+				await emitters.InsertOneAsync(emitter);
+			}
 		}
 
 		public async Task DeleteEmitterAsync(string emitterLogin) => await emitters.FindOneAndDeleteAsync(e => e.Login == emitterLogin);

Transcom.SocialGuard.Api/Startup.cs

@@ -16,6 +16,9 @@
 using Microsoft.AspNetCore.Authentication.JwtBearer;
 using Microsoft.IdentityModel.Tokens;
 using System.Text;
+using System.Reflection;
+using System.Threading.Tasks;
+using Microsoft.OpenApi.Extensions;
 
 namespace Transcom.SocialGuard.Api
 {
@@ -27,15 +30,23 @@ public Startup(IConfiguration configuration)
 		}
 
 		public IConfiguration Configuration { get; }
+		public static string Version { get; } = typeof(Startup).Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>().InformationalVersion;
+
 
 		// This method gets called by the runtime. Use this method to add services to the container.
 		public void ConfigureServices(IServiceCollection services)
 		{
-
 			services.AddControllers();
 			services.AddSwaggerGen(c =>
 			{
-				c.SwaggerDoc("2.0", new OpenApiInfo { Title = "Natsecure SocialGuard", Version = "2.0" });
+				c.SwaggerDoc(Version, new OpenApiInfo
+				{
+					Title = "SocialGuard",
+					Version = Version,
+					Description = "Centralised Discord Trustlist to keep servers safe from known blacklisted users.",
+					Contact = new() { Name = "Transcom-DT", Url = new("https://github.com/Transcom-DT/SocialGuard") },
+					License = new() { Name = "GNU GPLv3", Url = new("https://www.gnu.org/licenses/gpl-3.0.html") },
+				});
 
 				// Set the comments path for the Swagger JSON and UI.
 				string xmlFile = $"{typeof(Startup).Assembly.GetName().Name}.xml";
@@ -122,7 +133,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 			app.UseStaticFiles();
 
 			app.UseSwagger();
-			app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/2.0/swagger.json", "Natsecure SocialGuard 2.0"));
+			app.UseSwaggerUI(c => c.SwaggerEndpoint($"/swagger/{Version}/swagger.json", $"SocialGuard {Version}"));
 
 			app.UseHttpsRedirection();
 
@@ -141,6 +152,15 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 
 			app.UseEndpoints(endpoints =>
 			{
+				/*
+				 * Remove once proper website is built.
+				 */
+				endpoints.MapGet("/", context =>
+				{
+					context.Response.Redirect("swagger/index.html");
+					return Task.CompletedTask;
+				});
+
 				endpoints.MapControllers();
 			});
 		}

Transcom.SocialGuard.Api/Transcom.SocialGuard.Api.csproj

@@ -8,6 +8,13 @@
   <PropertyGroup>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <NoWarn>$(NoWarn);1591</NoWarn>
+    <Authors>Sakura Isayeki</Authors>
+    <Company>Transcom-DT</Company>
+    <Product>SocialGuard</Product>
+    <Version>2.1.0</Version>
+    <RepositoryUrl>https://github.com/Transcom-DT/SocialGuard</RepositoryUrl>
+    <RepositoryType>Git</RepositoryType>
+    <Copyright>GNU GPLv3</Copyright>
   </PropertyGroup>
 
   <ItemGroup>