Skip to content

Commit

Permalink
split-files split out each class into its own file in the src dir
Browse files Browse the repository at this point in the history
  • Loading branch information
@billneff79
billneff79 committed Oct 19, 2018
1 parent ccd7015 commit e4d3ccf
Show file tree
Hide file tree
Showing 6 changed files with 319 additions and 308 deletions.
42 changes: 21 additions & 21 deletions fulfillment_template.js
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
'use strict';


const {
dialogflow,
SignIn,
SimpleResponse,
BasicCard,
List,
Button,
Image,
NewSurface
dialogflow,
SignIn,
SimpleResponse,
BasicCard,
List,
Button,
Image,
NewSurface
} = require('actions-on-google');
const functions = require('firebase-functions');
const {YourConvoApp} = require('your-convo-app');
const { YourConvoApp } = require('your-convo-app');

exports.dialogflowFirebaseFulfillment = functions.https.onRequest(
new YourConvoApp()
.setClassMappings({
SignIn: obj => new SignIn(obj),
SimpleResponse: obj => new SimpleResponse(obj),
NewSurface: obj => new NewSurface(obj),
BasicCard: obj => new BasicCard(obj),
List: obj => new List(obj),
Button: obj => new Button(obj),
Image: obj => new Image(obj)
})
.bind(dialogflow({debug: true}))
new YourConvoApp()
.setClassMappings({
SignIn: obj => new SignIn(obj),
SimpleResponse: obj => new SimpleResponse(obj),
NewSurface: obj => new NewSurface(obj),
BasicCard: obj => new BasicCard(obj),
List: obj => new List(obj),
Button: obj => new Button(obj),
Image: obj => new Image(obj)
})
.bind(dialogflow({ debug: true }))
);
289 changes: 3 additions & 286 deletions index.js
View file
Original file line number Diff line number Diff line change
@@ -1,289 +1,6 @@
class Say {

static append(val) {
return new Say().append(val);
}

static sentence(val) {
return new Say().sentence(val);
}

constructor() {
this.str = '';
}

append(val) {
this.str += val;
return this;
}

newline() {
return this.append('\n');
}

paragraph() {
return this.newline().newline();
}

sentence(val) {
return this.append(' ').append(val);
}

toString() {
return this.str.trim();
}

}

class Convo {

static mockConv() {
return {
surface: {
capabilities: {
has: () => true
}
},
available: {
surfaces: {
capabilities: {
has: () => true
}
}
},
user: {
access: {},
storage: {}
},
contexts: {}
};
}

static setClassMappings(mappings) {
this._clsMappings = mappings;
}

/**
* @private
*/
static processMethod(type, data) {
return this._clsMappings && this._clsMappings[type] ? this._clsMappings[type](data) : { type, data };
}

/* eslint-disable new-cap */

static SignIn(obj) {
return this.processMethod('SignIn', obj);
}

static SimpleResponse(obj) {
return this.processMethod('SimpleResponse', obj);
}

static NewSurface(obj) {
return this.processMethod('NewSurface', obj);
}

static Image(obj) {
return this.processMethod('Image', obj);
}

static List(obj) {
return this.processMethod('List', obj);
}

static BasicCard(obj) {
return this.processMethod('BasicCard', obj);
}

static Button(obj) {
return this.processMethod('Button', obj);
}

static complete(convo, action = 'close', options = { log: false, logFunc: null }) {
if (!convo.conv){
if (options.log) {
console.log(`${action}:${JSON.stringify(convo, null, 1)}`);
}
return Promise.resolve(convo);
}
let finalText = convo._write.reduce((acc, text) => acc.sentence(text), new Say()).toString().trim();
let finalSpeech = convo._speak.reduce((acc, text) => acc.sentence(text), new Say()).toString().trim();
let promises = [];
let textWasPopulated = !!(finalText || finalSpeech);

let isRunningInDialogFlow = typeof convo.conv[action] === 'function';
let convoFunc = isRunningInDialogFlow ? obj => convo.conv[action](obj) : resp => {
if (options.log) {
if (options.logFunc) {
options.logFunc(action, resp);
}
else {
console.log(`${action}:${JSON.stringify(resp, null, 1)}`);
}
}
};

if (textWasPopulated) {
promises.push(convoFunc(Convo.SimpleResponse({
text: finalText || finalSpeech,
speech: finalSpeech || finalText
})));
}

convo._rich.forEach((richResponse) => {
if (richResponse.media && !richResponse.capabilities && !richResponse.send) {
promises.push(convoFunc(richResponse.media));
return;
}
if (convo.conv.surface && convo.conv.surface.capabilities.has(richResponse.capabilities)) {
if (!textWasPopulated && richResponse.send && (typeof richResponse.media !== 'string')) {
promises.push(convoFunc(Convo.SimpleResponse({
text: richResponse.send.notification,
speech: richResponse.send.notification
})));
}
promises.push(convoFunc(richResponse.media));
}
else if (richResponse.send && convo.conv.available && convo.conv.available.surfaces.capabilities.has(richResponse.capabilities)) {
promises.push(convoFunc(Convo.NewSurface(
{
context: richResponse.send.context,
notification: richResponse.send.notification,
capabilities: richResponse.capabilities
}
)));
}
});

return isRunningInDialogFlow ? Promise.all(promises) : Promise.all(promises).then(() => convo);
}

/* eslint-enable new-cap */
static prepComplete(obj, action = 'close', options) {
if (isPromise(obj)) {
return obj.then(result => this.prepComplete(result, action, options));
}

return this.complete(obj, action, options);
}

static ask(obj, options) {
return this.prepComplete(obj, 'ask', options);
}

static close(obj, options) {
return this.prepComplete(obj, 'close', options);
}

constructor(obj) {
this.conv = !obj ? Convo.mockConv() : obj.conv || obj;
this.clear();
}

clear() {
this._write = [];
this._speak = [];
this._rich = [];
return this;
}

write(message) {
this._write.push(message.toString());
return this;
}

speak(message, writeAlso = true) {
this._speak.push(message.toString());
if (writeAlso) {
this.write(message);
}
return this;
}

present(media, capabilities = null, send = null) {
this._rich.push({ capabilities, send, media });
return this;
}

/**
* Guarantee that func returns a promise
* @param {Function} func
*/
promise(func) {
return Promise.resolve().then(() => func(this) );
}

setAccessToken(token) {
if (!this.conv.user) {
this.conv.user = {};
}
if (!this.conv.user.access) {
this.conv.user.access = {};
}
this.conv.user.access.token = token;
return this;
}

getContext(context) {
let rContext;
if (this.conv && this.conv.contexts) {
rContext = this.conv.contexts.get ? this.conv.contexts.get(context) : this.conv.contexts[context];
}
return rContext && rContext.parameters || {};
}

setContext(context, lifespan, parameters) {
if (this.conv && this.conv.contexts) {
if (this.conv.contexts.set) {
this.conv.contexts.set(context, lifespan, parameters);
}
else {
this.conv.contexts[context] = { lifespan, parameters };
}
}
return this;
}

getStorage() {
return this.conv && this.conv.user && this.conv.user.storage || {};
}
}

function isPromise(obj) {
return !!(obj && obj.then);
}

class ConvoApp {

constructor() {
this.registeredIntents = [];
this.onRegisterIntents();
}

setClassMappings(obj){
Convo.setClassMappings(obj);
return this;
}

onRegisterIntents() {}

registerIntent(intent, intentHandler) {
this.registeredIntents.push({ intent, intentHandler });
}

bind(dialogFlowApp) {
this.registeredIntents.forEach(({ intent, intentHandler }) => {
dialogFlowApp.intent(intent, (conv, params, extra) => intentHandler(new Convo(conv), params, extra));
});
return dialogFlowApp;
}

intent(convo, intent, params = {}, option = {}, debugOptions = {}){
let registeredIntent = this.registeredIntents.filter(registeredIntent => registeredIntent.intent === intent)[0];
return registeredIntent.intentHandler(convo, params, option, debugOptions).then(convo => ({ app: this, convo }));
}
}

const { Convo } = require('./src/convo');
const { ConvoApp } = require('./src/convo-app');
const { Say } = require('./src/say');

module.exports = { Convo, ConvoApp, Say };
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "A uility for building conversational responses in DialogFlow fufillments",
"main": "index.js",
"scripts": {
"test": "eslint index.js"
"test": "eslint *.js src"
},
"author": "tmtek",
"license": "ISC",
Expand Down
34 changes: 34 additions & 0 deletions src/convo-app.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
const { Convo } = require('./convo');

class ConvoApp {

constructor() {
this.registeredIntents = [];
this.onRegisterIntents();
}

setClassMappings(obj){
Convo.setClassMappings(obj);
return this;
}

onRegisterIntents() {}

registerIntent(intent, intentHandler) {
this.registeredIntents.push({ intent, intentHandler });
}

bind(dialogFlowApp) {
this.registeredIntents.forEach(({ intent, intentHandler }) => {
dialogFlowApp.intent(intent, (conv, params, extra) => intentHandler(new Convo(conv), params, extra));
});
return dialogFlowApp;
}

intent(convo, intent, params = {}, option = {}, debugOptions = {}){
let registeredIntent = this.registeredIntents.filter(registeredIntent => registeredIntent.intent === intent)[0];
return registeredIntent.intentHandler(convo, params, option, debugOptions).then(convo => ({ app: this, convo }));
}
}

module.exports = { ConvoApp };
Loading

0 comments on commit e4d3ccf

Please sign in to comment.