Merge pull request #4 from evolv-ai/httpclient

Refactoring HttpClient implementations

Author: tfoster

README.md

@@ -27,27 +27,27 @@
     ```
 
     *Note: The SDK uses a standard interface for the http backend see [HttpClient.](https://github.com/evolv-ai/ascend-java-sdk/blob/master/src/main/java/ai/evolv/HttpClient.java). 
-    When configuring the client you must specify what implementation of HttpClient to use (or implement your own). See "Custom Http Backend" for more details.*
+    When configuring the AscendClient you must specify what implementation of HttpClient to use (or implement your own). See "Custom Http Backend" for more details.*
 
 2. Initialize the AscendClient.
     ```java
-       AscendClient client = AscendClientFactory.init(config);
+       AscendClient ascendClient = AscendClientFactory.init(config);
     ```
 
 ### Confirm the Allocation
 
-1. Once the client has been initialized, confirm the participant into the experiment.
+1. Once the AscendClient has been initialized, confirm the participant into the experiment.
     ```java
-       client.confirm();
+       ascendClient.confirm();
     ```
-    *Note: After the client has initialized, it is important to confirm the participant into the experiment. This action
+    *Note: After the AscendClient has initialized, it is important to confirm the participant into the experiment. This action
      records the participant's allocation and sends the info back to Ascend.*
 
 ### Value Retrieval
 
 1. Retrieve values from Ascend.
     ```java
-       T value = client.get(<key_for_value>, <default_value>);
+       T value = ascendClient.get(<key_for_value>, <default_value>);
     ```
 
    *Note: The return value's type is decided by the provided default value's type. If there is an issue retrieving the
@@ -61,7 +61,7 @@ subscribe to a value and apply any actions as a result of it asynchronously.
 
 1. Subscribe to a value from Ascend.
     ```java
-        client.subscribe(<key_for_value>, <default_value>, value -> {
+        ascendClient.subscribe(<key_for_value>, <default_value>, value -> {
             Your code...
         });
     ```
@@ -80,14 +80,14 @@ that is important to record is a "conversion" event. If you implemented the SDK
 
 1. Emit a custom event.
     ```java
-       client.emitEvent(<event_type>);
+       ascendClient.emitEvent(<event_type>);
     ```
 
     AND / OR
 
 2. Emit a custom event with an associated score.
     ```java
-       client.emitEvent(<event_type>, <score>);
+       ascendClient.emitEvent(<event_type>, <score>);
     ```
 
 ### Contaminate the Allocation (optional)
@@ -96,7 +96,7 @@ Sometimes it may be necessary to contaminate the participant's allocation. Meani
 
 1. Contaminate the participant's allocation.
     ```java
-       client.contaminate();
+       ascendClient.contaminate();
     ```    
 
 
@@ -109,24 +109,25 @@ AscendConfig class.
 1. Choose an HttpClient and pass it to the AscendConfig.
 
     ```java
-       HttpClient httpClient = new AsyncHttpClientImpl(<request_timeout>);
-       AscendConfig config = AscendConfig.builder(<environment_id>, httpClient).build();
-       AscendClient client = AscendClientFactory.init(config);
+       HttpClient httpClient = new AsyncHttpClient();
+       AscendConfig config = AscendConfig.builder('sandbox', httpClient).build();
+       AscendClient ascendClient = AscendClientFactory.init(config);
     ```
-    *Note: The above HttpClient implementation uses org.asynchttpclient:async-http-client as its http client. In order to use
+    *Note: Replace 'sandbox' with your own environment id.
+    *Note: The above HttpClient implementation uses org.asynchttpclient:async-http-httpClient as its http httpClient. In order to use
     the implementation you will need to bring the package into your dependencies.*
 
 ### Custom Allocation Store (optional)
 
 Once a participant has been allocated into an experiment you may want to retain the allocations they received. To do this, create a custom allocation store by implementing the AscendAllocationStore interface. You can supply the
-custom allocation store to the client when you build the AscendConfig.
+custom allocation store to the AscendClient when you build the AscendConfig.
 
-1. Supply the allocation store to the client.
+1. Supply the allocation store to the AscendClient.
     ```java
        AscendConfig config = AscendConfig.builder(<environment_id>, <http_client>)
            .setAscendAllocationStore(<custom_store>)
            .build();
-       AscendClient client = AscendClientFactory.init(config);
+       AscendClient ascendClient = AscendClientFactory.init(config);
    ```
 
 ### Optional Configurations

src/main/java/ai/evolv/AsyncHttpClientImpl.java

@@ -1,24 +1,21 @@
 package ai.evolv;
 
-import static org.asynchttpclient.Dsl.asyncHttpClient;
-import static org.asynchttpclient.Dsl.config;
-
-import java.io.IOException;
 import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
 
-import org.asynchttpclient.AsyncHandler;
-import org.asynchttpclient.AsyncHttpClient;
-import org.asynchttpclient.HttpResponseBodyPart;
-import org.asynchttpclient.HttpResponseHeaders;
-import org.asynchttpclient.HttpResponseStatus;
-
-public class AsyncHttpClientImpl implements HttpClient {
-
-    private final AsyncHttpClient httpClient;
+@Deprecated
+public class AsyncHttpClientImpl
+    extends ai.evolv.httpclients.AsyncHttpClient implements HttpClient {
 
+    /**
+     *
+     * @param timeout The milliseconds before the client should timeout and return the default
+     *                value.
+     *
+     * @deprecated use {@link ai.evolv.httpclients.AsyncHttpClient} instead.
+     */
     public AsyncHttpClientImpl(long timeout) {
-        this.httpClient = asyncHttpClient(config()
-        .setRequestTimeout(new Long(timeout).intValue()));
+        super(TimeUnit.MILLISECONDS, Math.toIntExact(timeout));
     }
 
     /**
@@ -29,55 +26,7 @@ public AsyncHttpClientImpl(long timeout) {
      *     the API
      */
     public CompletableFuture<String> get(String url) {
-
-        final CompletableFuture<String> responseFuture = new CompletableFuture<>();
-
-        StringBuilder chunks = new StringBuilder();
-
-        httpClient.prepareGet(url)
-                .execute(new AsyncHandler<String>() {
-                    private Integer status;
-
-                    @Override
-                    public State onStatusReceived(HttpResponseStatus responseStatus)
-                            throws Exception {
-                        int code = responseStatus.getStatusCode();
-                        if (code >= 200 && code < 300) {
-                            return State.CONTINUE;
-                        }
-                        throw new IOException("The request returned a bad status code.");
-                    }
-
-                    @Override
-                    public State onHeadersReceived(HttpResponseHeaders headers)
-                            throws Exception {
-                        return State.CONTINUE;
-                    }
-
-                    @Override
-                    public State onBodyPartReceived(HttpResponseBodyPart bodyPart)
-                            throws Exception {
-                        String chunk = new String(bodyPart.getBodyPartBytes()).trim();
-                        if (chunk.length() != 0) {
-                            chunks.append(chunk);
-                        }
-                        return State.CONTINUE;
-                    }
-
-                    @Override
-                    public String onCompleted() throws Exception {
-                        String response = chunks.toString();
-                        responseFuture.complete(response);
-                        return response;
-                    }
-
-                    @Override
-                    public void onThrowable(Throwable t) {
-                        responseFuture.completeExceptionally(t);
-                    }
-                });
-
-        return responseFuture;
+        return getStringCompletableFuture(url, httpClient);
     }
 
 }

src/main/java/ai/evolv/OkHttpClientImpl.java

@@ -1,72 +1,31 @@
 package ai.evolv;
 
-import java.io.IOException;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.TimeUnit;
 
-import okhttp3.Call;
-import okhttp3.Callback;
-import okhttp3.ConnectionPool;
-import okhttp3.OkHttpClient;
-import okhttp3.Request;
-import okhttp3.Response;
-import okhttp3.ResponseBody;
-
-public class OkHttpClientImpl implements HttpClient {
-
-    private final OkHttpClient client;
+@Deprecated
+public class OkHttpClientImpl extends ai.evolv.httpclients.OkHttpClient implements HttpClient {
 
     /**
      * Initializes the OhHttp# client.
+     *
      * @param timeout specify a request timeout for the client.
+     *
+     * @deprecated use {@link ai.evolv.httpclients.OkHttpClient} instead.
      */
     public OkHttpClientImpl(long timeout) {
-        this.client = new OkHttpClient.Builder()
-                .callTimeout(timeout, TimeUnit.MILLISECONDS)
-                .connectionPool(new ConnectionPool(3, 1000, TimeUnit.MILLISECONDS))
-                .build();
+        super(TimeUnit.MILLISECONDS, Math.toIntExact(timeout));
     }
 
     /**
      * Performs a GET request with the given url using the client from
      * okhttp3.
+     *
      * @param url a valid url representing a call to the Participant API.
      * @return a Completable future instance containing a response from
      *     the API
      */
     public CompletableFuture<String> get(String url) {
-        CompletableFuture<String> responseFuture = new CompletableFuture<>();
-        final Request request = new Request.Builder()
-                .url(url)
-                .build();
-
-        client.newCall(request).enqueue(new Callback() {
-            @Override
-            public void onFailure(Call call, IOException e) {
-                responseFuture.completeExceptionally(e);
-            }
-
-            @Override
-            public void onResponse(Call call, Response response) {
-                String body = "";
-                try (ResponseBody responseBody = response.body()) {
-                    if (responseBody != null) {
-                        body = responseBody.string();
-                    }
-
-                    if (!response.isSuccessful()) {
-                        throw new IOException(String.format("Unexpected response " +
-                                "when making GET request: %s using url: %s with body: %s",
-                                response, request.url(), body));
-                    }
-
-                    responseFuture.complete(body);
-                } catch (Exception e) {
-                    responseFuture.completeExceptionally(e);
-                }
-            }
-        });
-
-        return responseFuture;
+        return getStringCompletableFuture(url, httpClient);
     }
 }