Updated README and refactored some names.

Author: FranRiadigos

README.md

@@ -10,15 +10,15 @@
 
 Part of the [Voice & User Interaction SDK]().
 
-This library combines both native built-in resources and cloud services from various providers into 
-a Component capable to run reliably a Speech Synthesizer and a Voice Recognizer.
+This library combines both native built-in resources and cloud services into 
+a software component capable to run reliably a Speech Synthesizer and a Voice Recognizer.
 
-Besides, it provides an [Interface](#create-a-conversation) based on a 
+Besides, it provides an [Interface](#how-to-create-a-conversation) based on a 
 [Directed Graph](https://en.wikipedia.org/wiki/Directed_graph) 
 implementation with [Directed Cycles](https://en.wikipedia.org/wiki/Cycle_(graph_theory)) 
 that allows a developer to create connected nodes and build a consistent conversation flow between 
 a device and a user with ease. 
-<br/>**Consistency** here stands for the needless to code the flow using conditional statements or 
+<br/>_Consistency_ here stands for the needless to code the flow using conditional statements or 
 any extra state complexity while ensuring the conversation will behave as expected.
 
 It enables currently the following providers:
@@ -27,13 +27,13 @@ It enables currently the following providers:
     - [TextToSpeech](https://developer.android.com/reference/android/speech/tts/TextToSpeech)
     - [SpeechRecognizer](https://developer.android.com/reference/android/speech/SpeechRecognizer)
 - [Google Cloud](https://cloud.google.com/)
-    - [Speech-To-Text](https://cloud.google.com/speech-to-text/)
     - [Text-To-Speech](https://cloud.google.com/text-to-speech/)
+    - [Speech-To-Text](https://cloud.google.com/speech-to-text/)
 
     like Android, Google Cloud, 
     (Amazon, Wit.ai, Temi, Bing Speech, IBM, ...)
 
-<p align="center"><img src="assets/demo-sample.jpg" alt="demo-sample"/></p>
+<p align="center"><img src="art/demo-sample.jpg" alt="demo-sample"/></p>
 
 ## Why choosing this library?
 
@@ -95,7 +95,7 @@ conversation.start(question);
 
 There are different [Voice Nodes](), check the [wiki page]()
 
-<p align="center"><img src="assets/flow-sample.jpg" alt="flow-sample"/></p>
+<p align="center"><img src="art/flow-sample.jpg" alt="flow-sample"/></p>
 
 &nbsp;
 

demo/src/main/AndroidManifest.xml

@@ -13,18 +13,17 @@
         <meta-data android:name="net.hockeyapp.android.appIdentifier" android:value="${HOCKEYAPP_APP_ID}" />
         <activity android:name="com.chattylabs.demo.voice.BuildFromJsonActivity"
             android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
-            android:screenOrientation="portrait"
-            android:windowSoftInputMode="adjustResize">
+            android:screenOrientation="portrait">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
 
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
-        <activity android:name="com.chattylabs.demo.voice.CustomConversationActivity"
+        <activity android:name="com.chattylabs.demo.voice.TestTheComponentActivity"
             android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
             android:screenOrientation="portrait"
-            android:windowSoftInputMode="adjustResize"/>
+            android:windowSoftInputMode="adjustPan"/>
     </application>
 
 </manifest>

demo/src/main/java/com/chattylabs/demo/voice/BaseActivity.java

@@ -152,7 +152,7 @@ public boolean onOptionsItemSelected(MenuItem item) {
         switch (item.getItemId()) {
             case R.id.demo_custom_conversation:
                 ContextCompat.startActivity(this,
-                        new Intent(this, CustomConversationActivity.class), null);
+                        new Intent(this, TestTheComponentActivity.class), null);
                 return true;
             case R.id.demo_build_from_json:
                 ContextCompat.startActivity(this,

demo/src/main/java/com/chattylabs/demo/voice/BuildFromJsonActivity.java

@@ -2,15 +2,13 @@
 
 import android.annotation.SuppressLint;
 import android.os.Bundle;
-import android.support.constraint.ConstraintLayout;
-import android.view.Gravity;
+import android.text.Spanned;
 import android.view.ViewGroup;
-import android.widget.AbsListView;
 import android.widget.ArrayAdapter;
 import android.widget.Button;
 import android.widget.ListView;
-import android.widget.TextView;
 
+import com.chattylabs.sdk.android.common.HtmlUtils;
 import com.chattylabs.sdk.android.common.Tag;
 import com.chattylabs.sdk.android.voice.Conversation;
 import com.chattylabs.sdk.android.voice.ConversationFlow;
@@ -31,7 +29,7 @@ public class BuildFromJsonActivity extends BaseActivity {
 
     private static final String TAG = Tag.make(BuildFromJsonActivity.class);
 
-    private ArrayAdapter<String> listViewAdapter;
+    private ArrayAdapter<Spanned> listViewAdapter;
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
@@ -50,8 +48,7 @@ private void initViews() {
 
         ListView conversationListView = findViewById(R.id.conversation);
         listViewAdapter = new ArrayAdapter<>(this, R.layout.item_block,
-                R.id.conversation_item_text,
-                new ArrayList<>());
+                R.id.conversation_item_text, new ArrayList<>());
         listViewAdapter.setNotifyOnChange(true);
         conversationListView.setEmptyView(findViewById(R.id.empty_text));
         conversationListView.setAdapter(listViewAdapter);
@@ -76,9 +73,7 @@ private void loadConversation() {
                 VoiceMessage message = VoiceMessage.newBuilder()
                         .setText(text)
                         .setOnReady(() -> {
-                            runOnUiThread(() -> {
-                                listViewAdapter.add(text);
-                            });
+                            addIntoAdapter(text);
                         }).build();
 
                 VoiceMatch matches = null;
@@ -91,22 +86,22 @@ private void loadConversation() {
                     }
                     matches = VoiceMatch.newBuilder()
                             .setOnReady(() -> {
-                                listViewAdapter.add(dots);
+                                addIntoAdapter(dots);
                             })
                             .setExpectedResults(stringArray)
                             .setOnMatched(strings -> {
-                                listViewAdapter.remove(dots);
+                                removeLastFromAdapter();
                                 if (strings != null) {
-                                    listViewAdapter.add(strings.get(0));
+                                    addIntoAdapter("<b>You said:</b> " + strings.get(0));
                                     conversation.next();
                                 }
                             })
                             .build();
                     noMatches = VoiceMismatch.newBuilder()
                             .setOnNotMatched(strings -> {
-                                listViewAdapter.remove(dots);
-                                listViewAdapter.add("You said: " + strings);
-                                listViewAdapter.add("I did not expect that. Please try again!");
+                                removeLastFromAdapter();
+                                addIntoAdapter("<b>You said:</b> " + strings);
+                                addIntoAdapter("I was not expecting that. Please try again!");
                             }).build();
                 }
 
@@ -130,6 +125,20 @@ private void loadConversation() {
         }
     }
 
+    private void removeLastFromAdapter() {
+        runOnUiThread(() -> {
+            listViewAdapter.remove(listViewAdapter.getItem(
+                    listViewAdapter.getCount() - 1
+            ));
+        });
+    }
+
+    private void addIntoAdapter(String text) {
+        runOnUiThread(() -> {
+            listViewAdapter.add(HtmlUtils.from(text));
+        });
+    }
+
     public String loadJSONFromAsset() {
         String json = null;
         try {

demo/src/main/java/com/chattylabs/demo/voice/DemoApplication.java

@@ -32,7 +32,7 @@ static abstract class DemoModule {
         abstract ILogger provideLogger(ILoggerImpl logger);
 
         @ContributesAndroidInjector
-        abstract CustomConversationActivity conversationCreatorActivity();
+        abstract TestTheComponentActivity conversationCreatorActivity();
 
         @ContributesAndroidInjector
         abstract BuildFromJsonActivity mainActivity();

demo/src/main/java/com/chattylabs/demo/voice/CustomConversationActivity.java renamed to demo/src/main/java/com/chattylabs/demo/voice/TestTheComponentActivity.java

@@ -24,9 +24,9 @@
 import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.matches;
 
 
-public class CustomConversationActivity extends BaseActivity {
+public class TestTheComponentActivity extends BaseActivity {
 
-    private static final String TAG = Tag.make(CustomConversationActivity.class);
+    private static final String TAG = Tag.make(TestTheComponentActivity.class);
 
     // Constants
     private static final int CHECK = 3;
@@ -50,7 +50,7 @@ public class CustomConversationActivity extends BaseActivity {
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
-        setContentView(R.layout.activity_customize_the_component);
+        setContentView(R.layout.activity_test_the_component);
         peripheral = new Peripheral((AudioManager) getSystemService(AUDIO_SERVICE));
         initCommonViews();
         initViews();
@@ -102,10 +102,10 @@ private void representQueue(int index) {
                     }
                 }
                 String action = label + (item.first == LISTEN ? "" : " \"<i>" + text + "</i>\" ");
-                tx = new StringBuilder(tx == null || tx.length() == 0 ?
-                        action :
-                        tx.append((item.first == READ ? "<br/>" : "<br/>...then "))
-                          .append(action));
+                if (tx == null) {
+                    tx = new StringBuilder();
+                }
+                tx.append("<br/><br/> > ").append(action);
                 isChecking = item.first == CHECK;
             }
         }

demo/src/main/res/layout/activity_build_from_json.xml

@@ -7,23 +7,23 @@
     android:layout_height="match_parent"
     android:animateLayoutChanges="true"
     android:background="#ffffff"
-    tools:context="com.chattylabs.demo.voice.CustomConversationActivity">
+    tools:context="com.chattylabs.demo.voice.TestTheComponentActivity">
 
     <android.support.constraint.Guideline
         android:id="@+id/guideline"
         android:layout_width="0dp"
         android:layout_height="wrap_content"
         android:orientation="horizontal"
-        app:layout_constraintGuide_percent="0.65" />
+        app:layout_constraintGuide_percent="0.85" />
 
     <TextView
         android:id="@+id/empty_text"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:text="Choose an addon and press on proceed"
         app:layout_constraintBottom_toBottomOf="@+id/conversation"
-        app:layout_constraintStart_toStartOf="@+id/conversation"
         app:layout_constraintEnd_toEndOf="@+id/conversation"
+        app:layout_constraintStart_toStartOf="@+id/conversation"
         app:layout_constraintTop_toTopOf="@+id/conversation" />
 
     <ListView

demo/src/main/res/layout/activity_customize_the_component.xml renamed to demo/src/main/res/layout/activity_test_the_component.xml

@@ -6,14 +6,14 @@
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     android:animateLayoutChanges="true"
-    tools:context="com.chattylabs.demo.voice.CustomConversationActivity">
+    tools:context="com.chattylabs.demo.voice.TestTheComponentActivity">
 
     <android.support.constraint.Guideline
         android:id="@+id/guideline"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:orientation="horizontal"
-        app:layout_constraintGuide_percent="0.35" />
+        app:layout_constraintGuide_percent="0.55" />
 
     <TextView
         android:id="@+id/execution"
@@ -24,6 +24,7 @@
         android:padding="10dp"
         android:scrollbars="vertical"
         android:textColor="@android:color/darker_gray"
+        android:typeface="monospace"
         app:layout_constraintBottom_toTopOf="@+id/guideline"
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintStart_toStartOf="parent"

demo/src/main/res/menu/demos.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <menu xmlns:android="http://schemas.android.com/apk/res/android">
-    <item android:id="@+id/demo_custom_conversation"
-        android:title="Custom Conversation Activity"/>
     <item android:id="@+id/demo_build_from_json"
-        android:title="Build From Json Activity"/>
+        android:title="Build From Json"/>
+    <item android:id="@+id/demo_custom_conversation"
+        android:title="Test the Component"/>
 </menu>

demo/src/main/res/raw/demo_conversation.json

@@ -1,16 +1,16 @@
 [
   {
-    "message": "Hi!"
-  },
-  {
-    "message": "How are you?",
+    "message": "Hi! How are you doing today?",
     "results": ["good", "fine", "not bad"]
   },
   {
-    "message": "Good!. Are you ok if we keep talking?",
+    "message": "Good! Are you ok if we keep talking?",
     "results": ["yes", "sure", "no", "of course"]
   },
+  { "message": "Ok. I'm a voice synthesizer created to assist you." },
   {
-    "message": "Ok. I'm a bit lazy now, let's try next time."
-  }
+    "message": "Do you have any query so far?",
+    "results": ["yes", "sure", "no", "of course"]
+  },
+  { "message": "Ok. Let's keep that in mind in our next talk!" }
 ]

demo/src/main/res/values/arrays.xml

@@ -3,7 +3,7 @@
     <string-array name="actions">
         <item>Select and option&#8230;</item>
         <item>Read aloud&#8230;</item>
-        <item>Listen to any message</item>
+        <item>Listen&#8230;</item>
         <item>Check for&#8230;</item>
     </string-array>
     <string-array name="addons">

sdk-addon-android-speech/build.gradle

@@ -42,6 +42,7 @@ dependencies {
     api 'com.google.dagger:dagger:2.15'
     kapt 'com.google.dagger:dagger-compiler:2.15'
     // SDK
+    implementation 'com.chattylabs.sdk.android:common:+'
     api project(':sdk-conversational-flow-core')
 }
 

sdk-addon-google-speech/build.gradle

@@ -43,14 +43,12 @@ ext {
 
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
-
     // Dagger
     api 'com.google.dagger:dagger:2.15'
     kapt 'com.google.dagger:dagger-compiler:2.15'
-
     // SDK
+    implementation 'com.chattylabs.sdk.android:common:+'
     api project(':sdk-conversational-flow-core')
-
     // Google Cloud
     implementation "io.grpc:grpc-okhttp:$grpcVersion"
     implementation "com.google.cloud:google-cloud-texttospeech:0.55.0-beta"