Merge branch 'release/1.1.0'

Author: Konstantin Yakushev

.idea/modules.xml

@@ -1,5 +1,5 @@
 group 'com.bunq.sdk'
-version '1.0.0'
+version '1.1.0'
 
 apply plugin: 'java'
 apply plugin: 'maven'

build.gradle

@@ -10,7 +10,6 @@
 import com.bunq.sdk.exception.UncaughtExceptionError;
 import com.bunq.sdk.json.BunqGsonBuilder;
 import com.bunq.sdk.security.SecurityUtils;
-import com.bunq.sdk.util.BunqUtil;
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
@@ -50,8 +49,6 @@ public class ApiClient {
    */
   private static final String ERROR_COULD_NOT_DETERMINE_PINNED_KEY =
       "Could not determine pinned key.";
-  private static final String ERROR_COULD_NOT_DETERMINE_RESPONSE_ID =
-      "Could not determine response id.";
 
   /**
    * Endpoints not requiring active session for the request to succeed.
@@ -65,40 +62,12 @@ public class ApiClient {
       SESSION_SERVER_URL
   );
 
-  /**
-   * Header constants.
-   */
-  public static final String HEADER_ATTACHMENT_DESCRIPTION = "X-Bunq-Attachment-Description";
-  public static final String HEADER_CONTENT_TYPE = "Content-Type";
-  public static final String HEADER_USER_AGENT = "User-Agent";
-  public static final String HEADER_CACHE_CONTROL = "Cache-Control";
-  public static final String HEADER_LANGUAGE = "X-Bunq-Language";
-  public static final String HEADER_REGION = "X-Bunq-Region";
-  public static final String HEADER_REQUEST_ID = "X-Bunq-Client-Request-Id";
-  public static final String HEADER_GEOLOCATION = "X-Bunq-Geolocation";
-  private static final String HEADER_SIGNATURE = "X-Bunq-Client-Signature";
-  private static final String HEADER_AUTHENTICATION = "X-Bunq-Client-Authentication";
-  private static final String HEADER_RESPONSE_ID_LOWER_CASE = "x-bunq-client-response-id";
-  private static final String HEADER_RESPONSE_ID_UPPER_CASE = "X-Bunq-Client-Response-Id";
-
   /**
    * Field constants.
    */
   private static final String FIELD_ERROR = "Error";
   private static final String FIELD_ERROR_DESCRIPTION = "error_description";
 
-  /**
-   * Header value to disable the cache control.
-   */
-  public static final String CACHE_CONTROL_NONE = "no-cache";
-
-  /**
-   * Prefix for bunq's own headers.
-   */
-  private static final String USER_AGENT_BUNQ = "bunq-sdk-java/1.0.0";
-  public static final String LANGUAGE_EN_US = "en_US";
-  public static final String REGION_NL_NL = "nl_NL";
-  public static final String GEOLOCATION_ZERO = "0 0 0 0 000";
   private static final String SCHEME_HTTPS = "https";
 
   /**
@@ -183,11 +152,14 @@ public BunqResponseRaw post(
       customHeaders = new HashMap<>();
     }
 
-    BunqRequestBody bunqRequestBody = BunqRequestBody.create(ContentType.JSON.getMediaType(), requestBodyBytes);
+    BunqRequestBody bunqRequestBody = BunqRequestBody.create(
+        ContentType.JSON.getMediaType(),
+        requestBodyBytes
+    );
 
-    if (customHeaders.containsKey(HEADER_CONTENT_TYPE)) {
+    if (customHeaders.containsKey(BunqHeader.CONTENT_TYPE.getHeaderName())) {
       bunqRequestBody = BunqRequestBody.create(
-          MediaType.parse(customHeaders.get(HEADER_CONTENT_TYPE)),
+          MediaType.parse(customHeaders.get(BunqHeader.CONTENT_TYPE.getHeaderName())),
           requestBodyBytes
       );
     }
@@ -254,13 +226,13 @@ private void setHeaders(BunqRequestBuilder requestBuilder, Map<String, String> c
 
   /**
    */
-  private void setDefaultHeaders(Request.Builder httpEntity) {
-    httpEntity.addHeader(HEADER_CACHE_CONTROL, CACHE_CONTROL_NONE);
-    httpEntity.addHeader(HEADER_USER_AGENT, getVersion());
-    httpEntity.addHeader(HEADER_LANGUAGE, LANGUAGE_EN_US);
-    httpEntity.addHeader(HEADER_REGION, REGION_NL_NL);
-    httpEntity.addHeader(HEADER_REQUEST_ID, UUID.randomUUID().toString());
-    httpEntity.addHeader(HEADER_GEOLOCATION, GEOLOCATION_ZERO);
+  private void setDefaultHeaders(BunqRequestBuilder httpEntity) {
+    BunqHeader.CACHE_CONTROL.addTo(httpEntity);
+    BunqHeader.USER_AGENT.addTo(httpEntity);
+    BunqHeader.LANGUAGE.addTo(httpEntity);
+    BunqHeader.REGION.addTo(httpEntity);
+    BunqHeader.CLIENT_REQUEST_ID.addTo(httpEntity, UUID.randomUUID().toString());
+    BunqHeader.GEOLOCATION.addTo(httpEntity);
   }
 
   /**
@@ -277,8 +249,8 @@ private void setSessionHeaders(BunqRequestBuilder requestBuilder) {
     String sessionToken = apiContext.getSessionToken();
 
     if (sessionToken != null) {
-      requestBuilder.addHeader(HEADER_AUTHENTICATION, sessionToken);
-      requestBuilder.addHeader(HEADER_SIGNATURE, generateSignature(requestBuilder));
+      BunqHeader.CLIENT_AUTHENTICATION.addTo(requestBuilder, sessionToken);
+      BunqHeader.CLIENT_SIGNATURE.addTo(requestBuilder, generateSignature(requestBuilder));
     }
   }
 
@@ -289,12 +261,6 @@ private String generateSignature(BunqRequestBuilder requestBuilder) {
         apiContext.getInstallationContext().getKeyPairClient());
   }
 
-  /**
-   */
-  private String getVersion() {
-    return USER_AGENT_BUNQ;
-  }
-
   /**
    */
   private BunqResponseRaw createBunqResponseRaw(Response response)
@@ -313,15 +279,7 @@ private BunqResponseRaw createBunqResponseRaw(Response response)
   private static String getResponseId(Response response) {
     Map<String, String> headerMap = getHeadersMap(response);
 
-    if (headerMap.containsKey(HEADER_RESPONSE_ID_LOWER_CASE)) {
-      return headerMap.get(HEADER_RESPONSE_ID_LOWER_CASE);
-    } else {
-      return BunqUtil.getValueFromMapOrDefault(
-          headerMap,
-          HEADER_RESPONSE_ID_UPPER_CASE,
-          ERROR_COULD_NOT_DETERMINE_RESPONSE_ID
-      );
-    }
+    return BunqHeader.CLIENT_RESPONSE_ID.getHeaderValueOrDefault(headerMap);
   }
 
   /**

src/main/java/com/bunq/sdk/http/ApiClient.java

@@ -1,28 +1,83 @@
 package com.bunq.sdk.http;
 
-public class BunqBasicHeader implements Comparable<BunqBasicHeader> {
-  private String name;
-  private String value;
+import okhttp3.Response;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
 
+public class BunqBasicHeader implements Comparable<BunqBasicHeader> {
   /**
+   * String format constants for signing data
    */
-  public BunqBasicHeader(String name, String value) {
+  private static final String DELIMITER_HEADER_NAME_AND_VALUE = ": ";
+  private static final String NEWLINE = "\n";
+
+  private final BunqHeader name;
+  private final String value;
+
+  public static BunqBasicHeader get(BunqHeader header, Response response) {
+    return new BunqBasicHeader(header, response.header(header.getHeaderName()));
+  }
+
+  public BunqBasicHeader(BunqHeader name, String value) {
     this.name = name;
     this.value = value;
   }
 
-  /**
-   */
-  public String getName() {
+  public BunqHeader getName() {
     return name;
   }
 
-  /**
-   */
   public String getValue() {
     return value;
   }
 
+  private String forSigning() {
+    return getName().getHeaderName() + DELIMITER_HEADER_NAME_AND_VALUE + getValue();
+  }
+
+  public static String collectForSigning(
+          Collection<BunqBasicHeader> allBasicHeader,
+          BunqHeader exclude,
+          Collection<BunqHeader> allNonBunqHeaderToInclude) {
+    List<String> allHeaderForSigning = new ArrayList<String>();
+
+    for (BunqBasicHeader basicHeader:allBasicHeader) {
+      addHeaderForSigningIfNeeded(basicHeader, allHeaderForSigning, allNonBunqHeaderToInclude);
+    }
+
+    Collections.sort(allHeaderForSigning);
+
+    return  formatAllHeaderForSigning(allHeaderForSigning);
+  }
+
+  private static void addHeaderForSigningIfNeeded(
+      BunqBasicHeader basicHeader,
+      List<String> allHeaderForSigning,
+      Collection<BunqHeader> allNonBunqHeaderToInclude
+  ) {
+    BunqHeader header = basicHeader.getName();
+
+    if (header.isBunq() || allNonBunqHeaderToInclude.contains(header)) {
+      allHeaderForSigning.add(basicHeader.forSigning());
+    }
+  }
+
+  private static String formatAllHeaderForSigning(List<String> allHeaderForSigning) {
+    StringBuilder stringBuilder = new StringBuilder();
+
+    for (String header: allHeaderForSigning) {
+      stringBuilder.append(header);
+      stringBuilder.append(NEWLINE);
+    }
+
+    stringBuilder.deleteCharAt(stringBuilder.lastIndexOf(NEWLINE));
+
+    return stringBuilder.toString();
+  }
+
   @Override
   public int compareTo(BunqBasicHeader o) {
     return getName().compareTo(o.getName());

src/main/java/com/bunq/sdk/http/BunqBasicHeader.java

@@ -0,0 +1,103 @@
+package com.bunq.sdk.http;
+
+import java.util.Collection;
+import java.util.Map;
+
+public enum BunqHeader {
+  ATTACHMENT_DESCRIPTION("X-Bunq-Attachment-Description"),
+  CACHE_CONTROL("Cache-Control", "no-cache"),
+  CLIENT_AUTHENTICATION("X-Bunq-Client-Authentication"),
+  CLIENT_ENCRYPTION_HMAC("X-Bunq-Client-Encryption-Hmac"),
+  CLIENT_ENCRYPTION_IV("X-Bunq-Client-Encryption-Iv"),
+  CLIENT_ENCRYPTION_KEY("X-Bunq-Client-Encryption-Key"),
+  CLIENT_REQUEST_ID("X-Bunq-Client-Request-Id"),
+  CLIENT_RESPONSE_ID("X-Bunq-Client-Response-Id", "Could not determine response id."),
+  CLIENT_SIGNATURE("X-Bunq-Client-Signature"),
+  CONTENT_TYPE("Content-Type"),
+  GEOLOCATION("X-Bunq-Geolocation", "0 0 0 0 000"),
+  LANGUAGE("X-Bunq-Language", "en_US"),
+  REGION("X-Bunq-Region", "nl_NL"),
+  SERVER_SIGNATURE("X-Bunq-Server-Signature"),
+  USER_AGENT("User-Agent", "bunq-sdk-java/0.13.1");
+
+  private static final String PREFIX = "X-Bunq-";
+
+  private final String header;
+  private final String defaultValue;
+
+  BunqHeader(String header) {
+    this(header, null);
+  }
+
+  BunqHeader(String header, String defaultValue) {
+    this.header = header;
+    this.defaultValue = defaultValue;
+  }
+
+  public static BunqHeader parseHeaderOrNull(String value) {
+    for (BunqHeader header : values()) {
+      if (header.equals(value)) {
+        return header;
+      }
+    }
+
+    return null;
+  }
+
+  public String getHeaderName() {
+    return header;
+  }
+
+  public String getDefaultValue() {
+    return defaultValue;
+  }
+
+  private String getHeaderValueOrDefault(String value) {
+    if (value != null) {
+      return value;
+    }
+
+    return getDefaultValue();
+  }
+
+  public void addTo(Map<String, String> headers, String value) {
+    headers.put(getHeaderName(), getHeaderValueOrDefault(value));
+  }
+
+  public void addTo(BunqRequestBuilder requestBuilder) {
+    addTo(requestBuilder, null);
+  }
+
+  public void addTo(BunqRequestBuilder requestBuilder, String value) {
+    requestBuilder.addHeader(getHeaderName(), getHeaderValueOrDefault(value));
+  }
+
+  public boolean equals(String header) {
+    return getHeaderName().equalsIgnoreCase(header);
+  }
+
+  public boolean isBunq() {
+    return getHeaderName().startsWith(PREFIX);
+  }
+
+  private String findKeyOrNull(Collection<String> keys) {
+    for (String key : keys) {
+      if (this.equals(key)) {
+        return key;
+      }
+    }
+
+    return null;
+  }
+
+  public String getHeaderValueOrDefault(Map<String, String> headers) {
+    String key = findKeyOrNull(headers.keySet());
+
+    if (key != null && headers.get(key) != null) {
+      return headers.get(key);
+    }
+
+    return getDefaultValue();
+  }
+
+}

src/main/java/com/bunq/sdk/http/BunqHeader.java

@@ -75,12 +75,20 @@ public BunqRequestBuilder url(URL url) {
     return (BunqRequestBuilder) super.url(url);
   }
 
+  private void addToAllHeader(String name, String value) {
+    BunqHeader header = BunqHeader.parseHeaderOrNull(name);
+
+    if (header != null) {
+      this.allHeader.add(new BunqBasicHeader(header, value));
+    }
+  }
+
   /**
    * {@inheritDoc}
    */
   @Override
   public BunqRequestBuilder header(String name, String value) {
-    this.allHeader.add(new BunqBasicHeader(name, value));
+    addToAllHeader(name, value);
 
     return (BunqRequestBuilder) super.header(name, value);
   }
@@ -90,7 +98,7 @@ public BunqRequestBuilder header(String name, String value) {
    */
   @Override
   public BunqRequestBuilder addHeader(String name, String value) {
-    this.allHeader.add(new BunqBasicHeader(name, value));
+    addToAllHeader(name, value);
 
     return (BunqRequestBuilder) super.addHeader(name, value);
   }
@@ -205,13 +213,8 @@ public BunqRequestBody getBody() {
 
   /**
    */
-  public List<BunqBasicHeader> getAllHeaderAsList() {
+  public List<BunqBasicHeader> getAllHeader() {
     return this.allHeader;
   }
 
-  /**
-   */
-  public BunqBasicHeader[] getAllHeaderAsArray() {
-    return this.allHeader.toArray(new BunqBasicHeader[this.allHeader.size()]);
-  }
 }