Merge pull request #3 from handsonprogrammer/create-registration-endpoint

handsonprogrammer · web-flow · commit fdf8afbcd457 · 2025-01-16T15:32:25.000-05:00
Registration endpoint creation
diff --git a/ocommapi/pom.xml b/ocommapi/pom.xml
@@ -38,6 +38,10 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-data-jpa</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-validation</artifactId>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-security</artifactId>
diff --git a/ocommapi/src/main/java/com/ocommerce/api/configuration/SecurityConfig.java b/ocommapi/src/main/java/com/ocommerce/api/configuration/SecurityConfig.java
@@ -0,0 +1,26 @@
+package com.ocommerce.api.configuration;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.HttpMethod;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
+import org.springframework.security.web.SecurityFilterChain;
+
+@Configuration
+@EnableWebSecurity
+public class SecurityConfig {
+
+    @Bean
+    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
+
+        http.csrf((csrf) -> csrf
+                .ignoringRequestMatchers("/api/**"));
+        http.authorizeHttpRequests((authorize) ->
+                        authorize.requestMatchers("/api/auth/register").permitAll()
+                                .anyRequest().authenticated());
+        return http.build();
+    }
+
+}
diff --git a/ocommapi/src/main/java/com/ocommerce/api/controller/auth/AuthenticationController.java b/ocommapi/src/main/java/com/ocommerce/api/controller/auth/AuthenticationController.java
@@ -0,0 +1,66 @@
+package com.ocommerce.api.controller.auth;
+
+import com.ocommerce.api.exception.UserAlreadyExistsException;
+import com.ocommerce.api.model.RegistrationBody;
+import com.ocommerce.api.service.UserService;
+import jakarta.validation.Valid;
+import jakarta.validation.ValidationException;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
+import org.springframework.http.ProblemDetail;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.BindException;
+import org.springframework.validation.Errors;
+import org.springframework.validation.FieldError;
+import org.springframework.web.ErrorResponse;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Rest Controller for handling authentication requests.
+ */
+@RestController
+@RequestMapping("/api/auth")
+public class AuthenticationController {
+
+    /** The user service. */
+    private UserService userService;
+
+    /**
+     * Spring injected constructor.
+     * @param userService
+     */
+    public AuthenticationController(UserService userService) {
+        this.userService = userService;
+    }
+
+    /**
+     * Post Mapping to handle registering users.
+     * @param registrationBody The registration information.
+     * @return Response to front end.
+     */
+    @PostMapping("/register")
+    public ResponseEntity registerUser(@Valid @RequestBody RegistrationBody registrationBody) {
+        try {
+            userService.registerUser(registrationBody);
+            return ResponseEntity.ok().build();
+        } catch (UserAlreadyExistsException ex) {
+            return ResponseEntity.status(HttpStatus.CONFLICT).build();
+        }
+    }
+
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    public Map<String, String> handleValidationExceptions(MethodArgumentNotValidException ex) {
+        Map<String, String> errors = new HashMap<>();
+        ex.getBindingResult().getAllErrors().forEach((error) -> {
+            String fieldName = ((FieldError) error).getField();
+            String errorMessage = error.getDefaultMessage();
+            errors.put(fieldName, errorMessage);
+        });
+        return errors;
+    }
+}
diff --git a/ocommapi/src/main/java/com/ocommerce/api/exception/UserAlreadyExistsException.java b/ocommapi/src/main/java/com/ocommerce/api/exception/UserAlreadyExistsException.java
@@ -0,0 +1,4 @@
+package com.ocommerce.api.exception;
+
+public class UserAlreadyExistsException extends Exception{
+}
diff --git a/ocommapi/src/main/java/com/ocommerce/api/jpa/repositories/UserRegRepository.java b/ocommapi/src/main/java/com/ocommerce/api/jpa/repositories/UserRegRepository.java
@@ -0,0 +1,14 @@
+package com.ocommerce.api.jpa.repositories;
+
+import com.ocommerce.api.jpa.entities.UserReg;
+import org.springframework.data.repository.CrudRepository;
+
+import java.util.Optional;
+
+public interface UserRegRepository extends CrudRepository<UserReg, Long> {
+
+    Optional<UserReg> findByUsernameIgnoreCase(String username);
+
+    Optional<UserReg> findByEmailIgnoreCase(String email);
+
+}
diff --git a/ocommapi/src/main/java/com/ocommerce/api/model/RegistrationBody.java b/ocommapi/src/main/java/com/ocommerce/api/model/RegistrationBody.java
@@ -0,0 +1,40 @@
+package com.ocommerce.api.model;
+
+import jakarta.validation.constraints.Email;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Pattern;
+import jakarta.validation.constraints.Size;
+import lombok.Getter;
+
+/**
+ * The information required to register a user.
+ */
+@Getter
+public class RegistrationBody {
+
+    /** The username. */
+    @NotNull
+    @NotBlank
+    @Size(min=6, max=255)
+    private String username;
+    /** The email. */
+    @NotNull
+    @NotBlank
+    @Email
+    private String email;
+    /** The password. */
+    @NotNull
+    @NotBlank
+    @Pattern(regexp = "^(?=.*[A-Za-z])(?=.*\\d)[A-Za-z\\d]{6,}$")
+    @Size(min=8, max=32)
+    private String password;
+    /** The first name. */
+    @NotNull
+    @NotBlank
+    private String firstName;
+    /** The last name. */
+    @NotNull
+    @NotBlank
+    private String lastName;
+}
diff --git a/ocommapi/src/main/java/com/ocommerce/api/service/UserService.java b/ocommapi/src/main/java/com/ocommerce/api/service/UserService.java
@@ -0,0 +1,43 @@
+package com.ocommerce.api.service;
+
+import com.ocommerce.api.exception.UserAlreadyExistsException;
+import com.ocommerce.api.jpa.entities.UserReg;
+import com.ocommerce.api.jpa.repositories.UserRegRepository;
+import com.ocommerce.api.model.RegistrationBody;
+import org.springframework.stereotype.Service;
+
+@Service
+public class UserService {
+
+    /** The LocalUserDAO. */
+    private UserRegRepository userRegRepo;
+
+    /**
+     * Constructor injected by spring.
+     * @param userRegRepo
+     */
+    public UserService(UserRegRepository userRegRepo) {
+        this.userRegRepo = userRegRepo;
+    }
+
+    /**
+     * Attempts to register a user given the information provided.
+     * @param registrationBody The registration information.
+     * @return The local user that has been written to the database.
+     * @throws UserAlreadyExistsException Thrown if there is already a user with the given information.
+     */
+    public void registerUser(RegistrationBody registrationBody) throws UserAlreadyExistsException {
+        if (userRegRepo.findByEmailIgnoreCase(registrationBody.getEmail()).isPresent()
+                || userRegRepo.findByUsernameIgnoreCase(registrationBody.getUsername()).isPresent()) {
+            throw new UserAlreadyExistsException();
+        }
+        UserReg user = new UserReg();
+        user.setEmail(registrationBody.getEmail());
+        user.setUsername(registrationBody.getUsername());
+        user.setFirstName(registrationBody.getFirstName());
+        user.setLastName(registrationBody.getLastName());
+        //TODO: Encrypt passwords!!
+        user.setPassword(registrationBody.getPassword());
+       userRegRepo.save(user);
+    }
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +package com.ocommerce.api.exception;
++
 +public class UserAlreadyExistsException extends Exception{
 +}