Refactored Conversation node names.

Author: FranRiadigos

README.md

@@ -10,7 +10,7 @@
 Part of the [Voice User Interaction SDK]().
 
 The library wraps and combines single platform resources and builds 
-a **Software Component** capable of create a communication flow with ease.
+a _Software Component_ capable of create a communication flow between a devices and a user with ease.
 
 Besides, it also lets you choose between the following providers:
 like Android, Google Cloud, 
@@ -27,6 +27,10 @@ like Android, Google Cloud,
 
 ## Why choosing this library?
 
+The **Conversational Flow Component** is based on [Directed Graph](https://en.wikipedia.org/wiki/Directed_graph) 
+which also allows [Directed Cycles](https://en.wikipedia.org/wiki/Cycle_(graph_theory)) 
+to create connected nodes that build a consistent flow.
+
 Some devices don't have configured the resources you need to run a conversation in your app, 
 a developer needs to learn and test quite a lot before even to start coding for voice capabilities, noise is impacting 
 considerably the communication, android components force you to create a lot of boilerplate, some countries don't 
@@ -82,7 +86,7 @@ or update some changes on the current one at anytime.
 
 ```java
 // Optional
-conversationalFlowComponent.updateVoiceConfig(
+conversationalFlowComponent.updateConfiguration(
         builder -> builder.setBluetoothScoRequired(() -> preferences.connectToBluetoothSco()).build());
 ```
 
@@ -94,10 +98,7 @@ to user preferences.
 
 ### Create a Conversation
 
-The **Conversational Flow Component** is based on a [Directed Graph](https://en.wikipedia.org/wiki/Directed_graph) 
-which also allows [Directed Cycles](https://en.wikipedia.org/wiki/Cycle_(graph_theory)) 
-to create connected nodes that build a consistent flow.
-<br/>You can use the `ConversationalFlowComponent` at any context level, both in an Activity and a Service. 
+You can use the `ConversationalFlowComponent` at any context level, both in an Activity and a Service. 
 
 To create a conversation between the user and your app, you will create a set of `VoiceNode` objects and build a flow with them.
 
@@ -115,7 +116,7 @@ VoiceMessage question = VoiceMessage.newBuilder().setText("Do you need help?").b
 
 // We define the expected replies from the user.
 String[] expected = new String[]{ "Yes", "I think so", "Sure" };
-VoiceAction answers = VoiceAction.newBuilder().setExpectedResults(expected)
+VoiceMatch answers = VoiceMatch.newBuilder().setExpectedResults(expected)
                                  .setOnMatch(results -> conversation::next)
                                  .build();
 ```

app/src/main/java/com/chattylabs/demo/voice/MainActivity.java

@@ -34,7 +34,7 @@
 import com.chattylabs.sdk.android.voice.GoogleSpeechSynthesizer;
 import com.chattylabs.sdk.android.voice.Peripheral;
 import com.chattylabs.sdk.android.voice.TextFilterForUrl;
-import com.chattylabs.sdk.android.voice.VoiceConfig;
+import com.chattylabs.sdk.android.voice.ComponentConfig;
 
 import javax.inject.Inject;
 
@@ -130,17 +130,17 @@ public void onRequestPermissionsResult(int requestCode, @NonNull String[] permis
             if (PermissionsHelper.isPermissionGranted(grantResults)) {
                 serialThread.addTask(() -> {
                     //component = ConversationalFlowModule.provideComponent();
-                    component.updateVoiceConfig(builder ->
+                    component.updateConfiguration(builder ->
                             builder .setGoogleCredentialsResourceFile(() -> R.raw.credential)
                                     .setRecognizerServiceType(() ->
                                             ADDON_TYPE == R.id.addon_android ?
-                                                    VoiceConfig.RECOGNIZER_SERVICE_ANDROID_BUILTIN :
-                                                    VoiceConfig.RECOGNIZER_SERVICE_ANDROID_BUILTIN
+                                                    ComponentConfig.RECOGNIZER_SERVICE_ANDROID_BUILTIN :
+                                                    ComponentConfig.RECOGNIZER_SERVICE_ANDROID_BUILTIN
                                     )
                                     .setSynthesizerServiceType(() ->
                                             ADDON_TYPE == R.id.addon_android ?
-                                                    VoiceConfig.SYNTHESIZER_SERVICE_ANDROID_BUILTIN :
-                                                    VoiceConfig.SYNTHESIZER_SERVICE_GOOGLE_BUILTIN)
+                                                    ComponentConfig.SYNTHESIZER_SERVICE_ANDROID_BUILTIN :
+                                                    ComponentConfig.SYNTHESIZER_SERVICE_GOOGLE_BUILTIN)
                                     .build());
                     component.setup(this, status -> {
                         if (status.isAvailable()) {
@@ -331,7 +331,7 @@ private void initViews() {
                 Toast.makeText(this, "Not connected to a Bluetooth device", Toast.LENGTH_LONG).show();
                 return;
             }
-            component.updateVoiceConfig(
+            component.updateConfiguration(
                     builder -> {
                         builder.setBluetoothScoRequired(() ->
                                 peripheral.get(Peripheral.Type.BLUETOOTH).isConnected() && isChecked);

sdk-addon-android-speech/src/main/java/com/chattylabs/sdk/android/voice/AndroidSpeechRecognizer.java

@@ -20,21 +20,12 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.locks.ReentrantLock;
 
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.MIN_VOICE_RECOGNITION_TIME_LISTENING;
 import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.OnRecognizerError;
 import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.OnRecognizerMostConfidentResult;
 import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.OnRecognizerPartialResults;
 import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.OnRecognizerReady;
 import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.OnRecognizerResults;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RECOGNIZER_AFTER_PARTIALS_ERROR;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RECOGNIZER_EMPTY_RESULTS_ERROR;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RECOGNIZER_LOW_SOUND_ERROR;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RECOGNIZER_NO_SOUND_ERROR;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RECOGNIZER_RETRY_ERROR;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RECOGNIZER_STOPPED_TOO_EARLY_ERROR;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RECOGNIZER_UNAVAILABLE_ERROR;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RECOGNIZER_UNKNOWN_ERROR;
-import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RecognizerListenerContract;
+import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.RecognizerListener;
 import static com.chattylabs.sdk.android.voice.ConversationalFlowComponent.selectMostConfidentResult;
 
 public final class AndroidSpeechRecognizer implements ConversationalFlowComponent.SpeechRecognizer {
@@ -49,12 +40,12 @@ public final class AndroidSpeechRecognizer implements ConversationalFlowComponen
 
     // Resources
     private final Application application;
-    private final VoiceConfig config;
+    private final ComponentConfig config;
     private final AndroidHandler mainHandler;
     private final AndroidAudioHandler audioHandler;
     private final BluetoothSco bluetoothSco;
     private final Intent speechRecognizerIntent;
-    private final SpeechRecognizerCreator recognizerCreator;
+    private final SpeechRecognizerCreator<android.speech.SpeechRecognizer> recognizerCreator;
     private final ExecutorService executorService;
     private SpeechRecognizer speechRecognizer;
 
@@ -98,7 +89,7 @@ public void run() {
                     });
                 }
             };
-            timeout.schedule(task, MIN_VOICE_RECOGNITION_TIME_LISTENING * 3);
+            timeout.schedule(task, RecognizerListener.MIN_VOICE_RECOGNITION_TIME_LISTENING * 3);
         }
 
         private void cleanup() {
@@ -134,7 +125,8 @@ public void onReadyForSpeech(Bundle params) {
         public void onError(int error) {
             logger.e(TAG, "ANDROID VOICE - error: " + getErrorType(error));
             // We consider 2 sec as timeout for non speech
-            boolean stoppedTooEarly = (System.currentTimeMillis() - elapsedTime) < ConversationalFlowComponent.MIN_VOICE_RECOGNITION_TIME_LISTENING;
+            boolean stoppedTooEarly = (System.currentTimeMillis() - elapsedTime) <
+                    ConversationalFlowComponent.RecognizerListener.MIN_VOICE_RECOGNITION_TIME_LISTENING;
             // Start checking for the error
             OnRecognizerError errorListener = getOnError();
             int soundLevel = getSoundLevel();
@@ -143,27 +135,27 @@ public void onError(int error) {
             cancel();
             if (errorListener != null) {
                 if (needRetry(error)) {
-                    errorListener.execute(RECOGNIZER_UNAVAILABLE_ERROR, error);
+                    errorListener.execute(RecognizerListener.RECOGNIZER_UNAVAILABLE_ERROR, error);
                 }
                 else if (stoppedTooEarly) {
-                    errorListener.execute(RECOGNIZER_STOPPED_TOO_EARLY_ERROR, error);
+                    errorListener.execute(RecognizerListener.RECOGNIZER_STOPPED_TOO_EARLY_ERROR, error);
                 }
                 else if (soundLevel == NO_SOUND) {
-                    errorListener.execute(RECOGNIZER_NO_SOUND_ERROR, error);
+                    errorListener.execute(RecognizerListener.RECOGNIZER_NO_SOUND_ERROR, error);
                 }
                 else if (soundLevel == LOW_SOUND) {
-                    errorListener.execute(RECOGNIZER_LOW_SOUND_ERROR, error);
+                    errorListener.execute(RecognizerListener.RECOGNIZER_LOW_SOUND_ERROR, error);
                 }
                 else if (intents > 0) {
-                    errorListener.execute(RECOGNIZER_AFTER_PARTIALS_ERROR, error);
+                    errorListener.execute(RecognizerListener.RECOGNIZER_AFTER_PARTIALS_ERROR, error);
                 }
                 else if (isTryAgain()) {
                     errorListener.execute(error == SpeechRecognizer.ERROR_NO_MATCH ?
-                            RECOGNIZER_UNKNOWN_ERROR :
-                            RECOGNIZER_RETRY_ERROR, error);
+                            RecognizerListener.RECOGNIZER_UNKNOWN_ERROR :
+                            RecognizerListener.RECOGNIZER_RETRY_ERROR, error);
                 }
                 else { // Restore ANDROID VOICE
-                    errorListener.execute(RECOGNIZER_UNKNOWN_ERROR, error);
+                    errorListener.execute(RecognizerListener.RECOGNIZER_UNKNOWN_ERROR, error);
                 }
             }
         }
@@ -192,7 +184,7 @@ public void onResults(Bundle results) {
                 logger.e(TAG, "ANDROID VOICE - NO results");
                 OnRecognizerError listener = getOnError();
                 reset();
-                if (listener != null) listener.execute(RECOGNIZER_EMPTY_RESULTS_ERROR, -1);
+                if (listener != null) listener.execute(RecognizerListener.RECOGNIZER_EMPTY_RESULTS_ERROR, -1);
             }
         }
 
@@ -226,7 +218,7 @@ private boolean needRetry(int error) {
     // Log stuff
     private ILogger logger;
 
-    AndroidSpeechRecognizer(Application application, VoiceConfig configuration,
+    AndroidSpeechRecognizer(Application application, ComponentConfig configuration,
                             AndroidAudioHandler audioHandler, BluetoothSco bluetoothSco,
                             SpeechRecognizerCreator recognizerCreator, ILogger logger) {
         this.application = application;
@@ -322,7 +314,7 @@ public void shutdown() {
     }
 
     @Override
-    public void listen(RecognizerListenerContract... listeners) {
+    public void listen(RecognizerListener... listeners) {
         logger.i(TAG, "ANDROID VOICE - start listening");
         handleListeners(listeners);
         // Check whether Sco is connected or required
@@ -382,10 +374,10 @@ private void startListening() {
         });
     }
 
-    private void handleListeners(RecognizerListenerContract... listeners) {
+    private void handleListeners(RecognizerListener... listeners) {
         recognitionListener.reset();
         if (listeners != null && listeners.length > 0) {
-            for (RecognizerListenerContract item : listeners) {
+            for (RecognizerListener item : listeners) {
                 if (item instanceof OnRecognizerReady) {
                     recognitionListener.setOnReady((OnRecognizerReady) item);
                 }

sdk-addon-android-speech/src/main/java/com/chattylabs/sdk/android/voice/AndroidSpeechSynthesizer.java

@@ -44,7 +44,7 @@ public final class AndroidSpeechSynthesizer extends BaseSpeechSynthesizer {
     private OnSynthesizerSetup onSynthesizerSetup;
 
     AndroidSpeechSynthesizer(Application application,
-                             VoiceConfig configuration,
+                             ComponentConfig configuration,
                              AndroidAudioHandler audioHandler,
                              BluetoothSco bluetoothSco,
                              ILogger logger) {