Merge 237fdc4da5aca83f666946eb9882b55a3fb2ec7d into f91a622cc731197181dd1b1e4b17c9bcb450ae8a

README.md

@@ -627,7 +627,7 @@ Size.poll.options=Options must be greater than {2} and less than {1}
 
 * Create a `src/main/resource/import.sql` file with _DML statements_ for populating the database upon bootstrap. The `import.sql` should insert at least 15 polls, each with 3 or more options.
 	* Below is an example of `SQL` statements for creating a single poll with only one option.
-	
+	//DML = data manipulation language statements
 		* Poll Creation
 		
 			```sql

pom.xml

@@ -37,12 +37,16 @@
             <artifactId>hsqldb</artifactId>
             <scope>runtime</scope>
         </dependency>
-
         <dependency>
             <groupId>javax.inject</groupId>
             <artifactId>javax.inject</artifactId>
             <version>1</version>
         </dependency>
+        <dependency>
+            <groupId>com.mangofactory</groupId>
+            <artifactId>swagger-springmvc</artifactId>
+            <version>1.0.2</version>
+        </dependency>
     </dependencies>
 
 

src/main/java/dtos/ComputeResultController.java

@@ -0,0 +1,48 @@
+package dtos;
+
+import io.zipcoder.tc_spring_poll_application.Domain.Vote;
+import io.zipcoder.tc_spring_poll_application.repositories.VoteRepository;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import javax.inject.Inject;
+import java.util.HashMap;
+import java.util.Map;
+
+@RestController
+public class ComputeResultController {
+    private final VoteRepository voteRepository;
+
+    @Inject
+    public ComputeResultController(VoteRepository voteRepository) {
+        this.voteRepository = voteRepository;
+    }
+
+    @RequestMapping(value = "/computeresult", method = RequestMethod.GET)
+    public ResponseEntity<?> computeResult(@RequestParam Long pollId) {
+        VoteResult voteResult = new VoteResult();
+        Iterable<Vote> allVotes = voteRepository.findVotesByPoll(pollId);
+        int totalVotes = 0;
+        Map<Long, OptionCount> tempMap = new HashMap<Long, OptionCount>();
+        for(Vote v : allVotes) {
+            totalVotes ++;
+            // Get the OptionCount corresponding to this Option
+            OptionCount optionCount = tempMap.get(v.getOption().getId());
+            if(optionCount == null) {
+                optionCount = new OptionCount();
+                optionCount.setOptionId(v.getOption().getId());
+                tempMap.put(v.getOption().getId(), optionCount);
+            }
+
+            optionCount.setCount(optionCount.getCount()+1);
+        }
+
+        voteResult.setTotalVotes(totalVotes);
+        voteResult.setResults(tempMap.values());
+        return new ResponseEntity<VoteResult>(voteResult, HttpStatus.OK);
+    }
+}

src/main/java/dtos/OptionCount.java

@@ -0,0 +1,22 @@
+package dtos;
+
+public class OptionCount {
+    private Long optionId;
+    private int count;
+
+    public Long getOptionId() {
+        return optionId;
+    }
+
+    public void setOptionId(Long optionId) {
+        this.optionId = optionId;
+    }
+
+    public int getCount() {
+        return count;
+    }
+
+    public void setCount(int count) {
+        this.count = count;
+    }
+}

src/main/java/dtos/VoteResult.java

@@ -0,0 +1,24 @@
+package dtos;
+
+import java.util.Collection;
+
+public class VoteResult {
+    private int totalVotes;
+    private Collection<OptionCount> results;
+
+    public int getTotalVotes() {
+        return totalVotes;
+    }
+
+    public void setTotalVotes(int totalVotes) {
+        this.totalVotes = totalVotes;
+    }
+
+    public Collection<OptionCount> getResults() {
+        return results;
+    }
+
+    public void setResults(Collection<OptionCount> results) {
+        this.results = results;
+    }
+}

src/main/java/io/zipcoder/tc_spring_poll_application/Domain/Option.java

@@ -0,0 +1,41 @@
+package io.zipcoder.tc_spring_poll_application.Domain;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+
+
+/**
+ * @POJO
+ * I am POJO JOJO
+ */
+
+@Entity
+public class Option {
+
+    @Id
+    @GeneratedValue
+    @Column(name = "OPTION_ID")
+    private long id;
+
+    @Column(name = "OPTION_VALUE")
+    private String value;
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(long id) {
+        this.id = id;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    public void setValue(String value) {
+        this.value = value;
+    }
+}
+

src/main/java/io/zipcoder/tc_spring_poll_application/Domain/Poll.java

@@ -0,0 +1,52 @@
+package io.zipcoder.tc_spring_poll_application.Domain;
+
+import org.hibernate.validator.constraints.NotEmpty;
+import javax.persistence.*;
+import javax.validation.constraints.Size;
+import java.util.Set;
+/**
+ * @Another Pojojojo
+ */
+
+@Entity
+public class Poll {
+
+    @Id
+    @GeneratedValue
+    @Column (name = "POLL_ID")
+    private long id;
+
+    @Column (name = "QUESTION")
+    @NotEmpty
+    private String question;
+
+    @OneToMany (cascade = CascadeType.ALL)
+    @JoinColumn (name = "POLL_ID")
+    @OrderBy
+    @Size(min = 2, max = 6)
+    private Set<Option> options;
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(long id) {
+        this.id = id;
+    }
+
+    public String getQuestion() {
+        return question;
+    }
+
+    public void setQuestion(String question) {
+        this.question = question;
+    }
+
+    public Set getOptions() {
+        return options;
+    }
+
+    public void setOptions(Set<Option> options) {
+        this.options = options;
+    }
+}

src/main/java/io/zipcoder/tc_spring_poll_application/Domain/Vote.java

@@ -0,0 +1,37 @@
+package io.zipcoder.tc_spring_poll_application.Domain;
+
+import javax.persistence.*;
+
+/**
+ * @AnotherOne
+ * POJOJOJO
+ */
+
+@Entity
+public class Vote {
+
+    @Id
+    @GeneratedValue
+    @Column (name = "VOTE_ID")
+    private long id;
+
+    @ManyToOne
+    @JoinColumn (name = "OPTION_ID")
+    private Option option;
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(long id) {
+        this.id = id;
+    }
+
+    public Option getOption() {
+        return option;
+    }
+
+    public void setOption(Option option) {
+        this.option = option;
+    }
+}

src/main/java/io/zipcoder/tc_spring_poll_application/controller/PollController.java

@@ -0,0 +1,73 @@
+package io.zipcoder.tc_spring_poll_application.controller;
+
+import io.zipcoder.tc_spring_poll_application.Domain.Poll;
+import io.zipcoder.tc_spring_poll_application.exception.ResourceNotFoundException;
+import io.zipcoder.tc_spring_poll_application.repositories.PollRepository;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
+
+import javax.inject.Inject;
+import javax.validation.Valid;
+import java.net.URI;
+
+@RestController
+public class PollController {
+
+    private final PollRepository pollRepository;
+
+    @Inject
+    public PollController(PollRepository pollRepository) {
+        this.pollRepository = pollRepository;
+    }
+
+    @RequestMapping(value = "/polls", method = RequestMethod.GET)
+    public ResponseEntity<Iterable<Poll>> getAllPolls() {
+        Iterable<Poll> allPolls = pollRepository.findAll();
+        return new ResponseEntity<>(allPolls, HttpStatus.OK);
+    }
+
+    @RequestMapping(value = "/polls", method = RequestMethod.POST)
+    public ResponseEntity<?> createPoll(@Valid @RequestBody Poll poll) {
+        poll = pollRepository.save(poll);
+        HttpHeaders headers = new HttpHeaders();
+        URI newPollUri = ServletUriComponentsBuilder
+                .fromCurrentRequest()
+                .path("/{id}")
+                .buildAndExpand(poll.getId())
+                .toUri();
+        headers.setLocation(newPollUri);
+        return new ResponseEntity<>(headers, HttpStatus.CREATED);
+    }
+
+    @RequestMapping(value = "/polls/{pollId}", method = RequestMethod.DELETE)
+    public ResponseEntity<?> deletePoll(@PathVariable Long pollId) {
+        verifyPoll(pollId);
+        pollRepository.delete(pollId);
+        return new ResponseEntity<>(HttpStatus.OK);
+    }
+
+    @RequestMapping(value = "/polls/{pollId}", method = RequestMethod.PUT)
+    public ResponseEntity<?> updatePoll(@Valid @RequestBody Poll poll, @PathVariable Long pollId) {
+        verifyPoll(pollId);
+        // Save the entity
+        Poll p = pollRepository.save(poll);
+        return new ResponseEntity<>(HttpStatus.OK);
+    }
+
+    @RequestMapping(value = "/polls/{pollId}", method = RequestMethod.GET)
+    public ResponseEntity<?> getPoll(@PathVariable Long pollId) {
+        verifyPoll(pollId);
+        Poll p = pollRepository.findOne(pollId);
+        return new ResponseEntity<>(p, HttpStatus.OK);
+    }
+
+    private void verifyPoll(Long pollId) {
+        Poll p = pollRepository.findOne(pollId);
+        if(p == null){
+            throw new ResourceNotFoundException("Poll with id " + pollId + " does not exist");
+        }
+    }
+ }

src/main/java/io/zipcoder/tc_spring_poll_application/controller/VoteController.java

@@ -0,0 +1,37 @@
+package io.zipcoder.tc_spring_poll_application.controller;
+
+import io.zipcoder.tc_spring_poll_application.Domain.Vote;
+import io.zipcoder.tc_spring_poll_application.repositories.VoteRepository;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
+
+import javax.inject.Inject;
+
+@RestController
+public class VoteController {
+
+    private final VoteRepository voteRepository;
+
+    @Inject
+    public VoteController(VoteRepository voteRepository) {
+        this.voteRepository = voteRepository;
+    }
+
+    @RequestMapping(value = "/polls/{pollId}/votes", method = RequestMethod.POST)
+    public ResponseEntity<?> createVote(@PathVariable Long pollId, @RequestBody Vote
+            vote) {
+        vote = voteRepository.save(vote);
+        // Set the headers for the newly created resource
+        HttpHeaders responseHeaders = new HttpHeaders();
+        responseHeaders.setLocation(ServletUriComponentsBuilder.fromCurrentRequest().path("/{id}").buildAndExpand(vote.getId()).toUri());
+        return new ResponseEntity<>(responseHeaders, HttpStatus.CREATED);
+    }
+
+    @RequestMapping(value="/polls/{pollId}/votes", method=RequestMethod.GET)
+    public Iterable<Vote> getAllVotes(@PathVariable Long pollId) {
+        return voteRepository.findVotesByPoll(pollId);
+    }
+}

src/main/java/io/zipcoder/tc_spring_poll_application/dto/error/ErrorDetail.java

@@ -0,0 +1,60 @@
+package io.zipcoder.tc_spring_poll_application.dto.error;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class ErrorDetail {
+    private String title;
+    private int status;
+    private String detail;
+    private long timeStamp;
+    private String developerMessage;
+    private Map<String, List<ValidationError>> errors = new HashMap<>();
+
+
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
+    public int getStatus() {
+        return status;
+    }
+
+    public void setStatus(int status) {
+        this.status = status;
+    }
+
+    public String getDetail() {
+        return detail;
+    }
+
+    public void setDetail(String detail) {
+        this.detail = detail;
+    }
+
+    public long getTimeStamp() {
+        return timeStamp;
+    }
+
+    public void setTimeStamp(long timeStamp) {
+        this.timeStamp = timeStamp;
+    }
+
+    public String getDeveloperMessage() {
+        return developerMessage;
+    }
+
+    public void setDeveloperMessage(String developerMessage) {
+        this.developerMessage = developerMessage;
+    }
+
+    public Map<String, List<ValidationError>> getErrors() {
+        return this.errors;
+    }
+}

src/main/java/io/zipcoder/tc_spring_poll_application/dto/error/RestExceptionHandler.java

@@ -0,0 +1,63 @@
+package io.zipcoder.tc_spring_poll_application.dto.error;
+
+import io.zipcoder.tc_spring_poll_application.exception.ResourceNotFoundException;
+import org.springframework.context.MessageSource;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.FieldError;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import javax.inject.Inject;
+import javax.servlet.http.HttpServletRequest;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+@ControllerAdvice
+public class RestExceptionHandler {
+
+    private final MessageSource messageSource;
+
+    @Inject
+    public RestExceptionHandler(MessageSource messageSource) {
+        this.messageSource = messageSource;
+    }
+
+    @ExceptionHandler(ResourceNotFoundException.class)
+    public ResponseEntity<?> handleResourceNotFoundException(ResourceNotFoundException rnfe, HttpServletRequest request) {
+        ErrorDetail errorDetail = new ErrorDetail();
+        errorDetail.setTimeStamp(new Date().getTime());
+        errorDetail.setStatus(HttpStatus.NOT_FOUND.value());
+        errorDetail.setTitle("Resource Not Found");
+        errorDetail.setDetail(rnfe.getMessage());
+        errorDetail.setDeveloperMessage(rnfe.getClass().getName());
+        return new ResponseEntity<>(errorDetail, HttpStatus.NOT_FOUND);
+    }
+
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    public ResponseEntity<?>
+    handleValidationError(MethodArgumentNotValidException manve,HttpServletRequest request){
+        ErrorDetail errorDetail = new ErrorDetail();
+        errorDetail.setTitle("Bad Request");
+        errorDetail.setDetail(manve.getMessage());
+        errorDetail.setDeveloperMessage(manve.getClass().getName());
+        errorDetail.setStatus(HttpStatus.BAD_REQUEST.value());
+        errorDetail.setTimeStamp(new Date().getTime());
+
+        List<FieldError> fieldErrors =  manve.getBindingResult().getFieldErrors();
+        for(FieldError fe : fieldErrors) {
+
+            List<ValidationError> validationErrorList = errorDetail.getErrors().get(fe.getField());
+            if(validationErrorList == null) {
+                validationErrorList = new ArrayList<>();
+                errorDetail.getErrors().put(fe.getField(), validationErrorList);
+            }
+            ValidationError validationError = new ValidationError();
+            validationError.setCode(fe.getCode());
+            validationError.setMessage(messageSource.getMessage(fe, null));
+            validationErrorList.add(validationError);
+        }
+        return new ResponseEntity<>(errorDetail, null, HttpStatus.BAD_REQUEST);
+    }
+}

src/main/java/io/zipcoder/tc_spring_poll_application/dto/error/ValidationError.java

@@ -0,0 +1,22 @@
+package io.zipcoder.tc_spring_poll_application.dto.error;
+
+public class ValidationError {
+    private String code;
+    private String message;
+
+    public String getCode() {
+        return code;
+    }
+
+    public void setCode(String code) {
+        this.code = code;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public void setMessage(String message) {
+        this.message = message;
+    }
+}

src/main/java/io/zipcoder/tc_spring_poll_application/exception/ResourceNotFoundException.java

@@ -0,0 +1,19 @@
+package io.zipcoder.tc_spring_poll_application.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(HttpStatus.NOT_FOUND)
+public class ResourceNotFoundException extends RuntimeException {
+    private static final long serialVersionUID = 1L;
+    public ResourceNotFoundException() {
+    }
+
+    public ResourceNotFoundException(String message) {
+        super(message);
+    }
+
+    public ResourceNotFoundException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

src/main/java/io/zipcoder/tc_spring_poll_application/repositories/OptionRepository.java

@@ -0,0 +1,8 @@
+package io.zipcoder.tc_spring_poll_application.repositories;
+
+import io.zipcoder.tc_spring_poll_application.Domain.Option;
+import org.springframework.data.repository.CrudRepository;
+
+public interface OptionRepository  extends CrudRepository<Option,Long> {
+
+}

src/main/java/io/zipcoder/tc_spring_poll_application/repositories/PollRepository.java

@@ -0,0 +1,8 @@
+package io.zipcoder.tc_spring_poll_application.repositories;
+
+import io.zipcoder.tc_spring_poll_application.Domain.Poll;
+import org.springframework.data.repository.CrudRepository;
+
+public interface PollRepository extends CrudRepository<Poll,Long> {
+
+}

src/main/java/io/zipcoder/tc_spring_poll_application/repositories/VoteRepository.java

@@ -0,0 +1,13 @@
+package io.zipcoder.tc_spring_poll_application.repositories;
+
+import io.zipcoder.tc_spring_poll_application.Domain.Vote;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.CrudRepository;
+
+public interface VoteRepository extends CrudRepository<Vote, Long> {
+    @Query(value = "SELECT v.* " +
+            "FROM Option o, Vote v " +
+            "WHERE o.POLL_ID = ?1 " +
+            "AND v.OPTION_ID = o.OPTION_ID", nativeQuery = true)
+    Iterable<Vote> findVotesByPoll(Long pollId);
+}

src/main/resources/import.sql

@@ -0,0 +1,32 @@
+			insert into poll (poll_id, question) values (1, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (1, 'Red', 1);
+			insert into poll (poll_id, question) values (2, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (2, 'Orange', 1);
+			insert into poll (poll_id, question) values (3, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (3, 'Yellow', 1);
+			insert into poll (poll_id, question) values (4, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (4, 'Green', 1);
+			insert into poll (poll_id, question) values (5, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (5, 'Blue', 1);
+			insert into poll (poll_id, question) values (6, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (6, 'Indigo', 1);
+			insert into poll (poll_id, question) values (7, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (7, 'Violet', 1);
+			insert into poll (poll_id, question) values (8, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (8, 'Magenta', 1);
+			insert into poll (poll_id, question) values (9, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (9, 'Cyan', 1);
+			insert into poll (poll_id, question) values (10, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (10, 'Purple', 1);
+			insert into poll (poll_id, question) values (11, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (11, 'Pink', 1);
+			insert into poll (poll_id, question) values (12, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (12, 'Grey', 1);
+			insert into poll (poll_id, question) values (13, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (13, 'Black', 1);
+			insert into poll (poll_id, question) values (14, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (14, 'White', 1);
+			insert into poll (poll_id, question) values (15, 'What is your favorite color?');
+			insert into option (option_id, option_value, poll_id) values (15, 'Silver', 1);
+
+

src/main/resources/messages.properties

@@ -0,0 +1,2 @@
+NotEmpty.poll.question=Question is a required field
+Size.poll.options=Options must be greater than {2} and less than {1}