✅ functional test all supported APIs

ianardee · ianardee · commit 303aa714f58a · 2023-04-19T12:36:10.000+02:00
diff --git a/.github/workflows/test-code-samples.yml b/.github/workflows/test-code-samples.yml
@@ -1,20 +1,20 @@
-name: Test Code Samples
+name: Test Samples Java Classes
 on:
   pull_request:
   schedule:
     - cron:  '0 23 * * *'
-  # Allow running this workflow manually from the Actions tab
-  workflow_dispatch:
 
+  # Allows to run this workflow manually from the Actions tab
+  workflow_dispatch:
 jobs:
   build:
     name: Run Tests
     runs-on: ubuntu-latest
     strategy:
       matrix:
         java-version:
-          - "8"
           - "11"
+          - "8"
         distribution:
           - "temurin"
 
diff --git a/.github/workflows/test-sample-codes-java.yml b/.github/workflows/test-sample-codes-java.yml
diff --git a/docs/code_samples/bank_check_v1.txt b/docs/code_samples/bank_check_v1.txt
@@ -1,17 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.us.bankcheck.BankCheckV1Inference;
+import java.io.File;
+import java.io.IOException;
 
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+public class SimpleMindeeClient {
 
-com.mindee.parsing.common.Document<com.mindee.parsing.us.bankcheck.BankCheckV1Inference> documentParsed =
-  mindeeClient.parse(com.mindee.parsing.us.bankcheck.BankCheckV1Inference.class,docToParse);
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
 
-System.out.println(documentParsed.toString());
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
 
-code = 0;
-}
-/exit code
+    Document<BankCheckV1Inference> documentParsed = mindeeClient.parse(BankCheckV1Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
+}
diff --git a/docs/code_samples/carte_vitale_v1.txt b/docs/code_samples/carte_vitale_v1.txt
@@ -1,13 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.fr.cartevitale.CarteVitaleV1Inference;
+import java.io.File;
+import java.io.IOException;
 
-com.mindee.parsing.common.Document<com.mindee.parsing.fr.cartevitale.CarteVitaleV1Inference> documentParsed = mindeeClient.parse(com.mindee.parsing.fr.cartevitale.CarteVitaleV1Inference.class,docToParse);
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
+
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
+
+    Document<CarteVitaleV1Inference> documentParsed = mindeeClient.parse(CarteVitaleV1Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
-System.out.println(documentParsed.toString());
-code = 0;
 }
-/exit code
diff --git a/docs/code_samples/custom_v1.txt b/docs/code_samples/custom_v1.txt
@@ -16,8 +16,8 @@ public class SimpleMindeeClient {
     MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
     DocumentToParse docToParse = new DocumentToParse(new File(filePath));
 
-    CustomEndpoint customEndpoint = new CustomEndpoint("my-endpoint","my-account");
-    Document<CustomV1Inference> documentParsed =  mindeeClient.parse(docToParse,customEndpoint);
+    CustomEndpoint customEndpoint = new CustomEndpoint("my-endpoint", "my-account");
+    Document<CustomV1Inference> documentParsed =  mindeeClient.parse(docToParse, customEndpoint);
 
     System.out.println(documentParsed.toString());
   }
diff --git a/docs/code_samples/expense_receipts_v4.txt b/docs/code_samples/expense_receipts_v4.txt
@@ -1,13 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.receipt.ReceiptV4Inference;
+import java.io.File;
+import java.io.IOException;
 
-com.mindee.parsing.common.Document<com.mindee.parsing.receipt.ReceiptV4Inference> documentParsed = mindeeClient.parse(com.mindee.parsing.receipt.ReceiptV4Inference.class,docToParse);
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
+
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
+
+    Document<ReceiptV4Inference> documentParsed = mindeeClient.parse(ReceiptV4Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
-System.out.println(documentParsed.toString());
-code = 0;
 }
-/exit code
diff --git a/docs/code_samples/financial_document_v1.txt b/docs/code_samples/financial_document_v1.txt
@@ -1,13 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.financial.FinancialV1Inference;
+import java.io.File;
+import java.io.IOException;
 
-com.mindee.parsing.common.Document<com.mindee.parsing.financial.FinancialV1Inference> documentParsed = mindeeClient.parse(com.mindee.parsing.financial.FinancialV1Inference.class,docToParse);
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
+
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
+
+    Document<FinancialV1Inference> documentParsed = mindeeClient.parse(FinancialV1Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
-System.out.println(documentParsed.toString());
-code = 0;
 }
-/exit code
diff --git a/docs/code_samples/idcard_fr_v1.txt b/docs/code_samples/idcard_fr_v1.txt
@@ -1,13 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.fr.idcard.IdCardV1Inference;
+import java.io.File;
+import java.io.IOException;
 
-com.mindee.parsing.common.Document<com.mindee.parsing.fr.idcard.IdCardV1Inference> documentParsed = mindeeClient.parse(com.mindee.parsing.fr.idcard.IdCardV1Inference.class,docToParse);
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
+
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
+
+    Document<IdCardV1Inference> documentParsed = mindeeClient.parse(IdCardV1Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
-System.out.println(documentParsed.toString());
-code = 0;
 }
-/exit code
diff --git a/docs/code_samples/invoices_v4.txt b/docs/code_samples/invoices_v4.txt
@@ -15,7 +15,7 @@ public class SimpleMindeeClient {
     MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
     DocumentToParse docToParse = new DocumentToParse(new File(filePath));
 
-    Document<InvoiceV4Inference> documentParsed = mindeeClient.parse(InvoiceV4Inference.class,docToParse);
+    Document<InvoiceV4Inference> documentParsed = mindeeClient.parse(InvoiceV4Inference.class, docToParse);
 
     System.out.println(documentParsed.toString());
   }
diff --git a/docs/code_samples/license_plates_v1.txt b/docs/code_samples/license_plates_v1.txt
@@ -1,13 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.eu.licenseplate.LicensePlateV1Inference;
+import java.io.File;
+import java.io.IOException;
 
-com.mindee.parsing.common.Document<com.mindee.parsing.eu.licenseplate.LicensePlateV1Inference> documentParsed = mindeeClient.parse(com.mindee.parsing.eu.licenseplate.LicensePlateV1Inference.class,docToParse);
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
+
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
+
+    Document<LicensePlateV1Inference> documentParsed = mindeeClient.parse(LicensePlateV1Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
-System.out.println(documentParsed.toString());
-code = 0;
 }
-/exit code
diff --git a/docs/code_samples/passport_v1.txt b/docs/code_samples/passport_v1.txt
@@ -1,13 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.passport.PassportV1Inference;
+import java.io.File;
+import java.io.IOException;
 
-com.mindee.parsing.common.Document<com.mindee.parsing.passport.PassportV1Inference> documentParsed = mindeeClient.parse(com.mindee.parsing.passport.PassportV1Inference.class,docToParse);
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
+
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
+
+    Document<PassportV1Inference> documentParsed = mindeeClient.parse(PassportV1Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
-System.out.println(documentParsed.toString());
-code = 0;
 }
-/exit code
diff --git a/docs/code_samples/proof_of_address_v1.txt b/docs/code_samples/proof_of_address_v1.txt
@@ -1,13 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.proofofaddress.ProofOfAddressV1Inference;
+import java.io.File;
+import java.io.IOException;
 
-com.mindee.parsing.common.Document<com.mindee.parsing.proofofaddress.ProofOfAddressV1Inference> documentParsed = mindeeClient.parse(com.mindee.parsing.proofofaddress.ProofOfAddressV1Inference.class,docToParse);
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
+
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
+
+    Document<ProofOfAddressV1Inference> documentParsed = mindeeClient.parse(ProofOfAddressV1Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
-System.out.println(documentParsed.toString());
-code = 0;
 }
-/exit code
diff --git a/docs/code_samples/shipping_container_v1.txt b/docs/code_samples/shipping_container_v1.txt
@@ -1,13 +1,23 @@
-String apiKey = "my-api-key";
-String filePath = "/path/to/the/file.ext";
-int code = 1;
-{
-com.mindee.MindeeClient mindeeClient = com.mindee.MindeeClientInit.create(apiKey);
-com.mindee.DocumentToParse docToParse = new com.mindee.DocumentToParse(new File(filePath));
+import com.mindee.MindeeClient;
+import com.mindee.MindeeClientInit;
+import com.mindee.DocumentToParse;
+import com.mindee.parsing.common.Document;
+import com.mindee.parsing.shippingcontainer.ShippingContainerV1Inference;
+import java.io.File;
+import java.io.IOException;
 
-com.mindee.parsing.common.Document<com.mindee.parsing.shippingcontainer.ShippingContainerV1Inference> documentParsed = mindeeClient.parse(com.mindee.parsing.shippingcontainer.ShippingContainerV1Inference.class,docToParse);
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String filePath = "/path/to/the/file.ext";
+
+    MindeeClient mindeeClient = MindeeClientInit.create(apiKey);
+    DocumentToParse docToParse = new DocumentToParse(new File(filePath));
+
+    Document<ShippingContainerV1Inference> documentParsed = mindeeClient.parse(ShippingContainerV1Inference.class, docToParse);
+
+    System.out.println(documentParsed.toString());
+  }
 
-System.out.println(documentParsed.toString());
-code = 0;
 }
-/exit code
diff --git a/tests/test_code_samples.sh b/tests/test_code_samples.sh
diff --git a/tests/test_code_samples_java.sh b/tests/test_code_samples_java.sh

Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ public class SimpleMindeeClient {`
`16`	`16`	`MindeeClient mindeeClient = MindeeClientInit.create(apiKey);`
`17`	`17`	`DocumentToParse docToParse = new DocumentToParse(new File(filePath));`
`18`	`18`
`19`		`- CustomEndpoint customEndpoint = new CustomEndpoint("my-endpoint","my-account");`
`20`		`- Document<CustomV1Inference> documentParsed = mindeeClient.parse(docToParse,customEndpoint);`
	`19`	`+ CustomEndpoint customEndpoint = new CustomEndpoint("my-endpoint", "my-account");`
	`20`	`+ Document<CustomV1Inference> documentParsed = mindeeClient.parse(docToParse, customEndpoint);`
`21`	`21`
`22`	`22`	`System.out.println(documentParsed.toString());`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class SimpleMindeeClient {`
`15`	`15`	`MindeeClient mindeeClient = MindeeClientInit.create(apiKey);`
`16`	`16`	`DocumentToParse docToParse = new DocumentToParse(new File(filePath));`
`17`	`17`
`18`		`- Document<InvoiceV4Inference> documentParsed = mindeeClient.parse(InvoiceV4Inference.class,docToParse);`
	`18`	`+ Document<InvoiceV4Inference> documentParsed = mindeeClient.parse(InvoiceV4Inference.class, docToParse);`
`19`	`19`
`20`	`20`	`System.out.println(documentParsed.toString());`
`21`	`21`	`}`