/campfire-bot

An extensible bot for the Campfire web-based chat system #crc

Primary LanguageRubyMIT LicenseMIT

Campfire Bot

This is a multi-purpose and extensible bot for 37 Signals’ Campfire chat service. I’ve forked it to get it running for myself along with some misc clean up.

New plugins / commands added are:

  • Image Me (ala Zach Holman’s awesome automating inefficiencies video)
    • image me to get a random google image result
    • bieber me to get a random justin bieber image
  • TeamCity RSS
    • deploy today to start monitoring team city status (every hour bot will report if team city is red for a given project)
    • no deploy today to stop monitoring team city status

Internally changes include:

  • Added support for multi-word commands
  • Added bundler for dependencies management
  • Automatic support for plugin config files stores in var/plugin\_name.yml

If you have suggestions for useful or fun plugins, let me know; I’m always looking for new plugins to add on!

Installation

Download

Download the source from github

Configuration

Create a config.yml in the root of the source directory. Use config.example.yml as an example.

Usage

If this is your first time running the bot you will have to run:

bundle install

To run the bot, run script/bot with the environment name as the argument; for example:

script/bot development

Credits

BookRenter.com

This iteration of campfire-bot is currently maintained by Philippe Huibonhoa and funded by BookRenter.com.

The project was forked from Josh Wand. You can see the original project here.

CONTRIBUTING

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

COPYRIGHT

Copyright © 2011 Philippe Huibonhoa. See LICENSE.txt for further details.