[1.1.0]

QueueManager new constructor introduced
ApiRunner proper queue used for tests
QueueManager#close as AutoClosable
EtherScanApi as AutoClosable
CI updated
Tests API key exposed

Author: GoodforGod

.github/workflows/gradle.yml

@@ -33,3 +33,11 @@ jobs:
 
       - name: Test
         run: ./gradlew test jacocoTestReport
+        env:
+          API_KEY: ${{ secrets.API_KEY }}
+
+      - name: SonarQube
+        run: ./gradlew sonarqube
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

src/main/java/io/api/etherscan/core/impl/EtherScanApi.java

@@ -20,12 +20,13 @@
  * @author GoodforGod
  * @since 28.10.2018
  */
-public class EtherScanApi {
+public class EtherScanApi implements AutoCloseable {
 
     private static final Supplier<IHttpExecutor> DEFAULT_SUPPLIER = HttpExecutor::new;
 
     public static final String DEFAULT_KEY = "YourApiKeyToken";
 
+    private final IQueueManager queueManager;
     private final IAccountApi account;
     private final IBlockApi block;
     private final IContractApi contract;
@@ -87,6 +88,7 @@ public EtherScanApi(final String apiKey,
         final String ending = EthNetwork.TOBALABA.equals(network) ? "com" : "io";
         final String baseUrl = "https://" + network.getDomain() + ".etherscan." + ending + "/api" + "?apikey=" + apiKey;
 
+        this.queueManager = queue;
         this.account = new AccountApiProvider(queue, baseUrl, executor);
         this.block = new BlockApiProvider(queue, baseUrl, executor);
         this.contract = new ContractApiProvider(queue, baseUrl, executor);
@@ -130,4 +132,9 @@ public IProxyApi proxy() {
     public IStatisticApi stats() {
         return stats;
     }
+
+    @Override
+    public void close() throws Exception {
+        queueManager.close();
+    }
 }

src/main/java/io/api/etherscan/manager/IQueueManager.java

@@ -7,7 +7,7 @@
  * @author GoodforGod
  * @since 30.10.2018
  */
-public interface IQueueManager {
+public interface IQueueManager extends AutoCloseable {
 
     /**
      * Waits in queue for chance to take turn

src/main/java/io/api/etherscan/manager/impl/FakeQueueManager.java

@@ -15,4 +15,9 @@ public void takeTurn() {
         // no limit or await provided for fake impl so rate limit exception will be
         // thrown if too many calls
     }
+
+    @Override
+    public void close() {
+        // do nothing
+    }
 }

src/main/java/io/api/etherscan/manager/impl/QueueManager.java

@@ -12,21 +12,39 @@
  * @author GoodforGod
  * @since 30.10.2018
  */
-public class QueueManager implements IQueueManager {
+public class QueueManager implements IQueueManager, AutoCloseable {
 
     public static final QueueManager DEFAULT_KEY_QUEUE = new QueueManager(1, 7);
-    public static final QueueManager PERSONAL_KEY_QUEUE = new QueueManager(2, 1);
+    public static final QueueManager PERSONAL_KEY_QUEUE = new QueueManager(5, 1100L, 1100L, 5);
 
+    private final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
     private final Semaphore semaphore;
 
     public QueueManager(int size, int resetInSec) {
         this(size, resetInSec, resetInSec);
     }
 
     public QueueManager(int size, int queueResetTimeInSec, int delayInSec) {
-        this.semaphore = new Semaphore(size);
-        Executors.newSingleThreadScheduledExecutor()
-                .scheduleAtFixedRate(releaseLocks(size), delayInSec, queueResetTimeInSec, TimeUnit.SECONDS);
+        this(size, queueResetTimeInSec, delayInSec, size);
+    }
+
+    public QueueManager(int size,
+                        int queueResetTimeInSec,
+                        int delayInSec,
+                        int initialSize) {
+        this(size,
+                (long) queueResetTimeInSec * 1000,
+                (long) delayInSec * 1000,
+                initialSize);
+    }
+
+    public QueueManager(int size,
+                        long queueResetTimeInMillis,
+                        long delayInMillis,
+                        int initialSize) {
+        this.semaphore = new Semaphore(initialSize);
+        this.executorService.scheduleAtFixedRate(releaseLocks(size), delayInMillis, queueResetTimeInMillis,
+                TimeUnit.MILLISECONDS);
     }
 
     @Override
@@ -37,4 +55,9 @@ public void takeTurn() {
     private Runnable releaseLocks(int toRelease) {
         return () -> semaphore.release(toRelease);
     }
+
+    @Override
+    public void close() {
+        executorService.shutdown();
+    }
 }

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

@@ -1,6 +1,7 @@
 package io.api;
 
 import io.api.etherscan.core.impl.EtherScanApi;
+import io.api.etherscan.manager.impl.QueueManager;
 import io.api.etherscan.model.EthNetwork;
 import org.junit.Assert;
 
@@ -18,10 +19,11 @@ public class ApiRunner extends Assert {
                 ? EtherScanApi.DEFAULT_KEY
                 : apiKey;
 
-        api = new EtherScanApi(key, EthNetwork.MAINNET);
-        apiRopsten = new EtherScanApi(key, EthNetwork.ROPSTEN);
-        apiRinkeby = new EtherScanApi(key, EthNetwork.RINKEBY);
-        apiKovan = new EtherScanApi(key, EthNetwork.KOVAN);
+        final QueueManager queueManager = new QueueManager(2, 2100L, 2100L, 0);
+        api = new EtherScanApi(key, EthNetwork.MAINNET, queueManager);
+        apiKovan = new EtherScanApi(key, EthNetwork.KOVAN, queueManager);
+        apiRopsten = new EtherScanApi(key, EthNetwork.ROPSTEN, queueManager);
+        apiRinkeby = new EtherScanApi(key, EthNetwork.RINKEBY, queueManager);
     }
 
     public static String getKey() {

src/test/java/io/api/etherscan/proxy/ProxyCallApiTest.java

@@ -41,6 +41,6 @@ public void correctParamWithEmptyExpectedResult() {
         Optional<String> call = getApi().proxy().call("0xAEEF16DB4855E25702F8237E8f403FddcaF931C0",
                 "0x70a08231000000000000000000000000e16359506c028e51f16be38986ec5746251e9724");
         assertTrue(call.isPresent());
-        assertFalse(BasicUtils.isNotHex(call.get()));
+        assertFalse(call.get(), BasicUtils.isNotHex(call.get()));
     }
 }

src/test/java/io/api/etherscan/proxy/ProxyCodeApiTest.java

@@ -19,18 +19,18 @@ public class ProxyCodeApiTest extends ApiRunner {
     public void correct() {
         Optional<String> call = getApi().proxy().code("0xf75e354c5edc8efed9b59ee9f67a80845ade7d0c");
         assertTrue(call.isPresent());
-        assertFalse(BasicUtils.isNotHex(call.get()));
+        assertFalse(call.get(), BasicUtils.isNotHex(call.get()));
     }
 
     @Test(expected = InvalidAddressException.class)
     public void invalidParamWithError() {
-        Optional<String> call = getApi().proxy().code("0f75e354c5edc8efed9b59ee9f67a80845ade7d0c");
+        getApi().proxy().code("0f75e354c5edc8efed9b59ee9f67a80845ade7d0c");
     }
 
     @Test
     public void correctParamWithEmptyExpectedResult() {
         Optional<String> call = getApi().proxy().code("0xf15e354c5edc8efed9b59ee9f67a80845ade7d0c");
         assertTrue(call.isPresent());
-        assertFalse(BasicUtils.isNotHex(call.get()));
+        assertFalse(call.get(), BasicUtils.isNotHex(call.get()));
     }
 }