Exceptions updated etc

Author: syedabdullahrahman

Readme.md

@@ -1,7 +1,7 @@
 Spring Boot REST API Practices
 ========================================
 
-####Features:
+### Features:
 
 * JWT (Signin, Signup, Roles)
 * REST API best practices
@@ -11,6 +11,10 @@ Spring Boot REST API Practices
 ![task](Task.PNG)
 *
 
+### To-do Items
+* Spring HATEOAS
+* Spring Auto REST Docs
+
 ## Requirements
 
 For building and running the application you need:

api-requests.http

@@ -6,36 +6,41 @@
 # * 'mptr' and 'fptr' create a POST request to submit a form with a text or file field (multipart/form-data);
 
 
-GET http://localhost:8080/hello
-Accepts: application/json
-
-###
-
-GET http://localhost:8080/hello
-Accepts: application/json
-Authorization: Bearer <--token here-->
-
+### Sign up
+POST http://localhost:8080/api/auth/signup
+Content-Type: application/json
 
-###
+{
+  "email": "[email protected]",
+  "password": "admin001",
+  "role": [
+    "string"
+  ],
+  "username": "admin001"
+}
 
+### Sign in
 
-POST http://localhost:8080/authenticate
+POST http://localhost:8080/api/auth/signin
 Content-Type: application/json
-Accepts: application/json
 
 {
-"username" :learning,
-"password" :"password"
+  "password": "admin001",
+  "username": "admin001"
 }
 
 ###
 
+GET http://localhost:8080/api/v1/notes
+Accepts: application/json
+Authorization: Bearer <--token here-->
+###
+
 GET http://localhost:8080/api/v1/name/Bangla
 Accepts: application/json
 Authorization: Bearer <--token here-->
 
 ###
-
 GET http://localhost:8080/api/v1/name/bangladesh
 Accepts: application/json
 

src/main/java/com/learning/config/WebSecurityConfig.java

@@ -63,12 +63,10 @@ protected void configure(HttpSecurity httpSecurity) throws Exception {
 				exceptionHandling().authenticationEntryPoint(jwtAuthenticationEntryPoint).and().sessionManagement()
 				.sessionCreationPolicy(SessionCreationPolicy.STATELESS).and()
 				// dont authenticate this particular request
-				.authorizeRequests().antMatchers("/authenticate").permitAll()
-				.antMatchers("/users/signin").permitAll()//
-				.antMatchers("/users/signup").permitAll()//
-				.antMatchers("/h2-console/**/**").permitAll().
+				.authorizeRequests()
+				.antMatchers("/api/auth/**","/h2-console/**/**").permitAll()
 				// all other requests need to be authenticated
-				anyRequest().authenticated();
+				.anyRequest().authenticated();
 
 
 		// If a user try to access a resource without having enough permissions

src/main/java/com/learning/controller/api/v1/NoteController.java

@@ -25,10 +25,7 @@ public class NoteController {
             @ApiResponse(code = 500, message = "Internal Server Error")})
     public ResponseEntity<?> getAllNotes() {
         List<Note> note = noteService.getNotes();
-
-        ImmutableMap<String, Object> dataMap = ImmutableMap.of("status", 200,
-                "message", "success", "data", note);
-        return ResponseEntity.ok().body(dataMap);
+        return ResponseEntity.ok().body(note);
     }
 
     @PostMapping("/v1/notes")

src/main/java/com/learning/controller/auth/AuthController.java

@@ -15,14 +15,14 @@
 @CrossOrigin(origins = "*", maxAge = 3600)
 @RestController
 @RequestMapping("/api/auth")
-@Api(tags = "users")
+@Api(tags = "Auth Controller")
 public class AuthController {
 
   @Autowired
   UserDetailsServiceImpl userDetailsService;
 
   @PostMapping("/signin")
-  @ApiOperation(value = "${AuthController.signin}")
+  @ApiOperation(value = "${AuthController.authenticateUser}")
   @ApiResponses(value = {
           @ApiResponse(code = 400, message = "Something went wrong"),
           @ApiResponse(code = 422, message = "Invalid username/password supplied")})
@@ -31,7 +31,7 @@ public ResponseEntity<?> authenticateUser(@ApiParam("Signin User") @Valid @Reque
   }
 
   @PostMapping("/signup")
-  @ApiOperation(value = "${AuthController.signup}")
+  @ApiOperation(value = "${AuthController.registerUser}")
   @ApiResponses(value = {
           @ApiResponse(code = 400, message = "Something went wrong"),
           @ApiResponse(code = 403, message = "Access denied"),

src/main/java/com/learning/exception/GlobalExceptionHandler.java

@@ -1,14 +1,34 @@
 package com.learning.exception;
 
+import com.learning.payload.response.ErrorResponse;
+import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
+import org.springframework.boot.web.servlet.error.ErrorAttributes;
+import org.springframework.context.annotation.Bean;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.security.access.AccessDeniedException;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
 import org.springframework.web.context.request.WebRequest;
 
-@ControllerAdvice
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.util.Map;
+
+@RestControllerAdvice
 public class GlobalExceptionHandler {
 
+    @Bean
+    public ErrorAttributes errorAttributes() {
+        return new DefaultErrorAttributes() {
+            public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
+                Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);
+                errorAttributes.remove("exception");
+                return errorAttributes;
+            }
+        };
+    }
+
     /**
      * Resource not found exception response entity.
      *
@@ -31,10 +51,26 @@ public ResponseEntity<?> resourceNotFoundException(
      * @param request the request
      * @return the response entity
      */
-    @ExceptionHandler(Exception.class)
+    /*@ExceptionHandler(Exception.class)
     public ResponseEntity<?> globleExcpetionHandler(Exception ex, WebRequest request) {
         ErrorResponse errorDetails =
                 new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.toString() ,ex.getMessage(), request.getDescription(false));
         return new ResponseEntity<>(errorDetails, HttpStatus.INTERNAL_SERVER_ERROR);
+    }*/
+
+    @ExceptionHandler(CustomException.class)
+    public void handleCustomException(HttpServletResponse res, CustomException ex) throws IOException {
+        res.sendError(ex.getHttpStatus().value(), ex.getMessage());
     }
+
+    @ExceptionHandler(AccessDeniedException.class)
+    public void handleAccessDeniedException(HttpServletResponse res) throws IOException {
+        res.sendError(HttpStatus.FORBIDDEN.value(), "Access denied");
+    }
+
+    @ExceptionHandler(Exception.class)
+    public void handleException(HttpServletResponse res) throws IOException {
+        res.sendError(HttpStatus.BAD_REQUEST.value(), "Something went wrong");
+    }
+
 }

src/main/java/com/learning/exception/GlobalExceptionHandlerController.java

@@ -1,4 +1,4 @@
-package com.learning.exception;
+package com.learning.payload.response;
 
 import io.swagger.annotations.ApiModelProperty;
 

src/main/java/com/learning/exception/ErrorResponse.java renamed to src/main/java/com/learning/payload/response/ErrorResponse.java

@@ -11,5 +11,5 @@
 public interface UserRepository extends JpaRepository<User, Long> {
   Optional<User> findByUsername(String username);
   void deleteByUsername(String username);
-
+  Optional<User> findByEmail(String email);
 }

src/main/java/com/learning/repository/UserRepository.java

@@ -9,6 +9,7 @@
 import com.learning.payload.request.LoginRequest;
 import com.learning.payload.request.SignupRequest;
 import com.learning.payload.response.JwtResponse;
+import com.learning.payload.response.MessageResponse;
 import com.learning.repository.RoleRepository;
 import com.learning.repository.UserRepository;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -91,7 +92,7 @@ public JwtResponse signin(@Valid LoginRequest loginRequest) {
     }
   }
 
-  public JwtResponse signup(@Valid SignupRequest signUpRequest) {
+  public MessageResponse signup(@Valid SignupRequest signUpRequest) {
 
     // Create new user's account
     User user = new User(signUpRequest.getUsername(),
@@ -130,16 +131,7 @@ public JwtResponse signup(@Valid SignupRequest signUpRequest) {
     user.setRoles(roles);
     userRepository.save(user);
 
-    UserDetailsImpl userDetails = UserDetailsImpl.build(user);
-    final String token = jwtTokenUtil.generateToken(userDetails);
-
-    return new JwtResponse(token,
-            userDetails.getId(),
-            userDetails.getUsername(),
-            userDetails.getEmail(),
-            userDetails.getAuthorities().stream()
-                    .map(item -> item.getAuthority())
-                    .collect(Collectors.toList()));
+    return new MessageResponse("User registration successful");
   }
 
   public void delete(String username) {
@@ -164,10 +156,12 @@ public String refresh(String username) {
   }
 
   public boolean existsByUsername(String username) {
-    return false;
+    Optional<User> user = userRepository.findByUsername(username);
+    return user.isPresent();
   }
 
   public boolean existsByEmail(String email) {
-    return false;
+    Optional<User> user = userRepository.findByEmail(email);
+    return user.isPresent();
   }
 }

src/main/java/com/learning/service/UserDetailsServiceImpl.java

@@ -9,8 +9,9 @@
 spring.datasource.url=jdbc:h2:mem:testdb
 spring.datasource.driverClassName=org.h2.Driver
 spring.datasource.username=sa
-spring.datasource.password=password
+spring.datasource.password=
 spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
+spring.h2.console.enabled=true
 
 spring.jpa.defer-datasource-initialization=true
 
@@ -21,5 +22,3 @@ my.app.jwtExpirationMs= 6000000
 
 #logging.level.root=debug
 
-
-#jwt.get.token.uri=/authenticate