cleanup tests and api client; fix PRODUCTION url

Author: dnl-blkv

README.md

@@ -152,3 +152,20 @@ List<User> users = User.list(apiContext);
 
 ##### Example
 See [`UserListExample.java`](./src/main/java/com/bunq/sdk/example/UserListExample.java)
+
+## Running Examples
+In order to make the experience of getting into bunq Java SDK smoother, we
+have bundled it with example use cases (located under `./src/main/java/com/bunq/sdk/example/`).
+
+To run an example, please do the following:
+1. In your IDE, open the example you are interested in and adjust the constants,
+such as `API_KEY` or `USER_ID`, to hold your data.
+2. Since Java IDE's are typically advanced just run the example of your choice in your IDE.
+
+In order for examples to run, you would need a valid context file (`bunq.conf`)
+to be present in the bunq SDK project root directory. The file can either copied
+from somewhere else (e.g. tests) or created by executing the `ApiContextSaveExample.java` in your
+IDE.
+
+Please do not forget to set the `API_KEY` constant in `ApiContextSaveExample.java` to your actual
+API key before running the example!

src/main/java/com/bunq/sdk/context/ApiContext.java

@@ -108,6 +108,28 @@ public static ApiContext create(ApiEnvironmentType environmentType, String apiKe
     return apiContext;
   }
 
+  /**
+   * Restores a context from a default location.
+   */
+  public static ApiContext restore() {
+    return restore(PATH_API_CONTEXT_DEFAULT);
+  }
+
+  /**
+   * Restores a context from a given file.
+   */
+  public static ApiContext restore(String fileName) {
+    try {
+      File file = new File(fileName);
+      String json = FileUtils.readFileToString(file, ENCODING_BUNQ_CONF);
+      JsonObject jsonObject = gson.fromJson(json, JsonObject.class);
+
+      return gson.fromJson(jsonObject, ApiContext.class);
+    } catch (IOException exception) {
+      throw new BunqException(ERROR_COULD_NOT_RESTORE_API_CONTEXT, exception);
+    }
+  }
+
   private void initialize(String deviceDescription, List<String> permittedIps) {
     /* The calls below are order-sensitive: to initialize a Device Registration, we need an
      * Installation, and to initialize a Session we need a Device Registration. */
@@ -204,28 +226,6 @@ public void save(String fileName) {
     }
   }
 
-  /**
-   * Restores a context from a default location.
-   */
-  public static ApiContext restore() {
-    return restore(PATH_API_CONTEXT_DEFAULT);
-  }
-
-  /**
-   * Restores a context from a given file.
-   */
-  public static ApiContext restore(String fileName) {
-    try {
-      File file = new File(fileName);
-      String json = FileUtils.readFileToString(file, ENCODING_BUNQ_CONF);
-      JsonObject jsonObject = gson.fromJson(json, JsonObject.class);
-
-      return gson.fromJson(jsonObject, ApiContext.class);
-    } catch (IOException exception) {
-      throw new BunqException(ERROR_COULD_NOT_RESTORE_API_CONTEXT, exception);
-    }
-  }
-
   /**
    * @return The base URI of the current environment.
    */

src/main/java/com/bunq/sdk/context/ApiEnvironmentType.java

@@ -9,7 +9,7 @@
  */
 public enum ApiEnvironmentType {
 
-  PRODUCTION("https://public.api.bunq.com/v1/"),
+  PRODUCTION("https://api.bunq.com/v1/"),
   SANDBOX("https://sandbox.public.api.bunq.com/v1/");
 
   /**

src/main/java/com/bunq/sdk/examples/ApiContextSaveExample.java

@@ -4,7 +4,6 @@
 import com.bunq.sdk.context.ApiEnvironmentType;
 import com.bunq.sdk.json.BunqGsonBuilder;
 import com.google.gson.Gson;
-import java.util.ArrayList;
 
 /**
  * Create an API context and save it to a file.

src/main/java/com/bunq/sdk/examples/UserListExample.java

@@ -2,7 +2,6 @@
 
 import com.bunq.sdk.context.ApiContext;
 import com.bunq.sdk.model.generated.User;
-import com.bunq.sdk.model.generated.UserCompany;
 import java.util.List;
 
 /**

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

@@ -261,15 +261,14 @@ private byte[] getBodyBytes(CloseableHttpResponse response) throws IOException {
     Integer responseCode = response.getStatusLine().getStatusCode();
     byte[] responseBodyBytes = EntityUtils.toByteArray(response.getEntity());
 
-    validateResponseSignature(responseCode, responseBodyBytes, response);
     assertResponseSuccess(responseCode, responseBodyBytes);
+    validateResponseSignature(responseCode, responseBodyBytes, response);
 
     return responseBodyBytes;
   }
 
   private void validateResponseSignature(int responseCode, byte[] responseBodyBytes,
-      HttpResponse response)
-  {
+      HttpResponse response) {
     InstallationContext installationContext = apiContext.getInstallationContext();
 
     if (installationContext != null) {

src/main/java/com/bunq/sdk/json/SessionServerAdapter.java

@@ -29,6 +29,10 @@ public class SessionServerAdapter implements JsonDeserializer<SessionServer> {
   private static final String FIELD_USER_COMPANY = "UserCompany";
   private static final String FIELD_USER_PERSON = "UserPerson";
 
+  private static JsonElement getByIndexAndFieldName(JsonArray values, int index, String fieldName) {
+    return values.get(index).getAsJsonObject().get(fieldName);
+  }
+
   @Override
   public SessionServer deserialize(JsonElement json, Type typeOfT,
       JsonDeserializationContext context) throws JsonParseException {
@@ -61,8 +65,4 @@ public SessionServer deserialize(JsonElement json, Type typeOfT,
     }
   }
 
-  private static JsonElement getByIndexAndFieldName(JsonArray values, int index, String fieldName) {
-    return values.get(index).getAsJsonObject().get(fieldName);
-  }
-
 }

src/test/config.example.properties

@@ -1,24 +1,24 @@
 # For all test
 API_CONFIG_PATH=bunq-test.conf
-API_KEY = <API KEY>
+API_KEY=<API KEY>
 PERMITTED_IPS=<IP ADDRESS>
 
 #For UserTest
-USER_ID = xxxx
+USER_ID=xxxx
 
 #For AttachmentPublicTest
-CONTENT_TYPE = image/png
-ATTACHMENT_DESCRIPTION = TEST PNG JAVA
-PATH_ATTACHMENT_IN = assets/[email protected]
+CONTENT_TYPE=image/png
+ATTACHMENT_DESCRIPTION=TEST PNG JAVA
+PATH_ATTACHMENT_IN=assets/[email protected]
 
 #For MonetaryAccountTest
-MA_ID = xxxx
-MA_ID2 = xxxx
+MONETARY_ACCOUNT_ID=xxxx
+MONETARY_ACCOUNT_ID2=xxxx
 COUNTER_PARTY_ALIAS=<Email address>
 COUNTER_PARTY_TYPE=EMAIL
 
 #For TabUsageSingleTest
-CR_ID = xxx
+CASH_REGISTER_ID=xxx
 
 #For PaymentChatTest
 #Same user, alias from other account

src/test/java/com/bunq/sdk/model/generated/ApiContextHandler.java renamed to src/test/java/com/bunq/sdk/BunqSdkTestBase.java

@@ -1,29 +1,44 @@
-package com.bunq.sdk.model.generated;
+package com.bunq.sdk;
 
 import com.bunq.sdk.context.ApiContext;
 import com.bunq.sdk.context.ApiEnvironmentType;
 import com.bunq.sdk.exception.ApiException;
 import com.bunq.sdk.exception.BunqException;
+import com.bunq.sdk.model.generated.User;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Properties;
 
 /**
- * Checks if the sessionToken stored in the conf file is still valid, if not it will generate a new
- * one
+ * Base class for the Bunq SDK tests.
  */
-public class ApiContextHandler {
+public class BunqSdkTestBase {
 
   /**
-   * Config fields
+   * Description of the test device for Java SDK.
+   */
+  private static final String DEVICE_DESCRIPTION = "Java test device";
+
+  /**
+   * Config fields.
    */
-  private static final String DEVICE_DESCRIPTION = "Java test case";
   private static final String FIELD_API_KEY = "API_KEY";
   private static final String FIELD_PERMITTED_IPS = "PERMITTED_IPS";
   private static final String FIELD_API_CONFIG_PATH = "API_CONFIG_PATH";
+
+  /**
+   * Delimiter between the IP addresses in the PERMITTED_IPS field.
+   */
   private static final String DELIMITER_IPS = ", ";
+
+  /**
+   * Properties for the tests.
+   */
   private static Properties config = TestConfig.prop();
 
+  /**
+   * Individual properties.
+   */
   private static String apiKey = config.getProperty(FIELD_API_KEY);
   private static String[] permittedIps = config.getProperty(FIELD_PERMITTED_IPS).split(
       DELIMITER_IPS);
@@ -33,32 +48,20 @@ public class ApiContextHandler {
    * Based on the result of isSessionActive will create a new ApiContext or restore an old conf
    * file
    */
-  public static ApiContext getApiContext() {
+  protected static ApiContext getApiContext() {
     ApiContext apiContext;
 
-    if (isSessionActive()) {
+    try {
       apiContext = ApiContext.restore(apiConfigPath);
-    } else {
+      User.list(apiContext);
+    } catch (ApiException | BunqException exception) {
       List<String> ips = Arrays.asList(permittedIps);
       apiContext = ApiContext.create(ApiEnvironmentType.SANDBOX, apiKey, DEVICE_DESCRIPTION, ips);
-      apiContext.save();
     }
 
-    return apiContext;
-  }
-
-  /**
-   * Checks if the session is active by making an API call and see if an Api/Bunq exception is
-   * thrown
-   */
-  private static boolean isSessionActive() {
-    try {
-      User.list(ApiContext.restore(apiConfigPath));
+    apiContext.save();
 
-      return true;
-    } catch (ApiException|BunqException exception) {
-      return false;
-    }
+    return apiContext;
   }
 
 } 

src/test/java/com/bunq/sdk/model/generated/TestConfig.java renamed to src/test/java/com/bunq/sdk/TestConfig.java

@@ -1,4 +1,4 @@
-package com.bunq.sdk.model.generated;
+package com.bunq.sdk;
 
 import java.io.FileInputStream;
 import java.io.IOException;