Merge pull request #139 from TAMULib/2.x-unwrap

[Issue 138] Afford unwrapping API response
TAMULib · Apr 12, 2022 · 510cc44 · 510cc44
2 parents 504448e + 44cd925
commit 510cc44
Show file tree

Hide file tree

Showing 17 changed files with 130 additions and 17 deletions.
diff --git a/auth/pom.xml b/auth/pom.xml
@@ -12,7 +12,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/core/pom.xml b/core/pom.xml
@@ -1,4 +1,5 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 
   <modelVersion>4.0.0</modelVersion>
@@ -12,11 +13,23 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>
 
+    <dependency>
+      <groupId>javax.servlet</groupId>
+      <artifactId>servlet-api</artifactId>
+      <version>3.0-alpha-1</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-web</artifactId>
+    </dependency>
+
     <dependency>
       <groupId>org.springframework</groupId>
       <artifactId>spring-context</artifactId>
@@ -28,8 +41,8 @@
     </dependency>
 
     <dependency>
-      <groupId>com.fasterxml.jackson.core</groupId>
-      <artifactId>jackson-annotations</artifactId>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-json</artifactId>
     </dependency>
 
 

diff --git a/core/src/main/java/edu/tamu/weaver/context/SpringContext.java b/core/src/main/java/edu/tamu/weaver/context/SpringContext.java
@@ -32,4 +32,4 @@ public static <T> T bean(String name) {
         return (T) context.getBean(name);
     }
 
-}
+}
diff --git a/core/src/main/java/edu/tamu/weaver/response/ApiResponse.java b/core/src/main/java/edu/tamu/weaver/response/ApiResponse.java
@@ -4,6 +4,7 @@
 import java.util.HashMap;
 
 import com.fasterxml.jackson.annotation.JsonView;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 
 /**
  * Abstract class for an API response.
@@ -15,6 +16,7 @@
  * @author <a href="mailto:wwelling@library.tamu.edu">William Welling</a>
  * 
  */
+@JsonSerialize(using = ApiResponseSerializer.class)
 public class ApiResponse {
 
     @JsonView(ApiView.Partial.class)

diff --git a/core/src/main/java/edu/tamu/weaver/response/ApiResponseAdvice.java b/core/src/main/java/edu/tamu/weaver/response/ApiResponseAdvice.java
@@ -0,0 +1,16 @@
+package edu.tamu.weaver.response;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+@ControllerAdvice
+public class ApiResponseAdvice {
+
+  @ExceptionHandler(ApiResponseStatusException.class)
+  public @ResponseBody ResponseEntity<String> handleApiResponseStatusException(ApiResponseStatusException e) {
+    return ResponseEntity.status(e.getStatus()).body(e.getMessage());
+  }
+
+}
diff --git a/core/src/main/java/edu/tamu/weaver/response/ApiResponseSerializer.java b/core/src/main/java/edu/tamu/weaver/response/ApiResponseSerializer.java
@@ -0,0 +1,62 @@
+package edu.tamu.weaver.response;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.servlet.http.HttpServletRequest;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+
+import org.springframework.boot.jackson.JsonComponent;
+import org.springframework.web.context.request.RequestAttributes;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+
+import edu.tamu.weaver.response.ApiResponse.Meta;
+
+@JsonComponent
+public class ApiResponseSerializer extends JsonSerializer<ApiResponse> {
+
+  @Override
+  public void serialize(ApiResponse apiResponse, JsonGenerator jgen, SerializerProvider serializers)
+      throws IOException {
+    RequestAttributes attributes = RequestContextHolder.getRequestAttributes();
+    HttpServletRequest request = ((ServletRequestAttributes) attributes).getRequest();
+    if (request.getHeader("x-wvr-unwrap") != null) {
+
+      Meta meta = apiResponse.getMeta();
+      String message = meta.getMessage();
+      switch (meta.getStatus()) {
+        case ERROR:
+          throw new ApiResponseStatusException(message, 500);
+        case INVALID:
+          throw new ApiResponseStatusException(message, 400);
+        case REFRESH:
+        case UNAUTHORIZED:
+          throw new ApiResponseStatusException(message, 401);
+        case INFO:
+        case SUCCESS:
+        case WARNING:
+        default:
+          break;
+      }
+
+      List<Object> values = new ArrayList<>(apiResponse.getPayload().values());
+      if (values.size() > 1) {
+        jgen.writeObject(apiResponse.getPayload());
+      } else if (values.size() > 0) {
+        jgen.writeObject(values.get(0));
+      }
+
+    } else {
+      jgen.writeStartObject();
+      jgen.writeObjectField("meta", apiResponse.getMeta());
+      jgen.writeObjectField("payload", apiResponse.getPayload());
+      jgen.writeEndObject();
+    }
+  }
+
+}
diff --git a/core/src/main/java/edu/tamu/weaver/response/ApiResponseStatusException.java b/core/src/main/java/edu/tamu/weaver/response/ApiResponseStatusException.java
@@ -0,0 +1,20 @@
+package edu.tamu.weaver.response;
+
+public class ApiResponseStatusException extends RuntimeException {
+
+  private int status;
+
+  public ApiResponseStatusException(String message, int status) {
+    super(message);
+    this.status = status;
+  }
+
+  public int getStatus() {
+    return status;
+  }
+
+  public void setStatus(int status) {
+    this.status = status;
+  }
+
+}
diff --git a/data/pom.xml b/data/pom.xml
@@ -12,7 +12,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/email/pom.xml b/email/pom.xml
@@ -12,7 +12,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/messaging/pom.xml b/messaging/pom.xml
@@ -12,7 +12,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
 
   <artifactId>webservice-parent</artifactId>
 
-  <version>2.1.1-RC5</version>
+  <version>2.1.1-RC6</version>
 
   <name>Weaver Webservice Parent</name>
 
@@ -87,7 +87,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-resources-plugin</artifactId>
-          <version>3.0.2</version>
+          <version>3.2.0</version>
           <configuration>
             <delimiters>
               <delimiter>@</delimiter>

diff --git a/reporting/pom.xml b/reporting/pom.xml
@@ -12,7 +12,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/token-provider/pom.xml b/token-provider/pom.xml
@@ -13,7 +13,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/token/pom.xml b/token/pom.xml
@@ -12,7 +12,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/user/pom.xml b/user/pom.xml
@@ -12,7 +12,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/validation/pom.xml b/validation/pom.xml
@@ -12,7 +12,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>

diff --git a/wro/pom.xml b/wro/pom.xml
@@ -13,7 +13,7 @@
   <parent>
     <groupId>edu.tamu.weaver</groupId>
     <artifactId>webservice-parent</artifactId>
-    <version>2.1.1-RC5</version>
+    <version>2.1.1-RC6</version>
   </parent>
 
   <dependencies>