AISDK-221 Fix HIPAA Error Message on Incorrect Usage (#53)

Author: aaron-wilson-rev

pom.xml

@@ -5,7 +5,7 @@
     <!-- groupId, artifactId, these namespaces should not be changed -->
     <groupId>ai.rev</groupId>
     <artifactId>revai-java-sdk</artifactId>
-    <version>2.3.0</version>
+    <version>2.4.0</version>
     <name>Rev AI SDK for Java</name>
     <description>Java SDK for Rev AI API</description>
     <url>https://docs.rev.ai/</url>

src/main/java/ai/rev/exceptions/ForbiddenRequestException.java

@@ -0,0 +1,14 @@
+package ai.rev.exceptions;
+
+import org.json.JSONObject;
+
+/**
+ * The ForbiddenRequestException happens when the request contains parameters that do not pass validation
+ * or the request is not allowed for the user
+ */
+public class ForbiddenRequestException extends RevAiApiException {
+
+  public ForbiddenRequestException(JSONObject errorResponse) {
+    super("Forbidden Request Exception", errorResponse, 403);
+  }
+}

src/main/java/ai/rev/exceptions/RevAiApiException.java

@@ -16,36 +16,6 @@ public RevAiApiException(String message, JSONObject errorResponse, int responseC
 
   private static String formatErrorDetails(
       String message, JSONObject errorResponse, int responseCode) {
-    StringBuilder stringBuilder = new StringBuilder();
-    stringBuilder.append(message);
-    if (errorResponse.has("title")) {
-      stringBuilder.append(System.lineSeparator());
-      stringBuilder.append("Title: " + errorResponse.get("title"));
-    }
-    if (errorResponse.has("detail")) {
-      stringBuilder.append(System.lineSeparator());
-      stringBuilder.append("Detail: " + errorResponse.get("detail"));
-    }
-    if (errorResponse.has("type")) {
-      stringBuilder.append(System.lineSeparator());
-      stringBuilder.append("Type: " + errorResponse.get("type"));
-    }
-    if (errorResponse.has("status")) {
-      stringBuilder.append(System.lineSeparator());
-      stringBuilder.append("Status: " + errorResponse.get("status"));
-    }
-    if (errorResponse.has("parameters")) {
-      stringBuilder.append(System.lineSeparator());
-      stringBuilder.append("Parameters: " + errorResponse.get("parameters"));
-    }
-    if (errorResponse.has("allowed_values")) {
-      stringBuilder.append(System.lineSeparator());
-      stringBuilder.append("Allowed Values: " + errorResponse.get("allowed_values"));
-    }
-    if (errorResponse.has("current_value")) {
-      stringBuilder.append(System.lineSeparator());
-      stringBuilder.append("Current Value: " + errorResponse.get("current_value"));
-    }
-    return stringBuilder.toString();
+    return String.format("Response code: %s, Error: %s, Api response: %s", responseCode, message, errorResponse);
   }
 }

src/main/java/ai/rev/helpers/ErrorInterceptor.java

@@ -1,6 +1,7 @@
 package ai.rev.helpers;
 
 import ai.rev.exceptions.AuthorizationException;
+import ai.rev.exceptions.ForbiddenRequestException;
 import ai.rev.exceptions.ForbiddenStateException;
 import ai.rev.exceptions.InvalidHeaderException;
 import ai.rev.exceptions.InvalidParameterException;
@@ -31,6 +32,8 @@ public Response intercept(Interceptor.Chain chain) throws IOException {
           throw new AuthorizationException(errorResponse);
         case 400:
           throw new InvalidParameterException(errorResponse);
+        case 403:
+          throw new ForbiddenRequestException(errorResponse);
         case 404:
           throw new ResourceNotFoundException(errorResponse);
         case 406:

src/test/java/ai/rev/helpers/unit/ErrorInterceptorTest.java

@@ -59,7 +59,7 @@ public void setup() {
 
   @Parameterized.Parameters
   public static Collection<Object[]> input() {
-    return Arrays.asList(new Object[][] {{400}, {401}, {404}, {406}, {409}, {429}, {500}});
+    return Arrays.asList(new Object[][] {{400}, {401}, {403}, {404}, {406}, {409}, {429}, {500}});
   }
 
   @Test