complete

README.md

@@ -1,9 +1,9 @@
-# Poll Application
+****# Poll Application
 * **Purpose**
 	* to demonstrate the basic functionality of the [Spring Framework](https://spring.io/)
 	* to demonstrate API testing via [Postman](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en)
 
-# Part 1 - Domain Implementation
+# Part  1 - Domain Implementation
 
 * _Domain objects_ are the backbone for an application and contain the [business logic](https://en.wikipedia.org/wiki/Business_logic).
 * Create a sub package of `io.zipcoder.tc_spring_poll_application` named `domain`.

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,23 @@
+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/controller/ComputeResultController.java

@@ -0,0 +1,33 @@
+package io.zipcoder.tc_spring_poll_application.controller;
+
+import dtos.VoteResult;
+import io.zipcoder.tc_spring_poll_application.controller.VoteController;
+import io.zipcoder.tc_spring_poll_application.domain.Vote;
+import io.zipcoder.tc_spring_poll_application.repositories.VoteRepository;
+import org.springframework.beans.factory.annotation.Autowired;
+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;
+
+@RestController
+public class ComputeResultController {
+
+    private VoteRepository voteRepository;
+
+    @Autowired
+    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);
+
+        //TODO: Implement algorithm to count votes
+        return new ResponseEntity<VoteResult>(voteResult, HttpStatus.OK);
+    }
+}

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.beans.factory.annotation.Autowired;
+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.validation.Valid;
+import java.net.URI;
+
+@RestController
+public class PollController {
+
+    private PollRepository pollRepository;
+
+
+
+    @Autowired
+    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);
+        URI newPollUri = ServletUriComponentsBuilder
+                .fromCurrentRequest()
+                .path("/{id}")
+                .buildAndExpand(poll.getId())
+                .toUri();
+        HttpHeaders httpHeaders = new HttpHeaders();
+        httpHeaders.setLocation(newPollUri);
+        return new ResponseEntity<>(httpHeaders, HttpStatus.CREATED);
+    }
+
+
+    @RequestMapping(value="/polls/{pollId}", method=RequestMethod.GET)
+    public ResponseEntity<?> getPoll(@PathVariable Long pollId) {
+        Poll p = pollRepository.findOne(pollId);
+        return new ResponseEntity<> (p, HttpStatus.OK);
+    }
+
+    @RequestMapping(value="/polls/{pollId}", method=RequestMethod.PUT)
+    public ResponseEntity<?> updatePoll(@Valid @RequestBody Poll poll, @PathVariable Long pollId) {
+        // Save the entity
+        Poll p = pollRepository.save(poll);
+        return new ResponseEntity<>(HttpStatus.OK);
+    }
+
+    @RequestMapping(value="/polls/{pollId}", method=RequestMethod.DELETE)
+    public ResponseEntity<?> deletePoll(@PathVariable Long pollId) {
+        pollRepository.delete(pollId);
+        return new ResponseEntity<>(HttpStatus.OK);
+    }
+
+    public void verifyPoll(Long id) {
+        if (pollRepository.findOne(id) == null){
+            throw new ResourceNotFoundException("Sorry Unavailable");
+        }
+    }
+
+}

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

@@ -0,0 +1,45 @@
+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.beans.factory.annotation.Autowired;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.CrudRepository;
+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;
+
+@RestController
+public class VoteController {
+
+    private VoteRepository voteRepository;
+
+    @Autowired
+    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<>(null, responseHeaders, HttpStatus.CREATED);
+    }
+
+
+    @RequestMapping(value="/polls/votes", method=RequestMethod.GET)
+    public Iterable<Vote> getAllVotes() {
+        return voteRepository.findAll();
+    }
+
+    @RequestMapping(value="/polls/{pollId}/votes", method=RequestMethod.GET)
+    public Iterable<Vote> getVote(@PathVariable Long pollId) {
+        return voteRepository.findById(pollId);
+    }
+}

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

@@ -0,0 +1,34 @@
+package io.zipcoder.tc_spring_poll_application.domain;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+
+@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,50 @@
+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;
+
+@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<Option> 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,32 @@
+package io.zipcoder.tc_spring_poll_application.domain;
+
+import javax.persistence.*;
+
+@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/dto/error/ErrorDetail.java

@@ -0,0 +1,66 @@
+package io.zipcoder.tc_spring_poll_application.dto.error;
+
+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;
+
+    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(String message) {
+        return developerMessage;
+    }
+
+    public void setDeveloperMessage(String developerMessage) {
+        this.developerMessage = developerMessage;
+    }
+
+    public String getDeveloperMessage() {
+        return developerMessage;
+    }
+
+    public Map<String, List<ValidationError>> getErrors() {
+        return errors;
+    }
+
+    public void setErrors(Map<String, List<ValidationError>> errors) {
+        this.errors = errors;
+    }
+}

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

@@ -0,0 +1,51 @@
+package io.zipcoder.tc_spring_poll_application.dto.error;
+
+import io.zipcoder.tc_spring_poll_application.exception.ResourceNotFoundException;
+import org.springframework.beans.factory.annotation.Autowired;
+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.servlet.http.HttpServletRequest;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+@ControllerAdvice
+public class RestExceptionHandler {
+
+    @Autowired
+    private MessageSource messageSource;
+
+    @ExceptionHandler(ResourceNotFoundException.class)
+    public ResponseEntity<?> handleResourceNotFoundException(ResourceNotFoundException rnfe, HttpServletRequest request) {
+        ErrorDetail errorDetail = new ErrorDetail();
+        errorDetail.setTimeStamp(new Date().getTime());
+        errorDetail.getDeveloperMessage(rnfe.getMessage());
+        errorDetail.setDetail(rnfe.getLocalizedMessage());
+        return new ResponseEntity<>(errorDetail, HttpStatus.NOT_FOUND);
+    }
+
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    public ResponseEntity<?> handleValidationError(  MethodArgumentNotValidException manve, HttpServletRequest request){
+        ErrorDetail errorDetail = new ErrorDetail();
+        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<>(fieldErrors, HttpStatus.NOT_FOUND);
+    }
+}

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

@@ -0,0 +1,23 @@
+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 {
+
+    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,10 @@
+package io.zipcoder.tc_spring_poll_application.repositories;
+
+import io.zipcoder.tc_spring_poll_application.domain.Option;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.repository.PagingAndSortingRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface OptionRepository extends CrudRepository<Option, Long> {
+}

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

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

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

@@ -0,0 +1,18 @@
+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;
+import org.springframework.data.repository.PagingAndSortingRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+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);
+
+        Iterable<Vote> findById(Long pollId);
+}

src/main/resources/import.sql

@@ -0,0 +1,74 @@
+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 option (option_id, option_value, poll_id) values (2, 'Blue', 1);
+insert into option (option_id, option_value, poll_id) values (3, 'Orange', 1);
+
+insert into poll (poll_id, question) values (2, 'What is your favorite car?');
+insert into option (option_id, option_value, poll_id) values (4, 'Buick', 2);
+insert into option (option_id, option_value, poll_id) values (5, 'Ford', 2);
+insert into option (option_id, option_value, poll_id) values (6, 'Lexus', 2);
+
+insert into poll (poll_id, question) values (3, 'What is your favorite food?');
+insert into option (option_id, option_value, poll_id) values (7, 'Pizza', 3);
+insert into option (option_id, option_value, poll_id) values (8, 'Salad', 3);
+insert into option (option_id, option_value, poll_id) values (9, 'Burgers', 3);
+
+insert into poll (poll_id, question) values (4, 'What is your favorite Movie?');
+insert into option (option_id, option_value, poll_id) values (10, 'Avengers', 4);
+insert into option (option_id, option_value, poll_id) values (11, 'Titanic', 4);
+insert into option (option_id, option_value, poll_id) values (12, 'Taken', 4);
+
+insert into poll (poll_id, question) values (5, 'What is your favorite Drink?');
+insert into option (option_id, option_value, poll_id) values (13, 'Soda', 5);
+insert into option (option_id, option_value, poll_id) values (14, 'Water', 5);
+insert into option (option_id, option_value, poll_id) values (15, 'Tea', 5);
+
+insert into poll (poll_id, question) values (6, 'What is your favorite game?');
+insert into option (option_id, option_value, poll_id) values (16, 'Sorry', 6);
+insert into option (option_id, option_value, poll_id) values (17, 'Yatzee', 6);
+insert into option (option_id, option_value, poll_id) values (18, 'Orange', 6);
+
+insert into poll (poll_id, question) values (7, 'What is your favorite subject?');
+insert into option (option_id, option_value, poll_id) values (19, 'Math', 7);
+insert into option (option_id, option_value, poll_id) values (20, 'Science', 7);
+insert into option (option_id, option_value, poll_id) values (21, 'Gym', 7);
+
+insert into poll (poll_id, question) values (8, 'What is your favorite operating system?');
+insert into option (option_id, option_value, poll_id) values (22, 'Mac', 8);
+insert into option (option_id, option_value, poll_id) values (23, 'Windows', 8);
+insert into option (option_id, option_value, poll_id) values (24, 'Linux', 8);
+
+insert into poll (poll_id, question) values (9, 'What is your favorite phone?');
+insert into option (option_id, option_value, poll_id) values (25, 'Iphone', 9);
+insert into option (option_id, option_value, poll_id) values (26, 'Android', 9);
+insert into option (option_id, option_value, poll_id) values (27, 'Windows', 9);
+
+insert into poll (poll_id, question) values (10, 'What is your favorite company?');
+insert into option (option_id, option_value, poll_id) values (28, 'JPMC', 10);
+insert into option (option_id, option_value, poll_id) values (29, 'SEI', 10);
+insert into option (option_id, option_value, poll_id) values (30, 'Chatham', 10);
+
+insert into poll (poll_id, question) values (11, 'What is your favorite fruit?');
+insert into option (option_id, option_value, poll_id) values (31, 'Apple', 11);
+insert into option (option_id, option_value, poll_id) values (32, 'Orange', 11);
+insert into option (option_id, option_value, poll_id) values (33, 'Banana', 11);
+
+insert into poll (poll_id, question) values (12, 'What is your favorite vegetable?');
+insert into option (option_id, option_value, poll_id) values (34, 'String Beans', 12);
+insert into option (option_id, option_value, poll_id) values (35, 'Carrots', 12);
+insert into option (option_id, option_value, poll_id) values (35, 'Peas', 12);
+
+insert into poll (poll_id, question) values (13, 'What is your favorite state?');
+insert into option (option_id, option_value, poll_id) values (36, 'Delaware', 13);
+insert into option (option_id, option_value, poll_id) values (37, 'Florida', 13);
+insert into option (option_id, option_value, poll_id) values (38, 'California', 13);
+
+insert into poll (poll_id, question) values (14, 'What is your favorite country?');
+insert into option (option_id, option_value, poll_id) values (39, 'USA', 14);
+insert into option (option_id, option_value, poll_id) values (40, 'Europe', 14);
+insert into option (option_id, option_value, poll_id) values (41, 'Africa', 14);
+
+insert into poll (poll_id, question) values (15, 'What is your favorite search engine?');
+insert into option (option_id, option_value, poll_id) values (42, 'Google', 15);
+insert into option (option_id, option_value, poll_id) values (43, 'Bing', 15);
+insert into option (option_id, option_value, poll_id) values (44, 'Yahoo', 15);

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}