Add context API

Author: Amir Tocker

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

@@ -18,6 +18,17 @@
 
 @SuppressWarnings({"rawtypes", "unchecked"})
 public class Uploader {
+
+    private final class Command {
+        final static String add = "add";
+        final static String remove = "remove";
+        final static String replace = "replace";
+        final static String removeAll = "remove_all";
+
+        private Command() {
+        }
+    }
+
     public Map callApi(String action, Map<String, Object> params, Map options, Object file) throws IOException {
         return strategy.callApi(action, params, options, file);
     }
@@ -267,26 +278,26 @@ public Map addTag(String tag, String[] publicIds, Map options) throws IOExceptio
         if (options == null)
             options = ObjectUtils.emptyMap();
         boolean exclusive = ObjectUtils.asBoolean(options.get("exclusive"), false);
-        String command = exclusive ? "set_exclusive" : "add";
+        String command = exclusive ? "set_exclusive" : Command.add;
         return callTagsApi(tag, command, publicIds, options);
     }
 
     public Map removeTag(String tag, String[] publicIds, Map options) throws IOException {
         if (options == null)
             options = ObjectUtils.emptyMap();
-        return callTagsApi(tag, "remove", publicIds, options);
+        return callTagsApi(tag, Command.remove, publicIds, options);
     }
 
     public Map removeAllTags(String[] publicIds, Map options) throws IOException {
         if (options == null)
             options = ObjectUtils.emptyMap();
-        return callTagsApi(null, "remove_all", publicIds, options);
+        return callTagsApi(null, Command.removeAll, publicIds, options);
     }
 
     public Map replaceTag(String tag, String[] publicIds, Map options) throws IOException {
         if (options == null)
             options = ObjectUtils.emptyMap();
-        return callTagsApi(tag, "replace", publicIds, options);
+        return callTagsApi(tag, Command.replace, publicIds, options);
     }
 
     public Map callTagsApi(String tag, String command, String[] publicIds, Map options) throws IOException {
@@ -302,6 +313,58 @@ public Map callTagsApi(String tag, String command, String[] publicIds, Map optio
         return callApi("tags", params, options, null);
     }
 
+    /**
+     * Add a context keys and values. If a particular key already exists, the value associated with the key is updated.
+     * @param context a map of key and value. Serialized to "key1=value1|key2=value2"
+     * @param publicIds the public IDs of the resources to update
+     * @param options additional options passed to the request
+     * @return a list of public IDs that were updated
+     * @throws IOException
+     */
+    public Map addContext(Map context, String[] publicIds, Map options) throws IOException {
+        return callContextApi(context, Command.add, publicIds, options);
+    }
+
+    /**
+     * Add a context keys and values. If a particular key already exists, the value associated with the key is updated.
+     * @param context Serialized context in the form of "key1=value1|key2=value2"
+     * @param publicIds the public IDs of the resources to update
+     * @param options additional options passed to the request
+     * @return a list of public IDs that were updated
+     * @throws IOException
+     */
+    public Map addContext(String context, String[] publicIds, Map options) throws IOException {
+        return callContextApi(context, Command.add, publicIds, options);
+    }
+
+    /**
+     * Remove all custom context from the specified public IDs.
+     * @param publicIds the public IDs of the resources to update
+     * @param options additional options passed to the request
+     * @return a list of public IDs that were updated
+     * @throws IOException
+     */
+    public Map removeAllContext(String[] publicIds, Map options) throws IOException {
+        return callContextApi((String)null, Command.removeAll, publicIds, options);
+    }
+
+    protected Map callContextApi(Map context, String command, String[] publicIds, Map options) throws IOException {
+        return callContextApi(Util.encodeContext(context), command, publicIds, options);
+    }
+
+    protected Map callContextApi(String context, String command, String[] publicIds, Map options) throws IOException {
+        if (options == null)
+            options = ObjectUtils.emptyMap();
+        Map<String, Object> params = new HashMap<String, Object>();
+        if (context != null) {
+            params.put("context", context);
+        }
+        params.put("command", command);
+        params.put("type", (String) options.get("type"));
+        params.put("public_ids", Arrays.asList(publicIds));
+        return callApi("context", params, options, null);
+    }
+
     private final static String[] TEXT_PARAMS = {"public_id", "font_family", "font_size", "font_color", "text_align", "font_weight", "font_style",
             "background", "opacity", "text_decoration"};
 

cloudinary-http43/src/test/java/com/cloudinary/test/ContextTest.java

@@ -0,0 +1,5 @@
+package com.cloudinary.test;
+
+public class ContextTest extends AbstractContextTest {
+
+}

cloudinary-http44/src/test/java/com/cloudinary/test/ContextTest.java

@@ -0,0 +1,5 @@
+package com.cloudinary.test;
+
+public class ContextTest extends AbstractContextTest {
+
+}

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

@@ -0,0 +1,102 @@
+package com.cloudinary.test;
+
+import com.cloudinary.Api;
+import com.cloudinary.Cloudinary;
+import com.cloudinary.Transformation;
+import com.cloudinary.Uploader;
+import com.cloudinary.utils.ObjectUtils;
+import org.junit.*;
+import org.junit.rules.TestName;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static com.cloudinary.utils.ObjectUtils.asMap;
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
+import static org.junit.Assume.assumeNotNull;
+
+@SuppressWarnings({"rawtypes", "unchecked"})
+abstract public class AbstractContextTest extends MockableTest {
+
+    private static final String CONTEXT_TAG = "context_tag_" + String.valueOf(System.currentTimeMillis());
+    private static Map resource;
+    public static final Map CONTEXT = asMap("caption", "some cäption", "alt", "alternativè");
+    private Uploader uploader;
+
+    @BeforeClass
+    public static void setUpClass() throws Exception {
+        Cloudinary cloudinary = new Cloudinary();
+        if (cloudinary.config.apiSecret == null) {
+            System.err.println("Please setup environment for Upload test to run");
+        }
+
+        resource = cloudinary.uploader().upload(SRC_TEST_IMAGE,
+                asMap(  "tags", new String[]{SDK_TEST_TAG, CONTEXT_TAG},
+                        "context", CONTEXT,
+                        "transformation", new Transformation().crop("scale").width(10)));
+        final String publicId = (String) resource.get("public_id");
+        resource = cloudinary.api().resource(publicId, asMap("context", true));
+        assertEquals(asMap("custom", CONTEXT), resource.get("context"));
+
+    }
+
+    @AfterClass
+    public static void tearDownClass() {
+        Api api = MockableTest.cleanUp();
+        Cloudinary cloudinary = new Cloudinary();
+        try {
+            cloudinary.api().deleteResourcesByTag(CONTEXT_TAG, ObjectUtils.emptyMap());
+        } catch (Exception ignored) {
+        }
+    }
+
+    @Rule
+    public TestName currentTest = new TestName();
+
+    @Before
+    public void setUp() throws Exception {
+        System.out.println("Running " + this.getClass().getName() + "." + currentTest.getMethodName());
+        cloudinary = new Cloudinary();
+        uploader = cloudinary.uploader();
+        assumeNotNull(cloudinary.config.apiSecret);
+
+    }
+
+    @Test
+    public void testExplicit() throws Exception {
+        //should allow sending context
+
+        Map differentContext = asMap("caption", "different = caption", "alt2", "alt|alternative alternative");
+        Map result = uploader.explicit(publicId(), asMap("type", "upload", "context", differentContext));
+        assertEquals("explicit API should return the new context", asMap("custom", differentContext), result.get("context"));
+        resource = cloudinary.api().resource(publicId(), asMap("context", true));
+        assertEquals("explicit API should replace the context", asMap("custom", differentContext), resource.get("context"));
+    }
+
+    @Test
+    public void testAddContext() throws Exception {
+        Map context = new HashMap((Map)((Map)resource.get("context")).get("custom"));
+        context.put("caption", "new caption");
+        Map result = uploader.addContext(asMap("caption", "new caption"), new String[]{publicId(), "no-such-id"}, null);
+        assertThat("addContext should return a list of modified public IDs", (List<String>) result.get("public_ids"), contains(publicId()));
+
+        resource = cloudinary.api().resource(publicId(), asMap("context", true));
+        assertEquals(asMap("custom", context), resource.get("context"));
+    }
+
+    @Test
+    public void testRemoveAllContext() throws Exception {
+        Map result = uploader.removeAllContext(new String[]{publicId(), "no-such-id"}, null);
+        assertThat((List<String>) result.get("public_ids"), contains(publicId()));
+
+        resource = cloudinary.api().resource(publicId(), asMap("context", true));
+        assertThat((Map<? extends String, ?>)resource, not(hasKey("context")));
+    }
+
+    private String publicId(){
+        return (String) resource.get("public_id");
+    }
+}