Merge pull request #234 from binance/common_v2.5.0

Release common v2.5.0

Author: theo-s68

clients/common/pom.xml

@@ -10,6 +10,6 @@
 
     <artifactId>binance-common</artifactId>
     <name>common</name>
-    <version>2.4.2</version>
+    <version>2.5.0</version>
     <packaging>jar</packaging>
 </project>

clients/common/src/main/java/com/binance/connector/client/common/ApiClient.java

@@ -215,11 +215,8 @@ public ApiClient(
 
         SignatureConfiguration signatureConfiguration = configuration.getSignatureConfiguration();
         if (signatureConfiguration != null) {
-            Authentication authentication =
-                    binanceAuthenticationFactory.getAuthentication(signatureConfiguration);
-            if (authentication != null) {
-                authentications.put(BINANCE_SIGNATURE, authentication);
-            }
+            Map<String, Authentication> customAuthentications = getCustomAuthentications(binanceAuthenticationFactory, signatureConfiguration);
+            authentications.putAll(customAuthentications);
         }
 
         Authentication binanceApiKeyOnly =
@@ -515,6 +512,21 @@ public Map<String, Authentication> getAuthentications() {
         return authentications;
     }
 
+    /**
+     * Get custom authentications to be added (key: authentication name, value: authentication).
+     *
+     * @return Map of authentication objects
+     */
+    protected Map<String, Authentication> getCustomAuthentications(BinanceAuthenticationFactory binanceAuthenticationFactory, SignatureConfiguration signatureConfiguration) {
+        Map<String, Authentication> authentications = new HashMap<>();
+        Authentication authentication =
+                binanceAuthenticationFactory.getAuthentication(signatureConfiguration);
+        if (authentication != null) {
+            authentications.put(BINANCE_SIGNATURE, authentication);
+        }
+        return authentications;
+    }
+
     /**
      * Get authentication for the given name.
      *
@@ -1215,8 +1227,7 @@ public <T> ApiResponse<T> execute(Call call, Type returnType) throws ApiExceptio
         try {
             Response response = call.execute();
             T data = handleResponse(response, returnType);
-            Map<RateLimitType, RateLimit> rateLimit =
-                    getRateLimit(response.code(), response.headers());
+            Map<RateLimitType, ? extends RateLimit> rateLimit = getRateLimit(response.code(), response.headers());
             return new ApiResponse<T>(
                     response.code(), response.headers().toMultimap(), data, rateLimit);
         } catch (IOException e) {
@@ -1571,7 +1582,7 @@ public void updateParamsForAuth(
         for (String authName : authNames) {
             Authentication auth = authentications.get(authName);
             if (auth == null) {
-                if (BINANCE_SIGNATURE.equals(authName)) {
+                if (isRequiredAuth(authName)) {
                     throw new RuntimeException(
                             "Request is signed, please add signatureConfiguration to"
                                     + " clientConfiguration");
@@ -1586,6 +1597,10 @@ public void updateParamsForAuth(
         }
     }
 
+    protected boolean isRequiredAuth(String authName) {
+        return BINANCE_SIGNATURE.equals(authName);
+    }
+
     /**
      * Build a form-encoding request body with the given form parameters.
      *
@@ -1819,7 +1834,7 @@ private String requestBodyToString(RequestBody requestBody) throws ApiException
         return "";
     }
 
-    private Map<RateLimitType, RateLimit> getRateLimit(Integer responseCode, Headers headers) {
+    protected Map<RateLimitType, ? extends RateLimit> getRateLimit(Integer responseCode, Headers headers) {
         HashMap<RateLimitType, RateLimit> rateLimitMap = new HashMap<>();
         Integer retryAfter = null;
         if (Arrays.asList(HTTP_TEA_POT, HTTP_TOO_MANY_REQS).contains(responseCode)) {

clients/common/src/main/java/com/binance/connector/client/common/ApiResponse.java

@@ -22,7 +22,7 @@ public class ApiResponse<T> {
     private final int statusCode;
     private final Map<String, List<String>> headers;
     private final T data;
-    private final Map<RateLimitType, RateLimit> rateLimits;
+    private final Map<RateLimitType, ? extends RateLimit> rateLimits;
 
     /**
      * Constructor for ApiResponse.
@@ -57,7 +57,7 @@ public ApiResponse(
             int statusCode,
             Map<String, List<String>> headers,
             T data,
-            Map<RateLimitType, RateLimit> rateLimits) {
+            Map<RateLimitType, ? extends RateLimit> rateLimits) {
         this.statusCode = statusCode;
         this.headers = headers;
         this.data = data;
@@ -96,7 +96,7 @@ public T getData() {
      *
      * @return the rate limits info
      */
-    public Map<RateLimitType, RateLimit> getRateLimits() {
+    public Map<RateLimitType, ? extends RateLimit> getRateLimits() {
         return rateLimits;
     }
 }

clients/common/src/main/java/com/binance/connector/client/common/dtos/RateLimit.java

@@ -1,7 +1,7 @@
 package com.binance.connector.client.common.dtos;
 
 /** DTOs for rate limits */
-public final class RateLimit {
+public class RateLimit {
     private RateLimitType rateLimitType;
     private RateLimitInterval interval;
     private Integer intervalNum;

clients/common/src/main/java/com/binance/connector/client/common/dtos/RateLimitType.java

@@ -1,6 +1,7 @@
 package com.binance.connector.client.common.dtos;
 
 public enum RateLimitType {
+    DEFAULT,
     REQUEST_WEIGHT,
     ORDERS
 }