Merge pull request #141 from groupby/feature/SRC-309

Add iNav flag to Query

Author: JamesPace-GBI

pom.xml

@@ -10,7 +10,7 @@
   </parent>
 
   <artifactId>api-java-flux</artifactId>
-  <version>3.0.2-SNAPSHOT</version>
+  <version>3.1.0-SNAPSHOT</version>
 
   <packaging>jar</packaging>
 
@@ -31,7 +31,7 @@
     <repo.upload.retryAttempts>3</repo.upload.retryAttempts>
 
     <!-- ### Versions -->
-    <groupbyinc.common.version>189</groupbyinc.common.version>
+    <groupbyinc.common.version>190</groupbyinc.common.version>
     <api.servlet.version>2.5</api.servlet.version>
     <api.jsp.version>2.2</api.jsp.version>
     <junit.version>4.12</junit.version>

src/main/java/com/groupbyinc/api/Query.java

@@ -71,6 +71,7 @@ public class Query {
   private RestrictNavigation restrictNavigation;
   private Biasing biasing = new Biasing();
   private boolean bot = false;
+  private Boolean intelligentNavigationEnabled;
 
   /**
    * <code>
@@ -120,6 +121,8 @@ private Request populateRequest(String clientKey) {
     request.setRestrictNavigation(convertRestrictNavigation());
     request.setWildcardSearchEnabled(isWildcardSearchEnabled());
     request.setSecuredPayload(securedPayload);
+    request.setIntelligentNavigationEnabled(intelligentNavigationEnabled);
+
     if (CollectionUtils.isNotEmpty(sort)) {
       for (Sort s : sort) {
         request.setSort(convertSort(s));
@@ -1659,4 +1662,30 @@ public void setBot(boolean bot) {
       this.queryUrlParams.remove("bot");
     }
   }
+
+  /**
+   * @return The intelligent navigation flag.
+   */
+  public Boolean getIntelligentNavigationEnabled() {
+    return intelligentNavigationEnabled;
+  }
+
+  /**
+   * <code>
+   * Explicitly enable or disable Intelligent Navigation (iNav), which will override any configuration applied to Areas or Rules that might trigger.
+   * Leave 'null' to allow the Area or Rule configurations to take priority.
+   *
+   * iNav will attempt to reorder your navigations and refinements based on popularity.
+   *
+   *
+   * </code>
+   *
+   * @param intelligentNavigationEnabled
+   *        The intelligent navigation flag.
+   *
+   * @internal
+   */
+  public void setIntelligentNavigationEnabled(Boolean intelligentNavigationEnabled) {
+    this.intelligentNavigationEnabled = intelligentNavigationEnabled;
+  }
 }

src/test/java/com/groupbyinc/api/QueryTest.java

@@ -592,4 +592,20 @@ public void testPreFilterExpression() {
         "    'pre-filter': 'brand = \\\"shiny\\\"'" + //
         "}", test);
   }
+
+  @Test
+  public void testIntelligentNavigation() {
+    test.setQuery("Linen");
+    test.setIntelligentNavigationEnabled(true);
+
+    assertQuery("{" + //
+        "    'clientKey': 'aoeu'," + //
+        "    'pageSize': 10," + //
+        "    'pruneRefinements': true," + //
+        "    'query': 'Linen'," + //
+        "    'returnBinary': true," + //
+        "    'skip': 0," + //
+        "    'iNavEnabled': true" + //
+        "}", test);
+  }
 }