gasolin / webbybot Goto Github PK

chatterbot written in es6 (es2015), fork from hubot

JavaScript 99.14% Shell 0.86%

chat chatbot bot hubot

webbybot's Introduction

Webbybot

**THIS PROJECT IS NOT MAINTAINED, please consider Hubot or my client-side attempt Saihubot **

Webbybot is the next generation framework to build message/chat bots, written in ES6 and plain javascript. Fully compatible with Hubot's middleware and plugins.

The Differences:

Port hubot from CoffeeScript to ES6 (plain JS) with babel.
Auto test coverage report with Codecov.
Auto linting with eslint.
Support .env file to setup system parameters
robot.router upgraded to Express 4.x

The Same:

Still support hubot plugins written in coffeescript.
Can reuse hubot adapters*
Auto continue integration with Travis CI.
How it works(for now)
Support write plugin with plain Javascript

How to try Webbybot

You can start from webby-template , a template for make a working webby bot

$ git clone https://github.com/gasolin/webby-template.git demo
$ cd demo
$ npm install
$ ./bin/webby

You can find and install extra skills from npm

Enable a skill in external-scripts.json.

Add the environment variables in .env file.

How to replace Hubot to Webbybot

Refer to Getting Started With Hubot, Install hubot generator first

npm install -g yo generator-hubot

Then generate your robot with

yo hubot

Enter the folder, edit bin/hubot and replace hubot to webby.
install webbybot package

npm install --save webbybot

modify adapter's dependency

Let's take telegram adapter for example. Edit node_modules/hubot-telegram/src/telegram.coffee and replace first line require 'hubot' to require 'webbybot'.

start your bot as normal

./bin/hubot

Tested with hubot-telegram and hubot-messenger.

Development

$ npm install -g mocha

Build

run command

$ npm run build

Add plugins

$ npm install hubot-calculator hubot-diagnostics

Add external-scripts.json file which contain:

[
  "hubot-diagnostics",
  "hubot-calculator"
]

Run

run command

$ node ./bin/webby
webby > ping
webby > PONG
webby > echo hello
webby > hello
webby > webby calc 1 + 1
webby > 2

Test

$ npm test

Lint

$ npm run lint

Write your own plugin

You can clone webby-plugin template to get start.

webby-template already bundled with webby-plugin. You can check how it work for reference.

License

MIT license

webbybot's People

Contributors

Stargazers

Watchers

Forkers

raylin metalvegetarianoprogresivo scarletsky gitter-badger lawrips deleav chrisgalvan hashashin dkkv clickjankin

webbybot's Issues

make webbybot able to interact with default shell adapter

port adaptors/shell

port listener.js

Cannot read property 'robot' of undefined with hubot-timezone

input webby time in london

and got debug log with error:

[Wed Apr 13 2016 13:58:51 GMT+0800 (CST)] DEBUG Executing listener callback for Message '${message}'
[Wed Apr 13 2016 13:58:51 GMT+0800 (CST)] ERROR TypeError: Cannot read property 'robot' of undefined
  at http (/home/gasolin/webby-confbot/node_modules/webbybot/dist/src/response.js:224:18)
  at getTimezoneInfo (/home/gasolin/webby-confbot/node_modules/hubot-timezone/src/timezone.coffee:37:3)
  at sendLocalTime (/home/gasolin/webby-confbot/node_modules/hubot-timezone/src/timezone.coffee:77:5)
  at convertTime (/home/gasolin/webby-confbot/node_modules/hubot-timezone/src/timezone.coffee:92:5)
  at TextListener.callback (/home/gasolin/webby-confbot/node_modules/hubot-timezone/src/timezone.coffee:116:5)
  at executeListener (/home/gasolin/webby-confbot/node_modules/webbybot/dist/src/listener.js:116:19)
  at allDone (/home/gasolin/webby-confbot/node_modules/webbybot/dist/src/middleware.js:85:16)
  at /home/gasolin/webby-confbot/node_modules/webbybot/node_modules/async/lib/async.js:380:13
  at /home/gasolin/webby-confbot/node_modules/webbybot/node_modules/async/lib/async.js:52:16
  at iterate (/home/gasolin/webby-confbot/node_modules/webbybot/node_modules/async/lib/async.js:260:24)
  at Object.async.forEachOfSeries.async.eachOfSeries (/home/gasolin/webby-confbot/node_modules/webbybot/node_modules/async/lib/async.js:281:9)
  at Object.async.inject.async.foldl.async.reduce (/home/gasolin/webby-confbot/node_modules/webbybot/node_modules/async/lib/async.js:374:15)
  at /home/gasolin/webby-confbot/node_modules/webbybot/dist/src/middleware.js:91:22
  at nextTickCallbackWith0Args (node.js:420:9)
  at process._tickCallback (node.js:349:13)

remove dependency of babel-plugin-add-module-exports

we use babel-plugin-add-module-exports to smooth the porting effort to es6 modules, now all modules are es6 ready, we could start remove dependency of babel-plugin-add-module-exports

create example for es6 JS webbybot plugin

make HTTPClient replaceable

such as https://github.com/github/hubot/pull/1134/files

related to #54

bundled web dashboard

provide web interface to easy config the chatterbot

port middleware.js

respond result is wrong

$ npm install hubot-calculator
$ npm run build
$ ./bin/webby.js
webby> webby calc 1+1

Expected result:

webby > 2

Actual result

webby > 0

The return result in hubot-calculator is correct (2), so there is something wrong in respond or middleware module.

native support plugins written in es6

add boilerplate for demo

buildin conversation support

https://www.npmjs.com/package/hubot-conversation

broadcast local address through mdns

broadcast webby.local so user can type that in searchbar and connect to webby web dashboard.

fix robot tests

there's some skipped tests in robot_test related to middleware and listener

organize with es6 module

port brain.js

webbybot generator

to generate custom webbybot and javascript plugin

use ES6 for..of loop to replace forEach and for..in loop。

port user.js

mock hubot require to webbybot to use adapters directly

currently webbybot needs to modify the require('hubot') statement from every hubot-adapters, its not that convenient.

We can use mockery or mock-require to proxy hubot require to webbybot, so every hubot requirement will be redirected to webbybot

move build-in shell adapter out of webbybot

use webpack with express

refer http://stackoverflow.com/questions/31102035/how-can-i-use-webpack-with-express

merged to ff564c3

make ExpressRouter replaceable

to 4.x

expose webby as library

refer to http://webpack.github.io/docs/configuration.html#output-librarytarget

reconfig webpack to expose webby as commonjs library

port adaptor.js

create example for plain webbybot JS plugin

add .editorconfig for source format convention

remove lodash dependency for buildin shell adapter

fix webpack/node require conflict issue

webpack treat all require as webpack's require, but in some cases we need node require to require plugins dynamically

refactor: move loadFile and varients to expander.js file

support set command alias

add unit test framework

extensible via npm plugins

enableHttpd flag undefined

The enableHttpd flag default isn't being properly handed off to the loadBot function in the bin script

wrote with es6

support multiple adaptors

port response.js

use fetch instead of scoped-http-client

deprecated https://github.com/technoweenie/node-scoped-http-client because its no longer maintained

https://www.npmjs.com/package/node-fetch (preferred)

https://github.com/request/request