switch response deserialization to out-of-client syntax

Author: sebastianMindee

.github/workflows/_test-code-samples.yml

@@ -34,4 +34,4 @@ jobs:
 
       - name: Tests sample code
         run: |
-          ./tests/test_code_samples.sh ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }} ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }} ${{ secrets.MINDEE_API_KEY_SE_TESTS }} ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }}  ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
+          ./tests/test_code_samples.sh ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }} ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }} ${{ secrets.MINDEE_API_KEY_SE_TESTS }} ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }} ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}

src/main/java/com/mindee/MindeeClientV2.java

@@ -103,18 +103,6 @@ else if (resp.getJob().getStatus().equals("Processed")) {
     throw new RuntimeException("Max retries exceeded (" + max + ").");
   }
 
-  /**
-   * Deserialize a webhook payload (or any saved response) into an
-   * {@link InferenceResponse}.
-   */
-  public InferenceResponse loadInference(LocalResponse localResponse) throws IOException {
-    ObjectMapper mapper = new ObjectMapper().findAndRegisterModules();
-    InferenceResponse model =
-        mapper.readValue(localResponse.getFile(), InferenceResponse.class);
-    model.setRawResponse(localResponse.toString());
-    return model;
-  }
-
   private static MindeeApiV2 createDefaultApiV2(String apiKey) {
     MindeeSettingsV2 settings = apiKey == null || apiKey.trim().isEmpty()
         ? new MindeeSettingsV2()

src/main/java/com/mindee/input/LocalResponse.java

@@ -13,6 +13,10 @@
 import java.util.stream.Stream;
 import javax.crypto.Mac;
 import javax.crypto.spec.SecretKeySpec;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.mindee.MindeeException;
+import com.mindee.parsing.v2.CommonResponse;
 import lombok.Getter;
 import org.apache.commons.codec.binary.Hex;
 
@@ -91,4 +95,26 @@ public String getHmacSignature(String secretKey) {
   public boolean isValidHmacSignature(String secretKey, String signature) {
     return signature.equals(getHmacSignature(secretKey));
   }
+
+
+  /**
+   * Deserialize this local JSON payload into a specific {@link CommonResponse}
+   * subtype: {@code InferenceResponse}, {@code JobResponse}.
+   *
+   * @param responseClass the concrete class to instantiate
+   * @param <T>           generic {@link CommonResponse}
+   * @return a fully populated instance of {@code responseClass}
+   * @throws MindeeException if the payload cannot be deserialized into the
+   *                         requested type
+   */
+  public <T extends CommonResponse> T deserializeResponse(Class<T> responseClass) {
+    ObjectMapper mapper = new ObjectMapper();
+    try {
+      T response = mapper.readValue(this.file, responseClass);
+      response.setRawResponse(new String(this.file, StandardCharsets.UTF_8));
+      return response;
+    } catch (Exception ex) {
+      throw new MindeeException("Invalid class specified for deserialization.", ex);
+    }
+  }
 }

src/test/java/com/mindee/MindeeClientV2Test.java

@@ -114,18 +114,17 @@ void document_getInference_async() throws IOException {
   }
 
   @Nested
-  @DisplayName("loadInference()")
-  class LoadInference {
+  @DisplayName("deserializeResponse()")
+  class DeserializeResponse {
 
     @Test
     @DisplayName("parses local JSON and exposes correct field values")
     void inference_loadsLocally() throws IOException {
-      MindeeClientV2 mindeeClient = new MindeeClientV2("dummy");
       File jsonFile =
           new File("src/test/resources/v2/products/financial_document/complete.json");
       LocalResponse localResponse = new LocalResponse(jsonFile);
 
-      InferenceResponse loaded = mindeeClient.loadInference(localResponse);
+      InferenceResponse loaded = localResponse.deserializeResponse(InferenceResponse.class);
 
       assertNotNull(loaded, "Loaded InferenceResponse must not be null");
       assertEquals(

src/test/java/com/mindee/parsing/v2/InferenceTest.java

@@ -19,8 +19,8 @@
 class InferenceTest {
 
   private InferenceResponse loadFromResource(String resourcePath) throws IOException {
-    MindeeClientV2 dummyClient = new MindeeClientV2("dummy");
-    return dummyClient.loadInference(new LocalResponse(InferenceTest.class.getClassLoader().getResourceAsStream(resourcePath)));
+    LocalResponse localResponse = new LocalResponse(InferenceTest.class.getClassLoader().getResourceAsStream(resourcePath));
+    return localResponse.deserializeResponse(InferenceResponse.class);
   }
 
   private String readFileAsString(String path)