From e3e3ad4772e7722294ceea06618a081bc0375c7b Mon Sep 17 00:00:00 2001
From: dgrh99 <daniel.gerhardt@mni.thm.de>
Date: Tue, 5 Feb 2013 15:25:23 +0100
Subject: [PATCH] Splitted QuestionController into QuestionByAudienceController
and QuestionByLecturerController.
---
.../QuestionByAudienceController.java | 116 ++++++++
.../QuestionByLecturerController.java | 263 ++++++++++++++++++
.../QuestionByLecturerControllerTest.java | 86 ++++++
3 files changed, 465 insertions(+)
create mode 100644 src/main/java/de/thm/arsnova/controller/QuestionByAudienceController.java
create mode 100644 src/main/java/de/thm/arsnova/controller/QuestionByLecturerController.java
create mode 100644 src/test/java/de/thm/arsnova/controller/QuestionByLecturerControllerTest.java
diff --git a/src/main/java/de/thm/arsnova/controller/QuestionByAudienceController.java b/src/main/java/de/thm/arsnova/controller/QuestionByAudienceController.java
new file mode 100644
index 00000000..0dc9a826
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/controller/QuestionByAudienceController.java
@@ -0,0 +1,116 @@
+/*
+ * Copyright (C) 2012 THM webMedia
+ *
+ * This file is part of ARSnova.
+ *
+ * ARSnova is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * ARSnova is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package de.thm.arsnova.controller;
+
+import java.util.List;
+
+import javax.servlet.http.HttpServletResponse;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+import de.thm.arsnova.entities.InterposedQuestion;
+import de.thm.arsnova.entities.InterposedReadingCount;
+import de.thm.arsnova.services.IQuestionService;
+
+@Controller
+public class QuestionByAudienceController extends AbstractController {
+
+ public static final Logger LOGGER = LoggerFactory.getLogger(QuestionByAudienceController.class);
+
+ @Autowired
+ private IQuestionService questionService;
+
+ @RequestMapping(value = "/session/{sessionKey}/interposedcount", method = RequestMethod.GET)
+ @ResponseBody
+ public final int getInterposedCount(
+ @PathVariable final String sessionKey,
+ final HttpServletResponse response
+ ) {
+ return questionService.getInterposedCount(sessionKey);
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/interposedreadingcount", method = RequestMethod.GET)
+ @ResponseBody
+ public final InterposedReadingCount getUnreadInterposedCount(
+ @PathVariable final String sessionKey,
+ final HttpServletResponse response
+ ) {
+ return questionService.getInterposedReadingCount(sessionKey);
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/interposed", method = RequestMethod.GET)
+ @ResponseBody
+ public final List<InterposedQuestion> getInterposedQuestions(
+ @PathVariable final String sessionKey,
+ final HttpServletResponse response
+ ) {
+ return questionService.getInterposedQuestions(sessionKey);
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/interposed/{questionId}", method = RequestMethod.GET)
+ @ResponseBody
+ public final InterposedQuestion getInterposedQuestions(
+ @PathVariable final String sessionKey,
+ @PathVariable final String questionId,
+ final HttpServletResponse response
+ ) {
+ return questionService.readInterposedQuestion(sessionKey, questionId);
+ }
+
+ @RequestMapping(value = "/session/{sessionkey}/interposed", method = RequestMethod.POST)
+ @ResponseBody
+ public final void postInterposedQuestion(
+ @PathVariable final String sessionkey,
+ @RequestBody final InterposedQuestion question,
+ final HttpServletResponse response
+ ) {
+ if (!sessionkey.equals(question.getSessionId())) {
+ response.setStatus(HttpStatus.PRECONDITION_FAILED.value());
+ return;
+ }
+
+ if (questionService.saveQuestion(question)) {
+ response.setStatus(HttpStatus.CREATED.value());
+ return;
+ }
+
+ response.setStatus(HttpStatus.BAD_REQUEST.value());
+ return;
+ }
+
+ @RequestMapping(value = "/session/{sessionkey}/interposed/{questionId}", method = RequestMethod.DELETE)
+ @ResponseBody
+ public final void deleteInterposedQuestion(
+ @PathVariable final String sessionkey,
+ @PathVariable final String questionId,
+ final HttpServletResponse response
+ ) {
+ questionService.deleteQuestion(sessionkey, questionId);
+ }
+
+}
diff --git a/src/main/java/de/thm/arsnova/controller/QuestionByLecturerController.java b/src/main/java/de/thm/arsnova/controller/QuestionByLecturerController.java
new file mode 100644
index 00000000..b2a0c367
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/controller/QuestionByLecturerController.java
@@ -0,0 +1,263 @@
+/*
+ * Copyright (C) 2012 THM webMedia
+ *
+ * This file is part of ARSnova.
+ *
+ * ARSnova is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * ARSnova is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package de.thm.arsnova.controller;
+
+import java.util.List;
+
+import javax.servlet.http.HttpServletResponse;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+import de.thm.arsnova.entities.Answer;
+import de.thm.arsnova.entities.Question;
+import de.thm.arsnova.exceptions.NotFoundException;
+import de.thm.arsnova.services.IQuestionService;
+
+@Controller
+public class QuestionByLecturerController extends AbstractController {
+
+ public static final Logger LOGGER = LoggerFactory.getLogger(QuestionByLecturerController.class);
+
+ @Autowired
+ private IQuestionService questionService;
+
+ @RequestMapping(value = "/session/{sessionkey}/question/{questionId}", method = RequestMethod.GET)
+ @ResponseBody
+ public final Question getQuestion(
+ @PathVariable final String sessionkey,
+ @PathVariable final String questionId,
+ final HttpServletResponse response
+ ) {
+ Question question = questionService.getQuestion(questionId, sessionkey);
+ if (question != null) {
+ return question;
+ }
+
+ response.setStatus(HttpStatus.NOT_FOUND.value());
+ return null;
+ }
+
+ @RequestMapping(
+ value = "/session/{sessionkey}/question",
+ method = RequestMethod.POST
+ )
+ @ResponseBody
+ public final Question postQuestion(
+ @PathVariable final String sessionkey,
+ @RequestBody final Question question,
+ final HttpServletResponse response
+ ) {
+ if (!sessionkey.equals(question.getSession())) {
+ response.setStatus(HttpStatus.PRECONDITION_FAILED.value());
+ return null;
+ }
+
+ if (questionService.saveQuestion(question) != null) {
+ response.setStatus(HttpStatus.CREATED.value());
+ return question;
+ }
+
+ response.setStatus(HttpStatus.BAD_REQUEST.value());
+
+ return null;
+ }
+
+ @RequestMapping(
+ value = { "/getSkillQuestions/{sessionkey}", "/session/{sessionkey}/skillquestions" },
+ method = RequestMethod.GET
+ )
+ @ResponseBody
+ public final List<Question> getSkillQuestions(
+ @PathVariable final String sessionkey,
+ final HttpServletResponse response
+ ) {
+ List<Question> questions = questionService.getSkillQuestions(sessionkey);
+ if (questions == null || questions.isEmpty()) {
+ response.setStatus(HttpStatus.NOT_FOUND.value());
+ return null;
+ }
+ LOGGER.info(questions.toString());
+ return questions;
+ }
+
+ @RequestMapping(value = "/session/{sessionkey}/skillquestioncount", method = RequestMethod.GET)
+ @ResponseBody
+ public final int getSkillQuestionCount(@PathVariable final String sessionkey, final HttpServletResponse response) {
+ return questionService.getSkillQuestionCount(sessionkey);
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/questionids", method = RequestMethod.GET)
+ @ResponseBody
+ public final List<String> getQuestionIds(
+ @PathVariable final String sessionKey,
+ final HttpServletResponse response
+ ) {
+ List<String> questions = questionService.getQuestionIds(sessionKey);
+ if (questions == null || questions.isEmpty()) {
+ throw new NotFoundException();
+ }
+ LOGGER.info(questions.toString());
+ return questions;
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/questions/{questionId}", method = RequestMethod.DELETE)
+ @ResponseBody
+ public final void deleteAnswersAndQuestion(
+ @PathVariable final String sessionKey,
+ @PathVariable final String questionId,
+ final HttpServletResponse response
+ ) {
+ questionService.deleteQuestion(sessionKey, questionId);
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/questions/unanswered", method = RequestMethod.GET)
+ @ResponseBody
+ public final List<String> getUnAnsweredSkillQuestions(
+ @PathVariable final String sessionKey,
+ final HttpServletResponse response
+ ) {
+ List<String> answers = questionService.getUnAnsweredQuestions(sessionKey);
+ if (answers == null || answers.isEmpty()) {
+ throw new NotFoundException();
+ }
+ LOGGER.info(answers.toString());
+ return answers;
+ }
+
+ /**
+ * returns a JSON document which represents the given answer of a question.
+ *
+ * @param sessionKey
+ * Session Keyword to which the question belongs to
+ * @param questionId
+ * CouchDB Question ID for which the given answer should be
+ * retrieved
+ * @return JSON Document of {@link Answer} or {@link NotFoundException}
+ * @throws NotFoundException
+ * if wrong session, wrong question or no answer was given by
+ * the current user
+ * @throws ForbiddenException
+ * if not logged in
+ */
+ @RequestMapping(value = "/session/{sessionKey}/question/{questionId}/myanswer", method = RequestMethod.GET)
+ @ResponseBody
+ public final Answer getMyAnswer(
+ @PathVariable final String sessionKey,
+ @PathVariable final String questionId,
+ final HttpServletResponse response
+ ) {
+ Answer answer = questionService.getMyAnswer(sessionKey, questionId);
+ if (answer == null) {
+ throw new NotFoundException();
+ }
+ return answer;
+ }
+
+ /**
+ * returns a list of {@link Answer}s encoded as a JSON document for a given
+ * question id. In this case only {@link Answer} <tt>questionId</tt>,
+ * <tt>answerText</tt>, <tt>answerSubject</tt> and <tt>answerCount</tt>
+ * properties are set
+ *
+ * @param sessionKey
+ * Session Keyword to which the question belongs to
+ * @param questionId
+ * CouchDB Question ID for which the given answers should be
+ * retrieved
+ * @return List<{@link Answer}> or {@link NotFoundException}
+ * @throws NotFoundException
+ * if wrong session, wrong question or no answers was given
+ * @throws ForbiddenException
+ * if not logged in
+ */
+ @RequestMapping(value = "/session/{sessionKey}/question/{questionId}/answers", method = RequestMethod.GET)
+ @ResponseBody
+ public final List<Answer> getAnswers(
+ @PathVariable final String sessionKey,
+ @PathVariable final String questionId,
+ final HttpServletResponse response
+ ) {
+ List<Answer> answers = questionService.getAnswers(sessionKey, questionId);
+ if (answers == null || answers.isEmpty()) {
+ throw new NotFoundException();
+ }
+ return answers;
+ }
+
+ /**
+ *
+ * @param sessionKey
+ * Session Keyword to which the question belongs to
+ * @param questionId
+ * CouchDB Question ID for which the given answers should be
+ * retrieved
+ * @return count of answers for given question id
+ * @throws NotFoundException
+ * if wrong session or wrong question
+ * @throws ForbiddenException
+ * if not logged in
+ */
+ @RequestMapping(value = "/session/{sessionKey}/question/{questionId}/answercount", method = RequestMethod.GET)
+ @ResponseBody
+ public final int getAnswerCount(
+ @PathVariable final String sessionKey,
+ @PathVariable final String questionId,
+ final HttpServletResponse response
+ ) {
+ return questionService.getAnswerCount(sessionKey, questionId);
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/question/{questionId}/freetextanswers", method = RequestMethod.GET)
+ @ResponseBody
+ public final List<Answer> getFreetextAnswers(
+ @PathVariable final String sessionKey,
+ @PathVariable final String questionId,
+ final HttpServletResponse response
+ ) {
+ return questionService.getFreetextAnswers(sessionKey, questionId);
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/myanswers", method = RequestMethod.GET)
+ @ResponseBody
+ public final List<Answer> getMyAnswers(
+ @PathVariable final String sessionKey,
+ final HttpServletResponse response
+ ) {
+ return questionService.getMytAnswers(sessionKey);
+ }
+
+ @RequestMapping(value = "/session/{sessionKey}/answercount", method = RequestMethod.GET)
+ @ResponseBody
+ public final int getTotalAnswerCount(
+ @PathVariable final String sessionKey,
+ final HttpServletResponse response
+ ) {
+ return questionService.getTotalAnswerCount(sessionKey);
+ }
+
+}
diff --git a/src/test/java/de/thm/arsnova/controller/QuestionByLecturerControllerTest.java b/src/test/java/de/thm/arsnova/controller/QuestionByLecturerControllerTest.java
new file mode 100644
index 00000000..c78854e3
--- /dev/null
+++ b/src/test/java/de/thm/arsnova/controller/QuestionByLecturerControllerTest.java
@@ -0,0 +1,86 @@
+package de.thm.arsnova.controller;
+
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import javax.inject.Inject;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
+import org.springframework.mock.web.MockHttpServletRequest;
+import org.springframework.mock.web.MockHttpServletResponse;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.web.servlet.HandlerAdapter;
+import org.springframework.web.servlet.ModelAndView;
+import org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter;
+
+import de.thm.arsnova.dao.StubDatabaseDao;
+import de.thm.arsnova.exceptions.NotFoundException;
+import de.thm.arsnova.exceptions.UnauthorizedException;
+import de.thm.arsnova.services.StubUserService;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(locations = {
+ "file:src/main/webapp/WEB-INF/arsnova-servlet.xml",
+ "file:src/main/webapp/WEB-INF/spring/spring-main.xml",
+ "file:src/test/resources/test-config.xml" })
+public class QuestionByLecturerControllerTest {
+
+ @Inject
+ private ApplicationContext applicationContext;
+ private MockHttpServletRequest request;
+ private MockHttpServletResponse response;
+ private HandlerAdapter handlerAdapter;
+
+ @Autowired
+ private QuestionByLecturerController questionByLecturerController;
+
+ @Autowired
+ private StubUserService userService;
+
+ @Autowired
+ private StubDatabaseDao databaseDao;
+
+ @After
+ public final void cleanup() {
+ databaseDao.cleanupTestData();
+ }
+
+ @Before
+ public void setUp() {
+ this.request = new MockHttpServletRequest();
+ this.response = new MockHttpServletResponse();
+ handlerAdapter = applicationContext
+ .getBean(AnnotationMethodHandlerAdapter.class);
+ }
+
+ @Test(expected=NotFoundException.class)
+ public void testShouldNotGetQestionIdsForUnknownSession() throws Exception {
+ userService.setUserAuthenticated(true);
+
+ request.setMethod("GET");
+ request.setRequestURI("/session/00000000/questionids");
+ final ModelAndView mav = handlerAdapter.handle(request, response, questionByLecturerController);
+
+ assertNull(mav);
+ assertTrue(response.getStatus() == 404);
+ }
+
+ @Test(expected=UnauthorizedException.class)
+ public void testShouldNotGetQuestionIdsIfUnauthorized() throws Exception {
+ userService.setUserAuthenticated(false);
+
+ request.setMethod("GET");
+ request.setRequestURI("/session/00000000/questionids");
+ final ModelAndView mav = handlerAdapter.handle(request, response, questionByLecturerController);
+
+ assertNull(mav);
+ assertTrue(response.getStatus() == 401);
+ }
+
+}
--
GitLab