implement register api handler

jamesjieye · jamesjieye · commit 36e4686a4c7b · 2018-08-26T15:14:52.000+08:00
diff --git a/pom.xml b/pom.xml
@@ -42,6 +42,10 @@
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.apache.commons</groupId>
+      <artifactId>commons-lang3</artifactId>
+    </dependency>
 
     <dependency>
       <groupId>org.springframework.boot</groupId>
diff --git a/src/main/java/com/taskagile/domain/application/UserService.java b/src/main/java/com/taskagile/domain/application/UserService.java
@@ -0,0 +1,17 @@
+package com.taskagile.domain.application;
+
+import com.taskagile.domain.application.commands.RegistrationCommand;
+import com.taskagile.domain.model.user.RegistrationException;
+
+public interface UserService {
+
+  /**
+   * Register a new user with username, email address, and password.
+   *
+   * @param command instance of <code>RegistrationCommand</code>
+   * @throws RegistrationException when registration failed. Possible reasons are:
+   *                               1) Username already exists
+   *                               2) Email address already exists.
+   */
+  void register(RegistrationCommand command) throws RegistrationException;
+}
diff --git a/src/main/java/com/taskagile/domain/application/commands/RegistrationCommand.java b/src/main/java/com/taskagile/domain/application/commands/RegistrationCommand.java
@@ -0,0 +1,53 @@
+package com.taskagile.domain.application.commands;
+
+public class RegistrationCommand {
+
+  private String username;
+  private String emailAddress;
+  private String password;
+
+  public RegistrationCommand(String username, String emailAddress, String password) {
+    this.username = username;
+    this.emailAddress = emailAddress;
+    this.password = password;
+  }
+
+  public String getUsername() {
+    return this.username;
+  }
+
+  public String getEmailAddress() {
+    return this.emailAddress;
+  }
+
+  public String getPassword() {
+    return this.password;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+    RegistrationCommand that = (RegistrationCommand) o;
+    if (username != null ? !username.equals(that.username) : that.username != null) return false;
+    if (emailAddress != null ? !emailAddress.equals(that.emailAddress) : that.emailAddress != null) return false;
+    return password != null ? password.equals(that.password) : that.password == null;
+  }
+
+  @Override
+  public int hashCode() {
+    int result = username != null ? username.hashCode() : 0;
+    result = 31 * result + (emailAddress != null ? emailAddress.hashCode() : 0);
+    result = 31 * result + (password != null ? password.hashCode() : 0);
+    return result;
+  }
+
+  @Override
+  public String toString() {
+    return "RegistrationCommand{" +
+      "username='" + username + '\'' +
+      ", emailAddress='" + emailAddress + '\'' +
+      ", password='" + password + '\'' +
+      '}';
+  }
+}
diff --git a/src/main/java/com/taskagile/domain/application/impl/UserServiceImpl.java b/src/main/java/com/taskagile/domain/application/impl/UserServiceImpl.java
@@ -0,0 +1,16 @@
+package com.taskagile.domain.application.impl;
+
+import com.taskagile.domain.application.UserService;
+import com.taskagile.domain.application.commands.RegistrationCommand;
+import com.taskagile.domain.model.user.RegistrationException;
+import org.springframework.stereotype.Service;
+
+@Service
+public class UserServiceImpl implements UserService {
+
+  @Override
+  public void register(RegistrationCommand command) throws RegistrationException {
+    // TODO implement this
+  }
+
+}
diff --git a/src/main/java/com/taskagile/domain/model/user/EmailAddressExistsException.java b/src/main/java/com/taskagile/domain/model/user/EmailAddressExistsException.java
@@ -0,0 +1,7 @@
+package com.taskagile.domain.model.user;
+
+public class EmailAddressExistsException extends RegistrationException {
+
+  private static final long serialVersionUID = -7856406258381199164L;
+
+}
diff --git a/src/main/java/com/taskagile/domain/model/user/RegistrationException.java b/src/main/java/com/taskagile/domain/model/user/RegistrationException.java
@@ -0,0 +1,7 @@
+package com.taskagile.domain.model.user;
+
+public class RegistrationException extends Exception {
+
+  private static final long serialVersionUID = -2737904013752279210L;
+
+}
diff --git a/src/main/java/com/taskagile/domain/model/user/UsernameExistsException.java b/src/main/java/com/taskagile/domain/model/user/UsernameExistsException.java
@@ -0,0 +1,7 @@
+package com.taskagile.domain.model.user;
+
+public class UsernameExistsException extends RegistrationException {
+
+  private static final long serialVersionUID = -7856406258381199164L;
+
+}
diff --git a/src/main/java/com/taskagile/utils/JsonUtils.java b/src/main/java/com/taskagile/utils/JsonUtils.java
@@ -0,0 +1,24 @@
+package com.taskagile.utils;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public final class JsonUtils {
+
+  private static final Logger log = LoggerFactory.getLogger(JsonUtils.class);
+
+  private JsonUtils() {
+  }
+
+  public static String toJson(Object object) {
+    ObjectMapper mapper = new ObjectMapper();
+    try {
+      return mapper.writeValueAsString(object);
+    } catch (JsonProcessingException e) {
+      log.error("Failed to convert object to JSON string", e);
+      return null;
+    }
+  }
+}
diff --git a/src/main/java/com/taskagile/web/apis/RegistrationApiController.java b/src/main/java/com/taskagile/web/apis/RegistrationApiController.java
@@ -0,0 +1,41 @@
+package com.taskagile.web.apis;
+
+import com.taskagile.domain.application.UserService;
+import com.taskagile.domain.model.user.EmailAddressExistsException;
+import com.taskagile.domain.model.user.RegistrationException;
+import com.taskagile.domain.model.user.UsernameExistsException;
+import com.taskagile.web.payload.RegistrationPayload;
+import com.taskagile.web.results.ApiResult;
+import com.taskagile.web.results.Result;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+
+import javax.validation.Valid;
+
+@Controller
+public class RegistrationApiController {
+
+  private UserService service;
+
+  public RegistrationApiController(UserService service) {
+    this.service = service;
+  }
+
+  @PostMapping("/api/registrations")
+  public ResponseEntity<ApiResult> register(@Valid @RequestBody RegistrationPayload payload) {
+    try {
+      service.register(payload.toCommand());
+      return Result.created();
+    } catch (RegistrationException e) {
+      String errorMessage = "Registration failed";
+      if (e instanceof UsernameExistsException) {
+        errorMessage = "Username already exists";
+      } else if (e instanceof EmailAddressExistsException) {
+        errorMessage = "Email address already exists";
+      }
+      return Result.failure(errorMessage);
+    }
+  }
+}
diff --git a/src/main/java/com/taskagile/web/payload/RegistrationPayload.java b/src/main/java/com/taskagile/web/payload/RegistrationPayload.java
@@ -0,0 +1,51 @@
+package com.taskagile.web.payload;
+
+import com.taskagile.domain.application.commands.RegistrationCommand;
+
+import javax.validation.constraints.Email;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Size;
+
+public class RegistrationPayload {
+
+  @Size(min = 2, max = 50, message = "Username must be between 2 and 50 characters")
+  @NotNull
+  private String username;
+
+  @Email(message = "Email address should be valid")
+  @Size(max = 100, message = "Email address must not be more than 100 characters")
+  @NotNull
+  private String emailAddress;
+
+  @Size(min = 6, max = 30, message = "Password must be between 6 and 30 characters")
+  @NotNull
+  private String password;
+
+  public RegistrationCommand toCommand() {
+    return new RegistrationCommand(this.username, this.emailAddress, this.password);
+  }
+
+  public String getUsername() {
+    return username;
+  }
+
+  public void setUsername(String username) {
+    this.username = username;
+  }
+
+  public String getEmailAddress() {
+    return emailAddress;
+  }
+
+  public void setEmailAddress(String emailAddress) {
+    this.emailAddress = emailAddress;
+  }
+
+  public String getPassword() {
+    return password;
+  }
+
+  public void setPassword(String password) {
+    this.password = password;
+  }
+}
diff --git a/src/main/java/com/taskagile/web/results/ApiResult.java b/src/main/java/com/taskagile/web/results/ApiResult.java
@@ -0,0 +1,43 @@
+package com.taskagile.web.results;
+
+import org.springframework.util.Assert;
+
+import java.util.HashMap;
+
+public class ApiResult extends HashMap<String, Object> {
+
+  private static final long serialVersionUID = 877825499039674411L;
+
+  private static final String MESSAGE_KEY = "message";
+  private static final String ERROR_CODE_KEY = "errorReferenceCode";
+
+  public static ApiResult blank() {
+    return new ApiResult();
+  }
+
+  public static ApiResult message(String message) {
+    Assert.hasText(message, "Parameter `message` must not be blank");
+
+    ApiResult apiResult = new ApiResult();
+    apiResult.put("message", message);
+    return apiResult;
+  }
+
+  public static ApiResult error(String message, String errorReferenceCode) {
+    Assert.hasText(message, "Parameter `message` must not be blank");
+    Assert.hasText(errorReferenceCode, "Parameter `errorReferenceCode` must not be blank");
+
+    ApiResult apiResult = new ApiResult();
+    apiResult.put(MESSAGE_KEY, message);
+    apiResult.put(ERROR_CODE_KEY, errorReferenceCode);
+    return apiResult;
+  }
+
+  public ApiResult add(String key, Object value) {
+    Assert.hasText(key, "Parameter `key` must not be blank");
+    Assert.notNull(value, "Parameter `value` must not be null");
+
+    this.put(key, value);
+    return this;
+  }
+}
diff --git a/src/main/java/com/taskagile/web/results/Result.java b/src/main/java/com/taskagile/web/results/Result.java
@@ -0,0 +1,51 @@
+package com.taskagile.web.results;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.util.Assert;
+
+public final class Result {
+
+  private Result() {
+  }
+
+  public static ResponseEntity<ApiResult> created() {
+    return ResponseEntity.status(201).build();
+  }
+
+  public static ResponseEntity<ApiResult> ok() {
+    return ResponseEntity.ok().build();
+  }
+
+  public static ResponseEntity<ApiResult> ok(String message) {
+    Assert.hasText(message, "Parameter `message` must not be blank");
+
+    return ok(ApiResult.message(message));
+  }
+
+  public static ResponseEntity<ApiResult> ok(ApiResult payload) {
+    Assert.notNull(payload, "Parameter `payload` must not be null");
+
+    return ResponseEntity.ok(payload);
+  }
+
+  public static ResponseEntity<ApiResult> failure(String message) {
+    return ResponseEntity.badRequest().body(ApiResult.message(message));
+  }
+
+  public static ResponseEntity<ApiResult> serverError(String message, String errorReferenceCode) {
+    return ResponseEntity.status(500).body(ApiResult.error(message, errorReferenceCode));
+  }
+
+  public static ResponseEntity<ApiResult> notFound() {
+    return ResponseEntity.notFound().build();
+  }
+
+  public static ResponseEntity<ApiResult> unauthenticated() {
+    return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build();
+  }
+
+  public static ResponseEntity<ApiResult> forbidden() {
+    return ResponseEntity.status(HttpStatus.FORBIDDEN).build();
+  }
+}
diff --git a/src/test/java/com/taskagile/web/apis/RegistrationApiControllerTests.java b/src/test/java/com/taskagile/web/apis/RegistrationApiControllerTests.java
diff --git a/src/test/java/com/taskagile/web/payload/RegistrationPayloadTests.java b/src/test/java/com/taskagile/web/payload/RegistrationPayloadTests.java
