wesabot 1.0.1

data/lib/campfire/polling_bot/plugins/deploy/spec/deploy_plugin_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+describe DeployPlugin do
+  def use_example_config
+    @plugin.config = {
+      'projects' => {
+        'my_super_site' => {
+          'deployed_revision_url' => 'http://www.example.com/REVISION'
+        },
+
+        'other' => {
+          'deployed_revision_url' => 'http://www.other.com/REVISION'
+        }}}
+  end
+
+  def use_no_config
+    @plugin.config = nil
+  end
+
+  def use_blank_config
+    @plugin.config = {'project' => {}}
+  end
+
+  before do
+    @plugin = DeployPlugin.new
+  end
+
+  context "with no configuration" do
+    before do
+      use_no_config
+    end
+
+    it "has no default project" do
+      @plugin.default_project.should be_nil
+    end
+
+    it "has an empty hash of projects" do
+      @plugin.projects.should == {}
+    end
+
+    it "omits the short form of the 'on deck' command from the help" do
+      @plugin.help.should have(2).items
+    end
+  end
+
+  describe "the 'on deck' command" do
+    context "with no projects" do
+      before do
+        use_blank_config
+      end
+
+      it "tells the sender that it doesn't know about any projects" do
+        asking("wes, what's on deck?").
+          should make_wes_say( %r{I don't know about any projects} )
+      end
+    end
+
+    context "with projects" do
+      before do
+        use_example_config
+        @plugin.stub!(:deployed_revision).and_return('abcde')
+      end
+
+      it "tells the sender when the project asked about does not exist" do
+        asking("wes, what's on deck for foobar?").
+          should make_wes_say( %r{I don't know anything about foobar} ).
+                 and_paste("my_super_site\nother")
+      end
+
+      context "with no default project" do
+        before do
+          allow_message_expectations_on_nil
+          @project.stub!(:default_project).and_return(nil)
+        end
+
+        context "and more than one registered project" do
+          it "lists available projects when the project is omitted" do
+            asking("wes, what's on deck?").
+              should make_wes_say( %r{I don't have a default project} ).
+                     and_paste("my_super_site\nother")
+          end
+        end
+
+        context "and only one registered project" do
+          before do
+            @plugin.projects.delete(@plugin.projects.keys.first) while @plugin.projects.size > 1
+          end
+
+          it "uses the only listed project as the default project" do
+            @plugin.default_project.should == @plugin.projects.keys.first
+          end
+        end
+      end
+
+      context "with a default project" do
+        before do
+          @plugin.stub!(:default_project).and_return('my_super_site')
+          @plugin.stub!(:project_shortlog).
+                  and_return("John Tester (1):\n    Fix homepage links.\n")
+        end
+
+        it "uses the default project when the project is omitted" do
+          asking("wes, what's on deck?").
+            should make_wes_say( %r{Here's what's on deck for my_super_site} ).
+                   and_paste(anything)
+        end
+      end
+
+      context "when there is nothing on deck" do
+        before do
+          @plugin.stub!(:project_shortlog).
+                  and_return('')
+        end
+
+        it "responds that nothing is on deck for the project" do
+          asking("wes, what's on deck for my_super_site?").
+            should make_wes_say("There's nothing on deck for my_super_site right now.")
+        end
+      end
+
+      context "when there is something on deck" do
+        before do
+          @plugin.stub!(:project_shortlog).
+                  and_return("John Tester (1):\n    Fix homepage links.\n\n")
+        end
+
+        it "responds with the shortlog for the project" do
+          asking("wes, what's on deck for my_super_site?").
+            should make_wes_say("Here's what's on deck for my_super_site:").
+                    and_paste(<<-EOS)
+$ git shortlog abcde..HEAD
+
+John Tester (1):
+    Fix homepage links.
+
+EOS
+        end
+      end
+
+      context "when getting the shortlog fails" do
+        before do
+          @plugin.stub!(:project_shortlog).
+                  and_raise("testing")
+        end
+
+        it "reports the error to the user" do
+          asking("wes, what's on deck for my_super_site?").
+            should make_wes_say("Sorry John, I couldn't get what's on deck for my_super_site.")
+        end
+      end
+    end
+  end
+end

data/lib/campfire/polling_bot/plugins/greeting/greeting_plugin.rb

@@ -0,0 +1,146 @@
+# Plugin to greet people when they enter, provide a catch-up url, and notify them of any "future" messages
+# requires the HistoryPlugin
+class GreetingPlugin < Campfire::PollingBot::Plugin
+  accepts :text_message, :addressed_to_me => true
+  accepts :enter_message
+
+  def process(message)
+    user = message.user
+    wants_greeting = wants_greeting?(user)
+    if message.kind_of?(Campfire::EnterMessage)
+      link = catch_up_link(message.person_full_name)
+      futures = future_messages(message.person_full_name, message.person)
+      if wants_greeting && link
+        bot.say("Hey #{message.person.downcase}. Catch up: #{link}")
+      end
+      futures.each{|m| bot.say(m) }
+    elsif message.kind_of?(Campfire::TextMessage)
+      case message.command
+      when /(disable|turn off) greetings/i
+        wants_greeting(user, false)
+        bot.say("OK, I've disabled greetings for you, #{message.person}")
+        return HALT
+      when /(enable|turn on) greetings/i        
+        wants_greeting(user, true)
+        bot.say("OK, I've enabled greetings for you, #{message.person}")
+        return HALT
+      when /toggle greetings/i
+        old_setting = wants_greeting?(user)
+        wants_greeting(user, !old_setting)
+        bot.say("OK, I've #{old_setting ? 'disabled' : 'enabled'} greetings for you, #{message.person}")
+        return HALT
+      when /catch me up|ketchup/i
+        if link = catch_up_link(message.person_full_name, true)
+          bot.say("Here you go, #{message.person}: #{link}")
+        else
+          bot.say("Hmm...couldn't find when you last logged out, #{message.person}")
+        end
+        return HALT
+      end
+    end
+  end
+  # return array of available commands and descriptions
+  def help
+    [['(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"]
+    ]
+  end
+
+  private
+
+  # return the last message we saw from the user
+  def last_message(person_full_name)
+    # look for a leave message
+    last_left = Message.last_left(person_full_name)
+    # look for any message more than a couple minutes ago (this allows us
+    # to say hi in CF and then ask for a catch-up link without getting a link
+    # to the message we just sent)
+    last_message = Message.last_message(person_full_name, Time.now - 120)
+
+    if last_left && last_left.message_type == 'Kick'
+      # if person timed out, look for their last entry before the timeout
+      last_seen = last_message
+    else
+      # if the person said things after their last leave message, they are
+      # probably still in the room, so we use their last message instead
+      last_seen = [last_left, last_message].compact.sort_by{|m| m.timestamp }.last
+    end
+
+    return last_seen
+  end
+
+  # get link to when the user last left the room so they can catch up
+  # only return a link if the user has been gone long enough, unless forced
+  def catch_up_link(person_full_name, force=false)
+    message = last_message(person_full_name)
+    # only give a link if the last message is likely no longer on the first page
+    if message && (force || !message.visible?)
+      return message_link(message.message_id)
+    else
+      return nil
+    end
+  end
+
+  # Tell the person who's just entered about what people were asking them to
+  # read about while they were gone.
+  def future_messages(person_full_name, person)
+    future_messages = []
+    verbs = ["invoked", "called to", "cried out for", "made a sacrifice to", "let slip",
+             "doorbell ditched", "whispered sweetly to", "walked over broken glass to get to",
+             "prayed to the god of", "ran headlong at", "checked in a timebomb for",
+             "interpolated some strings TWO TIMES for", "wished upon a", "was like, oh my god",
+             "went all", "tested the concept of"]
+
+    # future Brian/future Brian Donovan
+    names = [person_full_name, person]
+
+    # future BD
+    name_words = person_full_name.split(/\s+/)
+    names << (name_words.first[0,1]+name_words.last[0,1]) if name_words.size > 1
+
+    future_person = Regexp.new("(?:future |@)(#{names.join('|')})\\b", Regexp::IGNORECASE)
+    future_everybody = Regexp.new("(?:future |@)everybody", Regexp::IGNORECASE)
+
+    if message = last_message(person_full_name)
+      candidates = Message.all(
+        :message_id.gt => message.message_id,
+        :person.not => ['Fogbugz','Subversion','Capistrano',bot.name],
+        :message_type => 'Text')
+      candidates.each do |row|
+        if row.body.match(future_person)
+          verbed = verbs[rand(verbs.size)]
+          future_messages << "#{row.person} #{verbed} future #{person} at: #{message_link(row.message_id)}"
+        elsif row.body.match(future_everybody)
+          verbed = verbs[rand(verbs.size)]
+          future_messages << "#{row.person} #{verbed} future everybody: \"#{row.body}\""
+        end
+      end
+    end
+    return future_messages
+  end
+
+  def wants_greeting?(user)
+    @wants_greeting_cache ||= User.all.inject({}) do |memo, u|
+      memo.merge(u => u.wants_greeting?)
+    end
+
+    if @wants_greeting_cache[user].nil?
+      @wants_greeting_cache[user] = user.wants_greeting = true
+    end
+
+    return @wants_greeting_cache[user]
+  end
+
+  def wants_greeting(user, wants_greeting)
+    user.wants_greeting = wants_greeting
+    @wants_greeting_cache[user] = wants_greeting
+  end
+
+  def message_link(id)
+    "#{bot.base_uri}/room/#{bot.room.id}/transcript/message/#{id}#message_#{id}"
+  end
+
+end
+

data/lib/campfire/polling_bot/plugins/greeting/greeting_setting.rb

@@ -0,0 +1,19 @@
+# used by GreetingPlugin
+class GreetingSetting
+  include DataMapper::Resource
+  property :id,             Serial
+  property :person,         String, :index => true
+  property :wants_greeting, Boolean
+
+  belongs_to :user, :required => false
+
+  def self.for_user(user)
+    result = first(:user => user) || first(:person => user.name, :user => nil)
+
+    if result && result.user.nil?
+      result.update(:user => user)
+    end
+
+    return result
+  end
+end

data/lib/campfire/polling_bot/plugins/greeting/spec/greeting_plugin_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe GreetingPlugin do
+  before do
+    GreetingSetting.all.destroy
+    User.all.destroy
+    @plugin = described_class.new
+    @plugin.stub!(:catch_up_link).and_return("http://example.com")
+  end
+
+  it 'greets users as they enter the room by default' do
+    entering.should make_wes_say(/^Hey John/i)
+  end
+
+  it 'allows disabling greetings per user' do
+    say('wes, disable greetings')
+    leave
+    entering.should_not make_wes_say_anything
+  end
+
+  it 'confirms disabling greetings per user' do
+    saying('wes, disable greetings').
+      should make_wes_say("OK, I've disabled greetings for you, John")
+  end
+
+  it 'allows re-enabling greetings per user' do
+    say('wes, disable greetings')
+    say('wes, enable greetings')
+    leave
+    entering.should make_wes_say(/^Hey John/i)
+  end
+
+  it 'confirms re-enabling greetings per user' do
+    say('wes, disable greetings')
+    saying('wes, enable greetings').
+      should make_wes_say("OK, I've enabled greetings for you, John")
+  end
+
+  it 'allows toggling greetings per user' do
+    say('wes, enable greetings')
+    say('wes, toggle greetings')
+    leave
+    entering.should_not make_wes_say_anything
+  end
+
+  it 'confirms toggling greetings per user' do
+    say('wes, enable greetings')
+    saying('wes, toggle greetings').
+      should make_wes_say("OK, I've disabled greetings for you, John")
+  end
+end

data/lib/campfire/polling_bot/plugins/greeting/spec/greeting_setting_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe GreetingSetting do
+  before do
+    @bot = FakeBot.new
+    User.all.destroy
+    GreetingSetting.all.destroy
+  end
+
+  describe ".for_user" do
+    context "when the user has no setting" do
+      before do
+        @user = User.create(:name => "Marc")
+      end
+
+      it "returns nil" do
+        described_class.for_user(@user).should be_nil
+      end
+    end
+
+    context "when the user has a setting by name only" do
+      before do
+        @user = User.create(:name => "Bob")
+        @gs = described_class.create(:person => "Bob")
+      end
+
+      it "returns the greeting setting" do
+        described_class.for_user(@user).should == @gs
+      end
+
+      it "associates the greeting setting with the user" do
+        lambda { described_class.for_user(@user) }.
+          should change { @gs.reload.user }.
+                  from(nil).to(@user)
+      end
+    end
+
+    context "when the user has the same name as another with an associated setting" do
+      before do
+        @user = User.create(:name => "Sam")
+        @other = User.create(:name => "Sam")
+        @gs = described_class.create(:person => "Sam", :user => @other)
+      end
+
+      it "returns nil" do
+        described_class.for_user(@user).should be_nil
+      end
+    end
+
+    context "when the user has an associated greeting setting" do
+      before do
+        @user = User.create(:name => "Coda")
+        @gs = described_class.create(:person => "Coda", :user => @user)
+      end
+
+      it "returns the associated greeting setting" do
+        described_class.for_user(@user).should == @gs
+      end
+    end
+  end
+end

data/lib/campfire/polling_bot/plugins/help/help_plugin.rb

@@ -0,0 +1,53 @@
+# Plugin to display available commands for each plugin
+class HelpPlugin < Campfire::PollingBot::Plugin
+  accepts :text_message, :addressed_to_me => true
+  priority 0
+
+  def process(message)
+    person = message.person
+    case message.command
+    when /help(?:\s(.*))?/i
+      if $1
+        name = $1
+        plugin = plugin_helps.keys.find do |k|
+          k =~ /(#{name}|#{name.gsub(/s$/i, '')})(plugin)?/i
+        end
+        matched_helps = { plugin => plugin_helps[plugin] } if plugin
+      end
+      matched_helps ||= plugin_helps
+
+      bot.paste msg_for(matched_helps)
+      return HALT
+    end
+  end
+
+  # return array of available commands and descriptions
+  def help
+    [['help', "this message"]]
+  end
+
+protected
+
+  def plugin_helps
+    @plugin_helps ||= begin
+      help = bot.plugins.map do |plugin|
+        begin
+          [plugin.to_s, plugin.help] if plugin.respond_to?(:help)
+        rescue Exception => e
+          bot.log_error(e)
+        end
+      end.compact
+      Hash[help]
+    end
+  end
+
+  def msg_for(help)
+    help.keys.sort.map do |plugin|
+      cmds = help[plugin].map do |command, description|
+        " - #{command}\n     #{description}\n"
+      end.join
+      "#{plugin}:\n" + cmds
+    end.join("\n")
+  end
+
+end

data/lib/campfire/polling_bot/plugins/history/history_plugin.rb

@@ -0,0 +1,34 @@
+# records every message the bot receives
+class HistoryPlugin < Campfire::PollingBot::Plugin
+  accepts :all
+  priority 100
+
+  def process(message)
+    @room_locked ||= false
+    if message.kind_of?(Campfire::LockMessage)
+      @room_locked = true
+      return
+    elsif message.kind_of?(Campfire::UnlockMessage)
+      @room_locked = false
+      return
+    end
+
+    save_message(message) unless @room_locked
+  end
+
+  private
+
+  def save_message(message)
+    params = {
+      :room => bot.room.id,
+      :message_id => message.message_id,
+      :message_type => message.type,
+      :person => message.respond_to?(:person_full_name) ? message.person_full_name : nil,
+      :user_id => message.user && message.user.id,
+      :link => message.respond_to?(:link) ? message.link : nil,
+      :body => message.respond_to?(:body) ? message.body : nil,
+      :timestamp => message.timestamp.to_i
+    }
+    Message.create(params)
+  end
+end

data/lib/campfire/polling_bot/plugins/image_search/displayed_image.rb

@@ -0,0 +1,8 @@
+# used by ImageSearchPlugin
+require 'dm-core'
+
+class DisplayedImage
+  include DataMapper::Resource
+  property :id,  Serial
+  property :uri, String, :index => true
+end

data/lib/campfire/polling_bot/plugins/image_search/image_search_plugin.rb

@@ -0,0 +1,106 @@
+require 'httparty'
+require 'google-search'
+
+# plugin to send a tweet to a Twitter account
+class ImageSearchPlugin < Campfire::PollingBot::Plugin
+  priority 1
+  accepts :text_message, :addressed_to_me => true
+
+  def process(message)
+    searched = false
+
+    case message.command
+    when /(google|flickr)\sfor\sa\s(?:photo|image|picture)\s+of:?\s+(?:a:?\s+)?\s*("?)(.*?)\1$/i
+      subject = $3
+      photo = next_photo(subject, $1)
+      searched = true
+    when /(?:photo|image|picture)\s+of:?\s+(?:a:?\s+)?\s*("?)(.*?)\1$/i
+      subject = $2
+      photo = next_photo(subject)
+      searched = true
+    end
+
+    if searched
+      if photo
+        DisplayedImage.create(:uri => photo)
+        bot.say(photo)
+      else
+        bot.say("Couldn't find anything for \"#{subject}\"")
+      end
+      return HALT
+    end
+  end
+
+  # return array of available commands and descriptions
+  def help
+    [
+      ['(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>"]
+    ]
+  end
+
+private
+
+  def next_photo(subject, sources = %w(google flickr))
+    next_photo = nil
+
+    if sources == ["google"] || (sources.include?("google") && bot.config.google_api_key)
+      # google search lazy-fetches pages of results, so we only search as far as we have to
+      if image = query_google(subject).find{|i| !DisplayedImage.first(:uri => i.uri) }
+        next_photo ||= image.uri
+      end
+    end
+
+    if sources.include?("flickr")
+      next_photo ||= query_flickr(subject).find{|u| !DisplayedImage.first(:uri => u) }
+    end
+
+    return next_photo
+  end
+
+  def query_google(subject)
+    unless bot.config.google_api_key
+      bot.say("I don't have a Google Search API key. " +
+        "Please add it to my config with the key 'google_api_key'.")
+      return []
+    end
+
+    logger.debug("Searching Google Images for #{subject}")
+    results = Google::Search::Image.new(
+      :query => subject,
+      :api_key => bot.config.google_api_key,
+      :image_type => :photo,
+      :safety_level => :off
+    )
+
+    logger.debug("Got response #{results.inspect}")
+    return results || []
+  end
+
+  def query_flickr(subject)
+    options = {:query => {:q => "select * from flickr.photos.search where text=\"#{subject}\""} }
+    logger.debug("YQL query #{options[:query][:q]}")
+
+    if proxy = (config && config['proxy']) || ENV['HTTP_PROXY']
+      proxy_uri = URI.parse(proxy)
+      options.update(:http_proxyaddr => proxy_uri.host, :http_proxyport => proxy_uri.port)
+    end
+
+    response = HTTParty.get("http://query.yahooapis.com/v1/public/yql", options)
+    logger.debug("Got response #{response.parsed_response.inspect}")
+    case response.code
+    when 200
+      return [] if response["query"]["yahoo:count"] == "0" || response["query"]["results"].nil?
+      photos = response["query"]["results"]["photo"]
+      photos = [photos] if photos.is_a?(Hash)
+      return photos.map {|p| "http://farm%s.static.flickr.com/%s/%s_%s.jpg?v=0" % [p['farm'], p['server'], p['id'], p['secret']]}
+    when 403
+      bot.say("Sorry, we seem to have hit our query limit for the day.")
+      return []
+    else
+      bot.say("Hmm...didn't work. Got this response:")
+      bot.paste(response.body)
+      return nil
+    end
+  end
+end

data/lib/campfire/polling_bot/plugins/interjector/interjector_plugin.rb

@@ -0,0 +1,58 @@
+# Plugin to make Wes actively comment (and maybe super annoying)
+class InterjectorPlugin < Campfire::PollingBot::Plugin
+  accepts :text_message
+  priority -1
+
+  def process(message)
+    person = message.person
+    case message.command || message.body
+    when /jessica alba/i
+      bot.say_random [
+        "Jessica Alba is my dream girl",
+        "no question, the hottest girl ever",
+        "yeah... er, what was I saying?",
+        "she really is incredibly hot, you know",
+      ]
+      return HALT
+    when /^(goodnight|night)(,?\s(all|every(body|one)))$/i
+      bot.say "goodnight, #{person}"
+      return HALT
+    when /^(facepalm|EFACEPALM|:fp|:facepalm:|\*facepalm\*|m\()$/i
+      bot.say_random [
+        # picard facepalm
+        "https://img.skitch.com/20110224-875h7w1654tgdhgrxm9bikhkwq.jpg",
+        # polar bear facepalm
+        "https://img.skitch.com/20110224-bsd2ds251eit8d3t1y2mkjtfx8.jpg"
+      ]
+    when /^(double facepalm|EDOUBLEFACEPALM|:fpfp|:doublefacepalm:|m\( m\()$/i
+      # picard + riker facepalm
+      bot.say "https://img.skitch.com/20110224-ncacgpudhfr2s4te6nswenxaqt.jpg"
+    when /^i see your problem/i
+      # pony mechanic
+      bot.say "https://img.skitch.com/20110224-8fmfwdmg6kkrcpijhamhqu7tm6.jpg"
+    when /^(wfm|womm|works on my machine)$/i
+      # works on my machine
+      bot.say "https://img.skitch.com/20110224-jrcf6e4gc936a2mxc3mueah2in.png"
+    when /^(stacktrace or gtfo|stacktrace or it didn't happen|stacktrace!)$/i
+      # stacktrace or gtfo
+      bot.say "https://img.skitch.com/20110224-pqtmiici9wp9nygqi4nw8gs6hg.png"
+    when /^this is sparta\!*?$/i
+      # this is sparta
+      bot.say "https://img.skitch.com/20110225-k9xpadr2hk37pe5ed4crcqria1.png"
+    when /^i have no idea what i'm doing$/i
+      # I have no idea what I'm doing
+      bot.say "https://img.skitch.com/20110304-1tcmatkhapiq6t51wqqq9igat5.jpg"
+    when /^party[?!.]*$/i
+      # party party party party party cat
+      bot.say "https://img.skitch.com/20110309-qtd33sy8k5yrdaeqa9e119bwd1.jpg"
+    when /^(bomb|system error)$/i
+      # sorry, a system error has occurred
+      bot.say "https://img.skitch.com/20110312-8g31a37spacdjgatr82g3g98j1.jpg"
+    when /^stop hitting yourself$/i
+      # and the angel said to him, Stop hitting yourself!
+      bot.say "https://img.skitch.com/20110316-q7h49p69pjhhyy8756rha2a1jf.jpg"
+    end
+  end
+
+
+end