Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

pretty up the readme and clean up some code and the todo file

  • Loading branch information...
commit 37aba81ded3fd17fd0661ad78a2fc76511d50e42 1 parent cb5fc8c
@timriley timriley authored
Showing with 53 additions and 37 deletions.
  1. +0 −23 README
  2. +41 −0 README.textile
  3. +12 −11 TODO
  4. +0 −3  lib/bot.rb
View
23 README
@@ -1,23 +0,0 @@
-This is an under-heavy-development bot for the Campfire web-based chat system.
-
-It aims to be multi-purpose and extensible.
-
- - Tim Riley <tim at openmonkey dot com>
-
-Requirements:
-
-rubygems
-timriley-tinder
-hpricot
-mime-types
-activesupport
-
-Configuration:
-
-in config.yml
-
-Running:
-
-Run script/bot with the environment name as the argument
-
-script/bot.rb development
View
41 README.textile
@@ -0,0 +1,41 @@
+h1. Campfire Bot
+
+This is an under-heavy-development bot for the Campfire web-based chat system.
+
+It aims to be multi-purpose and extensible.
+
+h2. Installation
+
+h3. Download
+
+Download the source from "github":http://github.com/timriley/campfire-bot
+
+h3. Dependencies:
+
+* rubygems
+* timriley-tinder (http://github.com/timriley/tinder)
+* hpricot
+* mime-types
+* activesupport
+
+h3. Configuration
+
+Configuration:
+
+in config.yml
+
+h2. Usage
+
+To run the bot, run @script/bot@ with the environment name as the argument:
+
+ script/bot.rb development
+
+h2. Authors
+
+Tim Riley - "github":http://github.com/timriley | "www":http://openmonkey.com/ | "email":mailto:tim@openmonkey.com
+
+h3. Contributors
+
+* Josh Wand - "github":http://github.com/joshwand
+* Hugh Evans - "github":http://github.com/hughevans
+* Sean O'Dowd - "github":http://github.com/seanodowd
View
23 TODO
@@ -22,24 +22,14 @@
from ./script/bot:7:in `require'
from ./script/bot:7
-
- need flood control for bot plugins
-- need to catch timeout errors and do something sensible, like wait and retry the connection
-
- http://www.google.com/search?q=ruby%20rescue%20Timeout::Error
- http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/136555
- http://jerith.livejournal.com/40063.html
- http://rails.lighthouseapp.com/projects/8994/tickets/6-patch-activeresource-connection-should-rescue-from-timeout-error
-
- need to catch no-network errors and return a sensible error message:
/opt/local/lib/ruby/1.8/net/http.rb:560:in `initialize': Network is unreachable - connect(2) (Errno::ENETUNREACH)
- plugins need callbacks, like on_join, bot_loaded, etc. Especially one that is run whenever control+c is caught (for plugins to clean up)
-- multi-room support
-
- gem-ify the bot and have it provide an executable to generate an application directory
like rails
@@ -58,4 +48,15 @@
- create a plugin that pulls in unfuddle ticket reports, eg. !unfuddle project_name active_tickets
-- modify the austin powers plugin to be a generic imdb quote puller. eg. !imdb austin_powers
+- modify the austin powers plugin to be a generic imdb quote puller. eg. !imdb austin_powers
+
+DONE
+
+- multi-room support
+
+- need to catch timeout errors and do something sensible, like wait and retry the connection
+
+ http://www.google.com/search?q=ruby%20rescue%20Timeout::Error
+ http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/136555
+ http://jerith.livejournal.com/40063.html
+ http://rails.lighthouseapp.com/projects/8994/tickets/6-patch-activeresource-connection-should-rescue-from-timeout-error
View
3  lib/bot.rb
@@ -14,9 +14,6 @@
require 'tinder'
module CampfireBot
-
-
-
class Bot
# this is necessary so the room and campfire objects can be accessed by plugins.
include Singleton
Please sign in to comment.
Something went wrong with that request. Please try again.