campfire-bot 0.0.1

data/spec/command_spec.rb

@@ -0,0 +1,96 @@
+require 'spec'
+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/jira_spec.rb

@@ -0,0 +1,264 @@
+require 'spec'
+require 'rubygems'
+require 'xmlsimple'
+
+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}/plugins/jira.rb"
+
+
+class SpecMessage < CampfireBot::Message
+  attr_reader :response
+  
+  #overwrite message.speak method so that we can expose the output
+  def speak(msg)
+    puts "specmessage.speak(#{msg})"
+    @response = msg
+  end
+  
+end 
+
+class SpecJira < CampfireBot::Plugin::Jira
+  attr_accessor :cached_ids, :last_checked
+end
+
+
+
+describe "checking jira and" do
+
+  
+  # send a message to the room and return the response
+  def sendmsg(msg)
+    # puts "sendmsg(#{msg})"
+    @message[:message] = msg
+    @message[:room] = mock('room', :name => 'test')
+    bot.send(:handle_message, @message)
+    # puts "sendmsg returns #{@message.response}"
+    @message.response
+  end
+
+  # instantiate the bot and the plugin fresh
+
+  def setup
+    bot = CampfireBot::Bot.instance
+    bot.stub!(:config).and_return({'nickname' => 'Bot', 'jira_url' => 'foo'})
+    YAML.stub!(:load).and_return {}
+    YAML.stub!(:dump).and_return true
+    
+    
+    
+    @jira = SpecJira.new()
+    CampfireBot::Plugin.registered_plugins['Jira'] = @jira
+    @jira.cached_ids = {}
+    @jira.last_checked = 15.minutes.ago
+    @message = nil
+  end
+
+  def jira_response(ticketarray)
+    
+    jira_hash = {'rss' => {'channel' => [] }}
+    
+    ticketarray.each do |ticket|
+      ticket.merge!({'description' => 'foo',
+     'link' => "http://oz/jira/browse/#{ticket['key']}",
+     'title' => 'foo',
+     'reporter' => 'foo',
+     'priority' => 'Critical',
+     'type' => 'Bug'})
+     
+     jira_hash['rss']['channel'] << {'item' => ticket }
+    end
+
+    @message = SpecMessage.new(:person => 'Josh', :room => mock('room', :name => 'test'))
+    
+    xmldata = XmlSimple.xml_out(jira_hash, {'NoAttr' => true, 'RootName' => nil})
+    
+    @jira.stub!(:open).and_return(mock('foo', :read => xmldata))
+    
+    @jira.check_jira(@message)
+  end
+
+  describe "seeing a ticket higher than the last stored id" do
+
+    before(:all) do
+      setup 
+      jira_response([{
+        'key' => 'PIM-123', 
+        'description' => 'foo',
+        'link' => 'http://oz/jira/browse/PIM-123',
+        'title' => 'foo',
+        'reporter' => 'foo',
+        'priority' => 'Critical',
+        'type' => 'Bug',
+        'updated' => 5.minutes.ago.to_s
+        }])
+      
+      @jira.last_checked = 5.minutes.ago
+      jira_response([{
+        'key' => 'PIM-124', 
+        'description' => 'foo',
+        'link' => 'http://oz/jira/browse/PIM-124',
+        'title' => 'foo',
+        'reporter' => 'foo',
+        'priority' => 'Critical',
+        'type' => 'Bug',
+        'updated' => 3.minutes.ago.to_s
+        }])
+    end
+
+    it "should update the cached highest id" do
+      @jira.cached_ids['PIM'].should eql(124)
+    end
+  
+    it "should speak the info of the ticket" do
+      @message.response.should match(/PIM-124/)
+    end
+    
+
+  end
+
+  describe "seeing a ticket we've already seen" do
+
+    before(:all) do
+      setup 
+       jira_response([{
+        'key' => 'PIM-123', 
+      
+        'updated' => Time.now().to_s
+        }])
+        
+      jira_response([{
+        'key' => 'PIM-123', 
+        'description' => 'foo',
+        'link' => 'http://oz/jira/browse/PIM-123',
+        'title' => 'foo',
+        'reporter' => 'foo',
+        'priority' => 'Critical',
+        'type' => 'Bug',
+        'updated' => Time.now().to_s
+        }])
+    end
+
+    it "should be quiet" do
+      @message.response.should be(nil)
+    end
+      
+    it "should not change the list of cached ids" do
+      @jira.cached_ids.size.should eql(1)
+    end
+
+
+  end
+    
+  describe "seeing a ticket whose ID is lower than the highest seen id" do
+    before(:all) do
+      setup 
+      jira_response([{
+        'key' => 'PIM-123', 
+        'updated' => 5.minutes.ago.to_s
+        }])
+      
+      @jira.last_checked = 3.minutes.ago 
+
+      jira_response([{
+       'key' => 'PIM-120', 
+       'updated' => Time.now().to_s
+      }])
+      
+    end
+    
+    it "should be quiet" do
+      @message.response.should be(nil)
+    end
+    
+  end
+  
+  describe "seeing a space we've never seen before" do
+     before(:all) do
+        setup 
+        jira_response([{
+          'key' => 'PIM-123', 
+          'updated' => 5.minutes.ago.to_s
+          }])
+
+        @jira.last_checked = 5.minutes.ago
+        jira_response([{
+          'key' => 'FOO-124', 
+          'updated' => 3.minutes.ago.to_s
+          }])
+      end
+      
+      it "should update the cached highest id" do
+        @jira.cached_ids['FOO'].should eql(124)
+      end
+
+      it "should speak the info of the ticket" do
+        @message.response.should match(/FOO-124/)
+      end
+  end
+  
+  describe "getting a bunch of tickets in one go" do
+    before(:all) do
+      setup 
+    end
+    
+    it "with all new" do
+      @jira.cached_ids = {}
+      
+      msg = SpecMessage.new(:person => 'Josh', :room => mock('room', :name => 'test'))
+      SpecMessage.should_receive(:new).and_return(msg)
+      msg.should_receive(:speak).twice
+
+      jira_response([{
+        'key' => 'PIM-1124', 
+        'updated' => 5.minutes.ago.to_s
+        }, 
+        {'key' => 'PIM-1123', 
+        'updated' => 5.minutes.ago.to_s}])  
+      @jira.cached_ids['PIM'].should eql(1124)
+
+    end
+
+    it "with a mix of old and new" do
+      msg = SpecMessage.new(:person => 'Josh', :room => mock('room', :name => 'test'))
+      SpecMessage.should_receive(:new).and_return(msg)
+      msg.should_receive(:speak).twice
+      
+      @jira.cached_ids['PIM'] = 1124
+      jira_response([{
+         'key' => 'PIM-1126', 
+         'updated' => 5.minutes.ago.to_s
+        },
+        {
+          'key' => 'PIM-1125', 
+          'updated' => 5.minutes.ago.to_s
+          },
+        {
+          'key' => 'PIM-1124', 
+        'updated' => 5.minutes.ago.to_s
+        }
+      ])  
+      @jira.cached_ids['PIM'].should eql(1126)
+    end
+    
+    it "with all old" do
+      @jira.cached_ids['PIM'] = 1125
+      jira_response([{
+        'key' => 'PIM-1125', 
+        'updated' => 5.minutes.ago.to_s
+        }, 
+        {'key' => 'PIM-1124', 
+        'updated' => 5.minutes.ago.to_s}])  
+      @jira.cached_ids['PIM'].should eql(1125)
+    end
+    
+    
+    
+    
+  end
+  
+end
+

data/spec/our_quotes_spec.rb

@@ -0,0 +1,186 @@
+require 'spec'
+BOT_ROOT        = File.join(File.dirname(__FILE__), '..')
+BOT_ENVIRONMENT = 'test'
+
+require File.join(File.dirname(__FILE__), '../lib/bot.rb')
+bot = CampfireBot::Bot.instance
+require "#{BOT_ROOT}/plugins/our_quotes.rb"
+
+describe "OurQuotes plugin" do
+
+  it "should remember added quotes" do
+    when_saying "!addquote Someone: Hello world."
+    bot_should_reply "Added quote #1."
+    quotes[0].should == "Someone: Hello world."
+  end
+
+  it "should complain when !addquote is given without a quote" do
+    when_saying "!addquote"
+    bot_should_reply "Please include the text of the quote and attribution."
+    quotes.size.should == 0
+  end
+
+  it "should regurgitate random quotes" do
+    with_quote_log {
+      add "Someone: Hello world."
+    }
+    when_saying "!quote"
+    # How to show attribution, index, room, and timestamp?
+    #bot_should_reply "Someone spake thusly: Hello world"
+    #                 "Foo quoth thither
+    bot_should_reply "#1 Someone: Hello world."
+  end
+
+  it "should find matching quotes" do
+    with_quote_log {
+      add "Anyone: Hello world."
+      add "Someone: Hello world."
+      del 1
+      add "Someone: It's too cold."
+    }
+    when_saying "!quote o w"
+    bot_should_reply "#2 Someone: Hello world. (1 match)"
+  end
+
+  it "should use proper grammer when showing number of matches" do
+    with_quote_log {
+      add "Anyone: hi!"
+      add "Anyone: bye."
+    }
+    when_saying "!quote Anyone"
+    bot_should_reply %r/ \(2 matches\)$/
+  end
+
+  it "should retrieve quotes by ID when the query is numeric" do
+    with_quote_log {
+      add "Anyone: 2+2"
+      add "Anyone: hi!"
+    }
+    when_saying "!quote 2"
+    bot_should_reply "#2 Anyone: hi!"
+  end
+
+  it "should display an explanation when !quote is given an invalid ID" do
+    when_saying "!quote 1"
+    bot_should_reply "No quote #1."
+  end
+
+  # Implementation idea: save array of matches in a hash
+  # keyed by query and perhaps user.  Should expire after
+  # a few minutes, so don't bother persisting it even to tmp/.
+  it "should iterate through results on repeat command" do
+    pending
+    with_quote_log {
+      add "Someone: Foo"
+      add "Someone: Bar"
+      add "Someone: Baz"
+    }
+    when_saying "!quote Someone"
+    bot_should_reply %r/#\d Someone: ... \(3 matches\)$/
+    when_saying "!quote Someone"
+    bot_should_reply %r/#\d Someone: ... \(2 of 3 matches\)$/
+    when_saying "!quote Someone"
+    bot_should_reply %r/#\d Someone: ... \(3 of 3 matches\)$/
+    # Or maybe (3 matches, none left) ?
+  end
+
+  it "should remove last quote upon request" do
+    with_quote_log {
+      add "Hello world."
+    }
+    when_saying "!rmquote 1"
+    bot_should_reply "Deleted quote #1."
+    @quote.quotes.size.should == 0
+  end
+
+  it "should free trailing IDs when removing quotes" do
+    with_quote_log {
+      add "One"
+      add "Two"
+      add "Three"
+      add "Four"
+      del 3
+      del 4
+      add "III"
+    }
+    quotes[3 - 1].should == "III"
+  end
+
+  it "should preserve IDs of quotes after the removed one" do
+    with_quote_log {
+      add "One"
+      add "Two"
+      add "Three"
+      del 2
+    }
+    quotes[3 - 1].should == "Three"
+  end
+
+  it "should display an explanation when !rmquote is given an invalid ID" do
+    when_saying "!rmquote 1"
+    bot_should_reply "No quote #1."
+  end
+
+  it "should save quotes between runs" do
+    with_quote_log {
+      add "One"
+      add "Two"
+    }
+    init_plugin # Should re-read the .yml file
+    quotes[2 - 1].should == "Two"
+  end
+
+  it "should handle angle brackets appropriately" do
+    # One convention for attribution is to place the speaker in brackets.
+    # And this is how Campfire+Tinder+CampfireBot send us the message.
+    when_saying "!addquote \\u0026lt;Someone\\u0026gt; Hello"
+    bot_should_reply "Added quote #1."
+    quotes[1 - 1].should == "<Someone> Hello"
+  end
+
+
+  before :each do
+    @bot = CampfireBot::Bot.instance
+    @bot.stub!(:config).and_return('nickname' => 'Bot',
+                                   'our_quotes_recall_command' => 'quote'
+                                   #,'our_quotes_debug_enabled' => true
+                                   )
+    init_plugin
+  end
+  after :each do
+    if File.exist? @quote.data_file
+      File.unlink(@quote.data_file)
+    end
+  end
+  def init_plugin
+    @quote = OurQuotes.new
+    CampfireBot::Plugin.registered_plugins['OurQuotes'] = @quote
+  end
+
+  def when_saying(msg)
+    @message = CampfireBot::Message.new(:room => Tinder::Room.new(42, "Room1"),
+                                        :message => msg,
+                                        :person => 'Josh')
+  end
+  def bot_should_reply(msg)
+    @message.should_receive(:speak).with(msg)
+    @bot.send(:handle_message, @message)
+  end
+
+  # Group log setup calls into a block
+  def with_quote_log
+    yield
+  end
+  # Add a quote to the log
+  def add(quote)
+    @quote.append_add("Someoneelse", "Room1", quote)
+  end
+  # Remove a quote from the log by id
+  def del(quote_id)
+    @quote.append_del("Someoneelse", "Room1", quote_id)
+  end
+  def quotes
+    @quote.quotes
+  end
+
+end