feat!: rename public interfaces from DVC to DevCycle (#92)

* feat!: rename public interfaces from DVC to DevCycle

* update example apps

* fix: cleanup

* fix: cleanup more DVC refrences in logs / docs

* Retrigger Test Harness

---------

Co-authored-by: chris-hoefgen <chris.hoefgen@taplytics.com>

Author: jonathannorris

README.md

@@ -58,28 +58,28 @@ To use the DevCycle Java SDK, initialize a client object.
 
 Cloud:
 ```java
-import com.devcycle.sdk.server.cloud.api.DVCCloudClient;
+import com.devcycle.sdk.server.cloud.api.DevCycleCloudClient;
 
 public class MyClass {
 
-    private DVCCloudClient dvcCloudClient;
+    private DevCycleCloudClient dvcCloudClient;
 
     public MyClass() {
-        dvcCloudClient = new DVCCloudClient("YOUR_DVC_SERVER_SDK_KEY");
+        dvcCloudClient = new DevCycleCloudClient("DEVCYCLE_SERVER_SDK_KEY");
     }
 }
 ```
 
 Local:
 ```java
-import com.devcycle.sdk.server.local.api.DVCLocalClient;
+import com.devcycle.sdk.server.local.api.DevCycleLocalClient;
 
 public class MyClass {
 
-    private DVCLocalClient dvcLocalClient;
+    private DevCycleLocalClient dvcLocalClient;
 
     public MyClass() {
-        dvcLocalClient = new DVCLocalClient("YOUR_DVC_SERVER_SDK_KEY");
+        dvcLocalClient = new DevCycleLocalClient("DEVCYCLE_SERVER_SDK_KEY");
     }
 }
 ```
@@ -91,13 +91,13 @@ To find usage documentation, visit our docs for [Local Bucketing](https://docs.d
 ## Logging
 
 The DevCycle SDK logs to **stdout** by default and does not require any specific logging package. To integrate with your 
-own logging system, such as Java Logging or SLF4J, you can create a wrapper that implements the `IDVCLogger` interface. 
+own logging system, such as Java Logging or SLF4J, you can create a wrapper that implements the `IDevCycleLogger` interface. 
 Then you can set the logger into the Java Server SDK setting the Custom Logger property in the options object used to 
 initialize the client.
 
 ```java
 // Create your logging wrapper
-IDVCLogger loggingWrapper = new IDVCLogger() {
+IDevCycleLogger loggingWrapper = new IDevCycleLogger() {
     @Override
     public void debug(String message) {
         // Your logging implementation here
@@ -124,13 +124,13 @@ IDVCLogger loggingWrapper = new IDVCLogger() {
     }
 };
 
-// Set the logger in the options before creating the DVCLocalClient
-DVCLocalOptions options = DVCLocalOptions.builder().customLogger(loggingWrapper).build();
-DVCLocalClient dvcClient = new DVCLocalClient("YOUR_DVC_SERVER_SDK_KEY", options);
+// Set the logger in the options before creating the DevCycleLocalClient
+DevCycleLocalOptions options = DevCycleLocalOptions.builder().customLogger(loggingWrapper).build();
+DevCycleLocalClient dvcClient = new DevCycleLocalClient("DEVCYCLE_SERVER_SDK_KEY", options);
 
-// Or for DVCCloudClient
-DVCCloudOptions options = DVCCloudOptions.builder().customLogger(loggingWrapper).build();
-DVCCloudClient dvcClient = new DVCCloudClient("YOUR_DVC_SERVER_SDK_KEY", options);
+// Or for DevCycleCloudClient
+DevCycleCloudOptions options = DevCycleCloudOptions.builder().customLogger(loggingWrapper).build();
+DevCycleCloudClient dvcClient = new DevCycleCloudClient("DEVCYCLE_SERVER_SDK_KEY", options);
 ```
 
-You can also disable all logging by setting the custom logger to `new SimpleDVCLogger(SimpleDVCLogger.Level.OFF)`.
+You can also disable all logging by setting the custom logger to `new SimpleDevCycleLogger(SimpleDevCycleLogger.Level.OFF)`.

benchmark/src/main/java/com/devcycle/SDKBenchmark.java

@@ -1,9 +1,9 @@
 package com.devcycle;
 
-import com.devcycle.sdk.server.common.model.User;
+import com.devcycle.sdk.server.common.model.DevCycleUser;
 import com.devcycle.sdk.server.common.model.Variable;
-import com.devcycle.sdk.server.local.api.DVCLocalClient;
-import com.devcycle.sdk.server.local.model.DVCLocalOptions;
+import com.devcycle.sdk.server.local.api.DevCycleLocalClient;
+import com.devcycle.sdk.server.local.model.DevCycleLocalOptions;
 
 import org.openjdk.jmh.annotations.*;
 import org.openjdk.jmh.runner.Runner;
@@ -19,7 +19,7 @@ public class SDKBenchmark {
     public static class BenchmarkState {
         public MockServer mockServer;
 
-        public DVCLocalClient client;
+        public DevCycleLocalClient client;
 
         @Setup(Level.Iteration)
         public void setup() {
@@ -30,7 +30,7 @@ public void setup() {
                 e.printStackTrace();
             }
 
-            DVCLocalOptions dvcLocalOptions = DVCLocalOptions.builder()
+            DevCycleLocalOptions dvcLocalOptions = DevCycleLocalOptions.builder()
                     .configPollingIntervalMS(10000)
                     .configRequestTimeoutMs(5000)
                     .eventFlushIntervalMS(5000)
@@ -40,18 +40,18 @@ public void setup() {
                     .eventsApiBaseUrl("http://localhost:8000/event/")
                     .build();
 
-            client = new DVCLocalClient("dvc_server_some_real_sdk_key", dvcLocalOptions);
+            client = new DevCycleLocalClient("dvc_server_some_real_sdk_key", dvcLocalOptions);
 
             try {
-                System.out.println("Waiting for DVC client to load");
+                System.out.println("Waiting for DevCycle client to load");
                 Thread.sleep(1000);
             } catch (InterruptedException e) {
                 throw new RuntimeException(e);
             }
         }
         @TearDown(Level.Iteration)
         public void tearDown() {
-            System.out.println("Cleaning up DVC client");
+            System.out.println("Cleaning up DevCycle client");
             client.close();
             System.out.println("Stop mock HTTP server");
             mockServer.close();
@@ -64,7 +64,7 @@ public void tearDown() {
     @Fork(1)
     @OutputTimeUnit(TimeUnit.NANOSECONDS)
     public void variableBenchmark(BenchmarkState state) {
-        User user = User.builder().userId("12345").email("some.user@gmail.com").build();
+        DevCycleUser user = DevCycleUser.builder().userId("12345").email("some.user@gmail.com").build();
         Variable<Boolean> var = state.client.variable(user, "v-key-25", false);
 
         if( var == null) {

benchmark/src/main/java/com/devcycle/VariableTest.java

@@ -1,20 +1,20 @@
 package com.devcycle;
 
 import com.devcycle.sdk.server.common.model.PlatformData;
-import com.devcycle.sdk.server.common.model.User;
+import com.devcycle.sdk.server.common.model.DevCycleUser;
 import com.devcycle.sdk.server.common.model.Variable;
-import com.devcycle.sdk.server.local.api.DVCLocalClient;
-import com.devcycle.sdk.server.local.model.DVCLocalOptions;
+import com.devcycle.sdk.server.local.api.DevCycleLocalClient;
+import com.devcycle.sdk.server.local.model.DevCycleLocalOptions;
 
 import java.io.IOException;
 
 /**
- * A simple loop to test and profile variable evaluation of the DVCClient
+ * A simple loop to test and profile variable evaluation of the DevCycleLocalClient
  */
 public class VariableTest {
     public static void main(String[] args) throws IOException {
         MockServer server = new MockServer();
-        DVCLocalOptions dvcLocalOptions = DVCLocalOptions.builder()
+        DevCycleLocalOptions dvcLocalOptions = DevCycleLocalOptions.builder()
                 .configPollingIntervalMS(10000)
                 .configRequestTimeoutMs(5000)
                 .eventFlushIntervalMS(5000)
@@ -24,9 +24,9 @@ public static void main(String[] args) throws IOException {
                 .disableAutomaticEventLogging(false)
                 .build();
 
-        System.out.println("Initializing DVC Client version: " + PlatformData.builder().build().getSdkVersion());
+        System.out.println("Initializing DevCycle Client version: " + PlatformData.builder().build().getSdkVersion());
         System.out.print("Setup Client");
-        DVCLocalClient dvcClient = new DVCLocalClient("dvc_server_some_sdk_key", dvcLocalOptions);
+        DevCycleLocalClient dvcClient = new DevCycleLocalClient("dvc_server_some_sdk_key", dvcLocalOptions);
 
         System.out.print("Wait for config to load");
         try {
@@ -39,7 +39,7 @@ public static void main(String[] args) throws IOException {
         int iterations = 100000;
         int defaultCount = 0;
         int nullVarCount = 0;
-        User user = User.builder().userId("1234567890").email("some.user@gmail.com").build();
+        DevCycleUser user = DevCycleUser.builder().userId("1234567890").email("some.user@gmail.com").build();
         for(int i = 0; i < iterations; i++) {
             Variable<Boolean> var = dvcClient.variable(user, "v-key-25", false);
             if( var == null) {

build.gradle

@@ -15,12 +15,12 @@ if (project == rootProject) {
 }
 
 task javadocJar(type: Jar) {
-    classifier = 'javadoc'
+    archiveClassifier.set("javadoc")
     from javadoc
 }
 
 task sourcesJar(type: Jar) {
-    classifier = 'sources'
+    archiveClassifier.set("sources")
     from sourceSets.main.allSource
 }
 
@@ -117,7 +117,7 @@ task downloadDVCBucketingWASM(type: Download) {
     src wasmUrl
     dest wasmResourcePath
     doLast {
-        println "Completed DVC Bucketing WASM Download to $wasmResourcePath"
+        println "Completed DevCycle Bucketing WASM Download to $wasmResourcePath"
     }
 }
 
@@ -156,9 +156,9 @@ dependencies {
     api("com.fasterxml.jackson.core:jackson-databind:$jackson_version")
     implementation("io.swagger.core.v3:swagger-annotations:$swagger_annotations_version")
 
-    implementation ("io.github.kawamuray.wasmtime:wasmtime-java:$wasmtime_version")
+    implementation("io.github.kawamuray.wasmtime:wasmtime-java:$wasmtime_version")
 
-    implementation ("com.google.protobuf:protobuf-java:$protobuf_version")
+    implementation("com.google.protobuf:protobuf-java:$protobuf_version")
 
     compileOnly("org.projectlombok:lombok:$lombok_version")
 

docs/Event.md renamed to docs/DevCycleEvent.md

@@ -1,4 +1,4 @@
-# Event
+# DevCycleEvent
 
 ## Properties
 Name | Type | Description | Notes

docs/DVC.md renamed to docs/DevCycleLocalClient.md

@@ -1,11 +1,11 @@
-# DVC API
+# DevCycleLocalClient
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**allFeatures**](DVC.md#allFeatures) | **POST** v1/features | Get all features for user data
-[**variable**](DVC.md#variable) | **POST** v1/variables/{key} | Get variable by key for user data
-[**allVariables**](DVC.md#allVariables) | **POST** v1/variables | Get all variables for user data
-[**track**](DVC.md#track) | **POST** v1/track | Post events to DevCycle for user
+[**allFeatures**](DevCycleLocalClient.md#allFeatures) | **POST** v1/features | Get all features for user data
+[**variable**](DevCycleLocalClient.md#variable) | **POST** v1/variables/{key} | Get variable by key for user data
+[**allVariables**](DevCycleLocalClient.md#allVariables) | **POST** v1/variables | Get all variables for user data
+[**track**](DevCycleLocalClient.md#track) | **POST** v1/track | Post events to DevCycle for user
 
 <a name="allFeatures"></a>
 # **allFeatures**
@@ -15,18 +15,18 @@ Get all features for user data
 
 ### Example
 ```java
-import com.devcycle.sdk.server.api.DVCClient;
+import com.devcycle.sdk.server.api.DevCycleLocalClient;
 
 public class MyClass {
 
-    private DVCClient dvcClient;
+    private DevCycleLocalClient dvcClient;
 
     public MyClass() {
-        dvcClient = new DVCClient("YOUR_DVC_SERVER_SDK_KEY");
+        dvcClient = new DevCycleLocalClient("DEVCYCLE_SERVER_SDK_KEY");
     }
 
     public void allFeatures() {
-        User user = User.builder()
+        DevCycleUser user = DevCycleUser.builder()
                 .userId("a_user_id")
                 .country("US")
                 .build();
@@ -40,7 +40,7 @@ public class MyClass {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **user** | [**User**](User.md)|  |
+ **user** | [**DevCycleUser**](DevCycleUser.md)|  |
 
 ### Return type
 
@@ -54,18 +54,18 @@ Get variable by key for user data
 
 ### Example
 ```java
-import com.devcycle.sdk.server.api.DVCClient;
+import com.devcycle.sdk.server.api.DevCycleLocalClient;
 
 public class MyClass {
 
-    private DVCClient dvcClient;
+    private DevCycleLocalClient dvcClient;
 
     public MyClass() {
-        dvcClient = new DVCClient("YOUR_DVC_SERVER_SDK_KEY");
+        dvcClient = new DevCycleLocalClient("DEVCYCLE_SERVER_SDK_KEY");
     }
 
     public void setFlag() {
-        User user = User.builder()
+        DevCycleUser user = DevCycleUser.builder()
                 .userId("a_user_id")
                 .country("US")
                 .build();
@@ -87,7 +87,7 @@ public class MyClass {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **user** | [**User**](User.md)|  |
+ **user** | [**DevCycleUser**](DevCycleUser.md)|  |
  **key** | **String**| Variable key |
 
 ### Return type
@@ -102,18 +102,18 @@ Get all variables for user data
 
 ### Example
 ```java
-import com.devcycle.sdk.server.api.DVCClient;
+import com.devcycle.sdk.server.api.DevCycleLocalClient;
 
 public class MyClass {
 
-    private DVCClient dvcClient;
+    private DevCycleLocalClient dvcClient;
 
     public MyClass() {
-        dvcClient = new DVCClient("YOUR_DVC_SERVER_SDK_KEY");
+        dvcClient = new DevCycleLocalClient("DEVCYCLE_SERVER_SDK_KEY");
     }
 
     public void allVariables() {
-        User user = User.builder()
+        DevCycleUser user = DevCycleUser.builder()
                 .userId("a_user_id")
                 .country("US")
                 .build();
@@ -127,7 +127,7 @@ public class MyClass {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
-**user** | [**User**](User.md)|  |
+**user** | [**DevCycleUser**](DevCycleUser.md)|  |
 
 ### Return type
 
@@ -141,30 +141,30 @@ Post events to DevCycle for user
 
 ### Example
 ```java
-import com.devcycle.sdk.server.api.DVCClient;
+import com.devcycle.sdk.server.api.DevCycleLocalClient;
 
 public class MyClass {
 
-    private DVCClient dvcClient;
+    private DevCycleLocalClient dvcClient;
 
     public MyClass() {
-        dvcClient = new DVCClient("YOUR_DVC_SERVER_SDK_KEY");
+        dvcClient = new DevCycleLocalClient("DEVCYCLE_SERVER_SDK_KEY");
     }
 
     public void addAnEvent() {
-        User user = User.builder()
+        DevCycleUser user = DevCycleUser.builder()
                 .userId("a_user_id")
                 .country("US")
                 .build();
 
-        Event event = Event.builder()
+        DevCycleEvent event = DevCycleEvent.builder()
                 .date(Instant.now().toEpochMilli())
                 .target("test target")
                 .type("test event")
                 .value(new BigDecimal(600))
                 .build();
 
-        DVCResponse response = dvcClient.track(user, event);
+        DevCycleResponse response = dvcClient.track(user, event);
     }
 }
 ```
@@ -173,9 +173,9 @@ public class MyClass {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
-**user** | [**User**](User.md)|  |
-**event** | [**Event**](Event.md)|
+**user** | [**DevCycleUser**](DevCycleUser.md)|  |
+**event** | [**DevCycleEvent**](DevCycleEvent.md)|
 
 ### Return type
 
-[**DVCResponse200**](DVCResponse.md)
+[**DVCResponse200**](DevCycleResponse.md)

docs/DVCResponse.md renamed to docs/DevCycleResponse.md

@@ -1,4 +1,4 @@
-# DVCResponse
+# DevCycleResponse
 
 ## Properties
 Name | Type | Description | Notes

docs/User.md renamed to docs/DevCycleUser.md

@@ -1,4 +1,4 @@
-# User
+# DevCycleUser
 
 ## Properties
 Name | Type | Description | Notes