Skip to content

[Fix] Changed endpoint names to follow RESTful API conventions #76

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.

Sign up for GitHub

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

Merged
kTrzcinskii merged 4 commits into from
Apr 19, 2025
Merged

[Fix] Changed endpoint names to follow RESTful API conventions #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5658a19
changed endpoint names
kubapoke Apr 14, 2025
f5e5477
Merge branch 'develop' into fix/endpoint-names
kubapoke Apr 18, 2025
02723bb
updated controller/endpoint names
kubapoke Apr 18, 2025
6f2ae9b
Merge branch 'refs/heads/develop' into fix/endpoint-names
kubapoke Apr 19, 2025
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
6 changes: 3 additions & 3 deletions ...es/Controllers/CategoryControllerTests.cs → .../Controllers/CategoriesControllerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

namespace TickAPI.Tests.Categories.Controllers;

public class CategoryControllerTests
public class CategoriesControllerTests
{
[Fact]
public async Task GetCategories_WhenDataIsValid_ShouldReturnOk()
Expand All @@ -25,7 +25,7 @@ public async Task GetCategories_WhenDataIsValid_ShouldReturnOk()
Result<PaginatedData<GetCategoryResponseDto>>.Success(new PaginatedData<GetCategoryResponseDto>(new List<GetCategoryResponseDto>(), pageNumber, pageSize, true, true,
new PaginationDetails(0, 0))));

var sut = new CategoryController(categoryServiceMock.Object);
var sut = new CategoriesController(categoryServiceMock.Object);

// Act
var res = await sut.GetCategories(pageSize, pageNumber);
Expand All @@ -49,7 +49,7 @@ public async Task CreateCategory_WhenDataIsValid_ShouldReturnSuccess()
.Setup(m => m.CreateNewCategoryAsync(categoryName))
.ReturnsAsync(Result<Category>.Success(new Category()));

var sut = new CategoryController(categoryServiceMock.Object);
var sut = new CategoriesController(categoryServiceMock.Object);

// Act
var res = await sut.CreateCategory(createCategoryDto);
Expand Down
10 changes: 5 additions & 5 deletions ...rs/Controllers/CustomerControllerTests.cs → ...s/Controllers/CustomersControllerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

namespace TickAPI.Tests.Customers.Controllers;

public class CustomerControllerTests
public class CustomersControllerTests
{
[Fact]
public async Task GoogleLogin_WhenAuthSuccessAndCustomerExists_ShouldReturnToken()
Expand All @@ -38,7 +38,7 @@ public async Task GoogleLogin_WhenAuthSuccessAndCustomerExists_ShouldReturnToken

var claimsServiceMock = new Mock<IClaimsService>();

var sut = new CustomerController(
var sut = new CustomersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
customerServiceMock.Object,
Expand Down Expand Up @@ -83,7 +83,7 @@ public async Task GoogleLogin_WhenAuthSuccessAndCustomerDoesNotExist_ShouldCreat

var claimsServiceMock = new Mock<IClaimsService>();

var sut = new CustomerController(
var sut = new CustomersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
customerServiceMock.Object,
Expand Down Expand Up @@ -137,7 +137,7 @@ public async Task AboutMe_WithValidEmailClaim_ShouldReturnCustomerDetails()
var claimsServiceMock = new Mock<IClaimsService>();
claimsServiceMock.Setup(m => m.GetEmailFromClaims(controllerContext.HttpContext.User.Claims)).Returns(Result<string>.Success(email));

var sut = new CustomerController(
var sut = new CustomersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
customerServiceMock.Object,
Expand Down Expand Up @@ -168,7 +168,7 @@ public async Task AboutMe_WithMissingEmailClaim_ShouldReturnBadRequest()
claimsServiceMock.Setup(m => m.GetEmailFromClaims(It.IsAny<IEnumerable<Claim>>())).Returns(Result<string>.Failure(StatusCodes.Status400BadRequest, "missing email claim"));


var sut = new CustomerController(
var sut = new CustomersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
customerServiceMock.Object,
Expand Down
26 changes: 13 additions & 13 deletions ...vents/Controllers/EventControllerTests.cs → ...ents/Controllers/EventsControllerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

namespace TickAPI.Tests.Events.Controllers;

public class EventControllerTests
public class EventsControllerTests
{
[Fact]
public async Task CreateEvent_WhenDataIsValid_ShouldReturnSuccess()
Expand Down Expand Up @@ -67,7 +67,7 @@ public async Task CreateEvent_WhenDataIsValid_ShouldReturnSuccess()

var organizerServiceMock = new Mock<IOrganizerService>();

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);

sut.ControllerContext = controllerContext;

Expand Down Expand Up @@ -110,7 +110,7 @@ public async Task CreateEvent_WhenMissingEmailClaims_ShouldReturnBadRequest()

var organizerServiceMock = new Mock<IOrganizerService>();

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);

sut.ControllerContext = new ControllerContext
{
Expand Down Expand Up @@ -181,7 +181,7 @@ public async Task GetOrganizerEvents_WhenAllOperationsSucceed_ShouldReturnOkWith
.Setup(m => m.GetOrganizerEventsAsync(organizer, page, pageSize))
.ReturnsAsync(Result<PaginatedData<GetEventResponseDto>>.Success(paginatedData));

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
sut.ControllerContext = controllerContext;

// Act
Expand Down Expand Up @@ -218,7 +218,7 @@ public async Task GetOrganizerEvents_WhenEmailClaimIsMissing_ShouldReturnBadRequ
var eventServiceMock = new Mock<IEventService>();
var organizerServiceMock = new Mock<IOrganizerService>();

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
sut.ControllerContext = new ControllerContext
{
HttpContext = new DefaultHttpContext
Expand Down Expand Up @@ -271,7 +271,7 @@ public async Task GetOrganizerEvents_WhenOrganizerIsNotFound_ShouldReturnNotFoun

var eventServiceMock = new Mock<IEventService>();

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
sut.ControllerContext = controllerContext;

// Act
Expand Down Expand Up @@ -323,7 +323,7 @@ public async Task GetOrganizerEvents_WhenPaginationFails_ShouldReturnBadRequest(
.Setup(m => m.GetOrganizerEventsAsync(organizer, page, pageSize))
.ReturnsAsync(Result<PaginatedData<GetEventResponseDto>>.Failure(StatusCodes.Status400BadRequest, errorMessage));

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
sut.ControllerContext = controllerContext;

// Act
Expand Down Expand Up @@ -375,7 +375,7 @@ public async Task GetOrganizerEventsPaginationDetails_WhenAllOperationsSucceed_S
.Setup(m => m.GetOrganizerEventsPaginationDetailsAsync(organizer, pageSize))
.ReturnsAsync(Result<PaginationDetails>.Success(paginationDetails));

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
sut.ControllerContext = controllerContext;

// Act
Expand Down Expand Up @@ -429,7 +429,7 @@ public async Task GetOrganizerEventsPaginationDetails_WhenPaginationDetailsFails
.Setup(m => m.GetOrganizerEventsPaginationDetailsAsync(organizer, pageSize))
.ReturnsAsync(Result<PaginationDetails>.Failure(StatusCodes.Status400BadRequest, errorMessage));

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
sut.ControllerContext = controllerContext;

// Act
Expand Down Expand Up @@ -470,7 +470,7 @@ public async Task GetEvents_WhenAllOperationsSucceed_ShouldReturnOkWithPaginated
.Setup(m => m.GetEventsAsync(page, pageSize))
.ReturnsAsync(Result<PaginatedData<GetEventResponseDto>>.Success(paginatedData));

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);

// Act
var response = await sut.GetEvents(pageSize, page);
Expand Down Expand Up @@ -507,7 +507,7 @@ public async Task GetEvents_WhenOperationFails_ShouldReturnErrorWithCorrectStatu
.Setup(m => m.GetEventsAsync(page, pageSize))
.ReturnsAsync(Result<PaginatedData<GetEventResponseDto>>.Failure(statusCode, errorMessage));

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);

// Act
var response = await sut.GetEvents(pageSize, page);
Expand Down Expand Up @@ -535,7 +535,7 @@ public async Task GetEventsPaginationDetails_WhenAllOperationsSucceed_ShouldRetu
.Setup(m => m.GetEventsPaginationDetailsAsync(pageSize))
.ReturnsAsync(Result<PaginationDetails>.Success(paginationDetails));

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);

// Act
var response = await sut.GetEventsPaginationDetails(pageSize);
Expand Down Expand Up @@ -566,7 +566,7 @@ public async Task GetEventsPaginationDetails_WhenOperationFails_ShouldReturnErro
.Setup(m => m.GetEventsPaginationDetailsAsync(pageSize))
.ReturnsAsync(Result<PaginationDetails>.Failure(statusCode, errorMessage));

var sut = new EventController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);
var sut = new EventsController(eventServiceMock.Object, claimsServiceMock.Object, organizerServiceMock.Object);

// Act
var response = await sut.GetEventsPaginationDetails(pageSize);
Expand Down
20 changes: 10 additions & 10 deletions ...s/Controllers/OrganizerControllerTests.cs → .../Controllers/OrganizersControllerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

namespace TickAPI.Tests.Organizers.Controllers;

public class OrganizerControllerTests
public class OrganizersControllerTests
{
[Fact]
public async Task GoogleLogin_WhenAuthSuccessAndVerifiedOrganizerExists_ShouldReturnValidVerifiedLoginDto()
Expand All @@ -44,7 +44,7 @@ public async Task GoogleLogin_WhenAuthSuccessAndVerifiedOrganizerExists_ShouldRe

var claimsServiceMock = new Mock<IClaimsService>();

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down Expand Up @@ -85,7 +85,7 @@ public async Task GoogleLogin_WhenAuthSuccessAndUnverifiedOrganizerExists_Should

var claimsServiceMock = new Mock<IClaimsService>();

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down Expand Up @@ -127,7 +127,7 @@ public async Task

var claimsServiceMock = new Mock<IClaimsService>();

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down Expand Up @@ -189,7 +189,7 @@ public async Task CreateOrganizer_WhenCreatingAccountIsSuccessful_ShouldReturnTo
var claimsServiceMock = new Mock<IClaimsService>();
claimsServiceMock.Setup(m => m.GetEmailFromClaims(controllerContext.HttpContext.User.Claims)).Returns(Result<string>.Success(email));

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down Expand Up @@ -218,7 +218,7 @@ public async Task CreateOrganizer_WhenMissingEmailClaim_ShouldReturnBadRequest()
var claimsServiceMock = new Mock<IClaimsService>();
claimsServiceMock.Setup(m => m.GetEmailFromClaims(It.IsAny<IEnumerable<Claim>>())).Returns(Result<string>.Failure(StatusCodes.Status400BadRequest, "missing email claim"));

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down Expand Up @@ -258,7 +258,7 @@ public async Task VerifyOrganizer_WhenVerificationSuccessful_ShouldReturnOk()

var claimsServiceMock = new Mock<IClaimsService>();

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down Expand Up @@ -318,7 +318,7 @@ public async Task AboutMe_WithValidEmailClaim_ShouldReturnOrganizerDetails()
var claimsServiceMock = new Mock<IClaimsService>();
claimsServiceMock.Setup(m => m.GetEmailFromClaims(controllerContext.HttpContext.User.Claims)).Returns(Result<string>.Success(email));

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down Expand Up @@ -351,7 +351,7 @@ public async Task AboutMe_WithMissingEmailClaim_ShouldReturnBadRequest()
var claimsServiceMock = new Mock<IClaimsService>();
claimsServiceMock.Setup(m => m.GetEmailFromClaims(It.IsAny<IEnumerable<Claim>>())).Returns(Result<string>.Failure(StatusCodes.Status400BadRequest, "missing email claim"));

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down Expand Up @@ -404,7 +404,7 @@ public async Task AboutMe_WhenOrganizerNotFound_ShouldReturnInternalServerError(
var claimsServiceMock = new Mock<IClaimsService>();
claimsServiceMock.Setup(m => m.GetEmailFromClaims(controllerContext.HttpContext.User.Claims)).Returns(Result<string>.Success(email));

var sut = new OrganizerController(
var sut = new OrganizersController(
googleAuthServiceMock.Object,
jwtServiceMock.Object,
organizerServiceMock.Object,
Expand Down
2 changes: 1 addition & 1 deletion ...API/Admins/Controllers/AdminController.cs → ...PI/Admins/Controllers/AdminsController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace TickAPI.Admins.Controllers;

[ApiController]
[Route("api/[controller]")]
public class AdminController : ControllerBase
public class AdminsController : ControllerBase
{

}
9 changes: 4 additions & 5 deletions ...egories/Controllers/CategoryController.cs → ...ories/Controllers/CategoriesController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ namespace TickAPI.Categories.Controllers;

[ApiController]
[Route("api/[controller]")]

public class CategoryController : Controller
public class CategoriesController : Controller
{
private readonly ICategoryService _categoryService;

public CategoryController(ICategoryService categoryService)
public CategoriesController(ICategoryService categoryService)
{
_categoryService = categoryService;
}

[AuthorizeWithPolicy(AuthPolicies.VerifiedUserPolicy)]
[HttpGet("get-categories")]
[HttpGet]
public async Task<ActionResult<PaginatedData<GetCategoryResponseDto>>> GetCategories([FromQuery] int pageSize, [FromQuery] int page)
{
var res = await _categoryService.GetCategoriesResponsesAsync(pageSize, page);
Expand All @@ -33,7 +32,7 @@ public async Task<ActionResult<PaginatedData<GetCategoryResponseDto>>> GetCatego
}

// TODO: Add appropriate policy verification (admin, maybe also organizer?)
[HttpPost("create-category")]
[HttpPost]
public async Task<ActionResult> CreateCategory([FromBody] CreateCategoryDto request)
{
var newCategoryResult = await _categoryService.CreateNewCategoryAsync(request.Name);
Expand Down
4 changes: 2 additions & 2 deletions ...stomers/Controllers/CustomerController.cs → ...tomers/Controllers/CustomersController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ namespace TickAPI.Customers.Controllers;

[ApiController]
[Route("api/[controller]")]
public class CustomerController : ControllerBase
public class CustomersController : ControllerBase
{
private readonly IGoogleAuthService _googleAuthService;
private readonly IJwtService _jwtService;
private readonly ICustomerService _customerService;
private readonly IClaimsService _claimsService;

public CustomerController(IGoogleAuthService googleAuthService, IJwtService jwtService, ICustomerService customerService, IClaimsService claimsService)
public CustomersController(IGoogleAuthService googleAuthService, IJwtService jwtService, ICustomerService customerService, IClaimsService claimsService)
{
_googleAuthService = googleAuthService;
_jwtService = jwtService;
Expand Down
14 changes: 7 additions & 7 deletions ...API/Events/Controllers/EventController.cs → ...PI/Events/Controllers/EventsController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ namespace TickAPI.Events.Controllers;
[Route("api/[controller]")]

// TODO: Add lists of categories and tickettypes
public class EventController : ControllerBase
public class EventsController : ControllerBase
{
private readonly IEventService _eventService;
private readonly IClaimsService _claimsService;
private readonly IOrganizerService _organizerService;

public EventController(IEventService eventService, IClaimsService claimsService, IOrganizerService organizerService)
public EventsController(IEventService eventService, IClaimsService claimsService, IOrganizerService organizerService)
{
_eventService = eventService;
_claimsService = claimsService;
_organizerService = organizerService;
}

[AuthorizeWithPolicy(AuthPolicies.VerifiedOrganizerPolicy)]
[HttpPost("create-event")]
[HttpPost]
public async Task<ActionResult<CreateEventResponseDto>> CreateEvent([FromBody] CreateEventDto request)
{
var emailResult = _claimsService.GetEmailFromClaims(User.Claims);
Expand All @@ -49,7 +49,7 @@ public async Task<ActionResult<CreateEventResponseDto>> CreateEvent([FromBody] C
}

[AuthorizeWithPolicy(AuthPolicies.VerifiedOrganizerPolicy)]
[HttpGet("get-organizer-events")]
[HttpGet("organizer")]
public async Task<ActionResult<PaginatedData<GetEventResponseDto>>> GetOrganizerEvents([FromQuery] int pageSize, [FromQuery] int page)
{
var emailResult = _claimsService.GetEmailFromClaims(User.Claims);
Expand All @@ -76,7 +76,7 @@ public async Task<ActionResult<PaginatedData<GetEventResponseDto>>> GetOrganizer
}

[AuthorizeWithPolicy(AuthPolicies.VerifiedOrganizerPolicy)]
[HttpGet("get-organizer-events-pagination-details")]
[HttpGet("organizer-pagination-details")]
public async Task<ActionResult<PaginationDetails>> GetOrganizerEventsPaginationDetails([FromQuery] int pageSize)
{
var emailResult = _claimsService.GetEmailFromClaims(User.Claims);
Expand All @@ -103,7 +103,7 @@ public async Task<ActionResult<PaginationDetails>> GetOrganizerEventsPaginationD
}

[AuthorizeWithPolicy(AuthPolicies.CustomerPolicy)]
[HttpGet("get-events")]
[HttpGet]
public async Task<ActionResult<PaginatedData<GetEventResponseDto>>> GetEvents([FromQuery] int pageSize, [FromQuery] int page)
{
var paginatedDataResult = await _eventService.GetEventsAsync(page, pageSize);
Expand All @@ -115,7 +115,7 @@ public async Task<ActionResult<PaginatedData<GetEventResponseDto>>> GetEvents([F
}

[AuthorizeWithPolicy(AuthPolicies.CustomerPolicy)]
[HttpGet("get-events-pagination-details")]
[HttpGet("pagination-details")]
public async Task<ActionResult<PaginationDetails>> GetEventsPaginationDetails([FromQuery] int pageSize)
{
var paginationDetailsResult = await _eventService.GetEventsPaginationDetailsAsync(pageSize);
Expand Down
Loading
Loading