campfire-bot_alexchee 1.0.0

data/lib/plugin.rb

@@ -0,0 +1,77 @@
+module CampfireBot
+  class Plugin
+    @registered_plugins   = {}
+
+    @registered_commands  = []
+    @registered_messages  = []
+    @registered_speakers  = []
+    @registered_intervals = []
+    @registered_times     = []
+
+    class << self
+      attr_reader :registered_plugins,
+                  :registered_commands,
+                  :registered_messages,
+                  :registered_speakers,
+                  :registered_intervals,
+                  :registered_times
+
+      @@config_defaults = {}
+
+      # Registering plugins
+
+      def inherited(child)
+        Plugin.registered_plugins[child.to_s] = child
+      end
+
+      # Event handlers
+
+      def on_command(command, *methods)
+        methods.each do |method|
+          Plugin.registered_commands << Event::Command.new(command, self.to_s, method)
+        end
+      end
+
+      def on_message(regexp, *methods)
+        methods.each do |method|
+          Plugin.registered_messages << Event::Message.new(regexp, self.to_s, method)
+        end
+      end
+
+      def on_speaker(speaker, *methods)
+        methods.each do |method|
+          Plugin.registered_speakers << Event::Speaker.new(speaker, self.to_s, method)
+        end
+      end
+
+      def at_interval(interval, *methods)
+        methods.each do |method|
+          Plugin.registered_intervals << Event::Interval.new(interval, self.to_s, method)
+        end
+      end
+
+      def at_time(timestamp, *methods)
+        methods.each do |method|
+          Plugin.registered_times << Event::Time.new(timestamp, self.to_s, method)
+        end
+      end
+
+      # Declare a plugin configuration parameter with its default value
+      def config_var(name, default)
+        attr_reader name
+        @@config_defaults ||= {}
+        @@config_defaults[self.name] ||= {}
+        @@config_defaults[self.name][name] = default
+      end
+    end
+    def initialize
+      # initialize attr_readers setup with config_var
+      config_prefix = self.class.to_s.underscore
+      (@@config_defaults[self.class.name] || {}).each_pair { |name, default|
+        instance_variable_set("@#{name.to_s}",
+                              bot.config["#{config_prefix}_#{name.to_s}"] ||
+                                default)
+      }
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module CampfireBot
+  VERSION = '1.0.0'
+end

data/plugins-example/fun.rb

@@ -0,0 +1,95 @@
+class Fun < CampfireBot::Plugin
+  on_command    'say',              :say
+  on_message    Regexp.new("^#{bot.config['nickname']},\\s+(should|can|will|shall) (i|he|she|we|they) do it\\?", Regexp::IGNORECASE), :do_or_do_not
+  on_message    Regexp.new("^(good morning|morning|m0ink|hello|hi|hey|whassup|what's up|yo|hola|ola|'sup|sup)(,)*\\s*(#{bot.config['nickname']}).*$", Regexp::IGNORECASE), :greet
+  on_message  /(how's it|how are|how're) (ya |you )*(going|doing|doin).*/, :howareya
+  on_command    "blame", :blame
+  on_command    "trout", :trout
+  on_command    "slap", :trout
+  on_command    "troutslap", :trout
+  # on_speaker    'Tim R.',           :agree_with_tim
+  # on_message    /undo it/i,         :do_it
+  # on_message    /(^|\s)do it/i,     :undo_it
+  # at_time       1.minute.from_now,  :do_it
+
+  def initialize
+    @last_agreed = 20.minutes.ago
+    @log = Logging.logger["CampfireBot::Plugin::Fun"]
+  end
+  
+  def say(m)
+    m.speak(m[:message])
+  end
+  
+  def do_it(m = nil)
+    m.speak('Do it!')
+  end
+  
+  def undo_it(m)
+    m.speak('Undo it!')
+  end
+  
+  def do_or_do_not(m)
+    responses = ['Do it!', 'Don\'t do it!', 'Undo it!']
+    m.speak(responses.choice)
+  end
+  
+  def agree_with_tim(m)
+    m.speak('I agree with Tim.') unless @last_agreed > 15.minutes.ago
+    @last_agreed = Time.now
+  end
+  
+  def greet(m)
+    messages = ['Howdy', 'Wassup', 'Greets', 'Hello', 'Hey there', "It's a", 'Good day']
+    m.speak("#{messages.choice} #{m[:person].split(' ')[0]}")
+  end
+  
+  def howareya(m)
+    messages = ["just great", "peachy", "mas o menos", 
+    	 "you know how it is", "eh, ok", "pretty good. how about you?"]
+    m.speak(messages[rand(messages.size)])
+  end
+  
+  def blame(m)
+    # TODO: capture user-submitted entries to a yaml file and regurgitate them
+    # TODO: put all the default ones in a separate yaml
+    if m[:message].strip.length > 0
+      blamed = m[:message].strip
+    else
+      users = m[:room].users.delete_if {|u| u[:name] == bot.campfire.me[:name]}.map {|u| u[:name]}
+      others = ["nobody", "my", "Microsoft", "Steve Jobs", "the terrorists", "your", 
+                "Project Management", "Development", "Management", "Corporate", "Cartman", "the user", 
+                "the liberal media", "Wall Street"]
+      
+      # mostly blame the other users
+      if rand(10) >= 2
+        blamed = users.choice
+      else 
+        blamed = others.choice
+      end
+      
+    end
+    
+    case blamed
+    when "nobody"
+      blamestring = "It's nobody's fault"
+    when "your", "my"
+      blamestring = "It's all #{blamed} fault"
+    else
+      blamestring = "It's all #{blamed}'s fault"
+      blamestring = "It's all #{blamed}' fault" if blamed[-1].chr == "s"
+    end
+   
+    m.speak blamestring
+  end
+  
+  def trout(m)
+    if m[:message].strip.length > 0
+      selected_user_name = m[:message].strip
+    else
+      users = m[:room].users.map{|u| u[:name] }
+      selected_user_name = users.choice
+    end
+    m.speak("#{m[:person]} slaps #{selected_user_name} #{["upside the head", "in the face", "on the rear", "where it counts", "in the knees", "ineffectually", "in the elbow", "on the funny bone", "in the ear", "on the nose", "in the teeth"].choice} with a #{%w(good-sized large decaying moldy spiked sabre-toothed surprised disappointed dramatic enraged rabid bug-eyed rotten foul-smelling demonic cluestick-holding).choice} trout")
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,96 @@
+require 'rspec'
+BOT_ROOT        = File.join(File.dirname(__FILE__), '..')
+BOT_ENVIRONMENT = 'development'
+
+require File.join(File.dirname(__FILE__), '../lib/bot.rb')
+bot = CampfireBot::Bot.instance
+require "#{BOT_ROOT}/lib/event.rb"
+
+
+class TestingCommand < CampfireBot::Event::Command
+
+  def filter_message(msg)
+    super
+  end
+end
+
+describe "processing messages" do
+  
+  before(:all) do
+    bot = CampfireBot::Bot.instance
+    @nickname = bot.config['nickname']
+  end
+  
+  before(:each) do
+    @command = TestingCommand.new("command", nil, nil)
+  end  
+    
+  def match?(msg)
+    @command.match?({:message => msg})
+  end
+  
+  describe "and recognizing a command" do
+    
+    it "should handle a !command" do
+      match?("!command").should be_true
+    end
+  
+    it "should handle a !command with arguments" do
+      match?("!command foo").should be_true
+    end
+  
+    it "should handle a command with nickname and a comma" do
+      match?("#{@nickname}, command").should be_true
+    end
+  
+    it "should handle a command with nickname and a colon" do
+      match?("#{@nickname}: command").should be_true
+    end
+  
+    it "should handle a command with nickname and arguments" do
+      match?("#{@nickname}, command foo").should be_true
+    end
+  
+    it "should ignore a non-matching !command" do
+      match?("!foo").should be_false
+    end
+  
+    it "should ignore an addressed non-command" do
+      match?("#{@nickname}, nothing").should be_false
+    end
+  
+    it "should ignore things that aren't commands at all" do
+      ["nothing", "#{@nickname}, ", " ! command", "hey #{@nickname}", "!command!command", "!command,command"].each do |t|
+        match?(t).should be_false
+      end
+    end
+  end
+  
+  describe "and filtering it" do
+    
+    def filter(msg)
+      @command.filter_message({:message => msg})[:message]
+    end
+
+    it "should be empty with no arguments" do
+      filter("!command").should == ""
+      filter("#{@nickname}, command").should == ""
+    end
+    
+    it "should return one argument" do
+      filter("!command foo").should == "foo"
+      filter("#{@nickname}, command foo").should == "foo"
+    end
+    
+    it "should return more than one argument" do
+      filter("!command foo bar baz").should == "foo bar baz"
+      filter("#{@nickname}, command foo bar baz").should == "foo bar baz"
+    end
+    
+    it "should deal with some weirdness" do
+      filter("!command !command").should == "!command"
+    end
+    
+  end
+end
+

data/spec/plugin_spec.rb

@@ -0,0 +1,43 @@
+require 'rspec'
+BOT_ROOT        = File.join(File.dirname(__FILE__), '..')
+BOT_ENVIRONMENT = 'test'
+
+require File.join(File.dirname(__FILE__), '../lib/bot.rb')
+bot = CampfireBot::Bot.instance
+
+describe "config_var method" do
+  class ExamplePlugin < CampfireBot::Plugin
+    config_var :foo, "default foo"
+  end
+
+  def setup_plugin(klass, config={})
+    @bot = CampfireBot::Bot.instance
+    @bot.stub!(:config).and_return({'nickname' => 'Bot'}.merge(config))
+    @plugin = klass.new
+    CampfireBot::Plugin.registered_plugins[klass.to_s] = @plugin
+  end
+
+  it "should setup default bug_url value" do
+    setup_plugin ExamplePlugin
+    @plugin.foo.should == "default foo"
+  end
+
+  it "should allow override of parameter via configuration" do
+    setup_plugin ExamplePlugin, 'example_plugin_foo' => 'bar'
+    @plugin.foo.should == "bar"
+  end
+
+  it "should keep defaults for two classes separate" do
+    class ExamplePlugin2 < CampfireBot::Plugin
+      config_var :bar, "default bar"
+    end
+    setup_plugin ExamplePlugin
+    plugin = @plugin
+    setup_plugin ExamplePlugin2
+    plugin.instance_variable_get(:@foo).should == "default foo"
+    @plugin.instance_variable_get(:@bar).should == "default bar"
+    # Used to fail with value "default bar"
+    plugin.instance_variable_get(:@bar).should == nil
+    @plugin.instance_variable_get(:@foo).should == nil
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/vendor/escape/ChangeLog

@@ -0,0 +1,30 @@
+2007-02-28  Tanaka Akira  <akr@fsij.org>
+
+	* escape.rb: Escape::HTMLAttrValue defined.
+	  Escape.html_attr_value returns it.
+
+2007-02-27  Tanaka Akira  <akr@fsij.org>
+
+	* escape.rb: make StringWrapper into class.
+	  Escape::ShellEscaped, Escape::HTMLEscaped and Escape::PercentEncoded
+	  inherit it.
+
+2007-02-26  Tanaka Akira  <akr@fsij.org>
+
+	* escape.rb: Escape::ShellEscaped defined.
+	  Escape.shell_command and Escape.shell_single_word returns
+	  Escape::ShellEscaped object instead of a string.
+
+	* escape.rb: Escape::HTMLEscaped defined.
+	  Escape.html_text and Escape.html_attr_value returns
+	  Escape::HTMLEscaped object instead of a string.
+
+	* escape.rb: Escape::PercentEncoded defined.
+	  Escape.uri_segment, Escape.uri_path and Escape.html_form returns
+	  Escape::PercentEncoded object instead of a string.
+
+	* escape.rb: rename Escape.html_attr to Escape.html_attr_value.
+
+2007-01-05  Tanaka Akira  <akr@fsij.org>
+
+	* version 0.1 released.

data/vendor/escape/Makefile

@@ -0,0 +1,5 @@
+rdoc:
+	rdoc --op rdoc escape.rb
+
+README: misc/README.erb
+	erb misc/README.erb > README

data/vendor/escape/README

@@ -0,0 +1,81 @@
+= escape - HTML/URI/shell escaping utilities
+
+
+escape library provides several HTML/URI/shell escaping functions.
+
+== Author
+
+Tanaka Akira <akr@fsij.org>
+
+== Home Page
+
+((<URL:http://www.a-k-r.org/escape/>))
+
+== Feature
+
+* several escaping/composing functions
+  * HTML text
+  * HTML attribute value
+  * HTML form (x-www-form-urlencoded)
+  * URI path
+  * shell command line
+* dedicated classes for escaped strings
+* escape and compose strongly related strings at once
+
+== Usage
+
+  require 'escape'
+
+  Escape.shell_command(["echo", "*"]) #=> #<Escape::ShellEscaped: echo '*'>
+  Escape.uri_path("a?b/c?d/e?f") #=> #<Escape::PercentEncoded: a%3Fb/c%3Fd/e%3Ff>
+  Escape.html_form([["a","b"], ["c","d"]]) #=> #<Escape::PercentEncoded: a=b&c=d>
+  Escape.html_form({"a"=>"b", "c"=>"d"}) #=> #<Escape::PercentEncoded: a=b&c=d>
+  Escape.html_text("a & b < c > d") #=> #<Escape::HTMLEscaped: a &amp; b &lt; c &gt; d>
+  Escape.html_attr_value("ab&<>\"c") #=> #<Escape::HTMLAttrValue: "ab&amp;&lt;&gt;&quot;c">
+
+== Requirements
+
+* ruby : http://www.ruby-lang.org/
+
+== Download
+
+* latest release: ((<escape-0.2.tar.gz|URL:escape-0.2.tar.gz>))
+
+* development version in Subversion repository:
+
+    % svn co svn://svn@svn.a-k-r.org/akr/escape/trunk escape
+
+== Install
+
+  % ruby install.rb
+
+== Reference Manual
+
+See rdoc/classes/Escape.html or
+((<URL:http://www.a-k-r.org/escape/rdoc/classes/Escape.html>))
+
+== License
+
+The modified BSD licence
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  
+   1. Redistributions of source code must retain the above copyright notice, this
+      list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+   3. The name of the author may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+  
+  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+  EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+  OF SUCH DAMAGE.

data/vendor/escape/VERSION

@@ -0,0 +1 @@
+0.2