wesabot 1.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+*.gem
+Gemfile.lock
+pkg/*
+config/*.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://www.rubygems.org"
+ 
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2008 Wesabe
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,182 @@
+# Wesabot
+
+Wesabot, the Campfire bot framework.
+
+## Description
+
+Wesabot is a Campfire bot framework we've been using and developing at Wesabe 
+since not long after our inception. It started as a way to avoid parking tickets
+near our office ("Wes, remind me in 2 hours to move my car"), and has evolved 
+into an essential work aid. When you enter the room, Wes greets you with a link 
+to the point in the transcript where you last left. You can also ask him to 
+bookmark points in the transcript, send an sms message (well, an email) to 
+someone, or even post a tweet, among other things. His functionality is easily 
+extendable via plugins.
+
+To give Wes new powers, simply drop a plugin file in the plugins directory and 
+restart Wes (or, via the ReloadPlugin, he can be told to reload himself). See 
+`campfire/polling_bot/sample_plugin.rb` for more information, or just browse 
+the included plugins. Some of the plugins are somewhat Wesabe-specific (like 
+DeployPlugin, which lets us see what commits are on deck to be deployed), but 
+can be adapted or ignored as you see fit.
+
+If any of your plugins need to use a database, just drop a Datamapper model in 
+the plugins/models directory and it will be automatically loaded.
+
+## Installation
+
+### Prerequisites
+
+Wesabot can be installed as a gem, but [Nokogiri](http://nokogiri.org/) is
+required, and it has rather complicated prerequisites that vary by platform, so
+rather than reproducing that information here, please see
+<http://nokogiri.org/tutorials/installing_nokogiri.html>.
+
+You'll also need to install [SQLite3](http://www.sqlite.org/), and, at least
+on Ubuntu, the sqlite3 development libraries 
+(`sudo apt-get install libsqlite3-dev`). If you have specific installation
+instructions for other platforms, please feel free to send a pull request
+with changes to this README.
+
+### Installing as a Gem
+
+    gem install wesabot
+
+### Installing from Git
+
+Clone this repository, then `cd` to it and run `bundle install`.
+
+## Usage
+
+The first thing you need to do is to create a Campfire user for your bot,
+and make sure that user has access to whichever room(s) you would like the bot
+to appear in. Log into Campfire as that user and get the API token (click on
+"My info" in the upper right corner).
+
+Wesabot has four required parameters:
+
+* subdomain - your Campfire subdomain
+* api_token - the Campfire API token
+* room - the room in which you'd like the bot to appear
+* datauri - the sqlite3 database uri/path
+
+These parameters can be passed in either via a YAML config file, or on the
+command-line. See `config/wesabot.yml.sample` for a sample configuration file.
+
+Examples:
+
+    bin/wesabot -c config/wesabot.yml
+    bin/wesabot -d example -r Sandbox -t ecca8793813bd3e5720d9d562285db --database /path/to/database.db
+
+Run `wesabot --help` for usage information.
+
+**A few important things to note:**
+
+* The SQLite database does not need to exist initially--wesabot will create one
+at the path you specify.
+* On some systems (Ubuntu, at least) you will need to use the `--ssl-no-verify`
+(`-k`) option, at least until the next release of [Faraday](https://github.com/technoweenie/faraday),
+which includes [a fix](https://github.com/technoweenie/faraday/commit/2b9b798d07b95b3a3348e95c513fe42f5e21c6ee)
+for looking up SSL certs in the system store. If you run wesabot and get the
+error:
+
+        /usr/lib/ruby/1.8/net/http.rb:1060:in `request': undefined method `closed?' for nil:NilClass (NoMethodError)
+
+    That is the cause. (Run it again in verbose mode to see the SSL error.)
+
+
+Once Wes (or whatever you decide to name your bot) is running, you can see a list of available commands by entering into Campfire:
+
+    Wes, help
+
+That list currently looks like:
+
+    AirbrakePlugin:
+     - resolve <error number>
+         mark an error as resolved
+     - unresolve <error number>
+         mark an error as unresolved
+
+    BookmarkPlugin:
+     - bookmark: <name>
+         bookmark the current location
+
+    DebugPlugin:
+     - <enable|disable> debugging
+         enable or disable debug mode
+
+    DeployPlugin:
+     - what's on deck for <project>?
+         shortlog of changes not yet deployed to production
+     - what's on deck for <project> staging?
+         shortlog of changes not yet deployed to staging
+
+    GreetingPlugin:
+     - (disable|turn off) greetings
+         don't say hi when you log in (you grump)
+     - (enable|turn on) greetings
+         say hi when you log in
+     - toggle greetings
+         disable greetings if enabled, enable if disabled. You know--toggle.
+     - catch me up|ketchup
+         gives you a link to the point in the transcript where you last logged out
+
+    HelpPlugin:
+     - help
+         this message
+
+    ImageSearchPlugin:
+     - (photo|image|picture) of <subject>
+         find a new picture of <subject>
+     - search (google|flickr) for a (photo|image|picture) of <subject>
+         search the stated service for a new picture of <subject>
+
+    ReloadPlugin:
+     - reload
+         update and reload Wes
+
+    RemindMePlugin:
+     - remind (me|<person>) [in] <time string> to <message>
+         set up a reminder
+     - remind (me|<person>) to <message> (in|on|at|next|this) <time string>
+         set up a reminder
+     - [list|show] [person]['s] reminders
+         display current reminders for yourself or person
+     - delete reminder <n>
+         delete your reminder #n
+
+    SMSPlugin:
+     - set my sms address to: <address>
+         set your sms address
+     - set <person>'s sms address to
+         set someone else's sms address
+     - (sms|text|txt) <person>: <message>
+         send an sms message
+     - list sms addresses
+         list all sms addresses
+
+    TimePlugin:
+     - time
+         say the current time
+
+    TweetPlugin:
+     - tweet: <message>
+         post <message> to the configured user's twitter account
+     - save tweet: <message>
+         save <message> for later
+     - show tweets
+         shows the queued tweets for the configured user's twitter account
+     - show next tweet
+         shows the oldest queued twitter message
+     - post next tweet
+         sends the oldest queued twitter message
+     - post tweet <n>
+         sends the <n>th tweet from the list
+     - delete tweet <n>
+         deletes the <n>th tweet from the list
+
+    TwitterSearchPlugin:
+     - what are (people|is everyone) saying about <subject>
+         search twitter for tweets on <subject>
+     - what's the word on <subject>
+         search twitter for tweets on <subject>

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require "bundler/gem_tasks"
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run the specs for wesabot"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :cruise => :spec
+task :default => :spec

data/bin/wesabot

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# get the real path of this file so we can load the library
+file = Pathname.new(__FILE__).realpath
+
+# save the original invocation so we can restart ourselves later
+INVOCATION = [file.to_s, *ARGV]
+
+# chdir to this project's directory so bundler will be able to find
+# the .bundle directory itself
+oldpwd = Dir.pwd
+Dir.chdir(File.expand_path('../..', file))
+
+# load dependencies
+$:.push File.expand_path("../../lib", file)
+require 'rubygems'
+require 'wesabot'
+require 'optparse'
+require 'openssl'
+
+config = Campfire::Configuration.new
+daemonize = false
+pidfile = nil
+
+# get configuration from ARGV
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options]"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-c", "--config FILE", "Configuration file") do |path|
+    config = Campfire::FileConfiguration.new(File.expand_path(path, oldpwd))
+  end
+
+  opts.separator "OR"
+
+  opts.on("-t", "--token TOKEN", "API token (required)") do |api_token|
+    config.api_token = api_token
+  end
+
+  opts.on("-d", "--subdomain SUBDOMAIN", "Campfire subdomain (required)") do |subdomain|
+    config.subdomain = subdomain
+  end
+
+  opts.on("-r", "--room ROOM", "Campfire room (required)") do |room|
+    config.room = room
+  end
+
+  opts.on("--database PATH", "The sqlite3 database to use (required)") do |path|
+    config.datauri = "sqlite3://#{Pathname(File.expand_path(path, oldpwd)).expand_path}"
+  end
+
+  opts.on("-D", "--daemonize", "Daemonize the bot (run in the background)") do
+    daemonize = true
+  end
+
+  opts.on("--pid-file PATH", "PID file to write the daemon's PID to") do |path|
+    pidfile = path
+  end
+
+  opts.on("-o", "--log-file PATH", "The file to log STDOUT and STDERR to") do |path|
+    config.logger = Logger.new(path)
+  end
+
+  opts.on("-k", "--ssl-no-verify", "Don't verify SSL certs") do
+    config.ssl_verify = false
+  end
+
+  opts.on("-v", "--verbose", "Be verbose") do
+    config.verbose = true
+  end
+
+  opts.on("--version", "Print version") do
+    puts Campfire::VERSION
+    exit
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+# check for required options
+begin
+  optparse.parse!
+  config.validate!
+
+  config.logger.level = config.verbose?? Logger::DEBUG : Logger::INFO
+
+  if daemonize
+    require 'daemons'
+    puts "Daemonizing..."
+    Daemons.daemonize
+  end
+
+  File.open(pidfile, 'w') {|f| f << $$.to_s } if pidfile
+rescue Campfire::ConfigurationError, OptionParser::InvalidOption, OptionParser::MissingArgument => e
+  puts "#{File.basename($0)}: #{e}"
+  puts optparse
+  exit(1)
+end
+
+OpenSSL::debug = config.verbose?
+
+bot = Campfire::PollingBot.new(config)
+trap(:INT)  { bot.leave; exit }
+trap(:TERM) { bot.leave; exit }
+bot.run

data/config/wesabot.yml.sample

@@ -0,0 +1,4 @@
+api_token: ecca8793813bd3e5720d9d562285db
+subdomain: example
+room: Development
+datauri: sqlite3:///path/to/database

data/lib/campfire/bot.rb

@@ -0,0 +1,53 @@
+require "tinder"
+
+module Campfire
+  class Bot
+    attr_accessor :config, :room, :name, :campfire, :debug
+
+    def initialize(config)
+      self.config = config
+      options = {:token => config.api_token, :ssl_verify => config.ssl_verify }
+      self.campfire = Tinder::Campfire.new(config.subdomain, options)
+      begin
+        self.name = campfire.me['name']
+        self.room = campfire.find_room_by_name(config.room) or
+          raise ConfigurationError, "Could not find a room named '#{config.room}'"
+      rescue Tinder::AuthenticationFailed => e
+        raise # maybe do some friendlier error handling later
+      end
+      room.join
+      say("hey guys")
+    end
+
+    def base_uri
+      campfire.connection.uri.to_s
+    end
+
+    # convenience method so I don't have to change all the old #say method to #speak
+    def say(*args)
+      room.speak(*args)
+    end
+
+    # pick something at random from an array of sayings
+    def say_random(sayings)
+      say(sayings[rand(sayings.size)])
+    end
+
+    # return a random person out of the list of users logged in to this room
+    def other_person(exclude = nil)
+      # don't choose the excluded person or ourself
+      options = room.users.reject{|u| u[:name] =~ /^(#{exclude}|#{self.name})/ }
+      # return the other person's first name, or nil if we didn't find one
+      options.any? ? options[rand(options.size)][:name].split(' ').first : nil
+    end
+
+    def logger
+      config.logger
+    end
+
+    # Proxy everything to the room.
+    def method_missing(m, *args)
+      room.send(m, *args)
+    end
+  end
+end

data/lib/campfire/configuration.rb

@@ -0,0 +1,65 @@
+require 'logger'
+
+module Campfire
+  class ConfigurationError < RuntimeError; end
+
+  class Configuration
+    protected
+
+    def initialize(data={})
+      load data
+    end
+
+    def load(data)
+      data = data.inject({}) {|h,(k,v)| h[k.to_sym] = v; h }
+      self.api_token = data[:api_token]
+      self.subdomain = data[:subdomain]
+      self.room = data[:room]
+      self.verbose = data[:verbose] || false
+      self.datauri = data[:datauri]
+      self.logger = data[:logger] || data[:logfile] || Logger.new(STDOUT)
+      self.google_api_key = data[:google_api_key]
+      self.ssl_verify = data[:ssl_verify] != false
+    end
+
+    public
+
+    attr_accessor :api_token, :subdomain, :room, :verbose, :datauri, :logger, 
+                  :google_api_key, :ssl_verify
+
+    alias_method :verbose?, :verbose
+
+    def logger=(logger)
+      logger = Logger.new(logger) unless logger.is_a?(Logger)
+      @logger = logger
+    end
+
+    def validate!
+      api_token or raise ConfigurationError, 'no api token given'
+      subdomain or raise ConfigurationError, 'no subdomain given'
+      room      or raise ConfigurationError, 'no room given'
+      datauri   or raise ConfigurationError, 'no datauri given'
+      logger    or raise ConfigurationError, 'no logger given'
+    end
+
+    def reload!
+    end
+  end
+
+  class FileConfiguration < Configuration
+    protected
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+      reload!
+    end
+
+    public
+
+    def reload!
+      load YAML.load_file(path)
+    end
+  end
+end

data/lib/campfire/message.rb

@@ -0,0 +1,102 @@
+# Classes to encapsulate the various campfire message types
+require 'cgi'
+
+module Campfire
+  # base message class. All messages have a message_id, timestamp, person (first name of the user generating
+  # the message), person_full_name, and body, which is the text of the message
+  class Message
+    attr_accessor :message_id, :timestamp, :user, :person, :person_full_name, :body, :type
+
+    def initialize(params)
+      self.message_id = params[:id]
+      self.timestamp = params[:created_at] || Time.now
+      self.body = params[:body]
+      self.type = params[:type].gsub(/(.*?)Message$/, '\1') if params[:type]
+    end
+
+    def person_full_name=(name)
+      @person_full_name = name
+      @person = @person_full_name.split(' ').first # just get first name
+    end
+
+    def user=(user)
+      self.person_full_name = user.name
+      @user = user
+    end
+  end
+
+  # TextMessage - normal user text message
+  #   #command - if the message is addressed to the bot ("<bot name>, ..." or "..., <bot name>"), the
+  #  the part of the body minus the bot name (and comma) is returned by #command
+  class TextMessage < Message
+    attr_accessor :command
+
+    def addressed_to_me?
+      not command.nil?
+    end
+  end
+
+  # a PasteMessage is sent when a paste block appears. #link contains the link to the full text of the
+  # pasted block (TODO: grab the full paste from the link and have it available)
+  class PasteMessage < Message
+    attr_accessor :link
+
+    def initialize(params)
+      super
+      # FIXME: link is no longer available as a param. If we want the link, we
+      # need to construct it from https://#{subdomain}.campfirenow.com/room/#{params[:room_id]}/paste/#{params[:id]}
+      # self.link = params[:link]
+    end
+  end
+
+  # an UploadMessage is sent when a user uploads a file. #link contains the link to the file
+  class UploadMessage < Message
+    attr_accessor :link
+
+    def initialize(params)
+      super
+      # FIXME: link is no longer available as a param. If we want the link, we
+      # need to construct it from https://#{subdomain}.campfirenow.com/room/#{params[:room_id]}/uploads/#{params[:id]}/#{params[:filename]} (?)
+      # self.link = params[:link]
+    end
+  end
+
+  # EnterMessage - sent when a user enters the room
+  class EnterMessage < Message; end
+
+  # LeaveMessage - sent when a user leaves the room
+  class LeaveMessage < Message; end
+
+  # KickMessage - sent when a user times out and is booted from the room
+  class KickMessage < Message; end
+
+  # LockMessage - sent when a user locks the room
+  class LockMessage < Message; end
+
+  # UnlockMessage - sent when the room is unlocked
+  class UnlockMessage < Message; end
+
+  # AllowGuestsMessage - sent when guest access is turned on
+  class AllowGuestsMessage < Message; end
+
+  # DisallowGuestsMessage - sent when guest access is turned off
+  class DisallowGuestsMessage < Message; end
+
+  # TopicChangeMessage - sent when the room's topic is changed
+  class TopicChangeMessage < Message; end
+
+  # TimestampMessage - sent when a timestamp is posted to the room
+  class TimestampMessage < Message; end
+
+  # AdvertisementMessage - ads
+  class AdvertisementMessage < Message; end
+
+  # SoundMessage - when a user plays a sound
+  class SoundMessage < Message; end
+
+  # ConferenceCreatedMessage - when a conference call is started
+  class ConferenceCreatedMessage < Message; end
+  
+  # TweetMessage - when a tweet is posted
+  class TweetMessage < Message; end
+end