Fixed issue #14: add purge operation to CouchDbConnector

org.ektorp/src/main/java/org/ektorp/CouchDbConnector.java

@@ -57,6 +57,12 @@ public interface CouchDbConnector {
 	 * @throws UpdateConflictException if there was an update conflict.
 	 */
 	String delete(String id, String revision);
+	/**
+	 * Permanently removes the references to deleted documents from the database.
+	 * @param revisionsToPurge document IDs & revisions to be purged
+	 * @return contains the purge sequence number, and a list of the document IDs and revisions successfully purged.
+	 */
+	PurgeResult purge(Map<String, List<String>> revisionsToPurge);
 	/**
 	 *
 	 * @param <T>

org.ektorp/src/main/java/org/ektorp/PurgeResult.java

@@ -0,0 +1,58 @@
+package org.ektorp;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.codehaus.jackson.annotate.JsonAnyGetter;
+import org.codehaus.jackson.annotate.JsonAnySetter;
+import org.codehaus.jackson.annotate.JsonCreator;
+import org.codehaus.jackson.annotate.JsonProperty;
+
+public class PurgeResult {
+
+	private final Map<String, List<String>> purged;
+	private final long purgeSeq;
+
+	@JsonCreator
+	public PurgeResult(@JsonProperty("purged") Map<String, 
+			List<String>> purged,@JsonProperty("purge_seq") long purgeSeq) {
+		this.purged = purged;
+		this.purgeSeq = purgeSeq;
+	}
+
+	public Map<String, List<String>> getPurged() {
+		return purged;
+	}
+
+	public long getPurgeSeq() {
+		return purgeSeq;
+	}
+
+	private Map<String, Object> anonymous;
+
+	/** 
+	 * @return a Map containing fields that did not map to any other field in the class during object deserializarion from a JSON document.
+	 */
+	@JsonAnyGetter
+	public Map<String, Object> getAnonymous() {
+		return anonymous();
+	}
+
+	/**
+	 * Exists in order to future proof this class. 
+	 * @param key
+	 * @param value
+	 */
+	@JsonAnySetter
+	public void setAnonymous(String key, Object value) {
+		anonymous().put(key, value);
+	}
+
+	private Map<String, Object> anonymous() {
+		if (anonymous == null) {
+			anonymous = new HashMap<String, Object>();
+		}
+		return anonymous;
+	}
+}

org.ektorp/src/main/java/org/ektorp/impl/StdCouchDbConnector.java

@@ -24,6 +24,7 @@
 import org.ektorp.Options;
 import org.ektorp.Page;
 import org.ektorp.PageRequest;
+import org.ektorp.PurgeResult;
 import org.ektorp.ReplicationCommand;
 import org.ektorp.ReplicationStatus;
 import org.ektorp.Revision;
@@ -183,6 +184,16 @@ public String delete(Object o) {
 		return delete(Documents.getId(o), Documents.getRevision(o));
 	}
 
+	@Override
+	public PurgeResult purge(Map<String, List<String>> revisionsToPurge) {
+		return restTemplate.post(dbURI.append("_purge").toString(), jsonSerializer.toJson(revisionsToPurge), new StdResponseHandler<PurgeResult>() {
+			@Override
+			public PurgeResult success(HttpResponse hr) throws Exception {
+				return objectMapper.readValue(hr.getContent(), PurgeResult.class);
+			}
+		});
+	}
+
 	public <T> T get(final Class<T> c, String id) {
 		return get(c, id, EMPTY_OPTIONS);
 	}

org.ektorp/src/test/java/org/ektorp/impl/StdCouchDbConnectorTest.java

@@ -529,6 +529,17 @@ public void testEnsureFullCommit() {
 		verify(httpClient).post("/test_db/_ensure_full_commit", "");
 	}
 
+	@Test
+	public void testPurge() {
+		String rsp = "{\"purged\" : { \"Billy\" : [ \"17-b3eb5ac6fbaef4428d712e66483dcb79\"]},\"purge_seq\" : 11}";
+		when(httpClient.post(eq("/test_db/_purge"), anyString())).thenReturn(HttpResponseStub.valueOf(200, rsp));
+		Map<String, List<String>> revisionsToPurge = new HashMap<String, List<String>>();
+		revisionsToPurge.put("Billy", Collections.singletonList("17-b3eb5ac6fbaef4428d712e66483dcb79"));
+		PurgeResult r = dbCon.purge(revisionsToPurge);
+		assertEquals(11, r.getPurgeSeq());
+		assertTrue(r.getPurged().containsKey("Billy"));
+	}
+
 	@SuppressWarnings("serial")
 	static class DateDoc extends CouchDbDocument {