robut 0.2.1 → 0.3.0

data/lib/robut/storage/yaml_store.rb

@@ -2,10 +2,10 @@ require 'yaml'
 
 # A store backed by a persistent on-disk yaml file.
 class Robut::Storage::YamlStore < Robut::Storage::Base
-    
+
   class << self
 
-    # The path to the file this store will persist to. 
+    # The path to the file this store will persist to.
     attr_reader :file
 
     # Sets the path to the file this store will persist to, and forces
@@ -16,7 +16,7 @@ class Robut::Storage::YamlStore < Robut::Storage::Base
       @file
     end
 
-    # Sets the key +k+ to the value +v+ 
+    # Sets the key +k+ to the value +v+
     def []=(k, v)
       internal[k] = v
       persist!
@@ -32,20 +32,26 @@ class Robut::Storage::YamlStore < Robut::Storage::Base
 
     # The internal in-memory representation of the yaml file
     def internal
-      @internal ||= begin
-        YAML.load_file(file) rescue {}
-      end
+      @internal ||= load_from_file
     end
-    
+
     # Persists the data in this store to disk. Throws an exception if
     # we don't have a file set.
     def persist!
       raise "Robut::Storage::YamlStore.file must be set" unless file
-      f = File.open(file, "w")
-      f.puts internal.to_yaml
-      f.close
+      File.open(file, "w") do |f|
+        f.puts internal.to_yaml
+      end
     end
-    
+
+    def load_from_file
+      begin
+        store = YAML.load_file(file)
+      rescue Errno::ENOENT
+      end
+
+      store || Hash.new
+    end
+
   end
-    
 end

data/lib/robut/version.rb

@@ -1,4 +1,4 @@
 module Robut # :nodoc:
   # Robut's version number.
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/test/fixtures/bad_location.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><xml_api_reply version="1"><weather module_id="0" tab_id="0" mobile_row="0" mobile_zipped="1" row="0" section="0" ><problem_cause data=""/></weather></xml_api_reply>

data/test/fixtures/las_vegas.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><xml_api_reply version="1"><weather module_id="0" tab_id="0" mobile_row="0" mobile_zipped="1" row="0" section="0" ><forecast_information><city data="Las Vegas, NV"/><postal_code data="Las Vegas"/><latitude_e6 data=""/><longitude_e6 data=""/><forecast_date data="2011-05-31"/><current_date_time data="2011-05-31 19:50:12 +0000"/><unit_system data="US"/></forecast_information><current_conditions><condition data="Mostly Cloudy"/><temp_f data="83"/><temp_c data="28"/><humidity data="Humidity: 8%"/><icon data="http://g0.gstatic.com/images/icons/onebox/weather_mostlycloudy-40.gif"/><wind_condition data="Wind: S at 9 mph"/></current_conditions><forecast_conditions><day_of_week data="Tue"/><low data="66"/><high data="91"/><icon data="http://g0.gstatic.com/images/icons/onebox/weather_partlycloudy-40.gif"/><condition data="Partly Cloudy"/></forecast_conditions><forecast_conditions><day_of_week data="Wed"/><low data="60"/><high data="86"/><icon data="http://g0.gstatic.com/images/icons/onebox/weather_partlycloudy-40.gif"/><condition data="Partly Cloudy"/></forecast_conditions><forecast_conditions><day_of_week data="Thu"/><low data="63"/><high data="80"/><icon data="http://g0.gstatic.com/images/icons/onebox/weather_sunny-40.gif"/><condition data="Sunny"/></forecast_conditions><forecast_conditions><day_of_week data="Fri"/><low data="70"/><high data="84"/><icon data="http://g0.gstatic.com/images/icons/onebox/weather_partlycloudy-40.gif"/><condition data="Partly Cloudy"/></forecast_conditions></weather></xml_api_reply>

data/test/fixtures/seattle.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><xml_api_reply version="1"><weather module_id="0" tab_id="0" mobile_row="0" mobile_zipped="1" row="0" section="0" ><forecast_information><city data="Seattle, WA"/><postal_code data="Seattle"/><latitude_e6 data=""/><longitude_e6 data=""/><forecast_date data="2011-05-23"/><current_date_time data="2011-05-23 22:52:57 +0000"/><unit_system data="US"/></forecast_information><current_conditions><condition data="Mostly Cloudy"/><temp_f data="58"/><temp_c data="14"/><humidity data="Humidity: 45%"/><icon data="/ig/images/weather/mostly_cloudy.gif"/><wind_condition data="Wind: E at 7 mph"/></current_conditions><forecast_conditions><day_of_week data="Mon"/><low data="48"/><high data="59"/><icon data="/ig/images/weather/partly_cloudy.gif"/><condition data="Partly Cloudy"/></forecast_conditions><forecast_conditions><day_of_week data="Tue"/><low data="51"/><high data="67"/><icon data="/ig/images/weather/partly_cloudy.gif"/><condition data="Partly Cloudy"/></forecast_conditions><forecast_conditions><day_of_week data="Wed"/><low data="49"/><high data="61"/><icon data="/ig/images/weather/rain.gif"/><condition data="Showers"/></forecast_conditions><forecast_conditions><day_of_week data="Thu"/><low data="49"/><high data="57"/><icon data="/ig/images/weather/rain.gif"/><condition data="Showers"/></forecast_conditions></weather></xml_api_reply>

data/test/fixtures/tacoma.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><xml_api_reply version="1"><weather module_id="0" tab_id="0" mobile_row="0" mobile_zipped="1" row="0" section="0" ><forecast_information><city data="Tacoma, WA"/><postal_code data="tacoma"/><latitude_e6 data=""/><longitude_e6 data=""/><forecast_date data="2011-05-23"/><current_date_time data="2011-05-23 22:46:28 +0000"/><unit_system data="US"/></forecast_information><current_conditions><condition data="Cloudy"/><temp_f data="60"/><temp_c data="16"/><humidity data="Humidity: 51%"/><icon data="/ig/images/weather/cloudy.gif"/><wind_condition data="Wind: N at 4 mph"/></current_conditions><forecast_conditions><day_of_week data="Mon"/><low data="45"/><high data="61"/><icon data="/ig/images/weather/rain.gif"/><condition data="Showers"/></forecast_conditions><forecast_conditions><day_of_week data="Tue"/><low data="50"/><high data="67"/><icon data="/ig/images/weather/partly_cloudy.gif"/><condition data="Partly Cloudy"/></forecast_conditions><forecast_conditions><day_of_week data="Wed"/><low data="48"/><high data="59"/><icon data="/ig/images/weather/rain.gif"/><condition data="Showers"/></forecast_conditions><forecast_conditions><day_of_week data="Thu"/><low data="48"/><high data="57"/><icon data="/ig/images/weather/rain.gif"/><condition data="Showers"/></forecast_conditions></weather></xml_api_reply>

data/test/unit/connection_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class SimplePlugin
+  include Robut::Plugin
   attr_accessor :run
 
   def initialize(*args)
@@ -13,7 +14,9 @@ class SimplePlugin
   end
 end
 
-class ReplyToUserPlugin < Robut::Plugin::Base
+class ReplyToUserPlugin
+  include Robut::Plugin
+
   def initialize(*args)
     super(*args)
   end
@@ -23,7 +26,9 @@ class ReplyToUserPlugin < Robut::Plugin::Base
   end
 end
 
-class ReplyToRoomPlugin < Robut::Plugin::Base
+class ReplyToRoomPlugin
+  include Robut::Plugin
+
   def initialize(*args)
     super(*args)
   end
@@ -39,7 +44,7 @@ class ReplyMock
   def initialize
     @messages = []
   end
-  
+
   def send(message)
     @messages << message
   end
@@ -96,7 +101,7 @@ class ConnectionTest < Test::Unit::TestCase
           })
         }
     })
-    
+
     @connection.handle_message(plugins(@connection), Time.now, 'justin WEISS', 'Test Message')
     message = @connection.client.messages.first
     assert_equal(justin, message.to.to_s)
@@ -119,5 +124,5 @@ class ConnectionTest < Test::Unit::TestCase
   def plugins(connection, sender = nil)
     Robut::Plugin.plugins.map { |p| p.new(connection, sender) }
   end
-  
+
 end

data/test/unit/plugin/alias_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+require 'robut/plugin/alias'
+require 'robut/plugin/echo'
+
+class Robut::Plugin::AliasTest < Test::Unit::TestCase
+
+  def setup
+    @connection = Robut::ConnectionMock.new
+    @plugin = Robut::Plugin::Alias.new(@connection)
+    @plugin.aliases = {}
+  end
+  
+  def test_aliases_this_to_that
+    @plugin.handle(Time.now, "@john", "@robut alias w weather?")
+    assert_equal 'weather?', @plugin.aliases['w']
+  end
+  
+  def test_thinks_this_is_that
+    @plugin.handle(Time.now, "@john", "@robut alias this @robut echo that")
+    @plugin.handle(Time.now, "@john", "this")
+    message = @plugin.connection.messages.first
+    assert_equal "@john", message[1]
+    assert_equal "@robut echo that", message[2]
+  end
+  
+  def test_doesnt_alias_when_it_shouldnt
+    @plugin.handle(Time.now, "@john", "@robut somthing alias w weather?")
+    assert @plugin.aliases.empty?
+  end  
+  
+  def test_can_alias_with_quotes
+    @plugin.handle(Time.now, "@john", '@robut alias "long string" "some other long string"')
+    assert_equal 'some other long string', @plugin.aliases['long string']
+  end
+  
+  def test_can_apply_aliases_with_quotes
+    @plugin.handle(Time.now, "@john", '@robut alias "long string" "some other long string"')
+    @plugin.handle(Time.now, "@john", "long string")
+    message = @plugin.connection.messages.first
+    assert_equal "@john", message[1]
+    assert_equal "some other long string", message[2]    
+  end
+  
+  def test_aliases_can_be_removed
+    @plugin.handle(Time.now, "@john", "@robut alias this that")
+    @plugin.handle(Time.now, "@john", "@robut remove alias this")
+    assert @plugin.aliases.empty?
+  end
+  
+  def test_remove_aliases_doesnt_choke_on_missing_key
+    @plugin.handle(Time.now, "@john", "@robut alias this that")
+    @plugin.handle(Time.now, "@john", "@robut remove alias")
+    assert_equal({'this' => 'that'}, @plugin.aliases)
+  end
+  
+  def test_remove_alias_handles_quotes
+    @plugin.handle(Time.now, "@john", '@robut alias "long string" "that"')
+    @plugin.handle(Time.now, "@john", '@robut remove alias "long string"')
+    assert @plugin.aliases.empty?
+  end
+  
+  def test_can_list_all_aliases
+    @plugin.handle(Time.now, "@john", "@robut alias this that")
+    @plugin.handle(Time.now, "@john", "@robut alias something something else")
+    @plugin.handle(Time.now, "@john", "@robut aliases")
+    assert_equal ["something => something else\nthis => that"], @plugin.connection.replies
+  end
+  
+  def test_can_clear_aliases
+    @plugin.handle(Time.now, "@john", "@robut alias this that")
+    @plugin.handle(Time.now, "@john", "@robut clear aliases")
+    assert_equal({}, @plugin.aliases)
+  end
+  
+end

data/test/unit/plugin/help_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+require 'robut/plugin/echo'
+require 'robut/plugin/help'
+
+class Robut::Plugin::PluginWithoutHelp
+  include Robut::Plugin
+
+  def usage
+    super
+  end
+end
+
+class Robut::Plugin::HelpTest < Test::Unit::TestCase
+
+  def setup
+    @connection = Robut::ConnectionMock.new
+    Robut::Plugin.plugins << Robut::Plugin::Echo
+    Robut::Plugin.plugins << Robut::Plugin::Help
+    @plugin = Robut::Plugin::Help.new(@connection)
+  end
+
+  def teardown
+    Robut::Plugin.plugins = []
+  end
+
+  def test_help
+    @plugin.handle(Time.now, "@justin", "@robut help")
+    assert_equal [
+      "Supported commands:",
+      "@robut echo <message> - replies to the channel with <message>",
+      "@robut help - displays this message",
+    ], @plugin.connection.replies
+  end
+
+  def test_empty_help
+    Robut::Plugin.plugins << Robut::Plugin::PluginWithoutHelp
+    @plugin.handle(Time.now, "@justin", "@robut help")
+    assert_equal [
+      "Supported commands:",
+      "@robut echo <message> - replies to the channel with <message>",
+      "@robut help - displays this message",
+    ], @plugin.connection.replies
+  end
+end
+  

data/test/unit/plugin/say_test.rb

@@ -25,4 +25,9 @@ class Robut::Plugin::SayTest < Test::Unit::TestCase
     assert_equal [], @plugin.system_calls
   end
   
+  def test_strips_bad_chars
+    @plugin.handle(Time.now, "@john", "@robut say it's time for $%@ more_test 123 p\"")
+    assert_equal ["say its time for more test 123 p"], @plugin.system_calls
+  end
+  
 end

data/test/unit/plugin/weather_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+require 'webmock/test_unit'
+require 'time-warp'
+require 'robut/plugin/weather'
+
+class Robut::Plugin::WeatherTest < Test::Unit::TestCase
+
+  def setup
+    @connection = Robut::ConnectionMock.new
+    @plugin = Robut::Plugin::Weather.new(@connection)
+  end
+
+  def teardown
+    Robut::Plugin::Weather.default_location = nil
+  end
+
+  def test_handle_no_weather
+    @plugin.handle(Time.now, "John", "lunch?")
+    assert_equal( [], @plugin.connection.replies )
+
+    @plugin.handle(Time.now, "John", "?")
+    assert_equal( [], @plugin.connection.replies )
+  end
+
+  def test_handle_no_location_no_default
+    @plugin.handle(Time.now, "John", "weather?")
+    assert_equal( ["I don't have a default location!"], @plugin.connection.replies )
+  end
+
+  def test_handle_no_location_default_set
+    Robut::Plugin::Weather.default_location = "Seattle"
+    stub_request(:any, "http://www.google.com/ig/api?weather=Seattle").to_return(:body => File.open(File.expand_path("../../../fixtures/seattle.xml", __FILE__), "r").read)
+
+    @plugin.handle(Time.now, "John", "weather?")
+    assert_equal( ["Weather for Seattle, WA: Mostly Cloudy, 58F"], @plugin.connection.replies )
+  end
+
+  def test_handle_location
+    stub_request(:any, "http://www.google.com/ig/api?weather=tacoma").to_return(:body => File.open(File.expand_path("../../../fixtures/tacoma.xml", __FILE__), "r").read)
+
+    @plugin.handle(Time.now, "John", "tacoma weather?")
+    assert_equal( ["Weather for Tacoma, WA: Cloudy, 60F"], @plugin.connection.replies )
+  end
+
+  def test_no_question_mark
+    @plugin.handle(Time.now, "John", "seattle weather")
+    assert_equal( [], @plugin.connection.replies )
+  end
+
+  def test_handle_day
+    stub_request(:any, "http://www.google.com/ig/api?weather=Seattle").to_return(:body => File.open(File.expand_path("../../../fixtures/seattle.xml", __FILE__), "r").read)
+
+    pretend_now_is(2011,"may",23,17) do
+      @plugin.handle(Time.now, "John", "Seattle weather tuesday?")
+      assert_equal( ["Forecast for Seattle, WA on Tue: Partly Cloudy, High: 67F, Low: 51F"], @plugin.connection.replies )
+    end
+  end
+
+  def test_handle_tomorrow
+    stub_request(:any, "http://www.google.com/ig/api?weather=Seattle").to_return(:body => File.open(File.expand_path("../../../fixtures/seattle.xml", __FILE__), "r").read)
+
+    pretend_now_is(2011,"may",23,17) do
+      @plugin.handle(Time.now, "John", "Seattle weather tomorrow?")
+      assert_equal( ["Forecast for Seattle, WA on Tue: Partly Cloudy, High: 67F, Low: 51F"], @plugin.connection.replies )
+    end
+  end
+
+  def test_handle_today
+    stub_request(:any, "http://www.google.com/ig/api?weather=Seattle").to_return(:body => File.open(File.expand_path("../../../fixtures/seattle.xml", __FILE__), "r").read)
+
+    pretend_now_is(2011,"may",23,17) do
+      @plugin.handle(Time.now, "John", "Seattle weather today?")
+      assert_equal( ["Forecast for Seattle, WA on Mon: Partly Cloudy, High: 59F, Low: 48F"], @plugin.connection.replies )
+    end
+  end
+
+  def test_handle_multi_word_location
+    stub_request(:any, "http://www.google.com/ig/api?weather=Las%20Vegas").to_return(:body => File.open(File.expand_path("../../../fixtures/las_vegas.xml", __FILE__), "r").read)
+    @plugin.handle(Time.now, "John", "Las Vegas weather?")
+    assert_equal( ["Weather for Las Vegas, NV: Mostly Cloudy, 83F"], @plugin.connection.replies )
+  end
+
+  def test_handle_location_with_comma
+    stub_request(:any, "http://www.google.com/ig/api?weather=Las%20Vegas,%20NV").to_return(:body => File.open(File.expand_path("../../../fixtures/las_vegas.xml", __FILE__), "r").read)
+    @plugin.handle(Time.now, "John", "Las Vegas, NV weather?")
+    assert_equal( ["Weather for Las Vegas, NV: Mostly Cloudy, 83F"], @plugin.connection.replies )
+  end
+
+  def test_handle_bad_location
+    stub_request(:any, "http://www.google.com/ig/api?weather=asdf").to_return(:body => File.open(File.expand_path("../../../fixtures/bad_location.xml", __FILE__), "r").read)
+    @plugin.handle(Time.now, "John", "asdf weather?")
+    assert_equal( ["I don't recognize the location: \"asdf\""], @plugin.connection.replies )
+  end
+
+  def test_handle_bad_date
+    @plugin.handle(Time.now, "John", "Seattle weather asdf?")
+    assert_equal( ["I don't recognize the date: \"asdf\""], @plugin.connection.replies )
+  end
+
+end

data/test/unit/plugin_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class Robut::PluginTest < Test::Unit::TestCase
+
+  class HandrolledStubPlugin
+    include Robut::Plugin
+  end
+
+  def setup
+    @plugin = HandrolledStubPlugin.new(Robut::ConnectionMock.new)
+  end
+
+  def test_sent_to_me?
+    assert @plugin.sent_to_me?("@Robut hello there")
+    assert !@plugin.sent_to_me?("@Robuto hello there")
+    assert !@plugin.sent_to_me?("@David hello there")
+    assert @plugin.sent_to_me?("this is a @Robut message")
+    assert @plugin.sent_to_me?("this is a message to @robut")
+    assert !@plugin.sent_to_me?("this is a message to@robut")
+  end
+
+  def test_without_nick_robut_do_this
+    assert_equal "do this", @plugin.without_nick("@robut do this")
+  end
+
+  def test_without_nick_do_this_robut
+    assert_equal "do this @robut", @plugin.without_nick("do this @robut")
+  end
+
+end

data/test/unit/storage/yaml_store_test.rb

@@ -7,7 +7,7 @@ class Robut::Storage::YamlStoreTest < Test::Unit::TestCase
     @store = Robut::Storage::YamlStore
     @store.file = new_yaml_file
   end
-  
+
   def teardown
     File.delete new_yaml_file if File.exists?(new_yaml_file)
   end
@@ -16,27 +16,32 @@ class Robut::Storage::YamlStoreTest < Test::Unit::TestCase
     assert_equal 'in the trunk', (@store['junk'] = 'in the trunk')
     assert_equal 'in the trunk', @store['junk']
   end
-  
+
+  def test_load_an_empty_file
+    FileUtils.touch(new_yaml_file)
+    assert_equal nil, @store['non-exising-key']
+  end
+
   def test_read_from_file
     @store.file = test_yaml_file
     assert_equal 'bar', @store['foo']
   end
-  
+
   def test_persists_to_file
     @store['pot'] = 'roast'
     assert File.exists?(new_yaml_file)
     yaml = YAML.load_file(new_yaml_file)
     assert_equal 'roast', yaml['pot']
   end
-  
+
   private
-  
+
   def test_yaml_file
     File.join(File.dirname(__FILE__), 'yaml_test.yml')
   end
-  
+
   def new_yaml_file
     File.join(File.dirname(__FILE__), 'new_yaml_test.yml')
   end
-  
-end
+
+end