Merge branch 'release/1.0.0.2' into 'develop'

Release/1.0.0.2

See merge request !3

Author: Stan Wijckmans

rest/build.gradle

@@ -8,19 +8,19 @@ android {
     defaultConfig {
         minSdkVersion 16
         targetSdkVersion 25
-        versionCode 1
-        versionName "1.0.0.0"
+        versionCode 3
+        versionName "1.0.1"
     }
 
     lintOptions {
-        abortOnError false
+        disable 'InvalidPackage'
     }
 }
 
 dependencies {
-    compile 'be.stannieman:commonservices:1.0.0.3'
+    compile 'be.stannieman:commonservices:1.0.1.0'
     compile 'com.android.volley:volley:1.0.0'
-    compile 'com.fasterxml.jackson.core:jackson-databind:2.8.6'
+    compile 'com.fasterxml.jackson.core:jackson-databind:2.8.7'
 }
 
 task createJavaDoc(type: Javadoc) {
@@ -34,14 +34,20 @@ task createJavaDocJar(type: Jar, dependsOn: createJavaDoc) {
     from createJavaDoc.destinationDir
 }
 
+task createSourcesJar(type: Jar) {
+    from android.sourceSets.main.java.srcDirs
+    classifier = 'sources'
+}
+
 publishing {
     publications {
         aar(MavenPublication) {
             groupId 'be.stannieman'
             artifactId 'rest'
-            version '1.0.0.0'
+            version '1.0.1'
             artifact "$buildDir\\outputs\\aar\\signed-${project.getName()}-release.aar"
             artifact createJavaDocJar
+            artifact createSourcesJar
 
             //generate pom nodes for dependencies
             pom.withXml {

rest/src/main/java/stannieman/rest/BasicAuthRestClient.java

@@ -13,7 +13,6 @@
 import stannieman.rest.models.ErrorResponseDataBase;
 import stannieman.rest.models.RequestProperties;
 import stannieman.rest.models.RestResult;
-import stannieman.rest.models.SuccessResponseDataBase;
 
 /**
  * A simple REST client that supports basic authentication.
@@ -24,73 +23,73 @@ public final class BasicAuthRestClient extends RestClientBase {
     private static final String BasicAuthHeaderValuePrefix = "Basic ";
     private final Map<String, String> authHeader;
 
-    BasicAuthRestClient(ObjectMapper objectMapper, RequestQueue requestQueue, Scheme schema, String host, int port, String apiBasePath, String endpointPath, long timeout, String userName, String password) {
+    BasicAuthRestClient(ObjectMapper objectMapper, RequestQueue requestQueue, Scheme schema, String host, int port, String apiBasePath, String endpointPath, long timeout, String username, String password) {
         super(objectMapper, requestQueue, schema, host, port, apiBasePath, endpointPath, timeout);
-        authHeader = getBasicAuthHeader(userName, password);
+        authHeader = getBasicAuthHeader(username, password);
     }
 
     @Override
-    public <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>> get(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
+    public <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>> get(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
         return doRequestWithAuthHeader(Request.Method.GET, requestProperties);
     }
 
     @Override
-    public <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>> post(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
+    public <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>> post(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
         return doRequestWithAuthHeader(Request.Method.POST, requestProperties);
     }
 
     @Override
-    public <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>> put(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
+    public <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>> put(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
         return doRequestWithAuthHeader(Request.Method.PUT, requestProperties);
     }
 
     @Override
-    public <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>> patch(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
+    public <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>> patch(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
         return doRequestWithAuthHeader(Request.Method.PATCH, requestProperties);
     }
 
     @Override
-    public <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> void getAsync(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
+    public <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> void getAsync(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
         doRequestWithAuthHeaderAsync(Request.Method.GET, requestProperties, requestResponseListener);
     }
 
     @Override
-    public <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> void postAsync(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
+    public <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> void postAsync(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
         doRequestWithAuthHeaderAsync(Request.Method.POST, requestProperties, requestResponseListener);
     }
 
     @Override
-    public <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> void putAsync(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
+    public <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> void putAsync(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
         doRequestWithAuthHeaderAsync(Request.Method.PUT, requestProperties, requestResponseListener);
     }
 
     @Override
-    public <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> void patchAsync(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
+    public <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> void patchAsync(RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
         doRequestWithAuthHeaderAsync(Request.Method.PATCH, requestProperties, requestResponseListener);
     }
 
-    private <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>> doRequestWithAuthHeader(int method, RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
+    private <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>> doRequestWithAuthHeader(int method, RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties) {
         return doRequest(method, requestProperties, requestProperties.getQueryParameters(), getHeadersWithAuthHeader(requestProperties.getHeaders()));
     }
 
-    private <SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> void doRequestWithAuthHeaderAsync(int method, RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
+    private <SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> void doRequestWithAuthHeaderAsync(int method, RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
         new DoRequestWithAuthHeaderAsyncTask<>(method, requestProperties, requestResponseListener).execute();
     }
 
-    private class DoRequestWithAuthHeaderAsyncTask<SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> extends DoRequestAsyncTaskBase<SuccessResponseDataType, ErrorResponseDataType> {
+    private class DoRequestWithAuthHeaderAsyncTask<SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> extends DoRequestAsyncTaskBase<SuccessResponseDataType, ErrorResponseDataType> {
         DoRequestWithAuthHeaderAsyncTask(int method, RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties, IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener) {
             super(method, requestProperties, requestResponseListener);
         }
 
         @Override
-        protected ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>> doInBackground(Void... voids) {
+        protected IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>> doInBackground(Void... voids) {
             return doRequestWithAuthHeader(method, requestProperties);
         }
     }
 
-    private Map<String, String> getBasicAuthHeader(String userName, String password) {
+    private Map<String, String> getBasicAuthHeader(String username, String password) {
         Map<String, String> basicAuthHeader = new HashMap<>();
-        basicAuthHeader.put(AuthHeaderKey, BasicAuthHeaderValuePrefix + Base64.encodeToString(String.format("%s:%s", userName, password).getBytes(), Base64.NO_WRAP));
+        basicAuthHeader.put(AuthHeaderKey, BasicAuthHeaderValuePrefix + Base64.encodeToString(String.format("%s:%s", username, password).getBytes(), Base64.NO_WRAP));
         return basicAuthHeader;
     }
 

rest/src/main/java/stannieman/rest/BasicAuthRestClientFactory.java

@@ -2,70 +2,40 @@
 
 import android.content.Context;
 
-import com.android.volley.RequestQueue;
-import com.android.volley.toolbox.Volley;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import stannieman.rest.models.BasicAuthRestClientFactoryConfig;
 
 /**
  * Factory that produces BasicAuthRestClients.
  */
-public final class BasicAuthRestClientFactory implements IRestClientFactory {
-    private final ObjectMapper objectMapper;
-    private final RequestQueue requestQueue;
-    private final Scheme scheme;
-    private final String host;
-    private final int port;
-    private final String apiBasePath;
-    private final long timeout;
-
-    private final String userName;
-    private final String password;
+public final class BasicAuthRestClientFactory extends RestClientFactoryBase implements IBasicAuthRestClientFactory {
+    private String username;
+    private String password;
 
     /**
-     * Constructor to create a factory with an existing object mapper and request queue.
-     * It is recommended to have only one object mapper and request queue in your application,
-     * so if you have more than one REST client factory you should to create them yourself
-     * and use this constructor to use the existing instances.
-     * @param objectMapper object mapper to map objects from and to JSON
-     * @param requestQueue Volley RequestQueue for performing requests
-     * @param scheme URI schema
-     * @param host REST server host
-     * @param port REST server port
-     * @param apiBasePath base path of the REST api
-     * @param timeout timeout for the requests
-     * @param userName user name for basic authentication
-     * @param password password for basic authentication
+     * Constructor to create a factory.
+     * @param context application context
      */
-    public BasicAuthRestClientFactory(ObjectMapper objectMapper, RequestQueue requestQueue, Scheme scheme, String host, int port, String apiBasePath, long timeout, String userName, String password) {
-        this.objectMapper = objectMapper;
-        this.requestQueue = requestQueue;
-        this.scheme = scheme;
-        this.host = host;
-        this.port = port;
-        this.apiBasePath = apiBasePath;
-        this.timeout = timeout;
-
-        this.userName = userName;
-        this.password = password;
+    public BasicAuthRestClientFactory(Context context) {
+        super(context);
     }
 
-    /**
-     * Constructor to create a factory without an existing object mapper and request queue.
-     * A new object mapper and request queue will be created for performing the REST calls.
-     * @param scheme URI schema
-     * @param host REST server host
-     * @param port REST server port
-     * @param apiBasePath base path of the REST api
-     * @param timeout timeout for the requests
-     * @param userName user name for basic authentication
-     * @param password password for basic authentication
-     */
-    public BasicAuthRestClientFactory(Context context, Scheme scheme, String host, int port, String apiBasePath, long timeout, String userName, String password) {
-        this(new ObjectMapper(), Volley.newRequestQueue(context), scheme, host, port, apiBasePath, timeout, userName, password);
+    @Override
+    public IRestClient getRestClient(String endpointPath) {
+        configLock.lock();
+        IRestClient client = new BasicAuthRestClient(objectMapper, requestQueue, scheme, host, port, apiBasePath, endpointPath, timeout, username, password);
+        configLock.unlock();
+
+        return client;
     }
 
     @Override
-    public IRestClient getRestClient(String endpointPath) {
-        return new BasicAuthRestClient(objectMapper, requestQueue, scheme, host, port, apiBasePath, endpointPath, timeout, userName, password);
+    public void loadConfig(BasicAuthRestClientFactoryConfig config) {
+        configLock.lock();
+
+        super.loadConfig(config);
+        username = config.getUsername();
+        password = config.getPassword();
+
+        configLock.unlock();
     }
 }

rest/src/main/java/stannieman/rest/DoRequestAsyncTaskBase.java

@@ -2,13 +2,12 @@
 
 import android.os.AsyncTask;
 
-import stannieman.commonservices.models.ServiceResult;
+import stannieman.commonservices.models.IHasDataAndSuccessState;
 import stannieman.rest.models.ErrorResponseDataBase;
 import stannieman.rest.models.RequestProperties;
 import stannieman.rest.models.RestResult;
-import stannieman.rest.models.SuccessResponseDataBase;
 
-abstract class DoRequestAsyncTaskBase<SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> extends AsyncTask<Void, Void, ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>>> {
+abstract class DoRequestAsyncTaskBase<SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> extends AsyncTask<Void, Void, IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>>> {
     final int method;
     private final IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType> requestResponseListener;
     final RequestProperties<SuccessResponseDataType, ErrorResponseDataType> requestProperties;
@@ -20,7 +19,7 @@ abstract class DoRequestAsyncTaskBase<SuccessResponseDataType extends SuccessRes
     }
 
     @Override
-    protected void onPostExecute(ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>> result) {
+    protected void onPostExecute(IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>> result) {
         requestResponseListener.onRequestResponse(result);
     }
 }

rest/src/main/java/stannieman/rest/IBasicAuthRestClientFactory.java

@@ -0,0 +1,7 @@
+package stannieman.rest;
+
+import stannieman.rest.models.BasicAuthRestClientFactoryConfig;
+
+public interface IBasicAuthRestClientFactory extends IRestClientFactory {
+    void loadConfig(BasicAuthRestClientFactoryConfig config);
+}

rest/src/main/java/stannieman/rest/IKeyAuthRestClientFactory.java

@@ -0,0 +1,7 @@
+package stannieman.rest;
+
+import stannieman.rest.models.KeyAuthRestClientFactoryConfig;
+
+public interface IKeyAuthRestClientFactory extends IRestClientFactory {
+    void loadConfig(KeyAuthRestClientFactoryConfig config);
+}

rest/src/main/java/stannieman/rest/IRequestResponseListener.java

@@ -1,19 +1,18 @@
 package stannieman.rest;
 
-import stannieman.commonservices.models.ServiceResult;
+import stannieman.commonservices.models.IHasDataAndSuccessState;
 import stannieman.rest.models.ErrorResponseDataBase;
-import stannieman.rest.models.SuccessResponseDataBase;
 import stannieman.rest.models.RestResult;
 
 /**
  * Interface defining a listener for the response of a REST call.
  * @param <SuccessResponseDataType> response data type for a successful request
  * @param <ErrorResponseDataType> response data type for an unsuccessful request
  */
-public interface IRequestResponseListener<SuccessResponseDataType extends SuccessResponseDataBase, ErrorResponseDataType extends ErrorResponseDataBase> {
+public interface IRequestResponseListener<SuccessResponseDataType, ErrorResponseDataType extends ErrorResponseDataBase> {
     /**
      * Called after an asynchronous REST call is finishes.
-     * @param result ServiceResult instance containing a RestResult instance which in turn contains the resulting info and data of the performed REST call
+     * @param result IHasDataAndSuccessState instance containing a RestResult instance which in turn contains the resulting info and data of the performed REST call
      */
-    void onRequestResponse(ServiceResult<RestResult<SuccessResponseDataType, ErrorResponseDataType>> result);
+    void onRequestResponse(IHasDataAndSuccessState<RestResult<SuccessResponseDataType, ErrorResponseDataType>> result);
 }