Release 22.1.1 (#36)

* Examples added

* Fix ApiInvoker code

Author: Denis-Averin

.github/workflows/check-urls.yml

@@ -11,7 +11,7 @@ on:
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a single job called "build"
-  build:
+  check-urls:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 

.github/workflows/net-framework.yml

@@ -23,6 +23,6 @@ jobs:
       run: msbuild -restore -p:Configuration=Release
 
     - name: Test with VSTest
-      run: VSTest.Console.exe Tests\bin\Release\net461\Aspose.BarCode.Cloud.Sdk.Tests.dll
+      run: VSTest.Console.exe /Framework:".NETFramework,Version=v4.6.1" Tests\bin\Release\net461\Aspose.BarCode.Cloud.Sdk.Tests.dll
       env:
         TEST_CONFIGURATION_JWT_TOKEN: ${{ secrets.TEST_CONFIGURATION_ACCESS_TOKEN }}

Makefile

@@ -3,7 +3,12 @@ all: test
 
 .PHONY: format
 format:
-	dotnet format ./Aspose.BarCode.Cloud.Sdk.sln
+	find . -iname "*.cs" -exec sed -i -e 's_[[:space:]]*$$__' {} \;
+	~/.dotnet/tools/dotnet-format ./Aspose.BarCode.Cloud.Sdk.sln
+
+.PHONY: format-doc
+format-doc:
+	find . -iname "*.md" -exec sed -i -e 's_[[:space:]]*$$__' {} \;
 
 .PHONY: test
 test:
@@ -12,3 +17,10 @@ test:
 .PHONY: update
 update:
 	echo "Not implemented"
+
+.PHONY: insert-examples
+insert-examples:
+	./scripts/insert-examples.bash
+
+.PHONY: after-gen
+after-gen: insert-examples format format-doc

README.md

@@ -13,18 +13,19 @@
 
 ## Demo applications
 
-[Generate Barcode](https://products.aspose.app/barcode/generate) | [Recognize Barcode](https://products.aspose.app/barcode/recognize) | [Embed Barcode](https://products.aspose.app/barcode/embed)
-:---: | :---: | :---:
-[![Generate](https://products.aspose.app/barcode/generate/img/aspose_generate-app-48.png)](https://products.aspose.app/barcode/generate) | [![Recognize](https://products.aspose.app/barcode/recognize/img/aspose_recognize-app-48.png)](https://products.aspose.app/barcode/recognize) | [![Embed](https://products.aspose.app/barcode/embed/img/aspose_embed-app-48.png)](https://products.aspose.app/barcode/embed)
+[Scan QR](https://products.aspose.app/barcode/scanqr) | [Generate Barcode](https://products.aspose.app/barcode/generate) | [Recognize Barcode](https://products.aspose.app/barcode/recognize) | [Embed Barcode](https://products.aspose.app/barcode/embed)
+:---: | :---: | :---: | :---:
+[![ScanQR](https://products.aspose.app/barcode/scanqr/img/aspose_scanqr-app-48.png)](https://products.aspose.app/barcode/scanqr) | [![Generate](https://products.aspose.app/barcode/generate/img/aspose_generate-app-48.png)](https://products.aspose.app/barcode/generate) | [![Recognize](https://products.aspose.app/barcode/recognize/img/aspose_recognize-app-48.png)](https://products.aspose.app/barcode/recognize) | [![Embed](https://products.aspose.app/barcode/embed/img/aspose_embed-app-48.png)](https://products.aspose.app/barcode/embed)
 
 [Aspose.BarCode for Cloud](https://products.aspose.cloud/barcode/) is a REST API for Linear, 2D and postal barcode generation and recognition in the cloud. API recognizes and generates barcode images in a variety of formats. Barcode REST API allows to specify barcode image attributes like image width, height, border style and output image format in order to customize the generation process. Developers can also specify the barcode type and text attributes such as text location and font styles in order to suit the application requirements.
 
-This repository contains Aspose.BarCode Cloud SDK for .NET source code. This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your .NET Core or .NET Standard applications quickly and easily.
+This repository contains Aspose.BarCode Cloud SDK for .NET source code. This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your .NET Core or .NET Framework applications quickly and easily.
 
 Aspose.BarCode Cloud SDK for .NET provides cross-platform bindings for:
 
-- .NET Standard 2.0
-- .NET Framework 2.0 and higher
+- .NET Standard 2.0 and higher
+- .NET Core 2.1 and higher
+- .NET Framework 4.6.1 and higher
 
 To use these SDKs, you will need Client Id and Client Secret which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/applications) (free registration in Aspose Cloud is required for this).
 
@@ -58,27 +59,142 @@ From within Visual Studio:
 4. Click on the *Browse* tab and search for "Aspose.BarCode-Cloud".
 5. Click on the Aspose.BarCode-Cloud package, select the appropriate version in the right-tab and click *Install*.
 
-## Sample usage
+## Recognize QR code
 
-The examples below show how you can generate Code128 barcode and save it into local file using Aspose.BarCode-Cloud library:
+The examples below show how you can recognize QR code from image:
 
 ```csharp
-const string clientId = "Client Id from https://dashboard.aspose.cloud/applications";
-const string clientSecret = "Client Secret from https://dashboard.aspose.cloud/applications";
+using Aspose.BarCode.Cloud.Sdk.Api;
+using Aspose.BarCode.Cloud.Sdk.Interfaces;
+using Aspose.BarCode.Cloud.Sdk.Model;
+using Aspose.BarCode.Cloud.Sdk.Model.Requests;
+using System;
+using System.IO;
+using System.Reflection;
+
+namespace ReadQR
+{
+    class Program
+    {
+        static Configuration MakeConfiguration()
+        {
+            var config = new Configuration();
+
+            var envToken = Environment.GetEnvironmentVariable("TEST_CONFIGURATION_JWT_TOKEN");
+            if (string.IsNullOrEmpty(envToken))
+            {
+                config.ClientId = "Client Id from https://dashboard.aspose.cloud/applications";
+                config.ClientSecret = "Client Secret from https://dashboard.aspose.cloud/applications";
+            }
+            else
+            {
+                config.JwtToken = envToken;
+            }
+
+            return config;
+        }
+
+        static string ReadQR(IBarcodeApi api, string fileName)
+        {
+            using (FileStream imageStream = File.OpenRead(fileName))
+            {
+                BarcodeResponseList recognized = api.PostBarcodeRecognizeFromUrlOrContent(
+                    new PostBarcodeRecognizeFromUrlOrContentRequest(image: imageStream)
+                );
+
+                return recognized.Barcodes[0].BarcodeValue;
+            }
+        }
+
+        static void Main(string[] args)
+        {
+            string fileName = Path.GetFullPath(Path.Join(
+                Path.GetDirectoryName(Assembly.GetEntryAssembly().Location),
+                "..", "..", "..", "..",
+                "qr.png"
+                ));
+
+            var api = new BarcodeApi(MakeConfiguration());
+
+            string result = ReadQR(api, fileName);
+            Console.WriteLine($"File '{fileName}' recognized, result: '{result}'");
+        }
+    }
+}
 
-var api = new BarcodeApi(clientSecret, clientId);
+```
+
+## Generate QR code
+
+The examples below show how you can generate QR code and save it into local file using Aspose.BarCode-Cloud library:
+
+```csharp
+using Aspose.BarCode.Cloud.Sdk.Api;
+using Aspose.BarCode.Cloud.Sdk.Interfaces;
+using Aspose.BarCode.Cloud.Sdk.Model;
+using Aspose.BarCode.Cloud.Sdk.Model.Requests;
+using System;
+using System.IO;
+using System.Reflection;
+
+namespace GenerateQR
+{
+    class Program
+    {
+        static Configuration MakeConfiguration()
+        {
+            var config = new Configuration();
+
+            var envToken = Environment.GetEnvironmentVariable("TEST_CONFIGURATION_JWT_TOKEN");
+            if (string.IsNullOrEmpty(envToken))
+            {
+                config.ClientId = "Client Id from https://dashboard.aspose.cloud/applications";
+                config.ClientSecret = "Client Secret from https://dashboard.aspose.cloud/applications";
+            }
+            else
+            {
+                config.JwtToken = envToken;
+            }
+
+            return config;
+        }
+
+        static void GenerateQR(IBarcodeApi api, string fileName)
+        {
+            using (Stream generated = api.GetBarcodeGenerate(
+                new GetBarcodeGenerateRequest(
+                    EncodeBarcodeType.QR.ToString(),
+                    "QR code text",
+                    textLocation: "None", format: "png"))
+            )
+            {
+                using (FileStream stream = File.Create(fileName))
+                {
+                    generated.CopyTo(stream);
+                }
+            }
+        }
+
+        static void Main(string[] args)
+        {
+            string fileName = Path.GetFullPath(Path.Join(
+                Path.GetDirectoryName(Assembly.GetEntryAssembly().Location),
+                "..", "..", "..", "..",
+                "qr.png"
+                ));
+
+            var api = new BarcodeApi(MakeConfiguration());
+
+            GenerateQR(api, fileName);
+            Console.WriteLine($"File '{fileName}' generated.");
+        }
+    }
+}
 
-using Stream response = api.GetBarcodeGenerate(
-    new GetBarcodeGenerateRequest(
-        EncodeBarcodeType.Code128.ToString(), "Sample text", format: "png")
-    );
-using FileStream stream = File.Create("out.png");
-response.CopyTo(stream);
 ```
 
 ## Dependencies
 
-- .NET Framework 2.0 or later, .NET Standard 2.0
 - [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/)
 
 ## Licensing

Tests/BarcodeApiTests.cs

@@ -84,7 +84,9 @@ public void GetBarcodeGenerateTest()
         public void GetBarcodeRecognizeTest()
         {
             // Arrange
-            var barcodesToRecognize = new List<GeneratorParams>
+            const string fileName = "Test_PostGenerateMultiple.png";
+
+            var expectedBarcodes = new List<GeneratorParams>
             {
                 new GeneratorParams
                 {
@@ -98,22 +100,22 @@ public void GetBarcodeRecognizeTest()
                 }
             };
 
-            const string fileName = "Test_PostGenerateMultiple.png";
             string folder = PutTestFile(fileName);
-            var request = new GetBarcodeRecognizeRequest(
-                fileName,
-                folder: folder,
-                preset: PresetType.HighPerformance.ToString()
-            );
 
             // Act
-            BarcodeResponseList response = _api.GetBarcodeRecognize(request);
+            BarcodeResponseList response = _api.GetBarcodeRecognize(
+                new GetBarcodeRecognizeRequest(
+                    fileName,
+                    folder: folder,
+                    preset: PresetType.HighPerformance.ToString()
+                )
+            );
 
             // Assert
-            Assert.AreEqual(barcodesToRecognize.Count, response.Barcodes.Count);
+            Assert.AreEqual(expectedBarcodes.Count, response.Barcodes.Count);
 
             foreach ((GeneratorParams generated, BarcodeResponse recognized) in
-                barcodesToRecognize.Zip(response.Barcodes,
+                expectedBarcodes.Zip(response.Barcodes,
                     (generated, recognized) => (generated, recognized)))
             {
                 Assert.AreEqual(generated.TypeOfBarcode.ToString(), recognized.Type);
@@ -139,18 +141,16 @@ public void InstanceTest()
         public void PostBarcodeRecognizeFromUrlOrContentTest()
         {
             // Arrange
-            BarcodeResponseList response;
-            using (Stream image = GetTestImage("1.png"))
-            {
-                var request = new PostBarcodeRecognizeFromUrlOrContentRequest(
+            using Stream image = GetTestImage("1.png");
+
+            // Act
+            BarcodeResponseList response = _api.PostBarcodeRecognizeFromUrlOrContent(
+                new PostBarcodeRecognizeFromUrlOrContentRequest(
                     image: image,
                     checksumValidation: ChecksumValidation.Off.ToString(),
                     preset: PresetType.HighPerformance.ToString()
-                );
-
-                // Act
-                response = _api.PostBarcodeRecognizeFromUrlOrContent(request);
-            }
+                )
+            );
 
             // Assert
             Assert.AreEqual(1, response.Barcodes.Count);
@@ -187,8 +187,8 @@ public void PostGenerateMultipleTest()
 
             // Act
             using Stream response = _api.PostGenerateMultiple(request);
-            // Assert
 
+            // Assert
             Assert.IsTrue(response.Length > 0);
             using FileStream savedFileStream = File.Create(TestFilePath("Test_PostGenerateMultiple.png"));
             response.CopyTo(savedFileStream);
@@ -204,8 +204,8 @@ public void PutBarcodeGenerateFileTest()
             // Arrange
             var request = new PutBarcodeGenerateFileRequest(
                 "Test_PutBarcodeGenerateFile.png",
-                EncodeBarcodeType.Code128.ToString(),
-                "Hello!",
+                type: EncodeBarcodeType.Code128.ToString(),
+                text: "Hello!",
                 folder: TempFolderPath
             );
 
@@ -238,17 +238,17 @@ public void PutBarcodeRecognizeFromBodyTest()
             const string fileName = "Test_GetBarcodeGenerate.png";
             string folder = PutTestFile(fileName);
 
-            var request = new PutBarcodeRecognizeFromBodyRequest(
-                fileName,
-                new ReaderParams
-                {
-                    Preset = PresetType.HighPerformance
-                },
-                folder: folder
-            );
-
             // Act
-            BarcodeResponseList response = _api.PutBarcodeRecognizeFromBody(request);
+            BarcodeResponseList response = _api.PutBarcodeRecognizeFromBody(
+                new PutBarcodeRecognizeFromBodyRequest(
+                    fileName,
+                    readerParams: new ReaderParams
+                    {
+                        Preset = PresetType.HighPerformance
+                    },
+                    folder: folder
+                )
+            );
 
             // Assert
             Assert.AreEqual(barcodesToRecognize.Count, response.Barcodes.Count);

Tests/GenerateAndThenRecognize.cs

@@ -1,6 +1,7 @@
 using System.IO;
 using System.Linq;
 using Aspose.BarCode.Cloud.Sdk.Api;
+using Aspose.BarCode.Cloud.Sdk.Interfaces;
 using Aspose.BarCode.Cloud.Sdk.Model;
 using Aspose.BarCode.Cloud.Sdk.Model.Requests;
 using NUnit.Framework;
@@ -16,7 +17,7 @@ public void Init()
             _api = new BarcodeApi(TestConfiguration);
         }
 
-        private BarcodeApi _api;
+        private IBarcodeApi _api;
 
         [Test]
         public void GenerateAndThenRecognizeTest()
@@ -32,6 +33,14 @@ public void GenerateAndThenRecognizeTest()
             Assert.AreEqual(1, recognized.Barcodes.Count);
             Assert.AreEqual(DecodeBarcodeType.QR.ToString(), recognized.Barcodes.First().Type);
             Assert.AreEqual("Test", recognized.Barcodes.First().BarcodeValue);
+            Assert.AreEqual(
+                "{\"barcodes\":[{" +
+                "\"barcodeValue\":\"Test\"," +
+                "\"type\":\"QR\"," +
+                "\"region\":[{\"x\":7,\"y\":7},{\"x\":49,\"y\":7},{\"x\":49,\"y\":49},{\"x\":7,\"y\":49}]," +
+                "\"checksum\":null}]}",
+                recognized.ToString()
+            );
         }
     }
 }