[SP-10204] get raw request response (#74)

* update-clients_GetRawRequestResponse * add property for raw json --------- Co-authored-by: GitHub Action <[email protected]>
regulaforensics · Jun 21, 2023 · d7ebea3 · d7ebea3
1 parent 40763a7
commit d7ebea3
Show file tree

Hide file tree

Showing 9 changed files with 59 additions and 28 deletions.
diff --git a/src/Regula.DocumentReader.NetCoreExample/Program.cs b/src/Regula.DocumentReader.NetCoreExample/Program.cs
@@ -43,16 +43,19 @@ public static void Main()
 
             var request = new RecognitionRequest(requestParams, new List<ProcessRequestImage>
             {
-                new ProcessRequestImage(new ImageData(whitePage0), Light.WHITE),
-                new ProcessRequestImage(new ImageData(irPage0), Light.IR),
-                new ProcessRequestImage(new ImageData(uvPage0), Light.UV)
+                new ProcessRequestImage(new ImageDataExt(whitePage0), Light.WHITE),
+                new ProcessRequestImage(new ImageDataExt(irPage0), Light.IR),
+                new ProcessRequestImage(new ImageDataExt(uvPage0), Light.UV)
             });
             var api = licenseFromEnv != null
                 ? new DocumentReaderApi(apiBaseUrl).WithLicense(licenseFromEnv)
                 : new DocumentReaderApi(apiBaseUrl).WithLicense(licenseFromFile);
 
             var response = api.Process(request);
 
+            var requestJson = request.Json;
+            var responseJson = response.Json;
+
             // overall status results 
             var status = response.Status();
             var docOverallStatus = status.OverallStatus == CheckResult.OK ? "valid" : "not valid";

diff --git a/src/Regula.DocumentReader.WebClient/Model/DocumentImage.cs b/src/Regula.DocumentReader.WebClient/Model/DocumentImage.cs
@@ -39,7 +39,7 @@ protected DocumentImage() { }
         /// Initializes a new instance of the <see cref="DocumentImage" /> class.
         /// </summary>
         /// <param name="image">Base64 encoded image (required).</param>
-        public DocumentImage(byte[] image = default(byte[]))
+        public DocumentImage(string image = default(string))
         {
             // to ensure "image" is required (not null)
             if (image == null)
@@ -58,7 +58,7 @@ protected DocumentImage() { }
         /// </summary>
         /// <value>Base64 encoded image</value>
         [DataMember(Name="image", EmitDefaultValue=true)]
-        public byte[] Image { get; set; }
+        public string Image { get; set; }
 
         /// <summary>
         /// Returns the string presentation of the object

diff --git a/src/Regula.DocumentReader.WebClient/Model/Ext/ImageDataExt.cs b/src/Regula.DocumentReader.WebClient/Model/Ext/ImageDataExt.cs
@@ -0,0 +1,15 @@
+using System;
+using System.Transactions;
+
+namespace Regula.DocumentReader.WebClient.Model.Ext
+{
+    public class ImageDataExt : ImageData
+    {
+        public ImageDataExt(byte[] imageData)
+        {
+            string base64Image = Convert.ToBase64String(imageData);
+
+            Image = base64Image;
+        }
+    }
+}
diff --git a/src/Regula.DocumentReader.WebClient/Model/Ext/ImagesFieldExtensions.cs b/src/Regula.DocumentReader.WebClient/Model/Ext/ImagesFieldExtensions.cs
@@ -1,21 +1,24 @@
+using System;
 using System.Linq;
 
 namespace Regula.DocumentReader.WebClient.Model.Ext
 {
     public static class ImagesFieldExtensions
     {
-        public static byte[] GetValue(this ImagesField field, string source, bool original = false) 
+        public static byte[] GetValue(this ImagesField field, string source, bool original = false)
         {
+            string strResult;
             foreach (var value in field.ValueList) 
             {
                 if (value.Source == source)
                 {
                     if (original) 
                     {
-                        return value.OriginalValue;
+                        strResult =  value.OriginalValue;
                     }
+                    strResult = value.Value;
 
-                    return value.Value;
+                    return Convert.FromBase64String(strResult);
                 }
             }
             return null;
@@ -41,7 +44,7 @@ public static byte[] GetValue(this ImagesField field)
                     bestValue = value;
             }
 
-            return bestValue.Value;
+            return Convert.FromBase64String(bestValue.Value);
         }
     }
 }
diff --git a/src/Regula.DocumentReader.WebClient/Model/Ext/ProcessRequestImage.cs b/src/Regula.DocumentReader.WebClient/Model/Ext/ProcessRequestImage.cs
@@ -1,4 +1,5 @@
 using System;
+using Regula.DocumentReader.WebClient.Model.Ext;
 
 // ReSharper disable once CheckNamespace
 namespace Regula.DocumentReader.WebClient.Model
@@ -12,7 +13,7 @@ public ProcessRequestImage(byte[] image, int lightIndex = -1)
                 throw new Exception("No image provided");
             }
 
-            ImageData = new ImageData(image);
+            ImageData = new ImageDataExt(image);
 
             if (lightIndex >= 0)
                 Light = lightIndex;

diff --git a/src/Regula.DocumentReader.WebClient/Model/Ext/RecognitionRequest.cs b/src/Regula.DocumentReader.WebClient/Model/Ext/RecognitionRequest.cs
@@ -4,20 +4,26 @@ namespace Regula.DocumentReader.WebClient.Model.Ext
 {
     public class RecognitionRequest : ProcessRequest
     {
-        public RecognitionRequest(ProcessParams param, ProcessRequestImage image, string tag=null)
-            :base(tag, param, new List<ProcessRequestImage> { image })
-        { }
-
-        public RecognitionRequest(ProcessParams param, byte[] image, string tag=null)
-            :base(tag, param, new List<ProcessRequestImage> {new ProcessRequestImage(image)})
-        { }
-
-        public RecognitionRequest(ProcessParams param, List<ProcessRequestImage> images, string tag=null)
-            :base(tag, param, images)
-        { }
+        public RecognitionRequest(ProcessParams param, ProcessRequestImage image, string tag = null)
+            : base(tag, param, new List<ProcessRequestImage> { image })
+        {
+        }
 
-        public RecognitionRequest(ProcessParams param, ContainerList containerList, string tag=null)
+        public RecognitionRequest(ProcessParams param, byte[] image, string tag = null)
+            : base(tag, param, new List<ProcessRequestImage> { new ProcessRequestImage(image) })
+        {
+        }
+
+        public RecognitionRequest(ProcessParams param, List<ProcessRequestImage> images, string tag = null)
+            : base(tag, param, images)
+        {
+        }
+
+        public RecognitionRequest(ProcessParams param, ContainerList containerList, string tag = null)
             : base(tag, param, null, containerList)
-        { }
+        {
+        }
+
+        public string Json => Newtonsoft.Json.JsonConvert.SerializeObject(this);
     }
 }
diff --git a/src/Regula.DocumentReader.WebClient/Model/Ext/RecognitionResponse.cs b/src/Regula.DocumentReader.WebClient/Model/Ext/RecognitionResponse.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 
 namespace Regula.DocumentReader.WebClient.Model.Ext
@@ -10,6 +11,8 @@ public RecognitionResponse(ProcessResponse originalResponse)
         }
 
         public ProcessResponse OriginalResponse { get; }
+
+        public string Json =>  Newtonsoft.Json.JsonConvert.SerializeObject(this.OriginalResponse);
 
         public Status Status() 
         {

diff --git a/src/Regula.DocumentReader.WebClient/Model/ImageData.cs b/src/Regula.DocumentReader.WebClient/Model/ImageData.cs
@@ -39,7 +39,7 @@ protected ImageData() { }
         /// Initializes a new instance of the <see cref="ImageData" /> class.
         /// </summary>
         /// <param name="image">Base64 encoded image (required).</param>
-        public ImageData(byte[] image = default(byte[]))
+        public ImageData(string image = default(string))
         {
             // to ensure "image" is required (not null)
             if (image == null)
@@ -58,7 +58,7 @@ protected ImageData() { }
         /// </summary>
         /// <value>Base64 encoded image</value>
         [DataMember(Name="image", EmitDefaultValue=true)]
-        public byte[] Image { get; set; }
+        public string Image { get; set; }
 
         /// <summary>
         /// Returns the string presentation of the object

diff --git a/src/Regula.DocumentReader.WebClient/Model/ImagesFieldValue.cs b/src/Regula.DocumentReader.WebClient/Model/ImagesFieldValue.cs
@@ -47,7 +47,7 @@ protected ImagesFieldValue() { }
         /// <param name="containerType">Same as Result type, but used for safe parsing of not-described values. See Result type. (required) (default to 0).</param>
         /// <param name="fieldRect">fieldRect.</param>
         /// <param name="rfidOrigin">rfidOrigin.</param>
-        public ImagesFieldValue(string source = default(string), byte[] value = default(byte[]), byte[] originalValue = default(byte[]), int originalPageIndex = default(int), int pageIndex = default(int), int lightIndex = default(int), int containerType = 0, RectangleCoordinates fieldRect = default(RectangleCoordinates), RfidOrigin rfidOrigin = default(RfidOrigin))
+        public ImagesFieldValue(string source = default(string), string value = default(string), string originalValue = default(string), int originalPageIndex = default(int), int pageIndex = default(int), int lightIndex = default(int), int containerType = 0, RectangleCoordinates fieldRect = default(RectangleCoordinates), RfidOrigin rfidOrigin = default(RfidOrigin))
         {
             // to ensure "source" is required (not null)
             if (source == null)
@@ -116,14 +116,14 @@ protected ImagesFieldValue() { }
         /// </summary>
         /// <value>Base64 encoded image</value>
         [DataMember(Name="value", EmitDefaultValue=true)]
-        public byte[] Value { get; set; }
+        public string Value { get; set; }
 
         /// <summary>
         /// Base64 encoded image
         /// </summary>
         /// <value>Base64 encoded image</value>
         [DataMember(Name="originalValue", EmitDefaultValue=false)]
-        public byte[] OriginalValue { get; set; }
+        public string OriginalValue { get; set; }
 
         /// <summary>
         /// Original page index