add simplified examples and a workflow to run them on PRs

Author: Rob ODwyer

.github/workflows/test-examples.yml

@@ -0,0 +1,25 @@
+name: Test Examples
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-java@v3
+      with:
+        distribution: temurin
+        java-version: 11
+    - name: Setup Gradle
+      uses: gradle/gradle-build-action@v2
+    - name: Run local bucketing example
+      run: ./gradlew runLocalExample
+      env:
+        DEVCYCLE_SERVER_SDK_KEY: "${{ secrets.DEVCYCLE_SERVER_SDK_KEY }}"
+    - name: Run cloud bucketing example
+      run: ./gradlew runCloudExample
+      env:
+        DEVCYCLE_SERVER_SDK_KEY: "${{ secrets.DEVCYCLE_SERVER_SDK_KEY }}"

build.gradle

@@ -169,3 +169,16 @@ dependencies {
     testCompileOnly("org.projectlombok:lombok:$lombok_version")
 }
 
+sourceSets.main.java.srcDirs += 'examples'
+
+task runLocalExample(type: JavaExec) {
+    description = "Run the local bucketing example"
+    classpath = sourceSets.main.runtimeClasspath
+    main = 'com.devcycle.sdk.server.local.LocalExample'
+}
+
+task runCloudExample(type: JavaExec) {
+    description = "Run the cloud bucketing example"
+    classpath = sourceSets.main.runtimeClasspath
+    main = 'com.devcycle.sdk.server.local.CloudExample'
+}

examples/com/devcycle/sdk/server/cloud/CloudExample.java

@@ -0,0 +1,49 @@
+package com.devcycle.sdk.server.cloud;
+
+import com.devcycle.sdk.server.cloud.api.DVCCloudClient;
+import com.devcycle.sdk.server.cloud.model.DVCCloudOptions;
+import com.devcycle.sdk.server.common.exception.DVCException;
+import com.devcycle.sdk.server.common.model.User;
+
+public class CloudExample {
+    public static String VARIABLE_KEY = "test-boolean-variable";
+
+    public static void main(String[] args) throws InterruptedException {
+        String server_sdk_key = System.getenv("DEVCYCLE_SERVER_SDK_KEY");
+        if (server_sdk_key == null) {
+            System.err.println("Please set the DEVCYCLE_SERVER_SDK_KEY environment variable");
+            System.exit(1);
+        }
+
+        // Create user object
+        User user = User.builder()
+                .userId("SOME_USER_ID")
+                .build();
+
+        // The default value can be of type string, boolean, number, or JSON
+        Boolean defaultValue = false;
+
+        DVCCloudOptions dvcOptions = DVCCloudOptions.builder().build();
+
+        // Initialize DevCycle Client
+        DVCCloudClient dvcClient = new DVCCloudClient(server_sdk_key, dvcOptions);
+
+        // Fetch variable values using the identifier key, with a default value and user
+        // object
+        // The default value can be of type string, boolean, number, or JSON
+        Boolean variableValue = false;
+        try {
+            variableValue = dvcClient.variableValue(user, VARIABLE_KEY, defaultValue);
+        } catch(DVCException e) {
+            System.err.println("Error fetching variable value: " + e.getMessage());
+            System.exit(1);
+        }
+
+        // Use variable value
+        if (variableValue) {
+            System.err.println("feature is enabled");
+        } else {
+            System.err.println("feature is NOT enabled");
+        }
+    }
+}

examples/com/devcycle/sdk/server/local/LocalExample.java

@@ -0,0 +1,50 @@
+package com.devcycle.sdk.server.local;
+
+import com.devcycle.sdk.server.local.api.DVCLocalClient;
+import com.devcycle.sdk.server.local.model.DVCLocalOptions;
+import com.devcycle.sdk.server.common.model.User;
+
+public class LocalExample {
+    public static String VARIABLE_KEY = "test-boolean-variable";
+
+    public static void main(String[] args) throws InterruptedException {
+        String server_sdk_key = System.getenv("DEVCYCLE_SERVER_SDK_KEY");
+        if (server_sdk_key == null) {
+            System.err.println("Please set the DEVCYCLE_SERVER_SDK_KEY environment variable");
+            System.exit(1);
+        }
+
+        // Create user object
+        User user = User.builder()
+                .userId("SOME_USER_ID")
+                .build();
+
+        // The default value can be of type string, boolean, number, or JSON
+        Boolean defaultValue = false;
+
+        DVCLocalOptions dvcOptions = DVCLocalOptions.builder().configPollingIntervalMs(60000)
+                .disableAutomaticEventLogging(false).disableCustomEventLogging(false).build();
+
+        // Initialize DevCycle Client
+        DVCLocalClient dvcClient = new DVCLocalClient(server_sdk_key, dvcOptions);
+
+        for (int i = 0; i < 10; i++) {
+            if(dvcClient.isInitialized()) {
+                break;
+            }
+            Thread.sleep(500);
+        }
+
+        // Fetch variable values using the identifier key, with a default value and user
+        // object
+        // The default value can be of type string, boolean, number, or JSON
+        Boolean variableValue = dvcClient.variableValue(user, VARIABLE_KEY, defaultValue);
+
+        // Use variable value
+        if (variableValue) {
+            System.err.println("feature is enabled");
+        } else {
+            System.err.println("feature is NOT enabled");
+        }
+    }
+}