Merge pull request #64 from launchdarkly/dr/deprecateToggle

Deprecate toggle method. Update readme.

Author: drichelson

README.md

@@ -29,36 +29,14 @@ Your first feature flag
 2. In your application code, use the feature's key to check wthether the flag is on for each user:
 
         LDUser user = new LDUser(username);
-        boolean showFeature = ldClient.toggle("your.feature.key", user, false);
+        boolean showFeature = ldClient.boolVariation("your.feature.key", user, false);
         if (showFeature) {
           // application code to show the feature 
         }
         else {
           // the code to run if the feature is off
         }
 
-Troubleshooting
----------------
-1. Json parsing exception: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was....ExceptionType: com.google.gson.JsonSyntaxException
-   Make sure your build tool is bringing in the proper version of Gson. The LaunchDarkly SDK may have problems with versions earlier than 2.2.4. To enforce the proper version add this dependency:
-   ```
-   <dependency>
-   	<groupId>com.google.code.gson</groupId>
-   	<artifactId>gson</artifactId>
-   	<version>2.2.4</version>
-   </dependency>
-   ```
-
-1. SSL exceptions when calling toggle():
-   Make sure your build tool is bringing in the proper version of the Apache http client. The LaunchDarkly SDK may have problems with versions earlier than 3.3.6. To enforce the proper version add this dependency:
-   ```
-   <dependency>
-     <groupId>org.apache.httpcomponents</groupId>
-     <artifactId>httpclient</artifactId>
-     <version>4.3.6</version>
-   </dependency>
-   ```
-
 Learn more
 ----------
 

src/main/java/com/launchdarkly/client/LDClient.java

@@ -173,19 +173,6 @@ private void sendFlagRequestEvent(String featureKey, LDUser user, JsonElement va
     NewRelicReflector.annotateTransaction(featureKey, String.valueOf(value));
   }
 
-  /**
-   * Calculates the boolean value of a feature flag for a given user.
-   *
-   * @param featureKey   the unique featureKey for the feature flag
-   * @param user         the end user requesting the flag
-   * @param defaultValue the default value of the flag
-   * @return whether or not the flag should be enabled, or {@code defaultValue} if the flag is disabled in the LaunchDarkly control panel
-   * @deprecated As of version 0.7.0, renamed to {@link #toggle(String, LDUser, boolean)}
-   */
-  public boolean getFlag(String featureKey, LDUser user, boolean defaultValue) {
-    return toggle(featureKey, user, defaultValue);
-  }
-
   /**
    * Returns a map from feature flag keys to Boolean feature flag values for a given user. The map will contain {@code null}
    * entries for any flags that are off or for any feature flags with non-boolean variations. If the client is offline or
@@ -227,14 +214,23 @@ public Map<String, Boolean> allFlags(LDUser user) {
    * @param defaultValue the default value of the flag
    * @return whether or not the flag should be enabled, or {@code defaultValue} if the flag is disabled in the LaunchDarkly control panel
    */
-  public boolean toggle(String featureKey, LDUser user, boolean defaultValue) {
+  public boolean boolVariation(String featureKey, LDUser user, boolean defaultValue) {
     JsonElement value = jsonVariation(featureKey, user, new JsonPrimitive(defaultValue));
     if (value.isJsonPrimitive() && value.getAsJsonPrimitive().isBoolean()) {
       return value.getAsJsonPrimitive().getAsBoolean();
     }
     return false;
   }
 
+  /**
+   * @deprecated use {@link #boolVariation(String, LDUser, boolean)}
+   */
+  @Deprecated
+  public boolean toggle(String featureKey, LDUser user, boolean defaultValue) {
+    logger.warn("Deprecated method: Toggle() called. Use boolVariation() instead.");
+   return boolVariation(featureKey, user, defaultValue);
+  }
+
   /**
    * Calculates the integer value of a feature flag for a given user.
    *

src/test/java/com/launchdarkly/client/LDClientTest.java

@@ -66,7 +66,7 @@ public void testTestFeatureStoreSetFeatureTrue() throws IOException, Interrupted
 
     client = createMockClient(config);
     testFeatureStore.setFeatureTrue("key");
-    assertTrue("Test flag should be true, but was not.", client.toggle("key", new LDUser("user"), false));
+    assertTrue("Test flag should be true, but was not.", client.boolVariation("key", new LDUser("user"), false));
 
     verifyAll();
   }
@@ -88,7 +88,7 @@ public void testTestFeatureStoreSetFalse() throws IOException, InterruptedExcept
 
     client = createMockClient(config);
     testFeatureStore.setFeatureFalse("key");
-    assertFalse("Test flag should be false, but was on (the default).", client.toggle("key", new LDUser("user"), true));
+    assertFalse("Test flag should be false, but was on (the default).", client.boolVariation("key", new LDUser("user"), true));
 
     verifyAll();
   }
@@ -111,10 +111,10 @@ public void testTestFeatureStoreFlagTrueThenFalse() throws IOException, Interrup
     client = createMockClient(config);
 
     testFeatureStore.setFeatureTrue("key");
-    assertTrue("Test flag should be true, but was not.", client.toggle("key", new LDUser("user"), false));
+    assertTrue("Test flag should be true, but was not.", client.boolVariation("key", new LDUser("user"), false));
 
     testFeatureStore.setFeatureFalse("key");
-    assertFalse("Test flag should be false, but was on (the default).", client.toggle("key", new LDUser("user"), true));
+    assertFalse("Test flag should be false, but was on (the default).", client.boolVariation("key", new LDUser("user"), true));
 
     verifyAll();
   }
@@ -342,7 +342,7 @@ public void testPollingWait() throws Exception {
   }
 
   private void assertDefaultValueIsReturned() {
-    boolean result = client.toggle("test", new LDUser("test.key"), true);
+    boolean result = client.boolVariation("test", new LDUser("test.key"), true);
     assertEquals(true, result);
   }