Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds GET products/all for privileged users #237

Merged
merged 4 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ public interface IProductService : IDisposable
Task<IEnumerable<Product>> GetPublicProductsAsync();
Task<IEnumerable<Product>> GetProductsForUserAsync(User user);
Task<Product> GetProductAsync(int productId);
Task<IEnumerable<Product>> GetAllProductsAsync();
Task<ChangedProductResponse> AddProduct(AddProductRequest product);

Task<ChangedProductResponse> UpdateProduct(UpdateProductRequest product);
Expand Down
8 changes: 8 additions & 0 deletions coffeecard/CoffeeCard.Library/Services/v2/ProductService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ private async Task<IEnumerable<Product>> GetProductsAsync(UserGroup userGroup)
.ToListAsync();
}

public async Task<IEnumerable<Product>> GetAllProductsAsync()
{
return await _context.Products
.OrderBy(p => p.Id)
.Include(p => p.ProductUserGroup)
.ToListAsync();
}

public async Task<Product> GetProductAsync(int productId)
{
var product = await _context.Products
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ namespace CoffeeCard.Models.DataTransferObjects.v2.Products
/// "name": "Coffee clip card",
/// "description": "Coffee clip card of 10 clips",
/// "isPerk": true,
/// "visible": true,
/// "AllowedUserGroups": ["Manager", "Board"]
/// }
/// </example>
Expand Down Expand Up @@ -68,6 +69,14 @@ public class ProductResponse
[Required]
public bool IsPerk { get; set; }

/// <summary>
/// Visibility of products for users
/// </summary>
/// <value>Product visibility</value>
/// <example>true</example>
[Required]
public bool Visible { get; set; }

/// <summary>
/// Decides the user groups that can access the product.
/// </summary>
Expand Down
144 changes: 129 additions & 15 deletions coffeecard/CoffeeCard.Tests.Unit/Services/v2/ProductServiceTest.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Threading.Tasks;
using CoffeeCard.Common.Configuration;
Expand Down Expand Up @@ -70,16 +70,14 @@ await productService.UpdateProduct(new UpdateProductRequest()
AllowedUserGroups = new List<UserGroup>() { UserGroup.Customer, UserGroup.Board }
});

var expected = new List<UserGroup>
{
UserGroup.Customer, UserGroup.Board
};

var result = await productService.GetProductAsync(1);

Assert.Collection<UserGroup>(expected,
e => e.Equals(UserGroup.Customer),
e => e.Equals(UserGroup.Board));
Assert.Collection<ProductUserGroup>(result.ProductUserGroup,
e => Assert.Equal(UserGroup.Customer, e.UserGroup),
e => Assert.Equal(UserGroup.Board, e.UserGroup));

Assert.DoesNotContain(UserGroup.Barista, result.ProductUserGroup.Select(e => e.UserGroup));
Assert.DoesNotContain(UserGroup.Manager, result.ProductUserGroup.Select(e => e.UserGroup));
}

[Fact(DisplayName = "AddProduct adds only selected user groups")]
Expand Down Expand Up @@ -113,16 +111,132 @@ public async Task AddProduct_Sets_Correct_UserGroups()

await productService.AddProduct(p);

var expected = new List<UserGroup>
var result = await productService.GetProductAsync(1);

Assert.Collection<ProductUserGroup>(result.ProductUserGroup,
e => Assert.Equal(UserGroup.Manager, e.UserGroup),
e => Assert.Equal(UserGroup.Board, e.UserGroup));
}

[Fact(DisplayName = "GetAllProducts shows non-visible products")]
public async Task GetAllProducts_Returns_Non_Visible_Products()
{
var builder = new DbContextOptionsBuilder<CoffeeCardContext>()
.UseInMemoryDatabase(nameof(GetAllProducts_Returns_Non_Visible_Products));

var databaseSettings = new DatabaseSettings
{
UserGroup.Manager, UserGroup.Board
SchemaName = "test"
};
var environmentSettings = new EnvironmentSettings()
{
EnvironmentType = EnvironmentType.Test
};

var result = await productService.GetProductAsync(1);
await using var context = new CoffeeCardContext(builder.Options, databaseSettings, environmentSettings);

using var productService = new ProductService(context);

var p1 = new AddProductRequest
{
Name = "Coffee",
Description = "Coffee Clip card",
NumberOfTickets = 10,
Price = 10,
Visible = true,
AllowedUserGroups = Enum.GetValues<UserGroup>()
};
await productService.AddProduct(p1);

var p2 = new AddProductRequest
{
Name = "Latte",
Description = "Fancy Drink Clip card",
NumberOfTickets = 10,
Price = 170,
Visible = false,
AllowedUserGroups = Enum.GetValues<UserGroup>()
};
await productService.AddProduct(p2);

var result = await productService.GetAllProductsAsync();

Assert.Collection(result,
e => e.Visible.Equals(true),
e => e.Visible.Equals(false));
}

[Fact(DisplayName = "GetAllProducts returns products from all user groups")]
public async Task GetAllProducts_Returns_Products_For_All_UserGroups()
{
var builder = new DbContextOptionsBuilder<CoffeeCardContext>()
.UseInMemoryDatabase(nameof(GetAllProducts_Returns_Products_For_All_UserGroups));

var databaseSettings = new DatabaseSettings
{
SchemaName = "test"
};
var environmentSettings = new EnvironmentSettings()
{
EnvironmentType = EnvironmentType.Test
};

await using var context = new CoffeeCardContext(builder.Options, databaseSettings, environmentSettings);

using var productService = new ProductService(context);

var p1 = new AddProductRequest
{
Name = "Coffee",
Description = "Coffee Clip card",
NumberOfTickets = 10,
Price = 10,
Visible = true,
AllowedUserGroups = new List<UserGroup> { UserGroup.Customer }
};
await productService.AddProduct(p1);

var p2 = new AddProductRequest
{
Name = "Latte",
Description = "Fancy Drink Clip card",
NumberOfTickets = 10,
Price = 170,
Visible = true,
AllowedUserGroups = new List<UserGroup> { UserGroup.Barista }
};
await productService.AddProduct(p2);

var p3 = new AddProductRequest
{
Name = "Frappuccino",
Description = "Blended ice with sugar",
NumberOfTickets = 1,
Price = 35,
Visible = true,
AllowedUserGroups = new List<UserGroup> { UserGroup.Manager }
};
await productService.AddProduct(p3);

var p4 = new AddProductRequest
{
Name = "Cortado",
Description = "Some spanish coffee",
NumberOfTickets = 1,
Price = 19,
Visible = true,
AllowedUserGroups = new List<UserGroup> { UserGroup.Board }
};
await productService.AddProduct(p4);

var result = await productService.GetAllProductsAsync();

Assert.Collection<UserGroup>(expected,
e => e.Equals(UserGroup.Customer),
e => e.Equals(UserGroup.Board));
Assert.Collection<Product>(result,
e => e.ProductUserGroup = new List<ProductUserGroup> { new ProductUserGroup { UserGroup = UserGroup.Customer } },
e => e.ProductUserGroup = new List<ProductUserGroup> { new ProductUserGroup { UserGroup = UserGroup.Barista } },
e => e.ProductUserGroup = new List<ProductUserGroup> { new ProductUserGroup { UserGroup = UserGroup.Manager } },
e => e.ProductUserGroup = new List<ProductUserGroup> { new ProductUserGroup { UserGroup = UserGroup.Board } }
);
}
}
}
15 changes: 15 additions & 0 deletions coffeecard/CoffeeCard.WebApi/Controllers/v2/ProductsController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,23 @@ private static ProductResponse MapProductToDto(Product product)
NumberOfTickets = product.NumberOfTickets,
Price = product.Price,
IsPerk = product.IsPerk(),
Visible = product.Visible,
AllowedUserGroups = product.ProductUserGroup.Select(e => e.UserGroup)
};
}

/// <summary>
/// Returns a list of all products
/// </summary>
/// <returns>List of all products</returns>
/// <response code="200">Successful request</response>
[HttpGet("all")]
[AuthorizeRoles(UserGroup.Board)]
[ProducesResponseType(typeof(IEnumerable<ProductResponse>), StatusCodes.Status200OK)]
public async Task<ActionResult<IEnumerable<ProductResponse>>> GetAllProducts()
{
IEnumerable<Product> products = await _productService.GetAllProductsAsync();
return Ok(products.Select(MapProductToDto).ToList());
}
}
}