PRA#02_SpringBoot-EmmaAlonsoMcCoy-CreateUserAPIRest

README.md

@@ -0,0 +1,95 @@
+# PRA#02-SpringBoot: Create User API Rest
+
+## CIFO La Violeta - FullStack IFCD0210-25 MF01
+
+This document serves as a guide and log for the backend development of the PRA#02 Spring Boot project.
+
+---
+
+## PR Submission Checklist
+
+### **Common Tasks:**
+
+- [x] Create User @Entity
+- [x] Create UserController (Rest API controller)
+- [x] Implement UserRepository
+- [x] Configure application properties with local H2 database
+- [x] Develop UserService
+- [x] Test all endpoints with Postman
+
+### Optional Tasks:
+
+- [x] Configure Postgres database
+- [x] Implement Faker for test data
+- [x] Add unit tests for services
+- [x] Integration tests for controllers
+
+### **Testing**:
+
+- [x] All endpoints tested in Postman.
+- [x] Error handling implemented in controllers.
+- [x] Data persistence verified in H2 database.
+
+---
+
+## Estimated Time for Tasks
+
+### Common Part
+
+| Task                        | Estimated Time | Actual Time    | Impediments (if any)                                                      | New Concepts                                                                                                 |
+| --------------------------- | -------------- | -------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| Create User @Entity         | 1 hours        | 45 min         |                                                                           | @PrePersist<br/>@GeneratedValue(strategy = GenerationType.UUID)<br/>@Column(unique = true, nullable = false) |
+| Create UserController       | 1 hours        | 1.5 hour       |                                                                           | ResponseEntity utility methods <br/> Centralize headers handling using helper method                         |
+| Implement UserRepository    | 0.5 hours      | 0.5 hours      |                                                                           |                                                                                                              |
+| Configure H2 database       | 0.5 hours      | 0.5 hours      |                                                                           |                                                                                                              |
+| Develop UserService         | 2 hours        | 1 hours        |                                                                           |                                                                                                              |
+| Test endpoints with Postman | 1.5 hours      | 2 hours        | data.sql only executes correctly if the table has been created previously | data.sql to introduce mock data <br/>postman data file to test and run collections                           |
+| **Total**                   | **6.5 hours**  | **6.25 hours** |                                                                           |                                                                                                              |
+
+### Optional Part
+
+| Task                              | Estimated Time | Actual Time   | Impediments (if any) | New Concepts                                                                                                                        |
+| --------------------------------- | -------------- | ------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| Configure Postgres database       | 2.5 hours      | 2.5 hours     |                      |                                                                                                                                     |
+| Implement Faker for test data     | 1 hours        | 1.5 hours     |                      | Use Faker dinamically via API (not implemented) <br/> Streams: IntStream.range(x, y).mapToObj(i -> ...).collect(Collectors.toList() |
+| Add unit tests for services       | 2 hours        | 1.5 hours     |                      | Mockito JUnit integration                                                                                                           |
+| Integration tests for controllers | 2 hours        | 1 hour so far |                      | MockMvc and Fluent API                                                                                                              |
+| **Total**                         | **7.5 hours**  | **6.5 hours** |                      |                                                                                                                                     |
+
+---
+
+## Images
+
+### <u>H2</u>
+
+#### Database Connection
+
+![](./PRA/PRA02-H2.png)
+
+#### Postman Runner Results
+
+![](./PRA/PRA02-PostmanRunner.png)
+
+### <u>Postgres</u>
+
+#### Database Connection (pgAdmin 4 & terminal)
+
+![](./PRA/PRA02-pgAdmin4.png)
+
+![](/./PRA/PRA02-PostgresTerminal.png)
+
+#### Postman Runner Results
+
+![](./PRA/PRA02-PostmanRunner-Postgres.png)
+
+---
+
+## Future Improvements
+
+- <mark>Implement Global Exception Handling.</mark>
+- Add more unit and integration tests for key functionalities.
+- Implement custom queries for enhanced user search.
+- Optimize service layer for better performance and maintainability.
+- Enhance validation for user input fields.
+
+---

backend/pronunciationAppBack/pom.xml

@@ -34,6 +34,11 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-data-jpa</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-web</artifactId>
@@ -65,6 +70,11 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>com.github.javafaker</groupId>
+			<artifactId>javafaker</artifactId>
+			<version>1.0.2</version>
+		</dependency>
 	</dependencies>
 
 	<build>

backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/HealthController.java

@@ -0,0 +1,86 @@
+package dev.pronunciationAppBack.controller;
+
+
+import dev.pronunciationAppBack.service.UserService;
+import dev.pronunciationAppBack.service.WordService;
+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.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+
+@RestController
+@RequestMapping("/api/health")
+public class HealthController {
+
+    @Autowired
+    private WordService wordService;
+
+    @Autowired
+    private UserService userService;
+
+    @GetMapping
+    public ResponseEntity<Map<String, Object>> healthCheck() {
+        Map<String, Object> healthStatus = new HashMap<>();
+        healthStatus.put("status", "UP");
+        healthStatus.put("timestamp", new Date());
+        healthStatus.put("wordCount", wordService.getWordCount());
+        healthStatus.put("userCount", userService.getUserCount());
+
+        // verify database connection
+        boolean databaseConnection = checkDatabaseConnection();
+        healthStatus.put("database", databaseConnection ? "Connected" : "Disconnected");
+
+        // Add more health checks as needed
+        healthStatus.put("memoryUsage", getMemoryUsage());
+        healthStatus.put("diskSpace", getDiskSpace());
+
+        HttpHeaders headers = getCommonHeaders("Health check endpoint");
+        HttpStatus status = databaseConnection ? HttpStatus.OK : HttpStatus.SERVICE_UNAVAILABLE;
+
+        return new ResponseEntity<>(healthStatus, headers, status);
+    }
+
+    private boolean checkDatabaseConnection() {
+        try {
+            wordService.getAllWords();
+            return true;
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
+    private Map<String, Long> getMemoryUsage() {
+        Runtime runtime = Runtime.getRuntime();
+        Map<String, Long> memoryInfo = new HashMap<>();
+        memoryInfo.put("total", runtime.totalMemory());
+        memoryInfo.put("free", runtime.freeMemory());
+        memoryInfo.put("used", runtime.totalMemory() - runtime.freeMemory());
+        return memoryInfo;
+    }
+
+    private Map<String, Long> getDiskSpace() {
+        java.io.File root = new java.io.File("/");
+        Map<String, Long> diskInfo = new HashMap<>();
+        diskInfo.put("total", root.getTotalSpace());
+        diskInfo.put("free", root.getFreeSpace());
+        diskInfo.put("usable", root.getUsableSpace());
+        return diskInfo;
+    }
+
+    private HttpHeaders getCommonHeaders(String description) {
+        HttpHeaders headers = new HttpHeaders();
+        headers.add("desc", description);
+        headers.add("content-type", "application/json");
+        headers.add("date", new Date().toString());
+        headers.add("server", "Spring Boot");
+        headers.add("version", "1.0.0");
+        return headers;
+    }
+}

backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/UserController.java

@@ -0,0 +1,98 @@
+package dev.pronunciationAppBack.controller;
+
+import dev.pronunciationAppBack.service.UserService;
+import dev.pronunciationAppBack.model.User;
+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 java.net.URI;
+import java.util.Date;
+import java.util.List;
+import java.util.Optional;
+
+@RestController
+@RequestMapping("/api/users")
+public class UserController {
+
+    @Autowired
+    public UserService userService;
+
+    private HttpHeaders getHeaders(String message) {
+        HttpHeaders headers = new HttpHeaders();
+        headers.add("Description", message);
+        return headers;
+    }
+
+    @GetMapping
+    public ResponseEntity<List<User>> getAllUsers() {
+        List<User> users = userService.getAllUsers();
+
+        return !users.isEmpty()
+            ? ResponseEntity.ok().headers(getHeaders("Returning all users")).body(users)
+            : ResponseEntity.notFound().headers(getHeaders("No users found")).build();
+    }
+
+    @GetMapping("/{id}")
+    public ResponseEntity<User> getUserById(@PathVariable String id) {
+        Optional<User> user = userService.getUserById(id);
+
+        return user.map(u -> ResponseEntity.ok().headers(getHeaders("User found")).body(u))
+                .orElseGet(() -> ResponseEntity.notFound().headers(getHeaders("User not found")).build());
+    }
+
+    @PostMapping("/createUser")
+    public ResponseEntity<User> createUser(@RequestBody User user){
+        User createdUser = userService.createUser(user);
+
+        //return ResponseEntity.ok().body(createdUser);
+        return ResponseEntity.status(HttpStatus.CREATED).body(createdUser);
+
+        //URI location = URI.create("/users/" + createdUser.getId());
+        //return ResponseEntity.created(location).headers(getHeaders("User created successfully")).body(user);
+    }
+
+    @PutMapping("/{id}")
+    public ResponseEntity<User> updateUser(@PathVariable String id, @RequestBody User user) {
+        if (user.getId() != null && !user.getId().equals(id)) {
+            return ResponseEntity.badRequest().headers(getHeaders("Mismatch between ID and user ID in body request")).build();
+        } else {
+            User updatedUser = userService.updateUser(user);
+            return ResponseEntity.ok().headers(getHeaders("User updated")).body(updatedUser);
+        }
+    }
+
+    @DeleteMapping("/{id}")
+    public ResponseEntity<String> deleteUserById(@PathVariable String id){
+        if (userService.existsById(id)) {
+            userService.deleteUser(id);
+            return ResponseEntity.ok().headers(getHeaders("User deleted successfully")).build();
+        } else {
+            return ResponseEntity.notFound().headers(getHeaders("User not found")).build();
+        }
+    }
+
+    @DeleteMapping
+    public ResponseEntity<String> deleteAllUsers(){
+        userService.deleteAllUsers();
+        if (userService.getAllUsers().isEmpty()){
+            return ResponseEntity.ok().headers(getHeaders("All users deleted succesfully")).build();
+        } else {
+            return ResponseEntity.notFound().headers(getHeaders("Could not delete all users")).build();
+        }
+    }
+
+//    private HttpHeaders getCommonHeaders(String description) {
+//        HttpHeaders headers = new HttpHeaders();
+//        headers.add("desc", description);
+//        headers.add("content-type", "application/json");
+//        headers.add("date", new Date().toString());
+//        headers.add("server", "Spring Boot");
+//        headers.add("version", "1.0.0");
+//        headers.add("word-count", String.valueOf(userService.getUserCount()));
+//        headers.add("object", "words");
+//        return headers;
+//    }
+}