Merge pull request #116 from lvchkn/paged-api-response

Change `/api/stories` return object to include the total number of pages

.env.example

@@ -0,0 +1,8 @@
+RMQ_USER=
+RMQ_PW=
+POSTGRES_DB=
+POSTGRES_USER=
+POSTGRES_PW=
+GH_APP_NAME=
+GH_CLIENT_ID=
+GH_CLIENT_SECRET=

Application/Paging/PagedStoriesDto.cs

@@ -0,0 +1,9 @@
+using Application.Stories;
+
+namespace Application.Paging;
+
+public record PagedStoriesDto
+{
+    public List<StoryDto> Stories { get; init; } = new ();
+    public int TotalPagesCount { get; init; }
+}

Application/Paging/PagingExtension.cs

@@ -0,0 +1,20 @@
+using Application.Stories;
+
+namespace Application.Paging;
+
+public static class PagingExtension
+{
+    public static PagedStoriesDto Paginate(this IEnumerable<StoryDto> stories, int skip, int take)
+    {
+        if (take <= 0) throw new ArgumentOutOfRangeException();
+
+        var pagedStories = stories.Skip(skip).Take(take).ToList();
+        var totalPagesCount = (int)Math.Ceiling((double)stories.Count() / take);
+
+        return new ()
+        {
+            Stories = pagedStories,
+            TotalPagesCount = totalPagesCount,
+        };
+    }
+}

Application/Stories/IStoriesRepository.cs

@@ -8,7 +8,7 @@ public interface IStoriesRepository
     Task<Story?> GetByIdAsync(int id);
     Task<List<Story>> GetByAuthorAsync(string author);
     Task<List<Story>> GetAllAsync();
-    List<Story> GetAll(IEnumerable<SortingParameters> sortingParameters, string? search, int skip, int take);
+    List<Story> GetAll(IEnumerable<SortingParameters> sortingParameters, string? search);
     Task AddAsync(Story story);
     Task UpdateAsync(int id, Story updatedStory);
     Task DeleteAsync(int id);

Application/Stories/IStoriesService.cs

@@ -1,8 +1,10 @@
+using Application.Paging;
+
 namespace Application.Stories;
 
 public interface IStoriesService
 {
     Task AddAsync(StoryDto storyDto);
     Task<List<StoryDto>> GetAllAsync();
-    List<StoryDto> GetStories(string? orderBy, string? search, int pageNumber, int pageSize);
+    PagedStoriesDto GetStories(string? orderBy, string? search, int pageNumber, int pageSize);
 }

Application/Stories/StoriesService.cs

@@ -1,3 +1,4 @@
+using Application.Paging;
 using Application.Sort;
 using AutoMapper;
 using Domain.Entities;
@@ -35,17 +36,19 @@ public async Task<List<StoryDto>> GetAllAsync()
         return _mapper.Map<List<StoryDto>>(stories);
     }
 
-    public List<StoryDto> GetStories(string? orderBy, string? search, int pageNumber, int pageSize)
+    public PagedStoriesDto GetStories(string? orderBy, string? search, int pageNumber, int pageSize)
     {
         var parsedSortingParameters = _sortingParameteresParser.Parse(orderBy);
         var skip = (pageNumber - 1) * pageSize;
         var take = pageSize;
 
-        var sortedStories = _storiesRepository.GetAll(parsedSortingParameters, search, skip, take);
+        var sortedStories = _storiesRepository.GetAll(parsedSortingParameters, search);
 
         var dtos = _mapper.Map<List<StoryDto>>(sortedStories);
         var rankedStories = _rankingService.Rank(dtos);
 
-        return rankedStories;
+        var pagedStories = rankedStories.Paginate(skip, take);
+
+        return pagedStories;
     }
-}
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,14 @@
+This is a respectful environment for everyone before everything else!
+
+I'd like to ensure that everyone can participate in this project in a friendly and constructive manner.
+
+So, the **standard guidelines** are:
+
+- Be respectful
+- Be collaborative
+
+The things I consider **inappropriate**:
+
+- Personal attacks, insults, or derogatory comments.
+- Posting or sharing explicit content.
+- Sharing personal information without consent.

HackerNewsCommentsFeed/Configuration/CustomExceptionHandler.cs

@@ -36,6 +36,7 @@ private static Task HandleExceptionAsync(HttpContext httpContext, Exception exce
         {
             NotFoundException => (int) HttpStatusCode.NotFound,
             AlreadyExistsException => (int) HttpStatusCode.BadRequest,
+            ArgumentException => (int) HttpStatusCode.BadRequest,
             _ => (int) HttpStatusCode.InternalServerError
         };
 

HackerNewsCommentsFeed/Configuration/Registrations.cs

@@ -42,7 +42,11 @@ private static IServiceCollection AddGithubAuth(this IServiceCollection services
             options.DefaultSignInScheme = CookieAuthenticationDefaults.AuthenticationScheme;
             options.DefaultChallengeScheme = "Github";
         })
-        .AddCookie()
+        .AddCookie(CookieAuthenticationDefaults.AuthenticationScheme, options => {
+            options.Cookie.SameSite = SameSiteMode.None;
+            options.Cookie.HttpOnly = true;
+            options.Cookie.SecurePolicy = CookieSecurePolicy.Always;
+        })
         .AddOAuth("Github", config =>
         {
             config.ClientId = clientId ?? string.Empty;

Infrastructure/Db/Repositories/StoriesRepository.cs

@@ -61,7 +61,7 @@ public async Task<List<Story>> GetAllAsync()
         return stories;
     }
 
-    public List<Story> GetAll(IEnumerable<SortingParameters> sortingParameters, string? search, int skip, int take)
+    public List<Story> GetAll(IEnumerable<SortingParameters> sortingParameters, string? search)
     {
         var included = _dbContext.Stories
             .AsNoTracking()
@@ -73,9 +73,6 @@ public List<Story> GetAll(IEnumerable<SortingParameters> sortingParameters, stri
 
         var sortedStories = _sorter
             .Sort(filteredStories, sortingParameters)
-            .OrderByDescending(s => s.Score)
-            .Skip(skip)
-            .Take(take)
             .ToList();
 
         return sortedStories;

README.md

@@ -1,3 +1,29 @@
 [![.NET](https://github.com/lvchkn/Hackernews-Feed/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/lvchkn/Hackernews-Feed/actions/workflows/build-and-test.yml)
 
 # Hackernews-Feed
+
+This API acts as a kind of proxy backend for my custom [HN client](https://github.com/lvchkn/hn-client) and provides RESTful endpoints that allow for sorting, filtering and paging stories from Hackernews.
+
+This is only partially implemented and still is under development, but the idea is that users may authenticate to the custom client page via Github, specify their topics of interest, and get a personal stories feed based on their preferences.
+
+## How to run locally
+
+1. Create a `.env` file in the project's root directory and fill it in according to the `.env.example` file.
+1. Start the compose stack
+
+   ```bash
+   docker compose -f docker-compose.local up
+   ```
+
+1. Run the following command from the root's directory:
+
+   ```bash
+    dotnet run --project HackerNewsCommentsFeed/HackerNewsCommentsFeed.csproj
+   ```
+
+1. Navigate to `http://localhost/index.html` or `https://localhost:7245` to see the Swagger OpenAPI definition.
+
+## How to run the tests
+
+Just run the `dotnet test` command in the project's root directory.
+Note that the entries in the `.env` file related to the authentication must be prepopulated before running the tests to avoid errors during the test server's startup.

Tests/Integration/DataSeeder.cs

@@ -5,11 +5,12 @@ namespace Tests.Integration;
 
 public static class DataSeeder
 {
-    public static void SeedStories(this AppDbContext dbContext)
+    public static int SeedStories(this AppDbContext dbContext)
     {
         dbContext.Stories.RemoveRange(dbContext.Stories);
-
-        dbContext.Stories?.AddRange(
+
+        var stories = new []
+        {
             new Story()
             {
                 By = "User1",
@@ -44,10 +45,14 @@ public static void SeedStories(this AppDbContext dbContext)
                 Title = "B Story",
                 Score = 250,
                 Time = 9,
-            }
-        );
+            }, 
+        };
+
+        dbContext.Stories?.AddRange(stories);
 
         dbContext.SaveChanges();
+
+        return stories.Length;
     }
 
     public static void SeedUsers(this AppDbContext dbContext)