tested with self dialog

rngadam · rngadam · commit e49c42f4aff4 · 2017-01-28T22:51:52.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+config.json
+.yarnrc
+.pki
+node_modules/
+tickets.json
+*.lock
+**.swp
+.v8flags.*
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+
+# installation
+
+```
+brew install chromedriver
+npm install
+```
+
+create config.json file:
+
+```
+cp config.json.example config.json
+vi config.json
+```
+
+run:
+
+```
+npm start
+```
diff --git a/bot.js b/bot.js
@@ -0,0 +1,13 @@
+'use strict'
+
+const { Wechaty } = require('wechaty')
+
+const reload = require('./reloader')
+
+const data = {}
+
+Wechaty.instance() // Singleton
+.on('scan', (url, code) => console.log(`Scan QR Code to login: ${code}\n${url}`))
+.on('login',       user => console.log(`User ${user} logined`))
+.on('message',  message => { reload('./handler.js')(data, message) })
+.init()
diff --git a/config.json.example b/config.json.example
@@ -0,0 +1,10 @@
+{
+    "prefix": "candra",
+    "whitelisted": [
+        "Agora Space #3:bunker",
+        "Agora - management",
+        "File Transfer"
+    ],
+    "management": "Agora - management",
+    "store": "./tickets.json"
+}
diff --git a/handler.js b/handler.js
@@ -0,0 +1,58 @@
+'use strict'
+
+const reload = require('./reloader')
+
+function roomName(message) {
+    return message.room() ? message.room().topic() : 'self'
+}
+
+function userName(message) {
+    return message.from().name()
+}
+
+function content(message) {
+    return message.content()
+}
+
+function cleanContent(prefix, message) {
+    return content(message).substr(prefix.length).trim()
+}
+
+function messageString(message) {
+    return `${roomName(message)}/${userName(message)}: ${content(message)}`
+}
+
+function mine(content, prefix) {
+    return content.substr(0, prefix.length).toLowerCase().startsWith(prefix)
+}
+
+function destination(message) {
+    return message.room()? message.room() : message.from()
+}
+
+function handler(data, message) {
+    console.log(messageString(message))
+    try {
+        var config = reload('./config.json')
+        if(mine(content(message), config.prefix) && config.whitelisted.indexOf(roomName(message)) != -1) {
+            console.log(`Captured message: ${message}`)
+
+            const processor = reload('./support.js')
+            if(!data.tickets) {
+                data.tickets = processor.load(data.store)
+            }        
+            const reply = processor.process(data.tickets, {
+                prefix: config.prefix,
+                roomName: roomName(message), 
+                userName: userName(message), 
+                content: cleanContent(config.prefix, message)
+            })
+            processor.store(config.store, data.tickets)
+            destination(message).say(reply)
+        }
+    } catch(e) {
+        destination(message).say(e)
+    }
+}
+
+module.exports = handler
diff --git a/package.json b/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "candra-wechaty-bot",
+  "version": "1.0.0",
+  "description": "support tickets bot",
+  "main": "bot.js",
+  "dependencies": {
+    "require-reload": "^0.2.2",
+    "wechaty": "^0.7.3"
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "mocha": "^3.2.0"
+  },
+  "scripts": {
+    "test": "node_modules/.bin/mocha",
+    "start": "node bot.js"
+  },
+  "author": "Ricky Ng-Adam <rngadam@gmail.com>",
+  "license": "ISC"
+}
diff --git a/reloader.js b/reloader.js
@@ -0,0 +1,19 @@
+'use strict'
+
+const reload = require('require-reload')(require)
+const fs = require('fs')
+
+const updates = {}
+const modules = {}
+
+function reloadIfUpdated(name) {
+    const mtime = fs.statSync(name).mtime.getTime()
+    if(!updates[name] || updates[name] < mtime) {
+        console.log(`RELOADING ${name}`)
+        updates[name] = mtime
+        modules[name] = reload(name)
+    }
+    return modules[name]
+}
+
+module.exports = reloadIfUpdated
diff --git a/support.js b/support.js
@@ -0,0 +1,219 @@
+'use strict'
+
+const fs = require('fs')
+
+const Sample = {
+    assignee: null,
+    status: 'open',
+    id: null,
+    content: null,
+    roomName: null,
+    requester: null,
+    created: null,
+    closed: null
+}
+
+function TicketError(message) {
+  this.name = 'TicketError';
+  this.message = message || 'Ticketing error';
+  this.stack = (new Error()).stack;
+}
+TicketError.prototype = Object.create(Error.prototype);
+TicketError.prototype.constructor = TicketError;
+
+function createTicket() {
+    return JSON.parse(JSON.stringify(Sample))
+}
+
+function closeTicket(tickets, id) {
+    const ticket = findTicket(tickets, id)
+    ticket.status = 'closed'
+    ticket.closed = Date.now()
+    return ticket
+}
+
+function openTicket(tickets, message, content) {
+    const newTicket = createTicket()
+    tickets.lastId = tickets.lastId + 1
+    newTicket.id = tickets.lastId
+    newTicket.created = new Date()
+    newTicket.content = content
+    newTicket.roomName = message.roomName
+    newTicket.requester = message.userName
+    tickets[newTicket.id] = newTicket
+    return tickets[newTicket.id]
+}
+
+function findTicket(tickets, id) {
+    if(!id) {
+        throw new TicketError(`Invalid id`)
+    }
+    if(!tickets[id]) {
+        throw new TicketError(`Not found: #${id}`)
+    }
+    return tickets[id]
+}
+
+function assignTicket(tickets, id, assignee) {
+    const ticket = findTicket(tickets, id)
+    ticket.assignee = message.userName
+    return ticket
+}
+
+function stringifyThis(message) {
+    return JSON.stringify(this)
+}
+
+function showTicket(ticket) {
+    return `${ticket.content} requested by ${ticket.requester} (${ticket.roomName}) assigned to ${ticket.assignee}`
+}
+
+function showTickets(tickets, states) {
+    var count = 0;
+    var output = "\n"
+    for(var i=1; i<tickets.lastId+1; i++) {
+        if(states.indexOf(tickets[i].status) != -1) {
+            output += `ticket #${i}: ${showTicket(tickets[i])}\n`
+            count++
+        }
+    }
+    if(!count) {
+        return "nothing TODO!"
+    }
+    return output
+}
+
+function forget(tickets) {
+    if(!tickets.lastId) {
+        return "nothing to remove!"
+    }
+    const lastId = tickets.lastId
+    for(var i=1; i<=tickets.lastId; i++) {
+       delete tickets[i]
+    }
+    tickets.lastId = 0
+    return lastId
+}
+
+function assign(tickets, id, assignee) {
+     const ticket = findTicket(tickets, id)
+     ticket.assignee = assignee
+     return ticket
+}
+
+function help() {
+    return actions.map(action => `${action.regexp.toString()}`).join('\n')
+}
+
+const actions = [
+    {
+        regexp: /^$/gi,
+        action: (tickets, message, id) => {},
+        reply: (message, output) => `Yes ${message.userName}?`,
+    },
+    {
+        regexp: /help/gi,
+        action: (tickets, message, id) => {return help() },
+        reply: (message, output) => '\n' + output,
+    },
+    {
+        regexp: /close #([0-9]*)/gi,
+        action: (tickets, message, id) => closeTicket(tickets, id),
+        reply: (message, output) =>  `ticket #${output.id} is closed`,
+    },
+    {
+        regexp: /please (.*)/gi,
+        action: (tickets, message, content) => openTicket(tickets, message, content),
+        reply:  (message, output) => `will ${output.content} (ticket #${output.id})`,
+    },
+    {
+        regexp:  /show #([0-9]*)/gi,
+        action: (tickets, message, id) => findTicket(tickets, id),
+        reply: (message, output) => showTicket(output),
+    },   
+    {
+        regexp:  /take #([0-9]*)/gi,
+        action: (tickets, message, id) => assign(tickets, id,  message.userName),
+        reply: (message, output) => `ticket #${output.id} is assigned to ${output.assignee}`,
+    },
+    {
+        regexp:  /assign #([0-9]*) to (\w*)/gi,
+        action: (tickets, message, id, assignee) => assign(tickets, id, assignee),
+        reply: (message, output) => `ticket #${output.id} is assigned to ${output.assignee}`,
+    },
+    {
+        regexp:  /debug/gi,
+        action: (tickets, message, id) => tickets,
+        reply: stringifyThis,
+    },
+    {
+        regexp:  /todo/gi,
+        action: (tickets, message, id) => tickets,
+        reply: (message, output) => showTickets(output, ['open']),
+    },
+    {
+        regexp:  /history/gi,
+        action: (tickets, message, id) => tickets,
+        reply: (message, output) => showTickets(output, ['open', 'closed']),
+    },
+    {
+        regexp:  /forget it/gi,
+        action: (tickets, message, id) => forget(tickets),
+        reply: (message, output) => `deleted ${output} tickets`,
+    },
+]
+
+function searchRegexp(action) {
+    if(action && action.regexp) {
+        const exec = action.regexp.exec(this.content)
+        if(exec) {
+            this.result = exec.slice(1)
+            return true
+        }
+    }
+    return false
+}
+
+function process(tickets, message) {
+    const findParams = {content: message.content, result: null}
+    const action = actions.find(searchRegexp, findParams)
+    var reply;
+    if(action) {
+        var output = action.action(tickets, message, ...findParams.result)
+        // if(!(output instanceof Object) && !output) {
+        //     reply = `${JSON.stringify(action)} did not return any output`
+        // } else {
+            reply = `${action.reply.bind(output)(message, output)}`
+        // }
+    } else {
+        reply = `I don't understand: ${message.content}`
+    }
+    return `#${message.prefix}: ${reply}`
+}
+
+function createTickets() {
+    return {
+        lastId: 0
+    }
+}
+
+function store(store, tickets) {
+    fs.writeFileSync(store, JSON.stringify(tickets, null, 4))
+}
+
+function load(store) {
+    try {
+        const datastore = fs.readFileSync(store)
+        return JSON.parse(datastore)
+    } catch(e) {
+        return createTickets() 
+    }
+}
+
+module.exports = {
+    store,
+    load,
+    createTickets,
+    process,
+    openTicket
+}
diff --git a/test/reloader_test.js b/test/reloader_test.js
diff --git a/test/support_test.js b/test/support_test.js
