Insert Example.java into README.md

Author: Denis-Averin

Makefile

@@ -32,5 +32,9 @@ display-updates:
 update:
 	mvn versions:update-properties
 
+.PHONY: insert-example
+insert-example:
+	./scripts/insert-example.bash
+
 .PHONY: after-gen
-after-gen: fix format
+after-gen: fix format insert-example

README.md

@@ -91,21 +91,26 @@ Then manually install the following JARs:
 Please follow the [installation](#installation) instruction and execute the following Java code:
 
 ```java
+package com.aspose.barcode.cloud.examples;
+
+import com.aspose.barcode.cloud.ApiClient;
+import com.aspose.barcode.cloud.ApiException;
 import com.aspose.barcode.cloud.api.BarcodeApi;
 import com.aspose.barcode.cloud.model.BarcodeResponseList;
+import com.aspose.barcode.cloud.model.DecodeBarcodeType;
 import com.aspose.barcode.cloud.model.EncodeBarcodeType;
-import com.aspose.barcode.cloud.model.PresetType;
 import com.aspose.barcode.cloud.requests.GetBarcodeGenerateRequest;
-import com.aspose.barcode.cloud.requests.PostBarcodeRecognizeFromUrlOrContentRequest;
+import com.aspose.barcode.cloud.requests.ScanBarcodeRequest;
 
 import java.io.File;
+import java.util.Collections;
 
-public class BarcodeApiExample {
+public class Example {
     public static void main(String[] args) {
-        ApiClient client = new ApiClient(
-            "Client Id from https://dashboard.aspose.cloud/applications",
-            "Client Secret from https://dashboard.aspose.cloud/applications"
-        );
+        ApiClient client =
+                new ApiClient(
+                        "Client Id from https://dashboard.aspose.cloud/applications",
+                        "Client Secret from https://dashboard.aspose.cloud/applications");
         client.setReadTimeout(5 * 60 * 1000);
 
         BarcodeApi api = new BarcodeApi(client);
@@ -116,7 +121,7 @@ public class BarcodeApiExample {
             System.out.println("Barcode image saved to file " + barcodeImage.getAbsolutePath());
 
             System.out.println("Recognizing barcode on image...");
-            BarcodeResponseList recognized = recognizeBarcode(api, barcodeImage);
+            BarcodeResponseList recognized = scanBarcode(api, barcodeImage);
             System.out.print("Barcode on image:");
             System.out.println(recognized.toString());
         } catch (ApiException e) {
@@ -130,18 +135,19 @@ public class BarcodeApiExample {
         String text = "Aspose.BarCode for Cloud Sample";
         GetBarcodeGenerateRequest request = new GetBarcodeGenerateRequest(type, text);
         request.textLocation = "None";
-        
+
         return api.getBarcodeGenerate(request);
     }
 
-    private static BarcodeResponseList recognizeBarcode(BarcodeApi api, File barcodeImage) throws ApiException {
-        PostBarcodeRecognizeFromUrlOrContentRequest recognizeRequest = new PostBarcodeRecognizeFromUrlOrContentRequest();
-        recognizeRequest.image = barcodeImage;
-        recognizeRequest.preset = PresetType.HIGHPERFORMANCE.toString();
+    private static BarcodeResponseList scanBarcode(BarcodeApi api, File barcodeImage)
+            throws ApiException {
+        ScanBarcodeRequest request = new ScanBarcodeRequest(barcodeImage);
+        request.decodeTypes = Collections.singletonList(DecodeBarcodeType.QR);
 
-        return api.postBarcodeRecognizeFromUrlOrContent(recognizeRequest);
+        return api.scanBarcode(request);
     }
 }
+
 ```
 
 ## Licensing
@@ -281,3 +287,4 @@ Authentication schemes defined for the API:
 ## Recommendation
 
 It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
+

scripts/extract_java_from_README.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -euo pipefail
+
+cd "$( dirname "${BASH_SOURCE[0]}" )/.."
+
+python "./scripts/insert-example.py" "README.template" > "README.md"
+
+rm "README.template"

scripts/insert-example.bash

@@ -0,0 +1,34 @@
+import argparse
+import os
+import re
+import typing
+
+REPLACE_RE = re.compile(r'^%insert (?P<file_name>[^%]+)%$', re.MULTILINE)
+
+
+def read_text(filename: str) -> str:
+    with open(filename, "rt") as rf:
+        text = rf.read()
+    return text
+
+
+def main(template: typing.TextIO) -> None:
+    content: str = template.read()
+
+    def sub_match(match):
+        file_name = match.group('file_name')
+        return read_text(file_name)
+
+    text = REPLACE_RE.sub(sub_match, content)
+    print(text)
+
+
+def parse_args() -> typing.Dict[str, typing.Any]:
+    parser = argparse.ArgumentParser()
+    parser.add_argument("template", type=argparse.FileType("rt"), help="README.template")
+    kwargs = vars(parser.parse_args())
+    return kwargs
+
+
+if __name__ == "__main__":
+    main(**parse_args())

scripts/insert-example.py

@@ -0,0 +1,56 @@
+package com.aspose.barcode.cloud.examples;
+
+import com.aspose.barcode.cloud.ApiClient;
+import com.aspose.barcode.cloud.ApiException;
+import com.aspose.barcode.cloud.api.BarcodeApi;
+import com.aspose.barcode.cloud.model.BarcodeResponseList;
+import com.aspose.barcode.cloud.model.DecodeBarcodeType;
+import com.aspose.barcode.cloud.model.EncodeBarcodeType;
+import com.aspose.barcode.cloud.requests.GetBarcodeGenerateRequest;
+import com.aspose.barcode.cloud.requests.ScanBarcodeRequest;
+
+import java.io.File;
+import java.util.Collections;
+
+public class Example {
+    public static void main(String[] args) {
+        ApiClient client =
+                new ApiClient(
+                        "Client Id from https://dashboard.aspose.cloud/applications",
+                        "Client Secret from https://dashboard.aspose.cloud/applications");
+        client.setReadTimeout(5 * 60 * 1000);
+
+        BarcodeApi api = new BarcodeApi(client);
+
+        try {
+            System.out.println("Generating barcode...");
+            File barcodeImage = generateBarcode(api);
+            System.out.println("Barcode image saved to file " + barcodeImage.getAbsolutePath());
+
+            System.out.println("Recognizing barcode on image...");
+            BarcodeResponseList recognized = scanBarcode(api, barcodeImage);
+            System.out.print("Barcode on image:");
+            System.out.println(recognized.toString());
+        } catch (ApiException e) {
+            System.err.println("Error");
+            e.printStackTrace();
+        }
+    }
+
+    private static File generateBarcode(BarcodeApi api) throws ApiException {
+        String type = EncodeBarcodeType.QR.toString();
+        String text = "Aspose.BarCode for Cloud Sample";
+        GetBarcodeGenerateRequest request = new GetBarcodeGenerateRequest(type, text);
+        request.textLocation = "None";
+
+        return api.getBarcodeGenerate(request);
+    }
+
+    private static BarcodeResponseList scanBarcode(BarcodeApi api, File barcodeImage)
+            throws ApiException {
+        ScanBarcodeRequest request = new ScanBarcodeRequest(barcodeImage);
+        request.decodeTypes = Collections.singletonList(DecodeBarcodeType.QR);
+
+        return api.scanBarcode(request);
+    }
+}