Merge pull request 'Enhanced role-based authorization and improved system messages.' (#3) from Feat/HttpPut into main

Reviewed-on: #3

survey-beta/Controllers/AnalyticsController.cs

@@ -1,6 +1,8 @@
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc;
+using survey_beta.Models;
+using System;
+using System.Threading.Tasks;
+using survey_beta.DTOs.Update;
 
 namespace survey_beta.Controllers
 {
@@ -8,23 +10,37 @@ namespace survey_beta.Controllers
     [ApiController]
     public class AnalyticsController : ControllerBase
     {
-        private readonly AnalyticsServices _analyticsServices;
+        private readonly AnalyticsServices _analyticsService;
 
-        public AnalyticsController(AnalyticsServices analyticsServices)
+        public AnalyticsController(AnalyticsServices analyticsService)
         {
-            _analyticsServices = analyticsServices;
+            _analyticsService = analyticsService;
         }
-        [HttpGet("survey/{surveyId}")]
-        public IActionResult GetSurveyAnalytics(string surveyId)
+
+        [HttpGet("{surveyId}/statistics")]
+        public async Task<ActionResult<SurveyStats>> GetSurveyStatistics(string surveyId)
         {
-            var analytics = _analyticsServices.GetAggregatedSurveyResponses(surveyId);
-            if (analytics == null) return NotFound("Survey analytics not found.");
-            return Ok(analytics);
+            if (string.IsNullOrWhiteSpace(surveyId))
+                return BadRequest(new { error = "Survey ID is required." });
+
+            var statistics = await Task.Run(() => _analyticsService.GetAggregatedSurveyResponses(surveyId));
+
+            if (statistics == null)
+                return NotFound(new { error = "No data available for the given survey." });
+
+            return Ok(statistics);
         }
-        [HttpGet("export/{surveyId}")]
-        public async Task<IActionResult> ExportSurveyData(string surveyId)
+        [HttpGet("{surveyId}/export")]
+        public async Task<IActionResult> ExportSurveyStatistics(string surveyId)
         {
-            return await _analyticsServices.ExportResponsesToCsv(surveyId);
+            if (string.IsNullOrWhiteSpace(surveyId))
+                return BadRequest(new { error = "Survey ID is required." });
+            var fileResult = await _analyticsService.ExportResponsesToCsv(surveyId);
+
+            if (fileResult == null)
+                return NotFound(new { error = "No data available to export." });
+
+            return fileResult;
         }
     }
-}
+}

survey-beta/Controllers/ResponsesController.cs

@@ -23,7 +23,7 @@ namespace survey_beta.Controllers
             try
             {
                 await _responsesService.AddResponseAsync(request);
-                return Ok(new { message = "Response added successfully." });
+                return Ok(new { message = "Your response has been submitted successfully." });
             }
             catch (Exception ex)
             {

survey-beta/Controllers/UsersController.cs

@@ -38,7 +38,7 @@ public class UserController : ControllerBase
         }
         catch (Exception ex)
         {
-            return Unauthorized(ex.Message);
+            return Unauthorized(new { error = "Invalid credentials. Please check your username and password." });
         }
     }
     //[Authorize]
@@ -81,7 +81,7 @@ public class UserController : ControllerBase
     {
         var users = await _usersServices.GetUserByIdAsync(id);
         if (users == null)
-            return NotFound();
+            return NotFound(new { message = "The specified user does not exist." });
         var result = await _usersServices.DeleteUsersAsync(id);
         return Ok(result);
     }

survey-beta/Program.cs

@@ -87,5 +87,4 @@ app.UseHttpsRedirection();
 app.UseAuthentication();
 app.UseAuthorization();
 app.MapControllers();
-
 app.Run();

survey-beta/Services/AnalyticsServices.cs

@@ -1,4 +1,5 @@
 using AutoMapper;
+using Microsoft.AspNetCore.Http.HttpResults;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
 using survey_beta.DataBaseContext;
@@ -33,7 +34,6 @@ public class AnalyticsServices
 
         SaveAnalytics(surveyId, analyticsData);
     }
-
     private SurveyStats CalculateAnalytics(List<Response> responses)
     {
         var answerFrequency = new Dictionary<string, int>();
@@ -89,7 +89,6 @@ public class AnalyticsServices
 
         return CalculateAnalytics(responses);
     }
-
     public async Task<IActionResult> ExportResponsesToCsv(string surveyId)
     {
         var responses = await _context.Responses
@@ -100,21 +99,43 @@ public class AnalyticsServices
             .ThenInclude(a => a.Choice)
             .ToListAsync();
 
+        if (!responses.Any())
+        {
+            return null;
+        }
         var csvLines = new List<string>
     {
-        "ResponseId,Question,ChoiceText"
+        "Survey Analysis",
+        $"Total Responses: {responses.Count}",
+        "",
+        "ResponseId,Question,ChoiceText,ChoiceCount,ChoicePercentage"
     };
-
+        var choiceStats = responses
+            .SelectMany(r => r.Answers)
+            .Where(a => a.Choice != null)
+            .GroupBy(a => new { a.Question.Content, a.Choice.Letter })
+            .Select(g => new
+            {
+                Question = g.Key.Content,
+                Choice = g.Key.Letter,
+                Count = g.Count(),
+                Percentage = (double)g.Count() / responses.Count * 100
+            })
+            .OrderByDescending(s => s.Count)
+            .ToList();
         foreach (var response in responses)
         {
             foreach (var answer in response.Answers)
             {
                 var questionText = answer.Question.Content;
-                csvLines.Add($"{response.Id},{questionText}");
+                var choiceText = answer.Choice?.Letter ?? "N/A";
+
+                var choiceStat = choiceStats.FirstOrDefault(s => s.Question == questionText && s.Choice == choiceText);
+
+                csvLines.Add($"{response.Id},{questionText},{choiceText},{choiceStat?.Count ?? 0},{choiceStat?.Percentage.ToString("0.00") ?? "0"}%");
             }
         }
-
-        var fileName = "Survey_Responses.csv";
+        var fileName = $"Survey_{surveyId}_Analysis.csv";
         var fileBytes = Encoding.UTF8.GetBytes(string.Join(Environment.NewLine, csvLines));
 
         return new FileContentResult(fileBytes, "text/csv")

survey-beta/Services/ResponsesServices.cs

@@ -29,15 +29,11 @@ public class ResponsesService
             CreatedAt = DateTime.UtcNow,
         };
 
-        foreach (var answer in responseDto.Answers)
+        response.Answers = responseDto.Answers.Select(answer => new Answer
         {
-            var answerEntity = new Answer
-            {
-                QuestionId = answer.QuestionId,
-                ResponseId = response.Id
-            };
-            response.Answers.Add(answerEntity);
-        }
+            QuestionId = answer.QuestionId,
+            ResponseId = response.Id
+        }).ToList();
 
         await _context.Responses.AddAsync(response);
         await _context.SaveChangesAsync();

survey-beta/Services/SurveyServices.cs

@@ -121,17 +121,17 @@ public class SurveyService
         await _context.SaveChangesAsync();
         return true;
     }
-    public async Task<bool> DeleteSurveyAsync(string id)
+    public async Task<bool> DeleteSurveyAsync(string id, CancellationToken cancellationToken)
     {
-        var survey = await _context.Surveys.AsNoTracking()
+        var survey = await _context.Surveys
             .Include(s => s.Questions)
-            .ThenInclude(q => q.Choices)
-            .FirstOrDefaultAsync(s => s.Id == id);
+                .ThenInclude(q => q.Choices)
+            .FirstOrDefaultAsync(s => s.Id == id, cancellationToken);
 
         if (survey == null) return false;
 
         _context.Surveys.Remove(survey);
-        await _context.SaveChangesAsync();
+        await _context.SaveChangesAsync(cancellationToken);
         return true;
     }
 }

survey-beta/Services/UsersServices.cs

@@ -36,9 +36,11 @@ public class UsersServices
         var result = await _userManager.CreateAsync(user, createUserDto.Password);
         if (!result.Succeeded)
         {
-            throw new Exception("Failed to create user: " + string.Join(", ", result.Errors.Select(e => e.Description)));
+            if (!result.Succeeded)
+            {
+                throw new Exception("Failed to create user. Please check your inputs and try again.");
+            }
         }
-
         var userDto = _mapper.Map<UserDto>(user);
         userDto.Token = GenerateJwtToken(user);
 
@@ -85,13 +87,17 @@ public class UsersServices
     }
     private string GenerateJwtToken(User user)
     {
-        var claims = new[]
-        {
-            new Claim(JwtRegisteredClaimNames.Sub, user.UserName),
-            new Claim(JwtRegisteredClaimNames.Jti, Guid.NewGuid().ToString()),
-            new Claim(ClaimTypes.Email, user.Email),
-            new Claim(ClaimTypes.Name, user.Fullname)
-        };
+        var userRoles = _userManager.GetRolesAsync(user).Result;
+
+        var claims = new List<Claim>
+    {
+        new Claim(JwtRegisteredClaimNames.Sub, user.UserName),
+        new Claim(JwtRegisteredClaimNames.Jti, Guid.NewGuid().ToString()),
+        new Claim(ClaimTypes.Email, user.Email),
+        new Claim(ClaimTypes.Name, user.Fullname)
+    };
+
+        claims.AddRange(userRoles.Select(role => new Claim(ClaimTypes.Role, role)));
 
         var key = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(_configuration["Jwt:Key"]));
         var creds = new SigningCredentials(key, SecurityAlgorithms.HmacSha256);
@@ -100,7 +106,7 @@ public class UsersServices
             issuer: _configuration["Jwt:Issuer"],
             audience: _configuration["Jwt:Audience"],
             claims: claims,
-            expires: DateTime.Now.AddMinutes(30),
+            expires: DateTime.UtcNow.AddMinutes(30),
             signingCredentials: creds);
 
         return new JwtSecurityTokenHandler().WriteToken(token);

survey-beta/bin/Debug/net8.0/survey-beta.deps.json

@@ -9,6 +9,7 @@
       "survey-beta/1.0.0": {
         "dependencies": {
           "AutoMapper.Extensions.Microsoft.DependencyInjection": "12.0.0",
+          "CsvHelper": "33.0.1",
           "EntityFramework": "6.5.1",
           "Microsoft.AspNet.Identity.EntityFramework": "2.2.4",
           "Microsoft.AspNetCore.Authentication.JwtBearer": "8.0.0",
@@ -48,6 +49,14 @@
           }
         }
       },
+      "CsvHelper/33.0.1": {
+        "runtime": {
+          "lib/net8.0/CsvHelper.dll": {
+            "assemblyVersion": "33.0.0.0",
+            "fileVersion": "33.0.1.24"
+          }
+        }
+      },
       "EntityFramework/6.5.1": {
         "dependencies": {
           "Microsoft.CSharp": "4.7.0",
@@ -1125,6 +1134,13 @@
       "path": "automapper.extensions.microsoft.dependencyinjection/12.0.0",
       "hashPath": "automapper.extensions.microsoft.dependencyinjection.12.0.0.nupkg.sha512"
     },
+    "CsvHelper/33.0.1": {
+      "type": "package",
+      "serviceable": true,
+      "sha512": "sha512-fev4lynklAU2A9GVMLtwarkwaanjSYB4wUqO2nOJX5hnzObORzUqVLe+bDYCUyIIRQM4o5Bsq3CcyJR89iMmEQ==",
+      "path": "csvhelper/33.0.1",
+      "hashPath": "csvhelper.33.0.1.nupkg.sha512"
+    },
     "EntityFramework/6.5.1": {
       "type": "package",
       "serviceable": true,

survey-beta/obj/Debug/net8.0/ApiEndpoints.json

@@ -1,8 +1,8 @@
 [
   {
     "ContainingType": "survey_beta.Controllers.AnalyticsController",
-    "Method": "ExportSurveyData",
-    "RelativePath": "api/Analytics/export/{surveyId}",
+    "Method": "ExportSurveyStatistics",
+    "RelativePath": "api/Analytics/{surveyId}/export",
     "HttpMethod": "GET",
     "IsController": true,
     "Order": 0,
@@ -17,8 +17,8 @@
   },
   {
     "ContainingType": "survey_beta.Controllers.AnalyticsController",
-    "Method": "GetSurveyAnalytics",
-    "RelativePath": "api/Analytics/survey/{surveyId}",
+    "Method": "GetSurveyStatistics",
+    "RelativePath": "api/Analytics/{surveyId}/statistics",
     "HttpMethod": "GET",
     "IsController": true,
     "Order": 0,
@@ -29,7 +29,17 @@
         "IsRequired": true
       }
     ],
-    "ReturnTypes": []
+    "ReturnTypes": [
+      {
+        "Type": "survey_beta.DTOs.Update.SurveyStats",
+        "MediaTypes": [
+          "text/plain",
+          "application/json",
+          "text/json"
+        ],
+        "StatusCode": 200
+      }
+    ]
   },
   {
     "ContainingType": "survey_beta.Controllers.ResponseController",

survey-beta/obj/Debug/net8.0/survey-beta.AssemblyInfo.cs

@@ -14,7 +14,7 @@ using System.Reflection;
 [assembly: System.Reflection.AssemblyCompanyAttribute("survey-beta")]
 [assembly: System.Reflection.AssemblyConfigurationAttribute("Debug")]
 [assembly: System.Reflection.AssemblyFileVersionAttribute("1.0.0.0")]
-[assembly: System.Reflection.AssemblyInformationalVersionAttribute("1.0.0+b9036d8b7a60afe583ac07dee1c8d53204b07278")]
+[assembly: System.Reflection.AssemblyInformationalVersionAttribute("1.0.0+5c735417f244b7740bc440f2ef03d57b0374188b")]
 [assembly: System.Reflection.AssemblyProductAttribute("survey-beta")]
 [assembly: System.Reflection.AssemblyTitleAttribute("survey-beta")]
 [assembly: System.Reflection.AssemblyVersionAttribute("1.0.0.0")]

survey-beta/obj/Debug/net8.0/survey-beta.AssemblyInfoInputs.cache

@@ -1 +1 @@
-881624211deead8316978ca8e0f7ecf013b98335c33420e117fca69e5d45c51f
+7225f480dc7507f33e7c1dff9d1d2efef5e1b397dfeeaeb8ca8ea4374e21a387

survey-beta/obj/Debug/net8.0/survey-beta.csproj.CoreCompileInputs.cache

@@ -1 +1 @@
-bf4cfa75951d95a308acd245137187f2446062728bd32c1ef69e8cdd119ba91a
+3879eb678b07b384c518e4050cdef22466b66afa8fee5cacbe2c485af19a45f3

survey-beta/obj/Debug/net8.0/survey-beta.csproj.FileListAbsolute.txt

@@ -334,3 +334,4 @@ C:\Users\alioa\Source\Repos\survey-beta2\survey-beta\obj\Debug\net8.0\refint\sur
 C:\Users\alioa\Source\Repos\survey-beta2\survey-beta\obj\Debug\net8.0\survey-beta.pdb
 C:\Users\alioa\Source\Repos\survey-beta2\survey-beta\obj\Debug\net8.0\survey-beta.genruntimeconfig.cache
 C:\Users\alioa\Source\Repos\survey-beta2\survey-beta\obj\Debug\net8.0\ref\survey-beta.dll
+C:\Users\alioa\Source\Repos\survey-beta2\survey-beta\bin\Debug\net8.0\CsvHelper.dll

survey-beta/obj/project.assets.json

@@ -31,6 +31,19 @@
           "lib/netstandard2.1/AutoMapper.Extensions.Microsoft.DependencyInjection.dll": {}
         }
       },
+      "CsvHelper/33.0.1": {
+        "type": "package",
+        "compile": {
+          "lib/net8.0/CsvHelper.dll": {
+            "related": ".xml"
+          }
+        },
+        "runtime": {
+          "lib/net8.0/CsvHelper.dll": {
+            "related": ".xml"
+          }
+        }
+      },
       "EntityFramework/6.5.1": {
         "type": "package",
         "dependencies": {
@@ -1797,6 +1810,34 @@
         "lib/netstandard2.1/AutoMapper.Extensions.Microsoft.DependencyInjection.dll"
       ]
     },
+    "CsvHelper/33.0.1": {
+      "sha512": "fev4lynklAU2A9GVMLtwarkwaanjSYB4wUqO2nOJX5hnzObORzUqVLe+bDYCUyIIRQM4o5Bsq3CcyJR89iMmEQ==",
+      "type": "package",
+      "path": "csvhelper/33.0.1",
+      "files": [
+        ".nupkg.metadata",
+        ".signature.p7s",
+        "Icon.png",
+        "csvhelper.33.0.1.nupkg.sha512",
+        "csvhelper.nuspec",
+        "lib/net462/CsvHelper.dll",
+        "lib/net462/CsvHelper.xml",
+        "lib/net47/CsvHelper.dll",
+        "lib/net47/CsvHelper.xml",
+        "lib/net48/CsvHelper.dll",
+        "lib/net48/CsvHelper.xml",
+        "lib/net6.0/CsvHelper.dll",
+        "lib/net6.0/CsvHelper.xml",
+        "lib/net7.0/CsvHelper.dll",
+        "lib/net7.0/CsvHelper.xml",
+        "lib/net8.0/CsvHelper.dll",
+        "lib/net8.0/CsvHelper.xml",
+        "lib/netstandard2.0/CsvHelper.dll",
+        "lib/netstandard2.0/CsvHelper.xml",
+        "lib/netstandard2.1/CsvHelper.dll",
+        "lib/netstandard2.1/CsvHelper.xml"
+      ]
+    },
     "EntityFramework/6.5.1": {
       "sha512": "sQRP2lWg1i3aAGWqdliAM8zrGx7LHMUk+9/MoxUjwfTZYGMXvZ2JYZTlyTm1PqDxvn3c9E3U76TWDON7Y5+CVA==",
       "type": "package",
@@ -5159,6 +5200,7 @@
   "projectFileDependencyGroups": {
     "net8.0": [
       "AutoMapper.Extensions.Microsoft.DependencyInjection >= 12.0.0",
+      "CsvHelper >= 33.0.1",
       "EntityFramework >= 6.5.1",
       "Microsoft.AspNet.Identity.EntityFramework >= 2.2.4",
       "Microsoft.AspNetCore.Authentication.JwtBearer >= 8.0.0",
@@ -5221,6 +5263,10 @@
             "target": "Package",
             "version": "[12.0.0, )"
           },
+          "CsvHelper": {
+            "target": "Package",
+            "version": "[33.0.1, )"
+          },
           "EntityFramework": {
             "target": "Package",
             "version": "[6.5.1, )"

survey-beta/obj/project.nuget.cache

@@ -1,11 +1,12 @@
 {
   "version": 2,
-  "dgSpecHash": "Q9FP2JQ+UXs=",
+  "dgSpecHash": "H2wNZ0h/QSI=",
   "success": true,
   "projectFilePath": "C:\\Users\\alioa\\Source\\Repos\\survey-beta2\\survey-beta\\survey-beta.csproj",
   "expectedPackageFiles": [
     "C:\\Users\\alioa\\.nuget\\packages\\automapper\\12.0.0\\automapper.12.0.0.nupkg.sha512",
     "C:\\Users\\alioa\\.nuget\\packages\\automapper.extensions.microsoft.dependencyinjection\\12.0.0\\automapper.extensions.microsoft.dependencyinjection.12.0.0.nupkg.sha512",
+    "C:\\Users\\alioa\\.nuget\\packages\\csvhelper\\33.0.1\\csvhelper.33.0.1.nupkg.sha512",
     "C:\\Users\\alioa\\.nuget\\packages\\entityframework\\6.5.1\\entityframework.6.5.1.nupkg.sha512",
     "C:\\Users\\alioa\\.nuget\\packages\\humanizer.core\\2.14.1\\humanizer.core.2.14.1.nupkg.sha512",
     "C:\\Users\\alioa\\.nuget\\packages\\microsoft.aspnet.identity.core\\2.2.4\\microsoft.aspnet.identity.core.2.2.4.nupkg.sha512",

survey-beta/obj/survey-beta.csproj.nuget.dgspec.json

@@ -50,6 +50,10 @@
               "target": "Package",
               "version": "[12.0.0, )"
             },
+            "CsvHelper": {
+              "target": "Package",
+              "version": "[33.0.1, )"
+            },
             "EntityFramework": {
               "target": "Package",
               "version": "[6.5.1, )"

survey-beta/survey-beta.csproj

@@ -9,6 +9,7 @@
 
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="12.0.0" />
+    <PackageReference Include="CsvHelper" Version="33.0.1" />
     <PackageReference Include="EntityFramework" Version="6.5.1" />
     <PackageReference Include="Microsoft.AspNet.Identity.EntityFramework" Version="2.2.4" />
     <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.0" />
@@ -25,9 +26,4 @@
     <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="8.0.0" />
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="Controllers\" />
-    <Folder Include="Services\" />
-  </ItemGroup>
-
 </Project>