[2.0.0-SNAPSHOT]

Javadoc improvements

Author: GoodforGod

src/main/java/io/goodforgod/api/etherscan/EthScanAPIBuilder.java

@@ -5,7 +5,6 @@
 import io.goodforgod.api.etherscan.http.EthHttpClient;
 import io.goodforgod.api.etherscan.http.impl.UrlEthHttpClient;
 import io.goodforgod.api.etherscan.manager.RequestQueueManager;
-import io.goodforgod.api.etherscan.manager.impl.FakeRequestQueueManager;
 import io.goodforgod.api.etherscan.util.BasicUtils;
 import io.goodforgod.gson.configuration.GsonConfiguration;
 import java.util.function.Supplier;
@@ -24,7 +23,7 @@ final class EthScanAPIBuilder implements EtherScanAPI.Builder {
 
     private String apiKey = DEFAULT_KEY;
     private EthNetwork ethNetwork = EthNetworks.MAINNET;
-    private RequestQueueManager queueManager = RequestQueueManager.DEFAULT;
+    private RequestQueueManager queueManager = RequestQueueManager.ANONYMOUS;
     private Supplier<EthHttpClient> ethHttpClientSupplier = DEFAULT_SUPPLIER;
     private Supplier<Converter> converterSupplier = () -> new Converter() {
 
@@ -42,7 +41,7 @@ public EtherScanAPI.Builder withApiKey(@NotNull String apiKey) {
 
         this.apiKey = apiKey;
         if (!DEFAULT_KEY.equals(apiKey)) {
-            queueManager = new FakeRequestQueueManager();
+            queueManager = RequestQueueManager.UNLIMITED;
         }
         return this;
     }

src/main/java/io/goodforgod/api/etherscan/http/impl/UrlEthHttpClient.java

@@ -20,6 +20,7 @@
 import java.util.Map;
 import java.util.zip.GZIPInputStream;
 import java.util.zip.InflaterInputStream;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Http client implementation
@@ -82,7 +83,7 @@ private HttpURLConnection buildConnection(URI uri, String method) throws IOExcep
     }
 
     @Override
-    public String get(URI uri) {
+    public @NotNull String get(@NotNull URI uri) {
         try {
             final HttpURLConnection connection = buildConnection(uri, "GET");
             final int status = connection.getResponseCode();
@@ -105,7 +106,7 @@ public String get(URI uri) {
     }
 
     @Override
-    public String post(URI uri, byte[] body) {
+    public @NotNull String post(@NotNull URI uri, byte[] body) {
         try {
             final HttpURLConnection connection = buildConnection(uri, "POST");
             final int contentLength = body.length;

src/main/java/io/goodforgod/api/etherscan/manager/RequestQueueManager.java

@@ -1,5 +1,6 @@
 package io.goodforgod.api.etherscan.manager;
 
+import io.goodforgod.api.etherscan.manager.impl.FakeRequestQueueManager;
 import io.goodforgod.api.etherscan.manager.impl.SemaphoreRequestQueueManager;
 import java.time.Duration;
 
@@ -12,8 +13,18 @@
  */
 public interface RequestQueueManager extends AutoCloseable {
 
-    RequestQueueManager DEFAULT = new SemaphoreRequestQueueManager(1, Duration.ofMillis(5005L));
-    RequestQueueManager PERSONAL = new SemaphoreRequestQueueManager(5, Duration.ofMillis(1005L));
+    /**
+     * Is used by default when no API KEY is provided
+     */
+    RequestQueueManager ANONYMOUS = new SemaphoreRequestQueueManager(1, Duration.ofMillis(5005L));
+
+    /**
+     * Is available for all registered free API KEYs
+     * <a href="https://docs.etherscan.io/getting-started/viewing-api-usage-statistics">Free API KEY</a>
+     */
+    RequestQueueManager FREE_PLAN = new SemaphoreRequestQueueManager(5, Duration.ofMillis(1005L));
+
+    RequestQueueManager UNLIMITED = new FakeRequestQueueManager();
 
     /**
      * Waits in queue for chance to take turn

src/test/java/io/goodforgod/api/etherscan/ApiRunner.java

@@ -20,8 +20,8 @@ public class ApiRunner extends Assertions {
                 .orElse(DEFAULT_KEY);
 
         final RequestQueueManager queueManager = (DEFAULT_KEY.equals(API_KEY))
-                ? RequestQueueManager.DEFAULT
-                : RequestQueueManager.PERSONAL;
+                ? RequestQueueManager.ANONYMOUS
+                : RequestQueueManager.FREE_PLAN;
 
         API = EtherScanAPI.builder()
                 .withApiKey(ApiRunner.API_KEY)

src/test/java/io/goodforgod/api/etherscan/proxy/ProxyBlockApiTests.java

@@ -17,7 +17,7 @@ class ProxyBlockApiTests extends ApiRunner {
     private final EtherScanAPI api;
 
     ProxyBlockApiTests() {
-        final RequestQueueManager queueManager = RequestQueueManager.DEFAULT;
+        final RequestQueueManager queueManager = RequestQueueManager.ANONYMOUS;
         this.api = EtherScanAPI.builder().withApiKey(getApiKey()).withNetwork(EthNetworks.MAINNET).withQueue(queueManager)
                 .build();
     }