Release 1.0.0-beta05 (#90)

Added support to List user balance
Updated documentation
Enhancements

Author: jsaini-hw

CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+[1.0.0-beta05](https://github.com/hyperwallet/hyperwallet-android-sdk/releases/tag/1.0.0-beta05)
+-------------------
+* Added support to list User Balance
+* Updated documentation
+
 [1.0.0-beta04](https://github.com/hyperwallet/hyperwallet-android-sdk/releases/tag/1.0.0-beta04)
 -------------------
 * Added support to create transfers

README.md

@@ -21,7 +21,7 @@ allprojects {
         mavenLocal()
     }
 
-    project.version = "1.0.0-beta04"
+    project.version = "1.0.0-beta05"
 }
 
 task clean(type: Delete) {

build.gradle

@@ -51,6 +51,10 @@ task javadocs(type: Javadoc) {
     source = android.sourceSets.main.java.srcDirs
     classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
     failOnError false
+    options.addStringOption 'Xdoclint:none', '-quiet'
+    options.addStringOption 'Xmaxwarns', '1'
+    options.addStringOption 'Xmaxerrs', '1'
+    options.links "https://docs.oracle.com/javase/8/docs/api"
 }
 
 task javadocsJar(type: Jar, dependsOn: javadocs) {

core/build.gradle

@@ -38,8 +38,13 @@
 import java.util.Date;
 import java.util.concurrent.TimeUnit;
 
-class Configuration {
+/**
+ * Authorized user's session {@code Configuration}
+ */
+public class Configuration {
 
+    private static final String INSIGHT_API_URI = "insights-uri";
+    private static final String ENVIRONMENT = "environment";
     private static final String JWT_EXP = "exp";
     private static final String JWT_IAT = "iat";
     private static final String JWT_ISS = "iss";
@@ -57,7 +62,14 @@ class Configuration {
     private String mRestUri;
     private String mUserToken;
     private long mExpireOnBootTime;
-
+    private String mInsightApiUri;
+    private String mEnvironment;
+
+    /**
+     * Construct {@Configuration} with Authentication token specified
+     *
+     * @param token authentication token
+     */
     public Configuration(@NonNull final String token) throws JSONException {
         if (token.isEmpty()) {
             throw new IllegalArgumentException();
@@ -66,34 +78,72 @@ public Configuration(@NonNull final String token) throws JSONException {
         parseAuthenticationToken();
     }
 
+    /**
+     * @return authentication token assigned to this {@code Configuration}
+     */
     public String getAuthenticationToken() {
         return mAuthenticationToken;
     }
 
+    /**
+     * @return creation {@link Date} of this {@code Configuration}
+     */
     public Date getCreatedOn() {
         return new Date(mCreatedOn);
     }
 
+    /**
+     * @return expiration {@link Date} of this {@code Configuration}
+     */
     public Date getExpiresOn() {
         return new Date(mExpiresOn);
     }
 
+    /**
+     * @return GraphQL Api Uri
+     */
     public String getGraphQlUri() {
         return mGraphQlUri;
     }
 
+    /**
+     * @return Program token that this {@code Configuration} is linked
+     */
     public String getProgramToken() {
         return mProgramToken;
     }
 
+    /**
+     * @return Rest Api Uri
+     */
     public String getRestUri() {
         return mRestUri;
     }
 
+    /**
+     * @return User token that this {@code Configuration} is linked
+     */
     public String getUserToken() {
         return mUserToken;
     }
 
+    /**
+     * @return Insight Api Uri
+     */
+    public String getInsightApiUri() {
+        return mInsightApiUri;
+    }
+
+    /**
+     * @return Platform environment information
+     */
+    public String getEnvironment() {
+        return mEnvironment;
+    }
+
+    /**
+     * @return {@code True} if and only if this {@code Configuration} is not stale; otherwise {@code False}
+     */
     public boolean isStale() {
         return SystemClock.elapsedRealtime() >= mExpireOnBootTime - STALE_PERIOD;
     }
@@ -129,6 +179,7 @@ private void parsePayload(String payload) throws JSONException {
         mUserToken = jsonObject.getString(JWT_SUB);
         long tokenLifespan = mExpiresOn - mCreatedOn;
         mExpireOnBootTime = SystemClock.elapsedRealtime() + tokenLifespan;
+        mEnvironment = jsonObject.optString(ENVIRONMENT);
+        mInsightApiUri = jsonObject.optString(INSIGHT_API_URI);
     }
-
 }

core/src/main/java/com/hyperwallet/android/Configuration.java

@@ -20,13 +20,13 @@
 import androidx.annotation.RestrictTo;
 import androidx.annotation.StringRes;
 
-import com.hyperwallet.android.exception.AuthenticationTokenProviderException;
+import com.hyperwallet.android.exception.HyperwalletAuthenticationTokenProviderException;
 import com.hyperwallet.android.exception.HyperwalletException;
 import com.hyperwallet.android.exception.HyperwalletGqlException;
 import com.hyperwallet.android.exception.HyperwalletJsonParseException;
 import com.hyperwallet.android.exception.HyperwalletRestException;
-import com.hyperwallet.android.model.HyperwalletError;
-import com.hyperwallet.android.model.HyperwalletErrors;
+import com.hyperwallet.android.model.Error;
+import com.hyperwallet.android.model.Errors;
 import com.hyperwallet.android.sdk.R;
 
 import org.json.JSONException;
@@ -53,14 +53,14 @@ public final class ExceptionMapper {
     public static final String EC_UNEXPECTED_EXCEPTION = "EC_UNEXPECTED_EXCEPTION";
 
     /**
-     * Converts a {@code HyperwalletException} containing a {@link HyperwalletErrors} object that is derived from the
+     * Converts a {@code HyperwalletException} containing a {@link Errors} object that is derived from the
      * {@code Exception} parameter or the REST/GraphQL response.
      *
      * <p>If an exception does not have a mapping defined the exception is created with the default error code,
      * {@code "EC_UNEXPECTED_EXCEPTION"}.</p>
      *
      * @param exception the {@code Exception} to be converted
-     * @return a {@code HyperwalletException} containing a {code HyperwalletErrors} object
+     * @return a {@code HyperwalletException} containing a {code Errors} object
      */
     public static HyperwalletException toHyperwalletException(@NonNull final Exception exception) {
         if (exception instanceof HyperwalletGqlException) {
@@ -75,7 +75,7 @@ public static HyperwalletException toHyperwalletException(@NonNull final Excepti
             return initHyperwalletException(R.string.json_exception, EC_JSON_EXCEPTION, exception);
         } else if (exception instanceof HyperwalletJsonParseException) {
             return initHyperwalletException(R.string.json_parse_exception, EC_JSON_PARSE_EXCEPTION, exception);
-        } else if (exception instanceof AuthenticationTokenProviderException) {
+        } else if (exception instanceof HyperwalletAuthenticationTokenProviderException) {
             return initHyperwalletException(R.string.authentication_token_provider_exception,
                     EC_AUTHENTICATION_TOKEN_PROVIDER_EXCEPTION, exception);
         } else {
@@ -85,10 +85,10 @@ public static HyperwalletException toHyperwalletException(@NonNull final Excepti
 
     private static HyperwalletException initHyperwalletException(@StringRes int stringResourceId,
             @NonNull final String code, @NonNull final Throwable throwable) {
-        HyperwalletError error = new HyperwalletError(stringResourceId, code);
-        List<HyperwalletError> errorList = new ArrayList<>();
+        Error error = new Error(stringResourceId, code);
+        List<Error> errorList = new ArrayList<>();
         errorList.add(error);
-        HyperwalletErrors errors = new HyperwalletErrors(errorList);
+        Errors errors = new Errors(errorList);
         return new HyperwalletException(throwable, errors);
     }
 }

core/src/main/java/com/hyperwallet/android/ExceptionMapper.java

@@ -23,7 +23,7 @@
 import com.hyperwallet.android.listener.HyperwalletListener;
 import com.hyperwallet.android.model.TypeReference;
 import com.hyperwallet.android.model.graphql.error.GqlErrors;
-import com.hyperwallet.android.model.graphql.query.HyperwalletGqlQuery;
+import com.hyperwallet.android.model.graphql.query.GqlQuery;
 import com.hyperwallet.android.util.HttpClient;
 import com.hyperwallet.android.util.HttpMethod;
 import com.hyperwallet.android.util.JsonUtils;
@@ -33,19 +33,41 @@
 import java.io.IOException;
 import java.lang.reflect.InvocationTargetException;
 
+/**
+ * {@code GqlTransaction} HTTP transaction service that sends request
+ * to Hyperwallet GQL platform api
+ */
 class GqlTransaction extends HttpTransaction {
 
+    /**
+     * Construct a {@code GqlTransaction} object based on specified required parameters
+     *
+     * @param uri                 GQL uri
+     * @param body                request query information
+     * @param authenticationToken authentication token assigned during authentication flow
+     * @param hyperwalletListener callback information please refer to {@link HyperwalletListener}
+     * @param typeReference       The class type reference to use in order to deserialize response into Hyperwallet SDK
+     *                            object
+     */
     private GqlTransaction(@NonNull final String uri, @NonNull final String body,
-            @NonNull final HyperwalletListener hyperwalletListener, @NonNull final TypeReference typeReference) {
+            @NonNull final String authenticationToken, @NonNull final HyperwalletListener hyperwalletListener,
+            @NonNull final TypeReference typeReference) {
         super(HttpMethod.POST, uri, typeReference, hyperwalletListener);
+        addHeader(HTTP_HEADER_AUTHORIZATION, AUTHENTICATION_STRATEGY + authenticationToken);
         setPayload(body);
     }
 
+    /**
+     * Refer to {@link HttpTransaction#performRequest(HttpClient)}
+     */
     @Override
     protected int performRequest(final @NonNull HttpClient client) throws IOException {
         return client.post(getPayload());
     }
 
+    /**
+     * Refer to {@link HttpTransaction#handleErrors(int, String)}
+     */
     @Override
     protected void handleErrors(final int responseCode, @NonNull final String response) throws JSONException,
             InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException {
@@ -54,22 +76,33 @@ protected void handleErrors(final int responseCode, @NonNull final String respon
         onFailure(new HyperwalletGqlException(gqlErrors));
     }
 
-    protected final static class Builder<T> {
-        private final HyperwalletGqlQuery gqlQuery;
+    /**
+     * Builder for {@link GqlTransaction}
+     */
+    protected static final class Builder<T> {
+        private final GqlQuery gqlQuery;
         private final TypeReference<T> typeReference;
         private final HyperwalletListener listener;
 
-        protected Builder(@NonNull final HyperwalletGqlQuery gqlQuery,
+        /**
+         * Construct a builder based on parameters
+         *
+         * @param gqlQuery GQL query information
+         * @param typeReference Response type generator result
+         * @param listener callback object; refer to {@link HyperwalletListener}
+         */
+        protected Builder(@NonNull final GqlQuery gqlQuery,
                 @NonNull final TypeReference<T> typeReference,
                 @NonNull final HyperwalletListener listener) {
             this.gqlQuery = gqlQuery;
             this.typeReference = typeReference;
             this.listener = listener;
         }
 
-        protected GqlTransaction build(@NonNull final String uri, @NonNull final String userToken) {
+        protected GqlTransaction build(@NonNull final String uri, @NonNull final String userToken,
+                @NonNull final String authenticationToken) {
             String query = gqlQuery.toQuery(userToken);
-            return new GqlTransaction(uri, query, listener, typeReference);
+            return new GqlTransaction(uri, query, authenticationToken, listener, typeReference);
         }
     }
 }

core/src/main/java/com/hyperwallet/android/GqlTransaction.java

@@ -16,11 +16,14 @@
  */
 package com.hyperwallet.android;
 
+import android.os.Build;
+
 import androidx.annotation.NonNull;
 import androidx.annotation.VisibleForTesting;
 
 import com.hyperwallet.android.listener.HyperwalletListener;
 import com.hyperwallet.android.model.TypeReference;
+import com.hyperwallet.android.sdk.BuildConfig;
 import com.hyperwallet.android.util.HttpClient;
 import com.hyperwallet.android.util.HttpMethod;
 import com.hyperwallet.android.util.JsonUtils;
@@ -32,13 +35,19 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * {@code HttpTransaction} HTTP transaction service that sends request
+ * to Hyperwallet API platforms
+ */
 public abstract class HttpTransaction implements Runnable {
 
     protected static final String AUTHENTICATION_STRATEGY = "Bearer ";
     protected static final String HTTP_HEADER_AUTHORIZATION = "Authorization";
     private static final String APPLICATION_JSON = "application/json";
     private static final String HTTP_HEADER_ACCEPT_KEY = "Accept";
     private static final String HTTP_HEADER_CONTENT_TYPE_KEY = "Content-Type";
+    private static final String HTTP_HEADER_USER_AGENT_KEY = "User-Agent";
+    private static final String HTTP_HEADER_USER_AGENT = "HyperwalletSDK/Android/%s; App: HyperwalletSDK; Android: %s";
     private Map<String, String> mHeaderMap;
     private HyperwalletListener mListener;
     private HttpMethod mMethod;
@@ -48,6 +57,14 @@ public abstract class HttpTransaction implements Runnable {
     private String mUri;
     private TypeReference mTypeReference;
 
+    /**
+     * Construct a {@code HttpTransaction} object based from specified required parameters
+     *
+     * @param httpMethod    Http method to use; refer to {@link HttpMethod}
+     * @param uri           location of api
+     * @param typeReference Response type generator result
+     * @param httpListener  callback object; refer to {@link HyperwalletListener}
+     */
     public HttpTransaction(@NonNull final HttpMethod httpMethod, @NonNull final String uri,
             @NonNull final TypeReference typeReference,
             @NonNull final HyperwalletListener httpListener) {
@@ -60,8 +77,12 @@ public HttpTransaction(@NonNull final HttpMethod httpMethod, @NonNull final Stri
 
         addHeader(HTTP_HEADER_ACCEPT_KEY, APPLICATION_JSON);
         addHeader(HTTP_HEADER_CONTENT_TYPE_KEY, APPLICATION_JSON);
+        addHeader(HTTP_HEADER_USER_AGENT_KEY, getUserAgent());
     }
 
+    /**
+     * Background execution
+     */
     public void run() {
         try {
             HttpClient client = new HttpClient.Builder(mUri).path(mPath).putHeaders(getHeaders()).putQueries(
@@ -80,9 +101,27 @@ public void run() {
         }
     }
 
+    /**
+     * Process errors, if available, from the resulting HTTP request
+     *
+     * @param responseCode HTTP response code
+     * @param response Serialized HTTP response
+     * @throws JSONException
+     * @throws InvocationTargetException
+     * @throws NoSuchMethodException
+     * @throws InstantiationException
+     * @throws IllegalAccessException
+     */
     protected abstract void handleErrors(int responseCode, String response) throws JSONException,
             InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException;
 
+    /**
+     * Perform HTTP request
+     *
+     * @param client Http client to use for this operation {@link HttpClient}
+     * @return HTTP response code
+     * @throws IOException
+     */
     protected abstract int performRequest(HttpClient client) throws IOException;
 
     public HyperwalletListener getListener() {
@@ -166,4 +205,8 @@ public void run() {
             });
         }
     }
+
+    private String getUserAgent() {
+        return String.format(HTTP_HEADER_USER_AGENT, BuildConfig.VERSION_NAME, Build.VERSION.RELEASE);
+    }
 }