campfire-bot 0.0.1

data/.autotest

@@ -0,0 +1,11 @@
+require 'autotest/redgreen'
+Autotest.add_hook :initialize do |at|
+  # Ignore files in tmp/
+  at.add_exception %r%^\./tmp%
+  
+  at.add_mapping(/plugins\/(.+).rb/) do |f, _|
+      at.files_matching(/.*spec.rb$/)
+  end
+  
+end
+

data/.gitignore

@@ -0,0 +1,6 @@
+*config.yml
+tmp/*
+var/*
+.bundle
+.rvmrc
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source :gemcutter
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    campfire-bot (0.0.1)
+      activesupport (~> 3.0.3)
+      eventmachine (~> 0.12.10)
+      hpricot (~> 0.8.3)
+      i18n (~> 0.5.0)
+      logging (~> 1.4.3)
+      mime-types (~> 1.16)
+      tinder (>= 1.4.3)
+      twitter-stream (~> 0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.10)
+    addressable (2.2.6)
+    eventmachine (0.12.10)
+    faraday (0.7.4)
+      addressable (~> 2.2.6)
+      multipart-post (~> 1.1.0)
+      rack (< 2, >= 1.1.0)
+    faraday_middleware (0.7.0)
+      faraday (~> 0.7.3)
+    hashie (1.1.0)
+    hpricot (0.8.4)
+    http_parser.rb (0.5.3)
+    i18n (0.5.0)
+    little-plugger (1.1.2)
+    logging (1.4.3)
+      little-plugger (>= 1.1.2)
+    mime-types (1.16)
+    multi_json (1.0.3)
+    multipart-post (1.1.3)
+    rack (1.3.4)
+    simple_oauth (0.1.5)
+    tinder (1.7.0)
+      activesupport (< 4, >= 2.3)
+      eventmachine (~> 0.12)
+      faraday (< 0.8, >= 0.6)
+      faraday_middleware (< 0.8, >= 0.6)
+      hashie (~> 1.0)
+      mime-types (~> 1.16)
+      multi_json (~> 1.0)
+      multipart-post (~> 1.1)
+      twitter-stream (~> 0.1)
+    twitter-stream (0.1.14)
+      eventmachine (>= 0.12.8)
+      http_parser.rb (~> 0.5.1)
+      simple_oauth (~> 0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  campfire-bot!

data/README.textile

@@ -0,0 +1,52 @@
+h1. Campfire Bot
+
+This is a bot for 37 Signals' Campfire chat service.
+
+It has plugin support so you can make your bot do whatever you want. 
+
+h2. Installation
+
+h3. Download
+
+Download the source from "github":http://github.com/joshwand/campfire-bot
+ 
+h3. Gem Dependencies
+
+  gem install bundler
+  bundle install
+
+h3. Configuration
+
+Create a @config.yml@ in the root of the source directory. Use @config.example.yml@ as an example.
+
+h2. Usage
+
+To run the bot, run @script/bot@ with the environment name as the argument:
+
+  script/bot development
+
+
+h2. Known issues
+
+h3. [BUG] Bus Error
+
+This is really an issue with EventMachine. If you are using this on a machine that has MacPorts, you'll need to make sure that you build both ruby and eventmachine linked against the openssl in /opt/local, not /usr/local.
+
+h3. warning: peer certificate won't be verified in this SSL session
+
+A bug in net/http. Noisy, but harmless.
+
+h2. Original Author
+
+Tim Riley - "github":http://github.com/timriley | "www":http://openmonkey.com/ | "email":mailto:tim@openmonkey.com
+
+h2. Maintainer
+
+* Josh Wand - "github":http://github.com/joshwand
+
+h3. Contributors
+
+* Marcel M. Cary - "github":http://github.com/mcary
+* Hugh Evans - "github":http://github.com/artpop
+* Sean O'Dowd - "github":http://github.com/seanodowd
+* Andrew Erickson - "github":http://github.com/aerickson

data/TODO

@@ -0,0 +1,72 @@
+- add chronic integration for interval-based events: at_time("every day at 9am", :method_name)
+
+- per-plugin config files (inside a config-specific dir) - best not to pollute a single YAML file.
+
+- get it to work with the newest version of mechanize.
+
+/opt/local/lib/ruby/gems/1.8/gems/timriley-tinder-1.1.9/lib/tinder/mechanize_ext.rb:6: undefined method `set_headers' for class `WWW::Mechanize' (NameError)
+	from /opt/local/lib/ruby/vendor_ruby/1.8/rubygems/custom_require.rb:27:in `gem_original_require'
+	from /opt/local/lib/ruby/vendor_ruby/1.8/rubygems/custom_require.rb:27:in `require'
+	from /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.2/lib/active_support/dependencies.rb:510:in `require'
+	from /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.2/lib/active_support/dependencies.rb:355:in `new_constants_in'
+	from /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.2/lib/active_support/dependencies.rb:510:in `require'
+	from /opt/local/lib/ruby/gems/1.8/gems/timriley-tinder-1.1.9/lib/tinder.rb:10
+	from /opt/local/lib/ruby/gems/1.8/gems/timriley-tinder-1.1.9/lib/tinder.rb:10:in `each'
+	from /opt/local/lib/ruby/gems/1.8/gems/timriley-tinder-1.1.9/lib/tinder.rb:10
+	from /opt/local/lib/ruby/vendor_ruby/1.8/rubygems/custom_require.rb:32:in `gem_original_require'
+	from /opt/local/lib/ruby/vendor_ruby/1.8/rubygems/custom_require.rb:32:in `require'
+	from /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.2/lib/active_support/dependencies.rb:510:in `require'
+	from /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.2/lib/active_support/dependencies.rb:355:in `new_constants_in'
+	from /opt/local/lib/ruby/gems/1.8/gems/activesupport-2.1.2/lib/active_support/dependencies.rb:510:in `require'
+	from ./script/../lib/bot.rb:13
+	from ./script/bot:7:in `require'
+	from ./script/bot:7
+
+- need flood control for bot plugins
+
+- plugins need callbacks, like on_join, bot_loaded, etc. Especially one that is run whenever control+c is caught (for plugins to clean up)
+
+- gem-ify the bot and have it provide an executable to generate an application directory 
+  like rails
+
+- move the plugins into their own repository and provide a way for them to be installed 
+  into the app dir above (like script/plugin install)
+
+- use a message handler chain in the same way that activesupport uses callback chains.
+
+- provide a way for plugins to buffer themselves, so they don't run too many times
+
+- buffer the "speak" calls so that they can be uniq'ed before printed to the channel?
+
+- plugins should be able to register respond_to blocks with a notion of priority.
+  eg. a low-priority command can say it doesn't need to be processed if something else matches.
+  conversely, a high-priority command can cause to bot to stop processing the message once it has matched.
+
+- 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
+
+- unit tests!
+
+- help plugin-- extend plugin class to provide help for each registered command
+
+- room.log method, can be called from plugins - store logs in ./log/*.log
+
+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
+
+- alternative addressing syntax (!command)
+
+- 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)
+
+- plugin: svn commit notification (multiple repos)

data/bin/bot

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# Run this script with the environment as the only argument. eg. ./script/bot development
+BOT_ENVIRONMENT = ARGV.first
+BOT_ROOT        = File.join(File.dirname(__FILE__), '..')
+
+require 'rubygems'
+require 'bundler/setup'
+require 'bot'
+
+bot = CampfireBot::Bot.instance
+bot.connect
+bot.run

data/campfire-bot.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "campfire-bot"
+  s.version     = CampfireBot::VERSION
+  s.authors     = ["Josh Wand", "Chad Boyd"]
+  s.email       = ["", "hoverlover@gmail.com"]
+  s.homepage    = "https://github.com/joshwand/campfire-bot"
+  s.summary     = %q{This is a bot for 37 Signals’ Campfire chat service.}
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib", "plugins"]
+
+  s.add_dependency 'twitter-stream', '~> 0.1'
+  s.add_dependency 'tinder', '>= 1.4.3'
+  s.add_dependency 'hpricot', '~> 0.8.3'
+  s.add_dependency 'mime-types', '~> 1.16'
+  s.add_dependency 'activesupport', '~> 3.0.3'
+  s.add_dependency 'logging', '~> 1.4.3'
+  s.add_dependency 'eventmachine', '~> 0.12.10'
+  s.add_dependency 'i18n', '~> 0.5.0'
+end

data/cfbot-stop.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# run as cfbot-stop.sh BOT_ENV_NAME
+for i in $(ps ajx |  awk "/[b]ot ${1}/ {print \$2;}")
+do
+  echo "killing pid $i"
+  kill -9 $i
+done

data/config.example.yml

@@ -0,0 +1,31 @@
+development:
+  site: campfire_subdomain_name 
+  use_ssl: true
+  log_dir: var
+  rooms:
+  - Main room
+  - <%= "Other room" %> # ERB interpolation
+  api_key: your_api_key
+  nickname: Bot
+  fullname: Bot Name
+  password: not_actually_needed
+  twitter_feed: 'http://search.twitter.com/search.atom?q=from%3Atimriley+OR+from%3Ahughevans+OR+from%3Aschlick+OR+from%3Aseanodowd'
+  twitter_hide_replies: false
+  enable_plugins: 
+    - xkcd
+    - basecamp
+production:
+  site: campfire_subdomain_name
+  use_ssl: true
+  rooms:
+  - Company Chat
+  username: foo@bar.com
+  nickname: Bot Name
+  password: password
+  twitter_feed: 'http://search.twitter.com/search.atom?q=from%3Atimriley+OR+from%3Ahughevans+OR+from%3Aschlick+OR+from%3Aseanodowd'
+  twitter_hide_replies: false
+  enable_plugins: 
+    - xkcd
+    - basecamp
+  svn_urls:
+    - http://your.svn/url/

data/lib/bot.rb

@@ -0,0 +1,194 @@
+# External Libs
+require 'rubygems'
+require 'active_support'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext'
+require 'yaml'
+require 'eventmachine'
+require 'logging'
+require 'fileutils'
+require 'erb'
+require 'tinder'
+
+module CampfireBot
+  autoload :Plugin, 'plugin'
+  autoload :Event, 'event'
+  autoload :Message, 'message'
+
+  class Bot
+    # this is necessary so the room and campfire objects can be accessed by plugins.
+    include Singleton
+
+    # FIXME - these will be invalid if disconnected. handle this.
+    attr_reader :campfire, :rooms, :config, :log
+
+    def initialize
+      if BOT_ENVIRONMENT.nil?
+        puts "you must specify a BOT_ENVIRONMENT"
+        exit 1
+      end
+      @timeouts = 0
+      @config   = YAML::load(ERB.new(File.read("#{BOT_ROOT}/config.yml")).result)[BOT_ENVIRONMENT]
+      @rooms    = {}
+      @root_logger = Logging.logger["CampfireBot"]
+      @log = Logging.logger[self]
+
+      log_dir = @config['log_dir']
+      Dir.mkdir(log_dir) unless Dir.exists? log_dir
+
+      # TODO much of this should be configurable per environment
+      @root_logger.add_appenders Logging.appenders.rolling_file("#{log_dir}/#{BOT_ENVIRONMENT}.log", 
+                            :layout => Logging.layouts.pattern(:pattern => "%d | %-6l | %-12c | %m\n"),
+                            :age => 'daily', 
+                            :keep => 7)
+      @root_logger.level = @config['log_level'] rescue :info
+    end
+
+    def connect
+      load_plugins unless !@config['enable_plugins']
+      begin
+        join_rooms
+      rescue Errno::ENETUNREACH, SocketError => e
+        @log.fatal "We had trouble connecting to the network: #{e.class}: #{e.message}"
+        abort "We had trouble connecting to the network: #{e.class}: #{e.message}"
+      rescue Exception => e
+        @log.fatal "Unhandled exception while joining rooms: #{e.class}: #{e.message} \n #{$!.backtrace.join("\n")}"
+        abort "Unhandled exception while joining rooms: #{e.class}: #{e.message} \n #{$!.backtrace.join("\n")}"
+      end  
+    end
+
+    def run(interval = 5)
+      catch(:stop_listening) do
+        trap('INT') { throw :stop_listening }
+        trap('TERM') { throw :stop_listening }
+
+        # since room#listen blocks, stick it in its own thread
+        @rooms.each_pair do |room_name, room|
+          Thread.new do
+            begin
+              room.listen(:timeout => 8) do |raw_msg|
+                handle_message(CampfireBot::Message.new(raw_msg.merge({:room => room})))
+              end
+            rescue Exception => e 
+              trace = e.backtrace.join("\n")
+              abort "something went wrong! #{e.message}\n #{trace}"
+            end
+          end
+        end
+
+        loop do
+          begin
+            @rooms.each_pair do |room_name, room|
+
+              # I assume if we reach here, all the network-related activity has occured successfully
+              # and that we're outside of the retry-cycle
+              @timeouts = 0
+
+              # Here's how I want it to look
+              # @room.listen.each { |m| EventHandler.handle_message(m) }
+              # EventHanlder.handle_time(optional_arg = Time.now)
+
+              # Run time-oriented events
+              Plugin.registered_intervals.each  do |handler| 
+                begin
+                  handler.run(CampfireBot::Message.new(:room => room))
+                rescue
+                  @log.error "error running #{handler.inspect}: #{$!.class}: #{$!.message} \n #{$!.backtrace.join("\n")}"
+                end
+              end
+
+              Plugin.registered_times.each_with_index  do |handler, index| 
+                begin
+                  Plugin.registered_times.delete_at(index) if handler.run
+                rescue
+                  @log.error "error running #{handler.inspect}: #{$!.class}: #{$!.message}, \n #{$!.backtrace.join("\n")}"
+                end
+              end
+
+            end
+            STDOUT.flush
+            sleep interval
+          rescue Timeout::Error => e
+            if @timeouts < 5
+              sleep(5 * @timeouts)
+              @timeouts += 1
+              retry
+            else
+              raise e.message
+            end
+          end
+        end
+      end
+
+      # Leave the room so users won't be under the false impression that the bot is still running.
+      @rooms.each_value.map(&:leave)
+    end
+
+    private
+
+    def join_rooms
+      join_rooms_as_user
+      @log.info "Joined all rooms."
+    end
+    
+    def join_rooms_as_user
+      @campfire = Tinder::Campfire.new(@config['site'], :token => @config['api_key'])
+
+      @config['rooms'].each do |room_name|
+        @rooms[room_name] = @campfire.find_room_by_name(room_name)
+        raise Exception.new("couldn't find a room named #{room_name}!") if @rooms[room_name].nil?
+        res = @rooms[room_name].join
+      end
+    end
+
+    def load_plugins
+      @config['enable_plugins'].each do |plugin_name|
+        load "#{plugin_name}.rb"
+      end
+
+      # And instantiate them
+      Plugin.registered_plugins.each_pair do |name, klass|
+        @log.info "loading plugin: #{name}"
+        STDOUT.flush
+        Plugin.registered_plugins[name] = klass.new
+      end
+    end
+
+    def handle_message(message)
+      # puts message.inspect
+
+      case message[:type]
+      when "KickMessage"
+        if message[:user][:id] == @campfire.me[:id]
+          @log.info "got kicked... rejoining after 10 seconds"
+          sleep 10
+          join_rooms_as_user
+          @log.info "rejoined room." 
+          return
+        end
+      when "TimestampMessage", "AdvertisementMessage"
+        return
+      when "TextMessage", "PasteMessage"
+        # only process non-bot messages
+        unless message[:user][:id] == @campfire.me[:id]
+          @log.info "#{message[:person]} | #{message[:message]}"
+          %w(commands speakers messages).each do |type|
+            Plugin.send("registered_#{type}").each do |handler|
+              begin
+                handler.run(message)
+              rescue Exception => e
+                @log.error "error running #{handler.inspect}: #{$!.class}: #{$!.message} \n #{$!.backtrace.join("\n")}"
+              end
+            end
+          end
+        end
+      else
+        @log.debug "got message of type #{message['type']} -- discarding"
+      end
+    end
+  end
+end
+
+def bot
+  CampfireBot::Bot.instance
+end