Dragonestia/RoomPicker
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documented Users

Browse Source
This commit is contained in:
Andrey Terentev 2024-02-15 00:30:21 +07:00 committed by Andrey Terentev
parent 576a908fcc
commit 0c673950c3
8 changed files with 67 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/src/main/java/ru/dragonestia/picker/api/repository/response/LinkUsersWithRoomResponse.java
View File

@ -1,3 +1,9 @@
package ru.dragonestia.picker.api.repository.response; package ru.dragonestia.picker.api.repository.response;
public record LinkUsersWithRoomResponse(int usedSlots, int totalSlots) {} import io.swagger.v3.oas.annotations.media.Schema;
@Schema(title = "Link users with room", hidden = true)
public record LinkUsersWithRoomResponse(
@Schema(description = "Number of users in room", example = "15") int usedSlots,
@Schema(description = "Maximum number of users in room", example = "20") int totalSlots
) {}

2
api/src/main/java/ru/dragonestia/picker/api/repository/response/LinkedRoomsWithUserResponse.java
View File

@ -1,7 +1,9 @@
package ru.dragonestia.picker.api.repository.response; package ru.dragonestia.picker.api.repository.response;
import io.swagger.v3.oas.annotations.media.Schema;
import ru.dragonestia.picker.api.repository.response.type.RRoom; import ru.dragonestia.picker.api.repository.response.type.RRoom;
import java.util.List; import java.util.List;
@Schema(title = "Linked rooms with user", hidden = true)
public record LinkedRoomsWithUserResponse(List<RRoom.Short> rooms) {} public record LinkedRoomsWithUserResponse(List<RRoom.Short> rooms) {}

8
api/src/main/java/ru/dragonestia/picker/api/repository/response/RoomUserListResponse.java
View File

@ -1,7 +1,13 @@
package ru.dragonestia.picker.api.repository.response; package ru.dragonestia.picker.api.repository.response;
import io.swagger.v3.oas.annotations.media.Schema;
import ru.dragonestia.picker.api.repository.response.type.RUser; import ru.dragonestia.picker.api.repository.response.type.RUser;
import java.util.List; import java.util.List;
public record RoomUserListResponse(int slots, int usedSlots, List<RUser> users) {} @Schema(title = "Users inside room", hidden = true)
public record RoomUserListResponse(
@Schema(description = "Number of users in room", example = "15") int slots,
@Schema(description = "Maximum number of users in room", example = "20") int usedSlots,
@Schema(description = "Users") List<RUser> users
) {}

2
api/src/main/java/ru/dragonestia/picker/api/repository/response/SearchUserResponse.java
View File

@ -1,7 +1,9 @@
package ru.dragonestia.picker.api.repository.response; package ru.dragonestia.picker.api.repository.response;
import io.swagger.v3.oas.annotations.media.Schema;
import ru.dragonestia.picker.api.repository.response.type.RUser; import ru.dragonestia.picker.api.repository.response.type.RUser;
import java.util.List; import java.util.List;
@Schema(title = "Search user", hidden = true)
public record SearchUserResponse(List<RUser> users) {} public record SearchUserResponse(List<RUser> users) {}

2
api/src/main/java/ru/dragonestia/picker/api/repository/response/UserDetailsResponse.java
View File

@ -1,5 +1,7 @@
package ru.dragonestia.picker.api.repository.response; package ru.dragonestia.picker.api.repository.response;
import io.swagger.v3.oas.annotations.media.Schema;
import ru.dragonestia.picker.api.repository.response.type.RUser; import ru.dragonestia.picker.api.repository.response.type.RUser;
@Schema(title = "User details", hidden = true)
public record UserDetailsResponse(RUser user) {} public record UserDetailsResponse(RUser user) {}

5
api/src/main/java/ru/dragonestia/picker/api/repository/response/type/RUser.java
View File

@ -1,13 +1,18 @@
package ru.dragonestia.picker.api.repository.response.type; package ru.dragonestia.picker.api.repository.response.type;
import io.swagger.v3.oas.annotations.media.Schema;
import ru.dragonestia.picker.api.repository.details.UserDetails; import ru.dragonestia.picker.api.repository.details.UserDetails;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
@Schema(title = "User")
public class RUser { public class RUser {
@Schema(description = "User identifier", example = "test-user")
private String id; private String id;
@Schema(description = "Additional data requested (Key-Value)")
private Map<UserDetails, String> details = new HashMap<>(); private Map<UserDetails, String> details = new HashMap<>();
private RUser() {} private RUser() {}

28
app/src/main/java/ru/dragonestia/picker/controller/UserController.java
View File

@ -1,5 +1,8 @@
package ru.dragonestia.picker.controller; package ru.dragonestia.picker.controller;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
import ru.dragonestia.picker.api.repository.response.LinkedRoomsWithUserResponse; import ru.dragonestia.picker.api.repository.response.LinkedRoomsWithUserResponse;
@ -14,6 +17,7 @@ import ru.dragonestia.picker.util.NamingValidator;
import java.util.List; import java.util.List;
@Tag(name = "Users", description = "User management")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/users") @RequestMapping("/users")
@ -23,10 +27,12 @@ public class UserController {
private final DetailsParser detailsParser; private final DetailsParser detailsParser;
private final NamingValidator namingValidator; private final NamingValidator namingValidator;
@Operation(summary = "Search user by identifier")
@GetMapping("/search") @GetMapping("/search")
SearchUserResponse search(@RequestParam(name = "input") String input, SearchUserResponse search(
@RequestParam(name = "requiredDetails", required = false, defaultValue = "") String detailsSeq) { @Parameter(description = "User identifier input") @RequestParam(name = "input") String input,
@Parameter(description = "Required addition user data", example = "COUNT_ROOMS") @RequestParam(name = "requiredDetails", required = false, defaultValue = "") String detailsSeq
) {
if (!namingValidator.validateUserId(input) || input.isEmpty()) { if (!namingValidator.validateUserId(input) || input.isEmpty()) {
return new SearchUserResponse(List.of()); return new SearchUserResponse(List.of());
} }
@ -34,10 +40,12 @@ public class UserController {
return new SearchUserResponse(userService.searchUsers(input, detailsParser.parseUserDetails(detailsSeq))); return new SearchUserResponse(userService.searchUsers(input, detailsParser.parseUserDetails(detailsSeq)));
} }
@Operation(summary = "Get user info")
@GetMapping("/{userId}") @GetMapping("/{userId}")
UserDetailsResponse find(@PathVariable(value = "userId") String userId, UserDetailsResponse find(
@RequestParam(value = "requiredDetails", required = false) String detailsSeq) { @Parameter(description = "User identifier") @PathVariable(value = "userId") String userId,
@Parameter(description = "Required addition user data", example = "COUNT_ROOMS") @RequestParam(value = "requiredDetails", required = false) String detailsSeq
) {
if (!namingValidator.validateUserId(userId)) { if (!namingValidator.validateUserId(userId)) {
return new UserDetailsResponse(new RUser(userId)); return new UserDetailsResponse(new RUser(userId));
} }
@ -45,10 +53,12 @@ public class UserController {
return new UserDetailsResponse(userService.getUserDetails(userId, detailsParser.parseUserDetails(detailsSeq))); return new UserDetailsResponse(userService.getUserDetails(userId, detailsParser.parseUserDetails(detailsSeq)));
} }
@Operation(summary = "Get rooms linked with user")
@GetMapping("/{userId}/rooms") @GetMapping("/{userId}/rooms")
LinkedRoomsWithUserResponse roomsOf(@PathVariable(value = "userId") String userId, LinkedRoomsWithUserResponse roomsOf(
@RequestParam(value = "requiredDetails", required = false) String detailsSeq) { @Parameter(description = "User identifier") @PathVariable(value = "userId") String userId,
@Parameter(description = "Required addition room data", example = "COUNT_USERS") @RequestParam(value = "requiredDetails", required = false) String detailsSeq
) {
if (!namingValidator.validateUserId(userId)) { if (!namingValidator.validateUserId(userId)) {
return new LinkedRoomsWithUserResponse(List.of()); return new LinkedRoomsWithUserResponse(List.of());
} }

35
app/src/main/java/ru/dragonestia/picker/controller/UserRoomController.java
View File

@ -1,5 +1,8 @@
package ru.dragonestia.picker.controller; package ru.dragonestia.picker.controller;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity; import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
@ -17,6 +20,7 @@ import ru.dragonestia.picker.util.NamingValidator;
import java.util.Arrays; import java.util.Arrays;
@Tag(name = "Users", description = "User management")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/nodes/{nodeId}/rooms/{roomId}/users") @RequestMapping("/nodes/{nodeId}/rooms/{roomId}/users")
@ -28,33 +32,40 @@ public class UserRoomController {
private final NamingValidator namingValidator; private final NamingValidator namingValidator;
private final DetailsParser detailsParser; private final DetailsParser detailsParser;
@Operation(summary = "Get users inside room")
@GetMapping @GetMapping
ResponseEntity<RoomUserListResponse> usersInsideRoom(@PathVariable(name = "nodeId") String nodeId, ResponseEntity<RoomUserListResponse> usersInsideRoom(
@PathVariable(name = "roomId") String roomId, @Parameter(description = "Node identifier") @PathVariable(name = "nodeId") String nodeId,
@RequestParam(name = "requiredDetails", required = false, defaultValue = "") String detailsSeq) { @Parameter(description = "Room identifier") @PathVariable(name = "roomId") String roomId,
@Parameter(description = "Required addition user data", example = "COUNT_ROOMS") @RequestParam(name = "requiredDetails", required = false, defaultValue = "") String detailsSeq
) {
var room = getNodeAndRoom(nodeId, roomId).room(); var room = getNodeAndRoom(nodeId, roomId).room();
var users = userService.getRoomUsersWithDetailsResponse(room, detailsParser.parseUserDetails(detailsSeq)); var users = userService.getRoomUsersWithDetailsResponse(room, detailsParser.parseUserDetails(detailsSeq));
return ResponseEntity.ok(new RoomUserListResponse(room.getSlots().getSlots(), users.size(), users)); return ResponseEntity.ok(new RoomUserListResponse(room.getSlots().getSlots(), users.size(), users));
} }
@Operation(summary = "Link users with room")
@PostMapping @PostMapping
ResponseEntity<LinkUsersWithRoomResponse> linkUserWithRoom(@PathVariable(name = "nodeId") String nodeId, ResponseEntity<LinkUsersWithRoomResponse> linkUserWithRoom(
@PathVariable(name = "roomId") String roomId, @Parameter(description = "Node identifier") @PathVariable(name = "nodeId") String nodeId,
@RequestParam(name = "userIds") String userIds, @Parameter(description = "Room identifier") @PathVariable(name = "roomId") String roomId,
@RequestParam(name = "force") boolean force) { @Parameter(description = "User identifiers", example = "user1,user2,user3") @RequestParam(name = "userIds") String userIds,
@Parameter(description = "Ignore slot limitation") @RequestParam(name = "force") boolean force
) {
var room = getNodeAndRoom(nodeId, roomId).room(); var room = getNodeAndRoom(nodeId, roomId).room();
var users = namingValidator.validateUserIds(Arrays.stream(userIds.split(",")).toList()); var users = namingValidator.validateUserIds(Arrays.stream(userIds.split(",")).toList());
var usedSlots = userService.linkUsersWithRoom(room, users, force); var usedSlots = userService.linkUsersWithRoom(room, users, force);
return ResponseEntity.ok(new LinkUsersWithRoomResponse(usedSlots, room.getSlots().getSlots())); return ResponseEntity.ok(new LinkUsersWithRoomResponse(usedSlots, room.getSlots().getSlots()));
} }
@Operation(summary = "Unlink users from room")
@DeleteMapping @DeleteMapping
ResponseEntity<?> unlinkUsersForBucket(@PathVariable(name = "nodeId") String nodeId, ResponseEntity<?> unlinkUsersForBucket(
@PathVariable(name = "roomId") String roomId, @Parameter(description = "Node identifier") @PathVariable(name = "nodeId") String nodeId,
@RequestParam(name = "userIds") String userIds) { @Parameter(description = "Room identifier") @PathVariable(name = "roomId") String roomId,
@Parameter(description = "User identifiers", example = "user1,user2,user3") @RequestParam(name = "userIds") String userIds
) {
var room = getNodeAndRoom(nodeId, roomId).room(); var room = getNodeAndRoom(nodeId, roomId).room();
var users = namingValidator.validateUserIds(Arrays.stream(userIds.split(",")).toList()); var users = namingValidator.validateUserIds(Arrays.stream(userIds.split(",")).toList());