Fix AdvOcr error handling

Author: const-cloudinary

CloudinaryDotNet.Tests/AdminApi/GetResourceTest.cs

@@ -66,6 +66,42 @@ public class GetResourceTest
             }
         ";
 
+        // OCR response with successful data array
+        private const string SuccessfulOcrResponse = @"
+        {
+          ""asset_id"": ""8abd06560fc75b3bbe80299b988035b0"",
+          ""public_id"": ""ocr_test_id"",
+          ""format"": ""jpg"",
+          ""info"": {
+            ""ocr"": {
+              ""adv_ocr"": {
+                ""status"": ""complete"",
+                ""data"": [
+                  {}
+                ]
+              }
+            }
+          }
+        }
+        ";
+
+        // OCR response with failed string error
+        private const string FailedOcrResponse = @"
+        {
+          ""asset_id"": ""8abd06560fc75b3bbe80299b988035b0"",
+          ""public_id"": ""ocr_failed_test_id"",
+          ""format"": ""jpg"",
+          ""info"": {
+            ""ocr"": {
+              ""adv_ocr"": {
+                ""status"": ""failed"",
+                ""data"": ""Failed to process request""
+              }
+            }
+          }
+        }
+        ";
+
         [Test]
         public void TestGetResourceModerationResponse_WithLabels()
         {
@@ -115,5 +151,38 @@ public void TestGetResourceModerationResponse_WithDuplicates()
             Assert.AreEqual("duplicate_id", firstModeration.Response.ModerationLabels[0].PublicId);
             Assert.AreEqual(1.0f, firstModeration.Response.ModerationLabels[0].Confidence);
         }
+
+        [Test]
+        public void TestGetResourceAdvOcr_WithSuccessfulData()
+        {
+            var localCloudinaryMock = new MockedCloudinary(SuccessfulOcrResponse);
+            var result = localCloudinaryMock.GetResource("ocr_test_id");
+
+            Assert.NotNull(result);
+            Assert.AreEqual("ocr_test_id", result.PublicId);
+            Assert.NotNull(result.Info);
+            Assert.NotNull(result.Info.Ocr);
+            Assert.NotNull(result.Info.Ocr.AdvOcr);
+            Assert.AreEqual("complete", result.Info.Ocr.AdvOcr.Status);
+            Assert.NotNull(result.Info.Ocr.AdvOcr.Data);
+            Assert.AreEqual(1, result.Info.Ocr.AdvOcr.Data.Count);
+            Assert.IsNull(result.Info.Ocr.AdvOcr.ErrorMessage);
+        }
+
+        [Test]
+        public void TestGetResourceAdvOcr_WithFailedString()
+        {
+            var localCloudinaryMock = new MockedCloudinary(FailedOcrResponse);
+            var result = localCloudinaryMock.GetResource("ocr_failed_test_id");
+
+            Assert.NotNull(result);
+            Assert.AreEqual("ocr_failed_test_id", result.PublicId);
+            Assert.NotNull(result.Info);
+            Assert.NotNull(result.Info.Ocr);
+            Assert.NotNull(result.Info.Ocr.AdvOcr);
+            Assert.AreEqual("failed", result.Info.Ocr.AdvOcr.Status);
+            Assert.IsNull(result.Info.Ocr.AdvOcr.Data);
+            Assert.AreEqual("Failed to process request", result.Info.Ocr.AdvOcr.ErrorMessage);
+        }
     }
 }

CloudinaryDotNet/Actions/AssetsManagement/NestedTypes/AdvOcr.cs

@@ -2,11 +2,13 @@
 {
     using System.Collections.Generic;
     using System.Runtime.Serialization;
+    using Newtonsoft.Json;
 
     /// <summary>
     /// Details of executing an ADV_OCR engine.
     /// </summary>
     [DataContract]
+    [JsonConverter(typeof(AdvOcrDataConverter))]
     public class AdvOcr
     {
         /// <summary>
@@ -16,9 +18,16 @@ public class AdvOcr
         public string Status { get; set; }
 
         /// <summary>
-        /// Gets or sets data returned by OCR plugin.
+        /// Gets or sets data returned by OCR plugin when successful.
+        /// This will be null if the operation failed and ErrorMessage contains the error.
         /// </summary>
         [DataMember(Name = "data")]
         public List<AdvOcrData> Data { get; set; }
+
+        /// <summary>
+        /// Gets or sets the error message when the OCR operation fails.
+        /// This property captures the string value of 'data' field when status is "failed".
+        /// </summary>
+        public string ErrorMessage { get; set; }
     }
-}
+}

CloudinaryDotNet/Actions/JsonConverter/AdvOcrDataConverter.cs

@@ -0,0 +1,77 @@
+namespace CloudinaryDotNet.Actions
+{
+    using System;
+    using System.Collections.Generic;
+    using Newtonsoft.Json;
+    using Newtonsoft.Json.Linq;
+
+    /// <summary>
+    /// Custom JSON converter to handle ADV_OCR data that can be either an array of objects or an error string.
+    /// </summary>
+    public class AdvOcrDataConverter : JsonConverter
+    {
+        /// <summary>
+        /// Gets a value indicating whether this <see cref="AdvOcrDataConverter"/> can write JSON.
+        /// </summary>
+        public override bool CanWrite => false;
+
+        /// <summary>
+        /// Reads the JSON representation of the object.
+        /// </summary>
+        /// <param name="reader">The <see cref="JsonReader"/> to read from.</param>
+        /// <param name="objectType">Type of the object.</param>
+        /// <param name="existingValue">The existing value of object being read.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        /// <returns>The object value.</returns>
+        public override object ReadJson(
+            JsonReader reader,
+            Type objectType,
+            object existingValue,
+            JsonSerializer serializer)
+        {
+            var jObject = JObject.Load(reader);
+            var advOcr = new AdvOcr();
+
+            // Handle status field
+            if (jObject["status"] != null)
+            {
+                advOcr.Status = jObject["status"].Value<string>();
+            }
+
+            // Handle data field - can be array or string
+            if (jObject["data"] != null)
+            {
+                var dataToken = jObject["data"];
+
+                if (dataToken.Type == JTokenType.Array)
+                {
+                    advOcr.Data = dataToken.ToObject<List<AdvOcrData>>(serializer);
+                }
+                else if (dataToken.Type == JTokenType.String)
+                {
+                    advOcr.ErrorMessage = dataToken.Value<string>();
+                }
+            }
+
+            return advOcr;
+        }
+
+        /// <summary>
+        /// Determines whether this instance can convert the specified object type.
+        /// </summary>
+        /// <param name="objectType">Type of the object.</param>
+        /// <returns>True if this instance can convert the specified object type; otherwise, false.</returns>
+        public override bool CanConvert(Type objectType) => objectType == typeof(AdvOcr);
+
+        /// <summary>
+        /// Writes the JSON representation of the object.
+        /// </summary>
+        /// <param name="writer">The <see cref="JsonWriter"/> to write to.</param>
+        /// <param name="existingValue">The value.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override void WriteJson(JsonWriter writer, object existingValue, JsonSerializer serializer)
+        {
+            throw new NotImplementedException("Unnecessary because of using just for Deserialization");
+        }
+    }
+}