diff --git a/README.md b/README.md index 7001517..4f122c4 100755 --- a/README.md +++ b/README.md @@ -40,6 +40,10 @@ Na koniec w przęglądarce dostaniesz w odpowiedzi token. W samym pliku można z Żeby zobaczyć dokumentację api trzeba wejść w przeglądarce na `http://localhost:1285/swagger-ui.html` po odpaleniu aplikacji. +### Nazewnictwo odpowiedzi + +Każdą odp zaczynamy od modelu, który opisuje np. `Courses` a kończymy na `Response`. Między tymi dwoma członami możemy dodawać modyfikatory opisujące dokładniej odpowiedź np. `Default`. W ten sposób możemy otrzymać nazwę `CoursesDefaultResponse.java` + ## Packaging Zeby spakowac apke do `jara` wystarcza dwie komendy zaczynajac z glownego katalogu projektu diff --git a/restservice/src/test/java/com/plannaplan/responses/mappers/AssignmentResponseMappersTest.java b/restservice/src/test/java/com/plannaplan/responses/mappers/AssignmentResponseMappersTest.java index 431211c..a77dee3 100755 --- a/restservice/src/test/java/com/plannaplan/responses/mappers/AssignmentResponseMappersTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/mappers/AssignmentResponseMappersTest.java @@ -9,7 +9,7 @@ import com.plannaplan.entities.Assignment; import com.plannaplan.entities.Commision; import com.plannaplan.entities.Course; import com.plannaplan.entities.Groups; -import com.plannaplan.responses.models.GetCurrentAssignmentsResponse; +import com.plannaplan.responses.models.AssignmentResponse; import com.plannaplan.entities.Lecturer; import com.plannaplan.types.WeekDay; @@ -25,9 +25,9 @@ public class AssignmentResponseMappersTest { new Lecturer("krul.", "Wladyslaw", "Potocki")), com), new Assignment(new Groups(32, "A4-1", course, 420, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")), com)); - final List response = AssignmentResponseMappers.mapToResponse(groups); + final List response = AssignmentResponseMappers.mapToResponse(groups); assertTrue(response.size() == 1); - assertTrue(response.get(0) instanceof GetCurrentAssignmentsResponse); + assertTrue(response.get(0) instanceof AssignmentResponse); } } diff --git a/restservice/src/test/java/com/plannaplan/responses/mappers/CoursesResponseMappersTest.java b/restservice/src/test/java/com/plannaplan/responses/mappers/CoursesResponseMappersTest.java index 60bb9e0..fc71c8f 100755 --- a/restservice/src/test/java/com/plannaplan/responses/mappers/CoursesResponseMappersTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/mappers/CoursesResponseMappersTest.java @@ -6,8 +6,8 @@ import java.util.Arrays; import java.util.List; import com.plannaplan.entities.Course; -import com.plannaplan.responses.models.GetCoursesResponse; -import com.plannaplan.responses.models.GetCoursesWithGroupsResponse; +import com.plannaplan.responses.models.CoursesDefaultResponse; +import com.plannaplan.responses.models.CoursesWithGroupsResponse; import org.junit.Test; @@ -15,21 +15,21 @@ public class CoursesResponseMappersTest { @Test public void shouldMapListCoursesToResponseList() { final List courses = Arrays.asList(new Course(), new Course()); - final List response = CoursesResponseMappers.mapToGetCoursesResponse(courses); + final List response = CoursesResponseMappers.mapToGetCoursesResponse(courses); assertTrue(response.size() == 2); - assertTrue(response.get(0) instanceof GetCoursesResponse); + assertTrue(response.get(0) instanceof CoursesDefaultResponse); } @Test public void shouldMapListCoursesToResponseWithGroupsList() { final List courses = Arrays.asList(new Course(), new Course()); - final List response = CoursesResponseMappers + final List response = CoursesResponseMappers .mapToGetCoursesWithGroupsResponse(courses); assertTrue(response.size() == 2); - assertTrue(response.get(0) instanceof GetCoursesWithGroupsResponse); + assertTrue(response.get(0) instanceof CoursesWithGroupsResponse); } } diff --git a/restservice/src/test/java/com/plannaplan/responses/mappers/GroupsMappersTest.java b/restservice/src/test/java/com/plannaplan/responses/mappers/GroupsMappersTest.java index cefc561..e41fe0a 100755 --- a/restservice/src/test/java/com/plannaplan/responses/mappers/GroupsMappersTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/mappers/GroupsMappersTest.java @@ -7,9 +7,9 @@ import java.util.List; import com.plannaplan.entities.Groups; import com.plannaplan.entities.Lecturer; -import com.plannaplan.responses.models.DefaultGroupResponse; -import com.plannaplan.responses.models.GetCourseGroupsResponse; -import com.plannaplan.responses.models.WithCapacityGroupResponse; +import com.plannaplan.responses.models.GroupDefaultResponse; +import com.plannaplan.responses.models.CourseWithGroupsResponse; +import com.plannaplan.responses.models.GroupWithCapacityResponse; import com.plannaplan.types.WeekDay; import org.junit.Test; @@ -19,10 +19,10 @@ public class GroupsMappersTest { public void shouldMapToResponseIncludingCapacity() { final List gropus = Arrays.asList( new Groups(42, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki"))); - final List response = GroupsMappers.mapToCapacityResponse(gropus); + final List response = GroupsMappers.mapToCapacityResponse(gropus); assert (response.get(0).getCapacity() == 42); - assert (response.get(0) instanceof WithCapacityGroupResponse); + assert (response.get(0) instanceof GroupWithCapacityResponse); assert (response.size() == 1); } @@ -30,9 +30,9 @@ public class GroupsMappersTest { public void shouldMapToResponseWiothoutCapacity() { final List gropus = Arrays.asList( new Groups(42, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki"))); - final List response = GroupsMappers.mapToDefaultResponse(gropus); + final List response = GroupsMappers.mapToDefaultResponse(gropus); - assert (response.get(0) instanceof DefaultGroupResponse); + assert (response.get(0) instanceof GroupDefaultResponse); assert (response.size() == 1); } @@ -41,7 +41,7 @@ public class GroupsMappersTest { final List groups = Arrays.asList( new Groups(150, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")), new Groups(24, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki"))); - final GetCourseGroupsResponse response = GroupsMappers.mapToGetCourseGroupsDefaultResponse(groups); + final CourseWithGroupsResponse response = GroupsMappers.mapToGetCourseGroupsDefaultResponse(groups); assertTrue(response.getClasses().size() == 1); assertTrue(response.getLectures().size() == 1); diff --git a/restservice/src/test/java/com/plannaplan/responses/mappers/UserResponseMappersTest.java b/restservice/src/test/java/com/plannaplan/responses/mappers/UserResponseMappersTest.java index f393f03..52ddb19 100755 --- a/restservice/src/test/java/com/plannaplan/responses/mappers/UserResponseMappersTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/mappers/UserResponseMappersTest.java @@ -7,7 +7,7 @@ import java.util.List; import com.plannaplan.entities.User; import com.plannaplan.types.UserRoles; -import com.plannaplan.responses.models.SearchForStudentsResponse; +import com.plannaplan.responses.models.UserResponse; import org.junit.Test; @@ -25,8 +25,8 @@ public class UserResponseMappersTest { final List users = Arrays.asList(new User(F_NAME, F_SURNAMENAME, F_EMAIL, UserRoles.TEST_USER), new User(S_NAME, S_SURNAMENAME, S_EMAIL, UserRoles.TEST_USER)); - final List resposne = UserResponseMappers.mapToDefaultResponse(users); + final List resposne = UserResponseMappers.mapToDefaultResponse(users); assertTrue(resposne.size() == 2); - assertTrue(resposne.get(0) instanceof SearchForStudentsResponse); + assertTrue(resposne.get(0) instanceof UserResponse); } } diff --git a/restservice/src/test/java/com/plannaplan/responses/models/GetCurrentAssignmentsResponseTest.java b/restservice/src/test/java/com/plannaplan/responses/models/AssignmentResponseTest.java similarity index 68% rename from restservice/src/test/java/com/plannaplan/responses/models/GetCurrentAssignmentsResponseTest.java rename to restservice/src/test/java/com/plannaplan/responses/models/AssignmentResponseTest.java index 8a2aa17..ee386c3 100755 --- a/restservice/src/test/java/com/plannaplan/responses/models/GetCurrentAssignmentsResponseTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/models/AssignmentResponseTest.java @@ -9,7 +9,7 @@ import com.plannaplan.types.WeekDay; import org.junit.Test; -public class GetCurrentAssignmentsResponseTest { +public class AssignmentResponseTest { @Test public void shouldMapGroupsToResponse() { @@ -19,10 +19,10 @@ public class GetCurrentAssignmentsResponseTest { final Groups classes = new Groups(22, "A4-2", null, 580, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")); - final GetCurrentAssignmentsResponse response = new GetCurrentAssignmentsResponse(course, lecture, classes); + final AssignmentResponse response = new AssignmentResponse(course, lecture, classes); assertTrue(response.getName() == "Kurs"); - assertTrue(response.getLecture() instanceof WithCapacityGroupResponse); - assertTrue(response.getClasses() instanceof WithCapacityGroupResponse); + assertTrue(response.getLecture() instanceof GroupWithCapacityResponse); + assertTrue(response.getClasses() instanceof GroupWithCapacityResponse); } @Test @@ -31,9 +31,9 @@ public class GetCurrentAssignmentsResponseTest { final Groups lecture = new Groups(142, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")); - final GetCurrentAssignmentsResponse response = new GetCurrentAssignmentsResponse(course, lecture); + final AssignmentResponse response = new AssignmentResponse(course, lecture); assertTrue(response.getName() == "Kurs"); - assertTrue(response.getLecture() instanceof WithCapacityGroupResponse); + assertTrue(response.getLecture() instanceof GroupWithCapacityResponse); assertTrue(response.getClasses() == null); } @@ -43,10 +43,10 @@ public class GetCurrentAssignmentsResponseTest { final Groups classes = new Groups(22, "A4-2", null, 580, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")); - final GetCurrentAssignmentsResponse response = new GetCurrentAssignmentsResponse(course, classes); + final AssignmentResponse response = new AssignmentResponse(course, classes); assertTrue(response.getName() == "Kurs"); assertTrue(response.getLecture() == null); - assertTrue(response.getClasses() instanceof WithCapacityGroupResponse); + assertTrue(response.getClasses() instanceof GroupWithCapacityResponse); } } diff --git a/restservice/src/test/java/com/plannaplan/responses/models/CourseWithGroupsResponseTest.java b/restservice/src/test/java/com/plannaplan/responses/models/CourseWithGroupsResponseTest.java new file mode 100755 index 0000000..dda1c8b --- /dev/null +++ b/restservice/src/test/java/com/plannaplan/responses/models/CourseWithGroupsResponseTest.java @@ -0,0 +1,28 @@ +package com.plannaplan.responses.models; + +import static org.junit.Assert.assertTrue; + +import java.util.Arrays; +import java.util.List; + +import com.plannaplan.entities.Groups; + +import org.junit.Test; + +public class CourseWithGroupsResponseTest { + + @Test public void shouldCreateInstance(){ + + final List classes = Arrays.asList(new GroupDefaultResponse(new Groups())); + + final List lectures = Arrays.asList(new GroupDefaultResponse(new Groups())); + + final CourseWithGroupsResponse instance = new CourseWithGroupsResponse<>(classes,lectures); + + assertTrue(instance.getClasses().get(0) instanceof GroupDefaultResponse); + assertTrue(instance.getLectures().get(0) instanceof GroupDefaultResponse); + + } + + +} diff --git a/restservice/src/test/java/com/plannaplan/responses/models/GetCoursesResponseTest.java b/restservice/src/test/java/com/plannaplan/responses/models/CoursesDefaultResponseTest.java similarity index 73% rename from restservice/src/test/java/com/plannaplan/responses/models/GetCoursesResponseTest.java rename to restservice/src/test/java/com/plannaplan/responses/models/CoursesDefaultResponseTest.java index 39f8b72..2dea02a 100755 --- a/restservice/src/test/java/com/plannaplan/responses/models/GetCoursesResponseTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/models/CoursesDefaultResponseTest.java @@ -6,11 +6,11 @@ import com.plannaplan.entities.Course; import org.junit.Test; -public class GetCoursesResponseTest { +public class CoursesDefaultResponseTest { @Test public void shouldMapFilledCourse() { final Course course = new Course("Test", "XD"); - final GetCoursesResponse response = new GetCoursesResponse(course); + final CoursesDefaultResponse response = new CoursesDefaultResponse(course); assertTrue(response.getId() == null); assertTrue(response.getName().equals("Test")); @@ -19,7 +19,7 @@ public class GetCoursesResponseTest { @Test public void shouldMapEmptyCourse() { final Course course = new Course(); - final GetCoursesResponse response = new GetCoursesResponse(course); + final CoursesDefaultResponse response = new CoursesDefaultResponse(course); assertTrue(response.getId() == null); assertTrue(response.getName().equals("")); diff --git a/restservice/src/test/java/com/plannaplan/responses/models/GetCoursesWithGroupsResponseTest.java b/restservice/src/test/java/com/plannaplan/responses/models/CoursesWithGroupsResponseTest.java similarity index 78% rename from restservice/src/test/java/com/plannaplan/responses/models/GetCoursesWithGroupsResponseTest.java rename to restservice/src/test/java/com/plannaplan/responses/models/CoursesWithGroupsResponseTest.java index 422ca10..846c6e4 100755 --- a/restservice/src/test/java/com/plannaplan/responses/models/GetCoursesWithGroupsResponseTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/models/CoursesWithGroupsResponseTest.java @@ -6,11 +6,11 @@ import com.plannaplan.entities.Course; import org.junit.Test; -public class GetCoursesWithGroupsResponseTest { +public class CoursesWithGroupsResponseTest { @Test public void shouldMapCourseToResponseWithGroupsIncluded() { - final GetCoursesWithGroupsResponse response = new GetCoursesWithGroupsResponse( + final CoursesWithGroupsResponse response = new CoursesWithGroupsResponse( new Course("Programowanie funkcyjne", "xd")); assertTrue(response.getName() == "Programowanie funkcyjne"); diff --git a/restservice/src/test/java/com/plannaplan/responses/models/GetCourseGroupsResponseTest.java b/restservice/src/test/java/com/plannaplan/responses/models/GetCourseGroupsResponseTest.java deleted file mode 100755 index 4da18db..0000000 --- a/restservice/src/test/java/com/plannaplan/responses/models/GetCourseGroupsResponseTest.java +++ /dev/null @@ -1,28 +0,0 @@ -package com.plannaplan.responses.models; - -import static org.junit.Assert.assertTrue; - -import java.util.Arrays; -import java.util.List; - -import com.plannaplan.entities.Groups; - -import org.junit.Test; - -public class GetCourseGroupsResponseTest { - - @Test public void shouldCreateInstance(){ - - final List classes = Arrays.asList(new DefaultGroupResponse(new Groups())); - - final List lectures = Arrays.asList(new DefaultGroupResponse(new Groups())); - - final GetCourseGroupsResponse instance = new GetCourseGroupsResponse<>(classes,lectures); - - assertTrue(instance.getClasses().get(0) instanceof DefaultGroupResponse); - assertTrue(instance.getLectures().get(0) instanceof DefaultGroupResponse); - - } - - -} diff --git a/restservice/src/test/java/com/plannaplan/responses/models/DefaultGroupResponseTest.java b/restservice/src/test/java/com/plannaplan/responses/models/GroupDefaultResponseTest.java similarity index 88% rename from restservice/src/test/java/com/plannaplan/responses/models/DefaultGroupResponseTest.java rename to restservice/src/test/java/com/plannaplan/responses/models/GroupDefaultResponseTest.java index e915566..747f527 100755 --- a/restservice/src/test/java/com/plannaplan/responses/models/DefaultGroupResponseTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/models/GroupDefaultResponseTest.java @@ -10,13 +10,13 @@ import com.plannaplan.types.WeekDay; import org.junit.Test; -public class DefaultGroupResponseTest { +public class GroupDefaultResponseTest { @Test public void shouldMapAssignmentClassToResponse() { final Assignment assignment = new Assignment( new Groups(42, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")), null); - final DefaultGroupResponse response = new DefaultGroupResponse(assignment); + final GroupDefaultResponse response = new GroupDefaultResponse(assignment); assertTrue(response.getDay() == 0); assertTrue(response.getLecturer().equals("krul. Wladyslaw Potocki")); assertTrue(response.getRoom().equals("A4-1")); @@ -29,7 +29,7 @@ public class DefaultGroupResponseTest { final Groups group = new Groups(42, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")); - final DefaultGroupResponse response = new DefaultGroupResponse(group); + final GroupDefaultResponse response = new GroupDefaultResponse(group); assertTrue(response.getDay() == 0); assertTrue(response.getLecturer().equals("krul. Wladyslaw Potocki")); assertTrue(response.getRoom().equals("A4-1")); @@ -41,7 +41,7 @@ public class DefaultGroupResponseTest { public void shouldMapEmptyGroupClassToResponse() { final Groups group = new Groups(); - final DefaultGroupResponse response = new DefaultGroupResponse(group); + final GroupDefaultResponse response = new GroupDefaultResponse(group); assertTrue(response.getDay() == -1); assertTrue(response.getLecturer().equals("")); assertTrue(response.getRoom().equals("")); diff --git a/restservice/src/test/java/com/plannaplan/responses/models/WithCapacityGroupResponseTest.java b/restservice/src/test/java/com/plannaplan/responses/models/GroupWithCapacityResponseTest.java similarity index 85% rename from restservice/src/test/java/com/plannaplan/responses/models/WithCapacityGroupResponseTest.java rename to restservice/src/test/java/com/plannaplan/responses/models/GroupWithCapacityResponseTest.java index 1495cef..4cad6cf 100755 --- a/restservice/src/test/java/com/plannaplan/responses/models/WithCapacityGroupResponseTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/models/GroupWithCapacityResponseTest.java @@ -10,13 +10,13 @@ import com.plannaplan.types.WeekDay; import org.junit.Test; -public class WithCapacityGroupResponseTest { +public class GroupWithCapacityResponseTest { @Test public void shouldMapAssignmentClassToResponse() { final Assignment assignment = new Assignment( new Groups(42, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")), null); - final WithCapacityGroupResponse response = new WithCapacityGroupResponse(assignment); + final GroupWithCapacityResponse response = new GroupWithCapacityResponse(assignment); assertTrue(response.getCapacity() == 42); assertTrue(response.getDay() == 0); assertTrue(response.getLecturer().equals("krul. Wladyslaw Potocki")); @@ -30,7 +30,7 @@ public class WithCapacityGroupResponseTest { final Groups group = new Groups(42, "A4-1", null, 520, WeekDay.MONDAY, new Lecturer("krul.", "Wladyslaw", "Potocki")); - final WithCapacityGroupResponse response = new WithCapacityGroupResponse(group); + final GroupWithCapacityResponse response = new GroupWithCapacityResponse(group); assertTrue(response.getCapacity() == 42); assertTrue(response.getDay() == 0); assertTrue(response.getLecturer().equals("krul. Wladyslaw Potocki")); @@ -43,7 +43,7 @@ public class WithCapacityGroupResponseTest { public void shouldMapEmptyGroupClassToResponse() { final Groups group = new Groups(); - final WithCapacityGroupResponse response = new WithCapacityGroupResponse(group); + final GroupWithCapacityResponse response = new GroupWithCapacityResponse(group); assertTrue(response.getCapacity() == 0); assertTrue(response.getDay() == -1); assertTrue(response.getLecturer().equals("")); diff --git a/restservice/src/test/java/com/plannaplan/responses/models/SearchForStudentsResponseTest.java b/restservice/src/test/java/com/plannaplan/responses/models/UserResponseTest.java similarity index 84% rename from restservice/src/test/java/com/plannaplan/responses/models/SearchForStudentsResponseTest.java rename to restservice/src/test/java/com/plannaplan/responses/models/UserResponseTest.java index d28f51d..c376636 100755 --- a/restservice/src/test/java/com/plannaplan/responses/models/SearchForStudentsResponseTest.java +++ b/restservice/src/test/java/com/plannaplan/responses/models/UserResponseTest.java @@ -7,14 +7,14 @@ import com.plannaplan.types.UserRoles; import org.junit.Test; -public class SearchForStudentsResponseTest { +public class UserResponseTest { private static final String NAME = "Tytus"; private static final String SURNAMENAME = "Romek"; private static final String EMAIL = "i@Atomek.pl"; @Test public void shouldMapUserToResponseElement() { - final SearchForStudentsResponse response = new SearchForStudentsResponse( + final UserResponse response = new UserResponse( new User(NAME, SURNAMENAME, EMAIL, UserRoles.TEST_USER)); assertTrue(response.getName().equals(NAME)); assertTrue(response.getSurname().equals(SURNAMENAME));