Merge pull request #479 from cloudant/477-replication-selector

Add replication selector support.

Author: smithsz

CHANGES.md

@@ -1,5 +1,6 @@
 # UNRELEASED
 - [NEW] Added database partition metadata fields for partitioned index count/limit.
+- [NEW] Added replication selector support.
 
 # 2.15.0 (2019-02-12)
 - [NEW] Added option for client to authenticate with IAM token server.

cloudant-client/src/main/java/com/cloudant/client/api/Replicator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 IBM Corp. All rights reserved.
+ * Copyright (c) 2015, 2019 IBM Corp. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at
@@ -14,6 +14,7 @@
 
 package com.cloudant.client.api;
 
+import com.cloudant.client.api.query.Selector;
 import com.cloudant.client.org.lightcouch.Replication;
 import com.cloudant.client.org.lightcouch.ReplicatorDocument;
 import com.cloudant.client.org.lightcouch.Response;
@@ -42,8 +43,9 @@
  * 	.target("target-db")
  * 	.continuous(true)
  * 	.createTarget(true)
- * 	.replicatorDB("replicator-db-name") // optional, defaults to _replicator
- * 	.replicatorDocId("doc-id")          // optional, defaults to UUID
+ * 	.replicatorDB("replicator-db-name")    // optional, defaults to _replicator
+ * 	.replicatorDocId("doc-id")             // optional, defaults to UUID
+ * 	.selector(eq("_id", "Schwarzenegger")) // optional replication selector
  * 	.save(); // trigger replication
  *
  * // find an existing replicator doc
@@ -239,4 +241,9 @@ public Replicator targetIamApiKey(String iamApiKey) {
         return this;
     }
 
+    public Replicator selector(Selector selector) {
+        this.replicator = replicator.selector(selector);
+        return this;
+    }
+
 }

cloudant-client/src/main/java/com/cloudant/client/api/query/JsonIndex.java

@@ -159,7 +159,7 @@ public Builder designDocument(String designDocumentId) {
          * <p>
          * Obtain a selector from an {@link Operation} or {@link Expression}.
          * </p>
-         * @param selector string representation of a JSON object describing criteria used to add
+         * @param selector {@code Selector} object describing criteria used to add
          *                 documents to index
          * @return the builder for chaining
          * @see Selector

cloudant-client/src/main/java/com/cloudant/client/org/lightcouch/Replicator.java

@@ -1,6 +1,6 @@
 /*
  * Copyright (C) 2011 lightcouch.org
- * Copyright (c) 2015 IBM Corp. All rights reserved.
+ * Copyright (c) 2015, 2019 IBM Corp. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at
@@ -19,6 +19,7 @@
 import static com.cloudant.client.org.lightcouch.internal.CouchDbUtil.close;
 import static com.cloudant.client.org.lightcouch.internal.CouchDbUtil.getAsString;
 
+import com.cloudant.client.api.query.Selector;
 import com.cloudant.client.internal.DatabaseURIHelper;
 import com.cloudant.client.internal.URIBase;
 import com.cloudant.client.org.lightcouch.ReplicatorDocument.UserCtx;
@@ -287,4 +288,9 @@ public Replicator targetIamApiKey(String iamApiKey) {
         replicatorDoc.setTargetIamApiKey(iamApiKey);
         return this;
     }
+
+    public Replicator selector(Selector selector) {
+        replicatorDoc.setSelector(selector);
+        return this;
+    }
 }

cloudant-client/src/main/java/com/cloudant/client/org/lightcouch/ReplicatorDocument.java

@@ -1,6 +1,6 @@
 /*
  * Copyright (C) 2011 lightcouch.org
- * Copyright (c) 2015 IBM Corp. All rights reserved.
+ * Copyright (c) 2015, 2019 IBM Corp. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at
@@ -15,6 +15,8 @@
 
 package com.cloudant.client.org.lightcouch;
 
+import com.cloudant.client.api.query.Selector;
+import com.cloudant.client.internal.query.Helpers;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonPrimitive;
@@ -67,6 +69,7 @@ public class ReplicatorDocument extends Document {
     private UserCtx userCtx;
     @SerializedName("since_seq")
     private Integer sinceSeq;
+    private JsonElement selector;
 
     public String getSource() {
         return getEndpointUrl(source);
@@ -289,6 +292,14 @@ public void setTargetIamApiKey(String iamApiKey) {
         target = getDestinationIamJson(this.getTarget(), iamApiKey);
     }
 
+    public String getSelector() {
+        return selector.getAsString();
+    }
+
+    public void setSelector(Selector selector) {
+        this.selector = Helpers.getJsonObjectFromSelector(selector);
+    }
+
     public static class UserCtx {
         private String name;
         private String[] roles;

cloudant-client/src/test/java/com/cloudant/tests/ReplicatorMockTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright © 2018 IBM Corp. All rights reserved.
+ * Copyright © 2018, 2019 IBM Corp. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  * except in compliance with the License. You may obtain a copy of the License at
@@ -14,6 +14,7 @@
 
 package com.cloudant.tests;
 
+import static com.cloudant.client.api.query.Expression.eq;
 import static com.cloudant.tests.HttpTest.takeN;
 import static com.cloudant.tests.util.MockWebServerResources.IAM_API_KEY;
 import static com.cloudant.tests.util.MockWebServerResources.IAM_API_KEY_2;
@@ -24,15 +25,13 @@
 
 import com.cloudant.client.api.CloudantClient;
 import com.cloudant.client.api.model.ReplicatorDocument;
+import com.cloudant.tests.base.TestWithMockedServer;
 import com.cloudant.tests.util.Utils;
 
-import com.cloudant.tests.base.TestWithMockedServer;
 import org.junit.jupiter.api.Test;
 
 import okhttp3.mockwebserver.RecordedRequest;
 
-import java.nio.charset.Charset;
-
 /**
  * Created by samsmith on 08/03/2018.
  */
@@ -232,4 +231,28 @@ public void createAndSaveReplicatorDocumentWithSourceAndTargetIamAuth() throws E
         assertThat("The replication document should contain the target IAM API key",
                 body, containsString(authJson + IAM_API_KEY_2));
     }
+
+    @Test
+    public void createAndSaveReplicatorDocumentWithSimpleSelector() throws Exception {
+        server.enqueue(JSON_OK);
+
+        CloudantClient c = CloudantClientHelper.newMockWebServerClientBuilder(server)
+                .build();
+
+        c.replicator()
+                .replicatorDocId(replicatorDocId)
+                .source(sourceDbUrl)
+                .target(targetDbUrl)
+                .selector(eq("_id", "Schwarzenegger"))
+                .save();
+
+        RecordedRequest[] requests = takeN(server, 1);
+
+        assertEquals(requests[0].getPath(), "/_replicator/" + replicatorDocId);
+
+        String body = requests[0].getBody().readUtf8();
+
+        assertThat("The replication document should contain the selector", body,
+                containsString(",\"selector\":{\"_id\":{\"$eq\":\"Schwarzenegger\"}},"));
+    }
 }