EW-1007 renamed some methods

hpi-schul-cloud · Sep 26, 2024 · 72893f4 · 72893f4
1 parent 061a6b0
commit 72893f4
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/.../modules/common-cartridge/common-cartridge-client/room-client/room-client.adapter.spec.ts b/.../modules/common-cartridge/common-cartridge-client/room-client/room-client.adapter.spec.ts
@@ -49,8 +49,8 @@ describe(CourseRoomsClientAdapter.name, () => {
 		expect(service).toBeDefined();
 	});
 
-	describe('getCourseRoomBoard', () => {
-		describe('when getCourseRoomBoard is called', () => {
+	describe('getRoomBoardByCourseId', () => {
+		describe('when getRoomBoardByCourseId is called', () => {
 			const setup = () => {
 				const roomId = faker.string.uuid();
 				const response = createMock<AxiosResponse<SingleColumnBoardResponse>>({
@@ -67,9 +67,9 @@ describe(CourseRoomsClientAdapter.name, () => {
 				return { roomId, response };
 			};
 
-			it('should return the structure of the course', async () => {
+			it('should return a room board with full contents', async () => {
 				const { roomId, response } = setup();
-				const result = await service.getRoomsByCourseId(roomId);
+				const result = await service.getRoomBoardByCourseId(roomId);
 
 				expect(result).toEqual(response.data);
 			});
@@ -91,7 +91,7 @@ describe(CourseRoomsClientAdapter.name, () => {
 		it('should throw an UnauthorizedException', async () => {
 			const { roomId, error, adapter } = setup();
 
-			await expect(adapter.getRoomsByCourseId(roomId)).rejects.toThrowError(error);
+			await expect(adapter.getRoomBoardByCourseId(roomId)).rejects.toThrowError(error);
 		});
 	});
 });
diff --git a/...r/src/modules/common-cartridge/common-cartridge-client/room-client/room-client.adapter.ts b/...r/src/modules/common-cartridge/common-cartridge-client/room-client/room-client.adapter.ts
@@ -9,7 +9,7 @@ import { CourseRoomsApi, SingleColumnBoardResponse } from './room-api-client';
 export class CourseRoomsClientAdapter {
 	constructor(private readonly courseRoomsApi: CourseRoomsApi, @Inject(REQUEST) private request: Request) {}
 
-	public async getRoomsByCourseId(roomId: string): Promise<SingleColumnBoardResponse> {
+	public async getRoomBoardByCourseId(roomId: string): Promise<SingleColumnBoardResponse> {
 		const options = this.createOptionParams();
 		const response = await this.courseRoomsApi.courseRoomsControllerGetRoomBoard(roomId, options);
 

diff --git a/apps/server/src/modules/common-cartridge/controller/common-cartridge.controller.ts b/apps/server/src/modules/common-cartridge/controller/common-cartridge.controller.ts
@@ -16,7 +16,7 @@ export class CommonCartridgeController {
 	}
 
 	@Get('export/:parentId/room')
-	public async exportCourseRooms(@Param() exportCourseParams: ExportCourseParams): Promise<SingleColumnBoardResponse> {
-		return this.commonCartridgeUC.exportCourseRooms(exportCourseParams.parentId);
+	public async exportRoomBoard(@Param() exportCourseParams: ExportCourseParams): Promise<SingleColumnBoardResponse> {
+		return this.commonCartridgeUC.exportRoomBoard(exportCourseParams.parentId);
 	}
 }
diff --git a/apps/server/src/modules/common-cartridge/service/common-cartridge-export.service.ts b/apps/server/src/modules/common-cartridge/service/common-cartridge-export.service.ts
@@ -26,8 +26,8 @@ export class CommonCartridgeExportService {
 		return courseCommonCartridgeMetadata;
 	}
 
-	public async findCourseRooms(courseId: string): Promise<SingleColumnBoardResponse> {
-		const courseRooms = await this.courseRoomsClientAdapter.getRoomsByCourseId(courseId);
+	public async findRoomBoardByCourseId(courseId: string): Promise<SingleColumnBoardResponse> {
+		const courseRooms = await this.courseRoomsClientAdapter.getRoomBoardByCourseId(courseId);
 
 		return courseRooms;
 	}

diff --git a/apps/server/src/modules/common-cartridge/uc/common-cartridge.uc.ts b/apps/server/src/modules/common-cartridge/uc/common-cartridge.uc.ts
@@ -24,8 +24,8 @@ export class CommonCartridgeUc {
 		return response;
 	}
 
-	public async exportCourseRooms(courseId: EntityId): Promise<SingleColumnBoardResponse> {
-		const response = await this.exportService.findCourseRooms(courseId);
+	public async exportRoomBoard(courseId: EntityId): Promise<SingleColumnBoardResponse> {
+		const response = await this.exportService.findRoomBoardByCourseId(courseId);
 
 		return response;
 	}