Ellen

A chatterbot framework, inspired by Hubot.

Dependencies

• Ruby 1.9.3+

Adapter

Adapter hooks up your robot to chat services.

• Ellen::Adapters::Shell
• Ellen::Adapters::Slack
• Ellen::Adapters::Hipchat
• Ellen::Adapters::Twitter
• Ellen::Adapters::Idobata

Brain

Brain persists your robot's memory.

• Ellen::Brains::Memory
• Ellen::Brains::Redis

Handler

Handler provides various behaviors to your robot.

• Ellen::Handlers::Help
• Ellen::Handlers::Ping
• Ellen::Handlers::Cron
• Ellen::Handlers::GoogleImage

Configuration

Store configuration value in envorinment variables. They are easy to change between deploys without changing any code. We recommend to put .env and run with ellen --dotenv option to manage them.

All you need to use your favorite plugins is to write their names into Gemfile. Ellen will load them before running.

# Gemfile
gem "ellen-cron"
gem "ellen-google_image"
gem "ellen-redis"
gem "ellen-slack"

Deploy

Here is the smallest example to deploy a simple chatterbot to Heroku.

$ gem install ellen
$ ellen --generate
$ cd ellen
$ echo 'gem "ellen-my_adapter"' >> Gemfile
$ echo 'bot: bundle exec ellen' >> Procfile
$ bundle install
$ git init
$ git add .
$ git commit -m "Initial commit"
$ heroku create
$ heroku config:set FOO=1 BAR=2 BAZ=3
$ git push heroku master
$ heroku scale bot=1

Screenshot