Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fczuardi/calamars
An alpha quality, under heavy development, proto-frramework for building chat applications.
https://github.com/fczuardi/calamars
Last synced: about 23 hours ago
JSON representation
An alpha quality, under heavy development, proto-frramework for building chat applications.
- Host: GitHub
- URL: https://github.com/fczuardi/calamars
- Owner: fczuardi
- License: other
- Created: 2016-04-22T17:11:53.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-31T19:10:38.000Z (over 7 years ago)
- Last Synced: 2024-11-03T18:02:03.547Z (10 days ago)
- Language: JavaScript
- Homepage: https://github.com/calamar-io/calamars
- Size: 743 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 227
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# calamars
[](https://badge.fury.io/js/calamars)
[](https://travis-ci.org/fczuardi/calamars)
[](https://david-dm.org/fczuardi/calamars)
[](https://coveralls.io/github/fczuardi/calamars?branch=master)
[][license]
[see all badges…][badges]
An alpha quality, under heavy development, proto-frramework for building
chat applications.
## Install
```sh
npm install --save calamars
```
## Documentation
See the [Library Reference][documentation] for full documentation.
## Overview
Calamars is a toolset of different libs that helps on common tasks of
a conversational application development, such as:
- bot daemon setup
- question/answer routing
- interaction with cloud-based natural language
message parsers (LUIS, wit.ai).
Below are some usage examples of the different pieces of the calamars framework.
For more use cases check the [documentation][documentation] or the
[test folder][testfolder].
### Facebook Messenger Bot Wrapper
#### basic echo bot
```javascript
const FacebookMessengerBot = require('calamars').FacebookMessengerBot;
const myPageToken = 'EAASxZBKlWU...SwZDZD';
const myVerifyToken = 'RMHFOBtOd...X91LBu';
const myCallbackPath = '/webhook';
const myPort = 9091;
const myMessageListener = function(updateEvent){
console.log('received message:', updateEvent.update.message.text);
// reply with the same received message
updateEvent.bot.sendMessage({
userId: updateEvent.update.sender.id,
text: updateEvent.update.message.text
})
};
const mybot = new FacebookMessengerBot({
port: myPort,
callbackPath: myCallbackPath,
verifyToken: myVerifyToken,
pageTokens: [myPageToken],
listeners: {
onMessage: myMessageListener
}
});
mybot.start().then(function(){
console.log(`server is running on port ${myPort}`);
})
```
Check the [Tutorial][echobottutorial] for a detailed guide of how to set up
a Facebook App, a Facebook Page and how to install and run the example above.
For details on the available methods and implementation please refer to the [FacebookMessengerBot][fbbotclass] class.
### Chat replies Routing
#### string → string
```javascript
import { createRouter } from 'calamars';
const routes = [
['yes', 'no'],
['stop', 'go go go'],
['goodbye', 'hello'],
['high', 'low'],
['why', 'I don’t know']
];
const router = createRouter(routes);
console.log(router('goodbye')); // hello
```
#### string → callback → string
```javascript
import { createRouter } from 'calamars';
const callbacks = {
yes() { return 'no'; },
halt() { return 'go go go'; },
goodbye() { return 'hello'; },
high() { return 'low'; },
why() { return 'I don’t know'; }
};
const routes = [
['yes', callbacks.yes],
['stop', callbacks.halt],
['goodbye', callbacks.goodbye],
['high', callbacks.high],
['why', callbacks.why]
];
const router = createRouter(routes);
console.log(router('goodbye')); // hello
```
#### echo any string input
```javascript
import { createRouter } from 'calamars';
const routes = [
[/.*/, matches => matches[0]]
];
const router = createRouter(routes);
console.log(router('goodbye')); // goodbye
```
#### string → LUIS → intentName → callback → string
```javascript
import { LuisDriver, createRouter } from 'calamars';
const luis = new LuisDriver(options);
const callback = () => 'go go go';
const routes = [
['goodbye', callback]
];
const router = createRouter(routes);
luis.query('Good Bye!')
.then(({ topScoringIntent }) => {
const intentName = topScoringIntent.intent;
console.log(router(intentName)); // 'go go go'
});
```
#### More usage examples
- [string → regex → string][regexString] - Using createRegexRouter
- [string → regex → callback → string][regexCallbackString] - With matches and default answer using createRegexFunctionRouter
- [object → comparisonFunction → callback → string][createPayloadFunctionRouter] - Using createPayloadFunctionRouter
- [more][routertests]
## Patches are welcome
If you want to help us improve this library with a fix, a feature, better
documentation or any other thing, please refer to the
[contributing guide][contributing].
## Showcase
Who is using calamars in the real world:
- [Calamarcopollo][pollo]: an open-source Telegram/Facebook Messenger bot that searches
for brazilian intercity bus schedules and tickets using natural language
(powered by wit.ai and clickbus api).
If you are using it or know of someone else using it please let us know, open a
pull request expanding this list, or file an issue :)
## License
- [AGPL-3.0][license]
[badges]: https://github.com/fczuardi/calamars/blob/master/badges.md
[documentation]: http://fczuardi.github.io/calamars/
[testfolder]: https://github.com/fczuardi/calamars/tree/master/test
[echobottutorial]: https://github.com/fczuardi/fbbotexample
[fbbotclass]: http://fczuardi.github.io/calamars/facebook.html
[routertests]: https://github.com/fczuardi/calamars/blob/master/test/router.js
[regexString]: https://github.com/fczuardi/calamars/blob/master/test/router.js#L37-L48
[regexCallbackString]: https://github.com/fczuardi/calamars/blob/master/test/router.js#L70-L81
[createPayloadFunctionRouter]: https://github.com/fczuardi/calamars/blob/master/test/router.js#L107-L134
[contributing]: https://github.com/fczuardi/calamars/blob/master/CONTRIBUTING.md
[pollo]: https://github.com/fczuardi/calamarcopollo
[license]: https://github.com/fczuardi/calamars/blob/master/LICENSE