Merge pull request #12 from pluggyai/development

Close version 0.3.0

Author: tmilar

README.md

@@ -18,7 +18,7 @@ Currently, the package is available in Github Packages, so make sure to have the
 <dependency>
   <groupId>ai.pluggy</groupId>
   <artifactId>pluggy-java</artifactId>
-  <version>0.2.0</version>
+  <version>0.3.0</version>
 </dependency>
 ```
 

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>ai.pluggy</groupId>
   <artifactId>pluggy-java</artifactId>
-  <version>0.2.0</version>
+  <version>0.3.0</version>
 
   <packaging>jar</packaging>
 

src/main/java/ai/pluggy/client/PluggyApiService.java

@@ -3,7 +3,7 @@
 import ai.pluggy.client.request.AccountsRequest;
 import ai.pluggy.client.request.ConnectorsSearchRequest;
 import ai.pluggy.client.request.CreateItemRequest;
-import ai.pluggy.client.request.DateFilters;
+import ai.pluggy.client.request.TransactionsSearchRequest;
 import ai.pluggy.client.request.UpdateItemRequest;
 import ai.pluggy.client.response.Account;
 import ai.pluggy.client.response.AccountsResponse;
@@ -64,7 +64,7 @@ Call<ItemResponse> updateItem(@Path("id") String itemId,
 
   @GET("/transactions")
   Call<TransactionsResponse> getTransactions(@Query("accountId") String accountId,
-    @QueryMap DateFilters dateFilters);
+    @QueryMap TransactionsSearchRequest transactionsSearchRequest);
 
   @GET("/transactions/{id}")
   Call<Transaction> getTransaction(@Path("id") String transactionId);

src/main/java/ai/pluggy/client/PluggyClient.java

@@ -4,7 +4,6 @@
 import static ai.pluggy.utils.Asserts.assertValidUrl;
 
 import ai.pluggy.client.auth.ApiKeyAuthInterceptor;
-import ai.pluggy.client.auth.TokenProvider;
 import ai.pluggy.client.response.AuthResponse;
 import ai.pluggy.client.response.ErrorResponse;
 import ai.pluggy.exception.PluggyException;
@@ -17,20 +16,17 @@
 import java.util.concurrent.TimeUnit;
 import okhttp3.MediaType;
 import okhttp3.OkHttpClient;
+import okhttp3.OkHttpClient.Builder;
 import okhttp3.Request;
 import okhttp3.RequestBody;
 import okhttp3.ResponseBody;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
 import retrofit2.Retrofit;
 import retrofit2.converter.gson.GsonConverterFactory;
 
 public final class PluggyClient {
 
-  private static final Logger logger = LogManager.getLogger(PluggyClient.class);
-
+  public static String AUTH_URL_PATH = "/auth";
   private String baseUrl;
-  private String authUrlPath = "/auth";
 
   private String clientId;
   private String clientSecret;
@@ -109,14 +105,22 @@ public static class PluggyClientBuilder {
     private static Integer DEFAULT_HTTP_CONNECT_TIMEOUT_SECONDS = 10;
     private static Integer DEFAULT_HTTP_READ_TIMEOUT_SECONDS = 180;
 
-    private String authPath = "/auth";
     private String clientId;
     private String clientSecret;
     private String baseUrl;
+    private Builder okHttpClientBuilder;
+    private boolean disableDefaultAuthInterceptor = false;
+
+    private PluggyClientBuilder() {
+      // init OkHttpClient.Builder instance, to expose it for configurability
+      this.okHttpClientBuilder = new Builder()
+        .readTimeout(DEFAULT_HTTP_READ_TIMEOUT_SECONDS, TimeUnit.SECONDS)
+        .connectTimeout(DEFAULT_HTTP_CONNECT_TIMEOUT_SECONDS, TimeUnit.SECONDS);
+    }
 
     public PluggyClientBuilder clientIdAndSecret(String clientId, String clientSecret) {
-      assertNotNull(clientId, "client id");
-      assertNotNull(clientSecret, "secret");
+      assertNotNull(clientId, "clientId");
+      assertNotNull(clientSecret, "clientSecret");
       this.clientId = clientId;
       this.clientSecret = clientSecret;
       return this;
@@ -128,16 +132,37 @@ public PluggyClientBuilder baseUrl(String baseUrl) {
       return this;
     }
 
+    /**
+     * Opt-out from provided default ApiKeyAuthInterceptor, which takes care of apiKey authorization,
+     * by requesting a new apiKey token when it's not set, or by reactively refreshing an existing
+     * one and retrying a request in case of 401 or 403 unauthorized error responses.
+     *
+     * In case of opt-out, the client will have to provide it's own auth interceptor implementation,
+     * which has to take care of including the "x-api-key" auth header to each http request.
+     */
+    public PluggyClientBuilder noAuthInterceptor() {
+      this.disableDefaultAuthInterceptor = true;
+      return this;
+    }
+
+    /**
+     * Provides access to the OkHttpClient.Builder instance,
+     * for more complex builds and configurations (interceptors, SSL, etc.)
+     */
+    public OkHttpClient.Builder okHttpClientBuilder() {
+      return okHttpClientBuilder;
+    }
+
     private OkHttpClient buildOkHttpClient(String baseUrl) {
-      String authUrlPath = baseUrl + authPath;
+      if (!disableDefaultAuthInterceptor) {
+        // use ApiKeyAuthInterceptor, unless decided to opt-out and use your own
+        // auth header interceptor implementation.
+        String authUrlPath = baseUrl + PluggyClient.AUTH_URL_PATH;
+        this.okHttpClientBuilder
+          .addInterceptor(new ApiKeyAuthInterceptor(authUrlPath, clientId, clientSecret));
+      }
 
-      OkHttpClient httpClient = new OkHttpClient.Builder()
-        .readTimeout(DEFAULT_HTTP_READ_TIMEOUT_SECONDS, TimeUnit.SECONDS)
-        .connectTimeout(DEFAULT_HTTP_CONNECT_TIMEOUT_SECONDS, TimeUnit.SECONDS)
-        .addInterceptor(
-          new ApiKeyAuthInterceptor(authUrlPath, clientId, clientSecret, new TokenProvider()))
-        .build();
-      return httpClient;
+      return okHttpClientBuilder.build();
     }
 
     private Gson buildGson() {
@@ -148,7 +173,7 @@ private Gson buildGson() {
 
     public PluggyClient build() {
       if (clientId == null || clientSecret == null) {
-        throw new IllegalArgumentException("Must set a clientId and secret.");
+        throw new IllegalArgumentException("Must set a clientId and clientSecret.");
       }
 
       if (baseUrl == null) {
@@ -159,6 +184,7 @@ public PluggyClient build() {
       }
 
       OkHttpClient httpClient = buildOkHttpClient(baseUrl);
+
       Retrofit retrofit = new Retrofit.Builder()
         .baseUrl(baseUrl)
         .validateEagerly(true)
@@ -199,7 +225,7 @@ public String authenticate() throws IOException {
     RequestBody body = RequestBody.create(jsonBody, mediaType);
 
     Request request = new Request.Builder()
-      .url(this.baseUrl + this.authUrlPath)
+      .url(this.baseUrl + AUTH_URL_PATH)
       .post(body)
       .addHeader("content-type", "application/json")
       .addHeader("cache-control", "no-cache")
@@ -218,6 +244,7 @@ public String authenticate() throws IOException {
       assertNotNull(responseBody, "response.body()");
       authResponse = gson.fromJson(responseBody.string(), AuthResponse.class);
     }
+
     return authResponse.getApiKey();
   }
 

src/main/java/ai/pluggy/client/auth/ApiKeyAuthInterceptor.java

@@ -30,12 +30,16 @@ public class ApiKeyAuthInterceptor implements Interceptor {
 
   private TokenProvider tokenProvider;
 
+  public ApiKeyAuthInterceptor(String authUrl, String clientId, String clientSecret) {
+    this(authUrl, clientId, clientSecret, new TokenProvider());
+  }
+
   public ApiKeyAuthInterceptor(String authUrl, String clientId, String clientSecret,
     TokenProvider tokenProvider) {
     assertNotNull(clientId, "clientId");
-    assertNotNull(clientId, "clientSecret");
-    assertNotNull(clientId, "authUrl");
-    assertNotNull(clientId, "tokenProvider");
+    assertNotNull(clientSecret, "clientSecret");
+    assertNotNull(authUrl, "authUrl");
+    assertNotNull(tokenProvider, "tokenProvider");
     this.authUrl = authUrl;
     this.clientId = clientId;
     this.clientSecret = clientSecret;
@@ -91,10 +95,13 @@ private Request requestWithAuth(Request originalRequest, String apiKey) {
 
   private Response proceedWithAuthRetry(@NotNull Chain chain, Request originalRequest)
     throws IOException {
+    // attempt to proceed with original request
     Response response = chain.proceed(originalRequest);
+
+    // check auth errors
     boolean isResponseAuthError = response.code() != 403 && response.code() != 401;
     if (isResponseAuthError) {
-      // no auth problems -> response OK
+      // no auth problems -> response was OK
       return response;
     }
 

src/main/java/ai/pluggy/client/request/DateFilters.java

@@ -0,0 +1,85 @@
+package ai.pluggy.client.request;
+
+import static ai.pluggy.utils.Asserts.assertNotNull;
+import static ai.pluggy.utils.Asserts.assertValidDateString;
+
+import java.time.format.DateTimeFormatter;
+import java.util.HashMap;
+
+public class TransactionsSearchRequest extends HashMap<String, Object> {
+
+  public static final DateTimeFormatter DATE_PARAM_FORMAT = DateTimeFormatter.ISO_DATE;
+
+  /**
+   * @param fromDate String - from date in 'YYYY-MM-DD' format
+   * @return this instance, useful to continue adding params
+   */
+  public TransactionsSearchRequest from(String fromDate) {
+    validateDateString(fromDate, "from");
+    put("from", fromDate);
+    return this;
+  }
+
+  /**
+   * @param fromDate String - from date in 'YYYY-MM-DD' format
+   * @return this instance, useful to continue adding params
+   */
+  public TransactionsSearchRequest to(String fromDate) {
+    validateDateString(fromDate, "to");
+    put("to", fromDate);
+    return this;
+  }
+
+  /**
+   * @param page Integer - page number to fetch, starting at page=1.
+   * @return this instance, useful to continue adding params
+   */
+  public TransactionsSearchRequest page(Integer page) {
+    assertNotNull(page, "page");
+    put("page", page);
+    return this;
+  }
+
+  /**
+   * @param pageSize Integer - page size value, indicates max items to fetch per page.
+   * @return this instance, useful to continue adding params
+   */
+  public TransactionsSearchRequest pageSize(Integer pageSize) {
+    assertNotNull(pageSize, "pageSize");
+    put("pageSize", pageSize);
+    return this;
+  }
+
+
+  private void validateDateString(String dateString, String name) {
+    assertValidDateString(dateString, DATE_PARAM_FORMAT, name);
+  }
+
+  public Integer getPage() {
+    if (!containsKey("page")) {
+      return null;
+    }
+    return (Integer) get("page");
+  }
+
+  public Integer getPageSize() {
+    if (!containsKey("pageSize")) {
+      return null;
+    }
+    return (Integer) get("pageSize");
+  }
+
+  public String getFrom() {
+    if (!containsKey("from")) {
+      return null;
+    }
+    return (String) get("from");
+  }
+  
+  public String getTo() {
+    if (!containsKey("to")) {
+      return null;
+    }
+    return (String) get("to");
+  }
+}

src/main/java/ai/pluggy/client/request/TransactionsSearchRequest.java

@@ -1,5 +1,8 @@
 package ai.pluggy.utils;
 
+import java.time.LocalDate;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeParseException;
 import okhttp3.HttpUrl;
 
 public abstract class Asserts {
@@ -21,7 +24,7 @@ public static void assertNotNull(Object value, String name) {
    * Asserts that a value is a valid URL.
    *
    * @param value the value to check.
-   * @param name the name of the parameter, used when creating the exception message.
+   * @param name  the name of the parameter, used when creating the exception message.
    * @throws IllegalArgumentException if the value is null or is not a valid URL.
    */
   public static void assertValidUrl(String value, String name) {
@@ -30,4 +33,24 @@ public static void assertValidUrl(String value, String name) {
     }
   }
 
+
+  /**
+   * Asserts that a value is a valid URL.
+   *
+   * @param value the value to check.
+   * @param name  the name of the parameter, used when creating the exception message.
+   * @throws IllegalArgumentException if the value is null or is not a valid URL.
+   */
+  public static void assertValidDateString(String value, DateTimeFormatter dateFormat,
+    String name) {
+    String invalidValueErrorMsg = String.format(
+      "Invalid date string format '%s' for field '%s', expected format: '%s'!",
+      value, name, dateFormat);
+
+    try {
+      LocalDate.parse(value, dateFormat);
+    } catch (DateTimeParseException e) {
+      throw new IllegalArgumentException(invalidValueErrorMsg);
+    }
+  }
 }