Added compactDesign and getRevsLimit()

Author: retrodaredevil

couchdb/src/main/java/me/retrodaredevil/couchdbjava/CouchDbDatabase.java

@@ -132,6 +132,20 @@ default String getCurrentRevision(String id) throws CouchDbException {
 	}
 
 	void compact() throws CouchDbException;
+	void compactDesign(String designDocument) throws CouchDbException;
+
+	/**
+	 * Note: Not supported on PouchDB
+	 * @throws CouchDbException
+	 * @throws me.retrodaredevil.couchdbjava.exception.CouchDbNotFoundException Only on PouchDB
+	 */
+	int getRevsLimit() throws CouchDbException;
+	/**
+	 * Note: Not supported on PouchDB
+	 * @throws CouchDbException
+	 * @throws me.retrodaredevil.couchdbjava.exception.CouchDbNotFoundException Only on PouchDB
+	 */
+	void setRevsLimit(int revsLimit) throws CouchDbException;
 
 	// TODO implement:
 	// _local_docs: https://docs.couchdb.org/en/stable/api/local.html#db-local-docs

couchdb/src/main/java/me/retrodaredevil/couchdbjava/okhttp/CouchDbDatabaseService.java

@@ -123,6 +123,15 @@ Call<DocumentResponse.Body> deleteAttachment(
 	@POST("_compact")
 	Call<SimpleStatus> compact();
 
+	@Headers({"Content-Type: application/json"})
+	@POST("_compact/{design-doc}")
+	Call<SimpleStatus> compactDesign(@Path("design-doc") String designDocument);
+
+	@GET("_revs_limit")
+	Call<Integer> getRevsLimit();
+	@PUT("_revs_limit")
+	Call<SimpleStatus> setRevsLimit(@Body int revsLimit);
+
 
 	// TODO active tasks: https://docs.couchdb.org/en/stable/api/server/common.html#api-server-active-tasks
 }

couchdb/src/main/java/me/retrodaredevil/couchdbjava/okhttp/OkHttpCouchDbDatabase.java

@@ -478,14 +478,32 @@ public boolean isOneShot() {
 		String batchString = batch ? "ok" : null;
 		return instance.executeAndHandle(service.deleteAttachment(documentId, attachmentName, documentRevision, batchString), OkHttpCouchDbDatabase::transformDocumentResponseOptionalETag);
 	}
+	// endregion
 
 	@Override
 	public void compact() throws CouchDbException {
 		instance.preAuthorize();
 		instance.executeAndHandle(service.compact());
 	}
 
-	// endregion
+	@Override
+	public void compactDesign(String designDocument) throws CouchDbException {
+		requireNonNull(designDocument);
+		instance.preAuthorize();
+		instance.executeAndHandle(service.compactDesign(designDocument));
+	}
+
+	@Override
+	public int getRevsLimit() throws CouchDbException {
+		instance.preAuthorize();
+		return instance.executeAndHandle(service.getRevsLimit());
+	}
+
+	@Override
+	public void setRevsLimit(int revsLimit) throws CouchDbException {
+		instance.preAuthorize();
+		instance.executeAndHandle(service.setRevsLimit(revsLimit));
+	}
 
 	private class OkHttpCouchDbShared implements CouchDbShared {
 		private final String prefix;

couchdb/src/main/java/me/retrodaredevil/couchdbjava/option/DatabaseCreationOption.java

@@ -2,7 +2,7 @@
 
 public class DatabaseCreationOption {
 
-	private static final DatabaseCreationOption DEFAULT_OPTION = new DatabaseCreationOption(null, null, null);
+	private static final DatabaseCreationOption DEFAULT_OPTION = builder().build();
 
 	private final Integer shards;
 	private final Integer replicas;
@@ -16,6 +16,9 @@ public DatabaseCreationOption(Integer shards, Integer replicas, Boolean partitio
 	public static DatabaseCreationOption createDefault() {
 		return DEFAULT_OPTION;
 	}
+	public static DatabaseCreationOption.Builder builder() {
+		return new DatabaseCreationOption.Builder();
+	}
 
 	public Integer getShards() {
 		return shards;
@@ -28,4 +31,34 @@ public Integer getReplicas() {
 	public Boolean getPartitioned() {
 		return partitioned;
 	}
+
+
+	public static final class Builder {
+		private Integer shards;
+		private Integer replicas;
+		private Boolean partitioned;
+
+		private Builder() {
+		}
+
+		public Builder shards(Integer shards) {
+			this.shards = shards;
+			return this;
+		}
+		public Builder replicas(Integer replicas) {
+			this.replicas = replicas;
+			return this;
+		}
+		public Builder partitioned(Boolean partitioned) {
+			this.partitioned = partitioned;
+			return this;
+		}
+		public Builder partitioned() {
+			return partitioned(true);
+		}
+
+		public DatabaseCreationOption build() {
+			return new DatabaseCreationOption(shards, replicas, partitioned);
+		}
+	}
 }

couchdb/src/test/java/me/retrodaredevil/couchdbjava/integration/test/IncludeDocsViewTest.java

@@ -6,7 +6,9 @@
 import me.retrodaredevil.couchdbjava.CouchDbDatabase;
 import me.retrodaredevil.couchdbjava.CouchDbInstance;
 import me.retrodaredevil.couchdbjava.TestConstants;
+import me.retrodaredevil.couchdbjava.exception.CouchDbBadRequestException;
 import me.retrodaredevil.couchdbjava.exception.CouchDbException;
+import me.retrodaredevil.couchdbjava.exception.CouchDbNotFoundException;
 import me.retrodaredevil.couchdbjava.integration.DatabaseService;
 import me.retrodaredevil.couchdbjava.integration.TestUtil;
 import me.retrodaredevil.couchdbjava.json.JsonData;
@@ -16,13 +18,10 @@
 import me.retrodaredevil.couchdbjava.response.DocumentResponse;
 import me.retrodaredevil.couchdbjava.response.ViewResponse;
 import org.junit.jupiter.api.Tag;
-import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 @Tag(TestConstants.INTEGRATION_TEST)
 public class IncludeDocsViewTest {
@@ -67,5 +66,13 @@ void test(DatabaseService databaseService) throws CouchDbException, JsonProcessi
 		assertEquals(documentId, objectNode.get("_id").asText());
 		assertEquals(revision, objectNode.get("_rev").asText());
 		assertEquals(43, objectNode.get("test").asInt());
+
+		if (databaseService == DatabaseService.COUCHDB) {
+			database.compactDesign("test_design"); // confirm that compact endpoint can be reached
+			assertThrows(CouchDbNotFoundException.class, () -> database.compactDesign("non-existent-design"));
+		} else if (databaseService == DatabaseService.POUCHDB) {
+			// PouchDB does not support compacting a design
+			assertThrows(CouchDbBadRequestException.class, () -> database.compactDesign("test_design"));
+		}
 	}
 }

couchdb/src/test/java/me/retrodaredevil/couchdbjava/integration/test/PartitionedDatabaseTest.java

@@ -17,8 +17,6 @@
 import me.retrodaredevil.couchdbjava.response.ViewResponse;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.MethodSource;
 
 import java.util.List;
 
@@ -34,7 +32,7 @@ void test() throws CouchDbException, JsonProcessingException {
 		// partitioned databases not available on PouchDB, so only test on CouchDB
 		CouchDbInstance instance = TestUtil.createInstance(DatabaseService.COUCHDB);
 		CouchDbDatabase database = instance.getDatabase(DATABASE);
-		database.create(new DatabaseCreationOption(null, null, true));
+		database.create(DatabaseCreationOption.builder().partitioned().build());
 		assertTrue(database.getDatabaseInfo().getProperties().isPartitioned());
 
 		try {

couchdb/src/test/java/me/retrodaredevil/couchdbjava/integration/test/RevsLimitTest.java

@@ -0,0 +1,42 @@
+package me.retrodaredevil.couchdbjava.integration.test;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import me.retrodaredevil.couchdbjava.CouchDbDatabase;
+import me.retrodaredevil.couchdbjava.CouchDbInstance;
+import me.retrodaredevil.couchdbjava.TestConstants;
+import me.retrodaredevil.couchdbjava.exception.CouchDbBadRequestException;
+import me.retrodaredevil.couchdbjava.exception.CouchDbException;
+import me.retrodaredevil.couchdbjava.exception.CouchDbNotFoundException;
+import me.retrodaredevil.couchdbjava.integration.DatabaseService;
+import me.retrodaredevil.couchdbjava.integration.TestUtil;
+import me.retrodaredevil.couchdbjava.option.DatabaseCreationOption;
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+@Tag(TestConstants.INTEGRATION_TEST)
+public class RevsLimitTest {
+
+	private static final String DATABASE = "test_revs_limit";
+
+	@ParameterizedTest
+	@MethodSource("me.retrodaredevil.couchdbjava.integration.DatabaseService#values")
+	void test(DatabaseService databaseService) throws CouchDbException {
+		CouchDbInstance instance = TestUtil.createDebugInstance(databaseService);
+		CouchDbDatabase database = instance.getDatabase(DATABASE);
+
+		if (databaseService == DatabaseService.COUCHDB) {
+			database.create(DatabaseCreationOption.builder().build());
+			assertEquals(1000, database.getRevsLimit()); // expect default value to be configured
+			database.getRevsLimit();
+			database.setRevsLimit(5);
+			assertEquals(5, database.getRevsLimit());
+		} else if (databaseService == DatabaseService.POUCHDB) {
+			database.create(DatabaseCreationOption.builder().build());
+			assertThrows(CouchDbNotFoundException.class, () -> database.getRevsLimit());
+		}
+		database.getDatabaseInfo();
+	}
+}