Support structured metadata in resources api call

Author: YomesInc

cloudinary-core/src/main/java/com/cloudinary/Api.java

@@ -88,15 +88,15 @@ public ApiResponse resources(Map options) throws Exception {
         if (type != null)
             uri.add(type);
 
-        ApiResponse response = callApi(HttpMethod.GET, uri, ObjectUtils.only(options, "next_cursor", "direction", "max_results", "prefix", "tags", "context", "moderations", "start_at"), options);
+        ApiResponse response = callApi(HttpMethod.GET, uri, ObjectUtils.only(options, "next_cursor", "direction", "max_results", "prefix", "tags", "context", "moderations", "start_at", "metadata"), options);
         return response;
     }
 
     public ApiResponse resourcesByTag(String tag, Map options) throws Exception {
         if (options == null) options = ObjectUtils.emptyMap();
         String resourceType = ObjectUtils.asString(options.get("resource_type"), "image");
 
-        ApiResponse response = callApi(HttpMethod.GET, Arrays.asList("resources", resourceType, "tags", tag), ObjectUtils.only(options, "next_cursor", "direction", "max_results", "tags", "context", "moderations"), options);
+        ApiResponse response = callApi(HttpMethod.GET, Arrays.asList("resources", resourceType, "tags", tag), ObjectUtils.only(options, "next_cursor", "direction", "max_results", "tags", "context", "moderations", "metadata"), options);
         return response;
     }
 
@@ -107,7 +107,7 @@ public ApiResponse resourcesByContext(String key, Map options) throws Exception
     public ApiResponse resourcesByContext(String key, String value, Map options) throws Exception {
         if (options == null) options = ObjectUtils.emptyMap();
         String resourceType = ObjectUtils.asString(options.get("resource_type"), "image");
-        Map params = ObjectUtils.only(options, "next_cursor", "direction", "max_results", "tags", "context", "moderations");
+        Map params = ObjectUtils.only(options, "next_cursor", "direction", "max_results", "tags", "context", "moderations", "metadata");
         params.put("key", key);
         if (StringUtils.isNotBlank(value)) {
             params.put("value", value);
@@ -143,7 +143,7 @@ public ApiResponse resourcesByModeration(String kind, String status, Map options
         if (options == null) options = ObjectUtils.emptyMap();
         String resourceType = ObjectUtils.asString(options.get("resource_type"), "image");
 
-        ApiResponse response = callApi(HttpMethod.GET, Arrays.asList("resources", resourceType, "moderations", kind, status), ObjectUtils.only(options, "next_cursor", "direction", "max_results", "tags", "context", "moderations"), options);
+        ApiResponse response = callApi(HttpMethod.GET, Arrays.asList("resources", resourceType, "moderations", kind, status), ObjectUtils.only(options, "next_cursor", "direction", "max_results", "tags", "context", "moderations", "metadata"), options);
         return response;
     }
 

cloudinary-test-common/src/main/java/com/cloudinary/test/AbstractApiTest.java

@@ -4,6 +4,7 @@
 import com.cloudinary.api.ApiResponse;
 import com.cloudinary.api.exceptions.BadRequest;
 import com.cloudinary.api.exceptions.NotFound;
+import com.cloudinary.metadata.StringMetadataField;
 import com.cloudinary.transformation.TextLayer;
 import com.cloudinary.utils.ObjectUtils;
 import org.junit.*;
@@ -367,6 +368,47 @@ public void testDeleteDerivedByTransformation() throws Exception {
         assertTrue(derived.size() == 0);
     }
 
+    @Test
+    public void testGetResourcesWithMetadata() throws Exception {
+        String public_id = "api_,withMetadata" + SUFFIX;
+        String fieldId = MetadataTestHelper.addFieldToAccount(api, MetadataTestHelper.newFieldInstance("some_field" + SUFFIX)).get("external_id").toString();
+        cloudinary.uploader().upload(SRC_TEST_IMAGE, 
+                ObjectUtils.asMap("public_id", public_id, 
+                    "tags", UPLOAD_TAGS, 
+                    "metadata", ObjectUtils.asMap(fieldId, "test"), 
+                    "moderation", "manual", 
+                    "context", ObjectUtils.asMap("name", "value")));
+        
+        Map result = api.resources(ObjectUtils.asMap("metadata", false));
+        assertNull(getMetadata(public_id, result));
+        
+        result = api.resources(ObjectUtils.asMap("metadata", true));
+        assertNotNull(getMetadata(public_id, result));
+        
+        result = api.resourcesByTag(UPLOAD_TAGS[0], ObjectUtils.asMap("metadata", true));
+        assertNotNull(getMetadata(public_id, result));
+        
+        result = api.resourcesByTag(UPLOAD_TAGS[0], ObjectUtils.asMap("metadata", false));
+        assertNull(getMetadata(public_id, result));
+        
+        result = api.resourcesByModeration("manual", "pending", ObjectUtils.asMap("metadata", true));
+        assertNotNull(getMetadata(public_id, result));
+        
+        result = api.resourcesByModeration("manual", "pending", ObjectUtils.asMap("metadata", false));
+        assertNull(getMetadata(public_id, result));
+        
+        result = api.resourcesByContext("name", "value", ObjectUtils.asMap("metadata", true));
+        assertNotNull(getMetadata(public_id, result));
+        
+        result = api.resourcesByContext("name", "value", ObjectUtils.asMap("metadata", false));
+        assertNull(getMetadata(public_id, result));
+    }
+
+    private Object getMetadata(String public_id, Map result) {
+        Map resource = findByAttr((List<Map>) result.get("resources"), "public_id", public_id);
+        return resource.get("metadata");
+    }
+
     @Test(expected = NotFound.class)
     public void test09DeleteResources() throws Exception {
         // should allow deleting resources