add studio.getById

howdyai · Feb 15, 2018 · 7b9bfe5 · 7b9bfe5
1 parent ea226b5
commit 7b9bfe5
Show file tree

Hide file tree

Showing 4 changed files with 94 additions and 2 deletions.
diff --git a/changelog.md b/changelog.md
@@ -4,6 +4,11 @@
 
 [Want to contribute? Read our guide!](https://github.com/howdyai/botkit/blob/master/CONTRIBUTING.md)
 
+# 0.6.11
+
+* For Botkit Studio users, added `controller.studio.getById()` for loading scripts
+by their unique ID rather than by name or trigger. [Docs here](docs/readme-studio.md#controller-studio-getbyid)
+
 # 0.6.10
 
 * Add support for Cisco Jabber. Thanks to @qiongfangzhang and @panx981389 and their team at Cisco for the contribution!

diff --git a/docs/readme-studio.md b/docs/readme-studio.md
@@ -163,6 +163,31 @@ controller.studio.get(bot, 'hello', message.user, message.channel).then(function
 ```
 
 
+### controller.studio.getById()
+| Argument | Description
+|---  |---
+| bot   | A bot instance
+| id | The id of a script defined in Botkit Studio
+| user | the user id of the user having the conversation
+| channel | the channel id where the conversation is occurring
+
+`controller.studio.getById()` does the same thing as `get()`, but uses the scripts unique ID rather than it's name.
+
+While developers may still tap into the conversation as it is conducted using the [before](#controllerstudiobefore), [after](#controllerstudioafter), and [validate](#controllerstudiovalidate) hooks, it must first be activated using `convo.activate()` in the results of the promise returned by the function.
+
+This enables developers to add template variables to the conversation object before it sends its first message. Read about [using variables in messages](readme.md#using-variable-tokens-and-templates-in-conversation-threads)
+
+```javascript
+controller.studio.getById(bot, '5a7381d85d49c200142ed7bf', message.user, message.channel).then(function(convo) {
+    convo.setVar('date', new Date()); // available in message text as {{vars.date}}
+    convo.setVar('news', 'This is a news item!'); // ailable as {{vars.news}}
+
+    // crucial! call convo.activate to set it in motion
+    convo.activate();
+});
+```
+
+
 ### controller.studio.runTrigger()
 | Argument | Description
 |---  |---

diff --git a/lib/Studio.js b/lib/Studio.js
@@ -68,6 +68,14 @@ module.exports = function(controller) {
         return sdk.createScript(trigger, text);
     };
 
+    // load a script from the pro service
+    controller.studio.getScriptById = function(bot, id, user) {
+
+        var userHash = md5(user);
+        var sdk = new SDK(genConfig(bot));
+        return sdk.getScriptById(id, user);
+    };
+
     // load a script from the pro service
     controller.studio.getScript = function(bot, text, user) {
 
@@ -221,6 +229,60 @@ module.exports = function(controller) {
         });
     };
 
+    /* Fetch a script from Botkit Studio by id, but do not execute it.
+     * returns a promise that resolves when the conversation is loaded
+     * but developer still needs to call convo.activate() to put it in motion */
+    controller.studio.getById = function(bot, id, user, channel, original_message) {
+        var context = {
+            id: id,
+            user: user,
+            channel: channel,
+            raw_message: original_message ? original_message.raw_message : null,
+            original_message: original_message || null
+        };
+        return new Promise(function(resolve, reject) {
+            controller.studio.getScriptById(bot, id, user).then(function(command) {
+                console.log('RESULTS', command);
+                if (command !== {} && command.id) {
+                    controller.trigger('command_triggered', [bot, context, command]);
+
+                    // make the script source information from Botkit Studio available to Botkit's convo object
+                    context.script_name = command.command;
+                    context.script_id = command._id;
+
+                    controller.studio.compileScript(
+                        bot,
+                        context,
+                        command
+                    ).then(function(convo) {
+                        convo.on('end', function(convo) {
+                            runHooks(
+                                after_hooks[command.command] ? after_hooks[command.command].slice() : [],
+                                convo,
+                                function(convo) {
+                                    controller.trigger('remote_command_end', [bot, context, command, convo]);
+                                }
+                            );
+                        });
+                        runHooks(
+                            before_hooks[command.command] ? before_hooks[command.command].slice() : [],
+                            convo,
+                            function(convo) {
+                                resolve(convo);
+                            }
+                        );
+                    }).catch(function(err) {
+                        reject(err);
+                    });
+                } else {
+                    reject('Script not found');
+                }
+            }).catch(function(err) {
+                reject(err);
+            });
+
+        });
+    };
 
     controller.studio.runTrigger = function(bot, input_text, user, channel, original_message) {
         var context = {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "botkit",
-  "version": "0.6.10",
+  "version": "0.6.11",
   "description": "Building blocks for Building Bots",
   "main": "lib/Botkit.js",
   "types": "lib/Botkit.d.ts",
@@ -9,7 +9,7 @@
     "back": "^1.0.1",
     "body-parser": "^1.17.1",
     "botbuilder": "^3.8.4",
-    "botkit-studio-sdk": "^1.0.7",
+    "botkit-studio-sdk": "^1.0.8",
     "ciscospark": "^1.26.0",
     "clone": "2.1.1",
     "command-line-args": "^4.0.2",