cleanup

Author: Igor Khomenko

samples/chat_bots/rivescript/config.js

@@ -5,16 +5,36 @@
  * by the command `npm i`
  */
 
-const CONFIG = require('./config').CONFIG;
 const QB = require('../../../src/qbMain.js');
 const RiveScript = require('rivescript');
 
-// Init RiveScript
+// In order to start develop you first Chat Bot you have to register new QuickBlox account and create your first application.
+// Go to https://quickblox.com/signup and get a QuickBlox account, then go to https://admin.quickblox.com/apps/new
+// and create your first application. Then put here Application ID, Authorization key, Authorization secret.
+// 
+// also
+//
+// Go to Users module in QuickBlox dashboard
+// (e.g. <your_app_id>/service/users https://admin.quickblox.com/apps/<your_app_id>/service/users) and create
+// new user for you chat bot. Then put here user's ID, password, login and full name.
+//
+const CONFIG = {
+    "appId": "13318",
+    "authKey": "WzrAY7vrGmbgFfP",
+    "authSecret": "xS2uerEveGHmEun",
+    "user": {
+        "id": "2740296",
+        "login": "qbot",
+        "password": "mehdoh00",
+        "fullname": "qbot"
+    }
+};
+
+// Init RiveScript logic
 var riveScriptGenerator = new RiveScript();
 
 function loadingDone(batch_num) {
     console.log(`[RiveScript] Batch #${batch_num} has finished loading!`);
-
     riveScriptGenerator.sortReplies();
 }
 
@@ -24,23 +44,21 @@ function loadingError(batch_num, error) {
 
 riveScriptGenerator.loadFile('replies.rive', loadingDone, loadingError);
 
-process.on('exit', function () {
-    console.log('The qbot is gone.');
-    QB.chat.disconnect();
-});
 
-
-/** Start fun */
+// Initialise QuickBlox
 QB.init(CONFIG.appId, CONFIG.authKey, CONFIG.authSecret);
 
 var qbListeners = {
+    // Contact list listener
     onSubscribeListener: function onSubscribeListener(userId) {
         console.log(`[QB] onSubscribeListener. Subscribe from ${userId}`);
 
         QB.chat.roster.confirm(userId, function() {
             console.log(`[QB] Confirm subscription from user ${userId}`);
         });
     },
+
+    // System messages listener
     onSystemMessageListener: function onSystemMessageListener(msg) {
         if(msg.extension.notification_type === '1'){
             console.log(`[QB] The user ${msg.userId} adds you to dialog`);
@@ -50,9 +68,12 @@ var qbListeners = {
             QB.chat.muc.join(roomJid);
         }
     },
+
+    // Chat messages listener
     onMessageListener: function onMessageListener(userId, msg) {
         var answer;
 
+        // process group chat messages
         if (msg.type == 'groupchat') {
 
             // - skip own messages in the group chat, don't replay to them
@@ -85,6 +106,8 @@ var qbListeners = {
 
                 QB.chat.send(QB.chat.helpers.getRoomJidFromDialogId(msg.dialog_id), answer);
             }
+
+        // process 1-1 messages
         } else if (msg.type == 'chat') {
             if(msg.body){
                 answer = {
@@ -101,40 +124,50 @@ var qbListeners = {
     }
  };
 
+// Create QuickBlox session
 QB.createSession({
-    login: CONFIG.user.name,
-    password: CONFIG.user.password
+  login: CONFIG.user.login,
+  password: CONFIG.user.password
 }, (createSessionError, res) => {
-        if(createSessionError) {
-            console.error('[QB] createSession is failed', JSON.stringify(createSessionError));
+    if(createSessionError) {
+        console.error('[QB] createSession is failed', JSON.stringify(createSessionError));
+        process.exit(1);
+    }
+
+    // Connect to Real-Time Chat
+    QB.chat.connect({
+        userId: CONFIG.user.id,
+        password: CONFIG.user.password
+    }, (chatConnectError) => {
+        if (chatConnectError) {
+            console.log('[QB] chat.connect is failed', JSON.stringify(chatConnectError));
             process.exit(1);
         }
 
-        QB.chat.connect({
-            userId: CONFIG.user.id,
-            password: CONFIG.user.password
-        }, (chatConnectError) => {
-            if (chatConnectError) {
-                console.log('[QB] chat.connect is failed', JSON.stringify(chatConnectError));
+        console.log('[QB] bot is up and running');
+
+        // Retireve all group chats where bot is in occupants list.
+        QB.chat.dialog.list({type: 2}, (dialogListError, dialogList) => {
+            if(dialogListError){
+                console.log('[QB] dialog.list is failed', JSON.stringify(dialogListError));
                 process.exit(1);
             }
 
-            console.log('[QB] bot is up and running');
-
-            QB.chat.dialog.list({type: 2}, (dialogListError, dialogList) => {
-                if(dialogListError){
-                    console.log('[QB] dialog.list is failed', JSON.stringify(dialogListError));
-                    process.exit(1);
-                }
-
-                dialogList.items.forEach((dialog) => {
-                    QB.chat.muc.join(dialog.xmpp_room_jid);
-                });
+            // Join bot's group chats
+            dialogList.items.forEach((dialog) => {
+                QB.chat.muc.join(dialog.xmpp_room_jid);
             });
-
-            QB.chat.onMessageListener = qbListeners.onMessageListener;
-            QB.chat.onSubscribeListener = qbListeners.onSubscribeListener;
-            QB.chat.onSystemMessageListener = qbListeners.onSystemMessageListener;
         });
-    }
+
+        // Add listeners
+        QB.chat.onMessageListener = qbListeners.onMessageListener;
+        QB.chat.onSubscribeListener = qbListeners.onSubscribeListener;
+        QB.chat.onSystemMessageListener = qbListeners.onSystemMessageListener;
+    });
+  }
 );
+
+process.on('exit', function () {
+    console.log('The qbot is gone.');
+    QB.chat.disconnect();
+});

samples/chat_bots/rivescript/index.js

@@ -2,6 +2,16 @@
 
 const QB = require('../../../src/qbMain.js');
 
+// In order to start develop you first Chat Bot you have to register new QuickBlox account and create your first application.
+// Go to https://quickblox.com/signup and get a QuickBlox account, then go to https://admin.quickblox.com/apps/new
+// and create your first application. Then put here Application ID, Authorization key, Authorization secret.
+//
+// also
+//
+// Go to Users module in QuickBlox dashboard
+// (e.g. <your_app_id>/service/users https://admin.quickblox.com/apps/<your_app_id>/service/users) and create
+// new user for you chat bot. Then put here user's ID, password and full name.
+//
 const CONFIG = {
     "appId": "13318",
     "authKey": "WzrAY7vrGmbgFfP",