REFACTOR: minor improvements for code reability and ADD bash script instructions on readme

Author: gmartinezramirez

README.md

@@ -27,6 +27,7 @@
 * JDK or OpenJDK - 1.8.x
 * Maven - 3.x.x
 * MySQL - 5.x.x or MariaDB 10.x.x
+* Spring - 2.0.0.RELEASE (inclued in pom.xml)
 
 * Tested on:
 * GNU/Linux Solus 3
@@ -82,6 +83,12 @@ java -jar target/person-1.0.0.jar
 mvn spring-boot:run
 ```
 
++ Also, you can run the app without packaging it using:
+
+```bash
+./run.sh
+```
+
 <p align="center"><img width=95% src="https://github.com/gmartinezramirez/Spring-API-REST-Person-CRUD/blob/master/docs/mvn-spring-bootrun.gif"></p>
 
 

pom.xml

@@ -14,7 +14,7 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>1.5.4.RELEASE</version>
+		<version>2.0.0.RELEASE</version>
 		<relativePath/> <!-- lookup parent from repository -->
 	</parent>
 

src/main/java/com/people23/person/controller/PersonController.java

@@ -6,6 +6,8 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 
+import com.people23.person.exception.PersonNotFoundException;
+
 import javax.validation.Valid;
 import java.util.List;
 
@@ -25,40 +27,35 @@ public List<Person> getAllPersons() {
 	}
 
 	@GetMapping("/persons/{id}")
-	public ResponseEntity<Person> getPersonById(@PathVariable(value = "id") Long id) {
-		Person person = personRepository.findOne(id);
-		if (person == null) {
-			return ResponseEntity.notFound().build();
-		}
-		return ResponseEntity.ok().body(person);
+	public Person getPersonById(@PathVariable(value = "id") Long id) {
+	    return personRepository.findById(id)
+	            .orElseThrow(() -> new PersonNotFoundException("Person", "id", id));
 	}
-
+	
 	@PostMapping("/persons")
 	public Person createPerson(@Valid @RequestBody Person person) {
 		return personRepository.save(person);
 	}
 
 	@PutMapping("/persons/{id}")
-	public ResponseEntity<Person> updatePerson(@PathVariable(value = "id") Long id,
-											   @Valid @RequestBody Person personDetails) {
-		Person person = personRepository.findOne(id);
-		if (person == null) {
-			return ResponseEntity.notFound().build();
-		}
+	public Person updatePerson(@PathVariable(value = "id") Long id, @Valid @RequestBody Person personDetails) {
+
+		Person person = personRepository.findById(id)
+				.orElseThrow(() -> new PersonNotFoundException("Person", "id", id));
+		
 		person.setFirstName(personDetails.getFirstName());
 		person.setLastName(personDetails.getLastName());
 
 		Person updatedPerson = personRepository.save(person);
-		return ResponseEntity.ok(updatedPerson);
+		return updatedPerson;
 	}
 
 	@DeleteMapping("/persons/{id}")
 	public ResponseEntity<Person> deletePerson(@PathVariable(value = "id") Long id) {
-		Person person = personRepository.findOne(id);
-		if (person == null) {
-			return ResponseEntity.notFound().build();
-		}
-
+		
+		Person person = personRepository.findById(id)
+				.orElseThrow(() -> new PersonNotFoundException("Person", "id", id));
+		
 		personRepository.delete(person);
 		return ResponseEntity.ok().build();
 	}

src/main/java/com/people23/person/exception/PersonNotFoundException.java

@@ -0,0 +1,30 @@
+package com.people23.person.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(value = HttpStatus.NOT_FOUND)
+public class PersonNotFoundException extends RuntimeException {
+    private String personName;
+    private String fieldName;
+    private Object fieldValue;
+
+    public PersonNotFoundException( String personName, String fieldName, Object fieldValue) {
+        super(String.format("%s not found with %s : '%s'", personName, fieldName, fieldValue));
+        this.personName = personName;
+        this.fieldName = fieldName;
+        this.fieldValue = fieldValue;
+    }
+
+    public String getPersonName() {
+        return personName;
+    }
+
+    public String getFieldName() {
+        return fieldName;
+    }
+
+    public Object getFieldValue() {
+        return fieldValue;
+    }
+}

src/main/java/com/people23/person/model/Person.java

@@ -1,13 +1,13 @@
 package com.people23.person.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
-import org.hibernate.validator.constraints.NotBlank;
 import org.springframework.data.annotation.CreatedDate;
 import org.springframework.data.annotation.LastModifiedDate;
 import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
 import javax.persistence.*;
 import java.util.Date;
+import javax.validation.constraints.NotBlank;
 
 /**
  * Created by gmartinezramirez on 01/03/18.

src/main/java/com/people23/person/repository/PersonRepository.java

@@ -2,11 +2,13 @@
 
 import com.people23.person.model.Person;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
 
 /**
  * Created by gmartinezramirez on 01/03/18.
  * This use JpaRepository that extends the PagingAndSortingRepository that extends CRUDRepository.
  */
+@Repository
 public interface PersonRepository extends JpaRepository<Person, Long> {
 
 }