Allow generating archive with multiple resource types

Author: const-cloudinary

Shared.Tests/CloudinaryTest.cs

@@ -1474,6 +1474,37 @@ public void TestResourcesCursor()
             Assert.AreNotEqual(result1.Resources[0].PublicId, result2.Resources[0].PublicId);
         }
 
+        [Test]
+        public void TestResourceFullyQualifiedPublicId()
+        {
+            // should return correct FullyQualifiedPublicId
+
+            var uploadParams = new ImageUploadParams()
+            {
+                File = new FileDescription(m_testImagePath),
+                PublicId = GetUniquePublicId(),
+                Tags = m_apiTag
+            };
+
+            m_cloudinary.Upload(uploadParams);
+
+            var listParams = new ListResourcesParams()
+            {
+                ResourceType = ResourceType.Image,
+                MaxResults = 1
+            };
+
+            var result = m_cloudinary.ListResources(listParams);
+
+            Assert.IsNotNull(result.Resources);
+            Assert.AreEqual(1, result.Resources.Length);
+
+            var res = result.Resources[0];
+            var expectedFullQualifiedPublicId = $"{res.ResourceType}/{res.Type}/{res.PublicId}";
+
+            Assert.AreEqual(expectedFullQualifiedPublicId, res.FullyQualifiedPublicId);
+        }
+
         [Test]
         public void TestEager()
         {
@@ -3286,6 +3317,73 @@ public void TestCreateArchiveMultiplePublicIds()
             Assert.AreEqual(1, result.FileCount);
         }
 
+        [Test]
+        public void TestCreateArchiveMultipleResourceTypes()
+        {
+            var raw = ApiShared.GetCloudinaryParam(ResourceType.Raw);
+
+            var tag = GetMethodTag();
+
+            var rawUploadParams = new RawUploadParams()
+            {
+                File = new FileDescription(m_testPdfPath),
+                Tags = $"{tag},{m_apiTag}"
+            };
+
+            var upRes1 = m_cloudinary.Upload(rawUploadParams, raw);
+
+            var imageUploadParams = new ImageUploadParams()
+            {
+                File = new FileDescription(m_testImagePath),
+                Tags = $"{tag},{m_apiTag}"
+            };
+
+            var upRes2 = m_cloudinary.Upload(imageUploadParams);
+
+            var videoUploadParams = new VideoUploadParams()
+            {
+                File = new FileDescription(m_testVideoPath),
+                Tags = $"{tag},{m_apiTag}"
+            };
+
+            var upRes3 = m_cloudinary.Upload(videoUploadParams);
+
+            var fQPublicIds = new List<string>
+            {
+                upRes1.FullyQualifiedPublicId,
+                upRes2.FullyQualifiedPublicId,
+                upRes3.FullyQualifiedPublicId
+            };
+
+            var parameters = new ArchiveParams()
+                .UseOriginalFilename(true)
+                .TargetTags(new List<string> { tag, m_apiTag });
+
+            var ex = Assert.Throws<ArgumentException>(() => m_cloudinary.CreateArchive(parameters));
+
+            StringAssert.StartsWith("At least one of the following", ex.Message);
+
+            parameters.ResourceType("auto").Tags(new List<string> {"tag"});
+
+            ex = Assert.Throws<ArgumentException>(() => m_cloudinary.CreateArchive(parameters));
+
+            StringAssert.StartsWith("To create an archive with multiple types of assets", ex.Message);
+
+            parameters.ResourceType("").Tags(null).FullyQualifiedPublicIds(fQPublicIds);
+
+            ex = Assert.Throws<ArgumentException>(() => m_cloudinary.CreateArchive(parameters));
+
+            StringAssert.StartsWith("To create an archive with multiple types of assets", ex.Message);
+
+            Assert.AreEqual(fQPublicIds, parameters.FullyQualifiedPublicIds());
+
+            parameters.ResourceType("auto");
+
+            var result = m_cloudinary.CreateArchive(parameters);
+
+            Assert.AreEqual(3, result.FileCount);
+        }
+
         /// <summary>
         /// Should create a zip archive
         /// </summary>

Shared/Actions/ArchiveParams.cs

@@ -10,6 +10,7 @@ namespace CloudinaryDotNet.Actions
     public class ArchiveParams : BaseParams
     {
         private List<string> m_publicIds;
+        private List<string> m_fullyQualifiedPublicIds;
         private List<string> m_tags;
         private List<string> m_prefixes;
 
@@ -48,6 +49,23 @@ public ArchiveParams PublicIds(List<string> publicIds)
             return this;
         }
 
+        /// <summary>
+        /// Get a list of Fully Qualified Public IDs for the specific assets to be included in the archive
+        /// </summary>
+        public List<string> FullyQualifiedPublicIds()
+        {
+            return m_fullyQualifiedPublicIds;
+        }
+
+        /// <summary>
+        /// Set a list of Fully Qualified Public IDs for the specific assets to be included in the archive
+        /// </summary>
+        public ArchiveParams FullyQualifiedPublicIds(List<string> fullyQualifiedPublicIds)
+        {
+            m_fullyQualifiedPublicIds = fullyQualifiedPublicIds;
+            return this;
+        }
+
         /// <summary>
         /// Get a list of tag names. All images with this tag(s) will be included in the archive
         /// </summary>
@@ -83,19 +101,29 @@ public ArchiveParams Prefixes(List<string> prefixes)
             return this;
         }
 
+        /// <inheritdoc />
         /// <summary>
         /// Validate object model
         /// </summary>
         public override void Check()
         {
-            if ((m_publicIds == null || m_publicIds.Count == 0) &&
-                (m_prefixes == null || m_prefixes.Count == 0) &&
-                (m_tags == null || m_tags.Count == 0))
-                throw new ArgumentException("At least one of the following \"filtering\" parameters needs to be specified: PublicIds, Tags or Prefixes.");
+            if (m_publicIds?.Any() != true &&
+                m_fullyQualifiedPublicIds?.Any() != true &&
+                m_prefixes?.Any() != true &&
+                m_tags?.Any() != true)
+                throw new ArgumentException("At least one of the following \"filtering\" parameters needs " +
+                                            "to be specified: PublicIds, FullyQualifiedPublicIds, Tags or Prefixes.");
+
+            if (m_resourceType == "auto" ^ (m_fullyQualifiedPublicIds?.Any() ?? false))
+            {
+                throw new ArgumentException(
+                    "To create an archive with multiple types of assets, you must set ResourceType to \"auto\" " +
+                    "and provide FullyQualifiedPublicIds (For example, 'video/upload/my_video.mp4')");
+            }
         }
 
         /// <summary>
-        /// Get Mode whether to return the generated archive file (download) 
+        /// Get Mode whether to return the generated archive file (download)
         /// or to store it as a raw resource (create)
         /// </summary>
         public virtual ArchiveCallMode Mode()
@@ -104,7 +132,7 @@ public virtual ArchiveCallMode Mode()
         }
 
         /// <summary>
-        /// Determines whether to return the generated archive file (download) 
+        /// Determines whether to return the generated archive file (download)
         /// or to store it as a raw resource in your Cloudinary account and return a JSON with the URLs for accessing the archive file (create)
         /// </summary>
         /// <param name="mode"></param>
@@ -246,7 +274,7 @@ public int ExpiresAt()
         }
 
         /// <summary>
-        /// Set the Unix time in seconds when the generated download URL expires (e.g., 1415060076). 
+        /// Set the Unix time in seconds when the generated download URL expires (e.g., 1415060076).
         /// If this parameter is omitted then the generated download URL expires after 1 hour.
         /// Note: Relevant only for download call.
         /// </summary>
@@ -382,6 +410,9 @@ public override SortedDictionary<string, object> ToParamsDictionary()
             if (m_publicIds != null && m_publicIds.Count > 0)
                 AddParam(dict, "public_ids", m_publicIds);
 
+            if (m_fullyQualifiedPublicIds != null && m_fullyQualifiedPublicIds.Count > 0)
+                AddParam(dict, "fully_qualified_public_ids", m_fullyQualifiedPublicIds);
+
             if (m_prefixes != null && m_prefixes.Count > 0)
                 AddParam(dict, "prefixes", m_prefixes);
 

Shared/Actions/ExplicitResult.cs

@@ -11,9 +11,6 @@ namespace CloudinaryDotNet.Actions
     [DataContract]
     public class ExplicitResult : RawUploadResult
     {
-        [DataMember(Name = "type")]
-        public string Type { get; protected set; }
-
         [DataMember(Name = "eager")]
         public Eager[] Eager { get; protected set; }
 
@@ -35,10 +32,10 @@ internal override void SetValues(JToken source)
         /// </summary>
         [DataMember(Name = "status")]
         public string Status { get; protected set; }
-        
+
         [DataMember(Name = "info")]
         public Info Info { get; protected set; }
-        
+
         [DataMember(Name = "quality_analysis")]
         public QualityAnalysis QualityAnalysis{ get; protected set; }
     }

Shared/Actions/ListResourcesResult.cs

@@ -13,7 +13,6 @@ public class ListResourcesResult : BaseResult
 
         [DataMember(Name = "next_cursor")]
         public string NextCursor { get; protected set; }
-        
     }
 
     [DataContract]
@@ -45,5 +44,7 @@ public class Resource : UploadResult
 
         [DataMember(Name = "context")]
         public JToken Context { get; protected set; }
+
+        public string FullyQualifiedPublicId => $"{ResourceType}/{Type}/{PublicId}";
     }
 }

Shared/Actions/RawUploadResult.cs

@@ -16,6 +16,12 @@ public class RawUploadResult : UploadResult
         [DataMember(Name = "signature")]
         public string Signature { get; protected set; }
 
+        /// <summary>
+        /// Storage type
+        /// </summary>
+        [DataMember(Name = "type")]
+        public string Type { get; protected set; }
+
         /// <summary>
         /// Resource type
         /// </summary>
@@ -30,10 +36,11 @@ public class RawUploadResult : UploadResult
 
         [DataMember(Name = "tags")]
         public string[] Tags { get; protected set; }
-        
+
         [DataMember(Name = "access_control")]
         public List<AccessControlRule> AccessControl { get; protected set; }
-        
+
+        public string FullyQualifiedPublicId => $"{ResourceType}/{Type}/{PublicId}";
     }
 
     /// <summary>
@@ -47,6 +54,5 @@ public class RawPartUploadResult : RawUploadResult
         /// </summary>
         [DataMember(Name = "upload_id")]
         public string UploadId { get; protected set; }
-        
     }
 }