Merging version 1.0.2 to Master (#6)

* participant finished typing message in a conversation API and event (#4)

* foundation - moved foundation specific config to ComapiConfig class, extend Role builder APIs, Sender obj constructor added, APIs adjusted for chat module

* Foundation module - added messaging service method queryConversationEvents that fixes list of available events in the response. Messaging service method queryEvents has been deprecated.

(cherry picked from commit 07029b4)

* Added missing description getter in conversation.

* extended public MessageToSend obj API to allow injection of metadata by other modules

* added patch profile service API

* added eTags to conversation and profile socket events model

* moved isPublic conversation to base class

* Added new API for getting all conversations, the return type is extended with information about last sent event id, participant count and eTag per conversation.

* added event id to message sent response

* Added configuration to switch of FCM registration to avoid initialisation error if Firebase not configured. Added tests for patching profile.

* Updated Readme.

Author: MarcinSwierczek

COMAPI/foundation/src/main/java/com/comapi/BaseClient.java

@@ -116,8 +116,8 @@ public abstract class BaseClient<T> implements IClient<T> {
      * Initialise ComapiImpl client instance.
      *
      * @param application Application context.
-     * @param instance Client instance.
-     * @param adapter Observables to callbacks adapter.
+     * @param instance    Client instance.
+     * @param adapter     Observables to callbacks adapter.
      * @return Observable returning client instance.
      */
     <E extends BaseClient> Observable<E> initialise(@NonNull final Application application, @NonNull final E instance, @NonNull final CallbackAdapter adapter) {
@@ -138,7 +138,7 @@ public Observable<SessionData> call(Boolean state) {
                         }
                     })
                     .flatMap(session -> {
-                        if (state.get() == GlobalState.SESSION_ACTIVE) {
+                        if (state.get() == GlobalState.SESSION_ACTIVE && config.isFcmEnabled()) {
                             return instance.service.updatePushToken()
                                     .doOnNext(sessionComapiResultPair -> log.d("Push token updated"))
                                     .doOnError(throwable -> log.f("Error updating push token", throwable))
@@ -150,12 +150,12 @@ public SessionData call(Throwable throwable) {
                                         }
                                     });
                         }
-                        return Observable.just(session);
+                        return Observable.fromCallable(() -> session);
                     })
                     .map(result -> instance);
 
         } else if (state.get() >= GlobalState.INITIALISED) {
-            return Observable.just(instance);
+            return Observable.fromCallable(() -> instance);
         } else {
             return Observable.error(new ComapiException("Initialise in progress. Shouldn't be called twice. Ignoring."));
         }
@@ -165,7 +165,7 @@ public SessionData call(Throwable throwable) {
      * Performs basic initialisation.
      *
      * @param application Application application.
-     * @param adapter Observables to callbacks adapter.
+     * @param adapter     Observables to callbacks adapter.
      * @return Observable emitting True if initialisation ended successfully.
      */
     private Observable<Boolean> init(@NonNull final Application application, @NonNull final CallbackAdapter adapter) {
@@ -209,7 +209,14 @@ private Observable<Boolean> init(@NonNull final Application application, @NonNul
                 //services
                 service = new InternalService(application, adapter, dataMgr, pushMgr, config.getApiSpaceId(), application.getPackageName(), log);
                 RestApi restApi = service.initialiseRestClient(logConfig.getNetworkLevel().getValue(), baseURIs);
-                SessionController sessionController = service.initialiseSessionController(application, new SessionCreateManager(new AtomicBoolean()), pushMgr, state, config.getAuthenticator(), restApi, new Handler(mainLooper), listenerListAdapter);
+                SessionController sessionController = service.initialiseSessionController(application,
+                        new SessionCreateManager(new AtomicBoolean()),
+                        pushMgr,
+                        state,
+                        config.getAuthenticator(),
+                        restApi, new Handler(mainLooper),
+                        config.isFcmEnabled(),
+                        listenerListAdapter);
 
                 //sockets
                 SocketController socketController = service.initialiseSocketClient(sessionController, listenerListAdapter, baseURIs);

COMAPI/foundation/src/main/java/com/comapi/BaseConfig.java

@@ -43,10 +43,6 @@ public abstract class BaseConfig<T extends BaseConfig<T>> {
 
     protected String apiSpaceId;
 
-    protected IStateListener stateListener;
-
-    protected IProfileListener profileListener;
-
     protected CallbackAdapter callbackAdapter;
 
     protected int logSizeLimit;
@@ -55,6 +51,8 @@ public abstract class BaseConfig<T extends BaseConfig<T>> {
 
     private PushTokenProvider pushTokenProvider;
 
+    protected boolean fcmEnabled = true;
+
     /**
      * Gets Comapi ApiSpace identifier.
      *
@@ -91,24 +89,6 @@ PushMessageListener getPushMessageListener() {
         return pushMessageListener;
     }
 
-    /**
-     * Gets listener for SDK state changes.
-     *
-     * @return Listener for SDK state changes.
-     */
-    protected IStateListener getStateListener() {
-        return stateListener;
-    }
-
-    /**
-     * Gets listener for profile changes.
-     *
-     * @return Listener for profile changes.
-     */
-    protected IProfileListener getProfileListener() {
-        return profileListener;
-    }
-
     /**
      * Gets observables to callbacks adapter.
      *
@@ -145,6 +125,15 @@ PushTokenProvider getPushTokenProvider() {
         return pushTokenProvider;
     }
 
+    /**
+     * Is Firebase Cloud Messaging configuraed and initialised. If yes the SDK will register FCM token on the server.
+     *
+     * @return True if Firebase Cloud Messaging is configured and initialised
+     */
+    boolean isFcmEnabled() {
+        return fcmEnabled;
+    }
+
     /**
      * Sets Comapi App Space identifier.
      *
@@ -189,30 +178,6 @@ public T authenticator(ComapiAuthenticator authenticator) {
         return getThis();
     }
 
-    /**
-     * Sets listener for SDK state changes.
-     *
-     * @param stateListener {@link StateListener} callback for state changes.
-     * @param <E>           Extends {@link StateListener}
-     * @return BaseURIs instance with new value set.
-     */
-    public <E extends StateListener> T stateListener(E stateListener) {
-        this.stateListener = stateListener;
-        return getThis();
-    }
-
-    /**
-     * Sets listener for profile changes.
-     *
-     * @param profileListener {@link ProfileListener} callback for profile changes.
-     * @param <E>             Extends {@link ProfileListener}
-     * @return BaseURIs instance with new value set.
-     */
-    public <E extends ProfileListener> T profileListener(E profileListener) {
-        this.profileListener = profileListener;
-        return getThis();
-    }
-
     /**
      * Sets total file size limit for internal logs.
      *
@@ -246,6 +211,16 @@ T pushTokenProvider(PushTokenProvider pushTokenProvider) {
         return getThis();
     }
 
+    /**
+     * Sets if Firebase Cloud Messaging is configured and initialised. If yes the SDK will register FCM token on the server.
+     *
+     * @param fcmEnabled True if Firebase Cloud Messaging is configured and initialised
+     */
+    public T fcmEnabled(boolean fcmEnabled) {
+        this.fcmEnabled = fcmEnabled;
+        return getThis();
+    }
+
     /**
      * Sets observables to callbacks adapter. By Overriding CallbackAdapter#adapt(Observable, Callback) method you can change
      * e.g. the threads on which SDK subscribe to observable when callback APIs version are being called. By default they subscribe on

COMAPI/foundation/src/main/java/com/comapi/ClientHelper.java

@@ -65,4 +65,9 @@ public static RxComapiService getComapiService(RxComapiClient client) {
     public static void resetShared() {
         RxComapi.reset();
     }
+
+    public static void resetChecks() {
+        Comapi.reset();
+        RxComapi.reset();
+    }
 }

COMAPI/foundation/src/main/java/com/comapi/ComapiClient.java

@@ -27,7 +27,7 @@
 import com.comapi.internal.CallbackAdapter;
 
 /**
- * ComapiImpl Client implementation for foundation SDK. Handles initialisation and stores all internal objects.
+ * Comapi Client implementation for foundation SDK. Handles initialisation and stores all internal objects.
  *
  * @author Marcin Swierczek
  * @since 1.0.0

COMAPI/foundation/src/main/java/com/comapi/ComapiConfig.java

@@ -21,6 +21,8 @@
 package com.comapi;
 
 import com.comapi.internal.IMessagingListener;
+import com.comapi.internal.IProfileListener;
+import com.comapi.internal.IStateListener;
 
 /**
  * Class describing the initial configuration for a {@link ComapiClient} instance.
@@ -32,6 +34,10 @@ public class ComapiConfig extends BaseConfig<ComapiConfig> {
 
     private IMessagingListener messagingListener;
 
+    private IStateListener stateListener;
+
+    private IProfileListener profileListener;
+
     /**
      * Gets Comapi message listener.
      *
@@ -41,6 +47,24 @@ IMessagingListener getMessagingListener() {
         return messagingListener;
     }
 
+    /**
+     * Gets listener for SDK state changes.
+     *
+     * @return Listener for SDK state changes.
+     */
+    IStateListener getStateListener() {
+        return stateListener;
+    }
+
+    /**
+     * Gets listener for profile changes.
+     *
+     * @return Listener for profile changes.
+     */
+    IProfileListener getProfileListener() {
+        return profileListener;
+    }
+
     /**
      * Sets Comapi message listener.
      *
@@ -52,6 +76,30 @@ public <E extends MessagingListener> ComapiConfig messagingListener(E messagingL
         return getThis();
     }
 
+    /**
+     * Sets listener for SDK state changes.
+     *
+     * @param stateListener {@link StateListener} callback for state changes.
+     * @param <E>           Extends {@link StateListener}
+     * @return BaseURIs instance with new value set.
+     */
+    public <E extends StateListener> ComapiConfig stateListener(E stateListener) {
+        this.stateListener = stateListener;
+        return getThis();
+    }
+
+    /**
+     * Sets listener for profile changes.
+     *
+     * @param profileListener {@link ProfileListener} callback for profile changes.
+     * @param <E>             Extends {@link ProfileListener}
+     * @return BaseURIs instance with new value set.
+     */
+    public <E extends ProfileListener> ComapiConfig profileListener(E profileListener) {
+        this.profileListener = profileListener;
+        return getThis();
+    }
+
     @Override
     protected ComapiConfig getThis() {
         return this;

COMAPI/foundation/src/main/java/com/comapi/MessagingListener.java

@@ -28,6 +28,7 @@
 import com.comapi.internal.network.model.events.conversation.ParticipantAddedEvent;
 import com.comapi.internal.network.model.events.conversation.ParticipantRemovedEvent;
 import com.comapi.internal.network.model.events.conversation.ParticipantTypingEvent;
+import com.comapi.internal.network.model.events.conversation.ParticipantTypingOffEvent;
 import com.comapi.internal.network.model.events.conversation.ParticipantUpdatedEvent;
 import com.comapi.internal.network.model.events.conversation.message.MessageDeliveredEvent;
 import com.comapi.internal.network.model.events.conversation.message.MessageReadEvent;
@@ -118,4 +119,10 @@ public void onConversationUndeleted(ConversationUndeleteEvent event) {}
      */
     public void onParticipantIsTyping(ParticipantTypingEvent event) {}
 
+    /**
+     * Dispatch participant stopped typing event.
+     *
+     * @param event Event to dispatch.
+     */
+    public void onParticipantTypingOff(ParticipantTypingOffEvent event) {}
 }

COMAPI/foundation/src/main/java/com/comapi/RxComapiClient.java

@@ -44,7 +44,7 @@ public class RxComapiClient extends BaseClient<RxServiceAccessor> {
      *
      * @param config ComapiImpl configuration.
      */
-    RxComapiClient(final ComapiConfig config) {
+    protected RxComapiClient(final ComapiConfig config) {
         super(config);
     }
 
@@ -106,7 +106,7 @@ public void clean(@NonNull Context context) {
      *
      * @return Internal logger.
      */
-    Logger getLogger() {
+    protected Logger getLogger() {
         return super.getLogger();
     }
 
@@ -119,7 +119,7 @@ void addLifecycleListener(LifecycleListener listener) {
         super.addLifecycleListener(listener);
     }
 
-    RxComapiService getComapiService() {
+    protected RxComapiService getComapiService() {
         return service;
     }
 }