✨ add job information to inference

Author: ianardee

src/main/java/com/mindee/parsing/v2/Inference.java

@@ -23,6 +23,12 @@ public class Inference {
   @JsonProperty("id")
   private String id;
 
+  /**
+   * Job the inference belongs to.
+   */
+  @JsonProperty("job")
+  private InferenceJob job;
+
   /**
    * Model info.
    */
@@ -53,6 +59,8 @@ public String toString() {
     joiner
       .add("Inference")
       .add("#########")
+      .add(job.toString())
+      .add("")
       .add(model.toString())
       .add("")
       .add(file.toString())

src/main/java/com/mindee/parsing/v2/InferenceJob.java

@@ -0,0 +1,32 @@
+package com.mindee.parsing.v2;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.StringJoiner;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * Information on the Job associated to a given Inference.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public class InferenceJob {
+  /**
+   * UUID of the Job.
+   */
+  @JsonProperty("id")
+  private String id;
+
+  public String toString() {
+
+    StringJoiner joiner = new StringJoiner("\n");
+    joiner.add("Job").add("===").add(":ID: " + id);
+    return joiner.toString();
+  }
+}

src/main/java/com/mindee/parsing/v2/Job.java

@@ -12,7 +12,7 @@
 import lombok.NoArgsConstructor;
 
 /**
- * Defines an enqueued Job.
+ * Information on the processing of a file sent to the Mindee API.
  */
 
 @Getter
@@ -22,12 +22,19 @@
 @NoArgsConstructor
 public final class Job {
   /**
-   * Date and time the job was created at.
+   * Date and time of the Job creation.
    */
   @JsonProperty("created_at")
   @JsonDeserialize(using = LocalDateTimeDeserializer.class)
   private LocalDateTime createdAt;
 
+  /**
+   * Date and time of the Job completion. Filled once processing is finished.
+   */
+  @JsonProperty("completed_at")
+  @JsonDeserialize(using = LocalDateTimeDeserializer.class)
+  private LocalDateTime completedAt;
+
   /**
    * ID of the job.
    */

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

@@ -107,6 +107,9 @@ void asyncPredict_whenComplete_mustExposeAllProperties() throws IOException {
       assertNotNull(inference);
       assertEquals("12345678-1234-1234-1234-123456789abc", inference.getId());
 
+      InferenceJob job = inference.getJob();
+      assertEquals("12345678-1234-1234-1234-jobid1234567", job.getId());
+
       InferenceModel model = inference.getModel();
       assertNotNull(model, "Model must not be null");
       assertEquals("12345678-1234-1234-1234-123456789abc", model.getId());

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

@@ -19,15 +19,35 @@ private JobResponse loadJob(String filePath) throws IOException {
   }
 
   @Nested
-  @DisplayName("When the Job is OK")
-  class OkTest {
+  @DisplayName("When the Job is processing")
+  class ProcessingTest {
     @Test
     @DisplayName("properties must be valid")
     void whenProcessing_mustHaveValidProperties() throws IOException {
       JobResponse response = loadJob("job/ok_processing.json");
       Job job = response.getJob();
       assertNotNull(job);
       assertEquals("Processing", job.getStatus());
+      assertNotNull(job.getCreatedAt());
+      assertNull(job.getCompletedAt());
+      assertNull(job.getResultUrl());
+      assertNull(job.getError());
+    }
+  }
+
+  @Nested
+  @DisplayName("When the Job is processed")
+  class ProcessedTest {
+    @Test
+    @DisplayName("properties must be valid")
+    void whenProcessing_mustHaveValidProperties() throws IOException {
+      JobResponse response = loadJob("job/ok_processed_webhooks_ok.json");
+      Job job = response.getJob();
+      assertNotNull(job);
+      assertEquals("Processed", job.getStatus());
+      assertNotNull(job.getCreatedAt());
+      assertNotNull(job.getCompletedAt());
+      assertNotNull(job.getResultUrl());
       assertNull(job.getError());
     }
   }
@@ -41,6 +61,9 @@ void when422_mustHaveValidProperties() throws IOException {
       JobResponse response = loadJob("job/fail_422.json");
       Job job = response.getJob();
       assertNotNull(job);
+      assertNotNull(job.getCreatedAt());
+      assertNotNull(job.getCompletedAt());
+      assertNull(job.getResultUrl());
       ErrorResponse jobError = job.getError();
       assertNotNull(jobError);
       assertEquals(422, jobError.getStatus());