robut 0.2.1 → 0.3.0

data/lib/robut/plugin/calc.rb

@@ -2,15 +2,21 @@ require 'calc'
 
 # A simple calculator. This delegates all calculations to the 'calc'
 # gem.
-class Robut::Plugin::Calc < Robut::Plugin::Base
+class Robut::Plugin::Calc
+  include Robut::Plugin
 
+  # Returns a description of how to use this plugin
+  def usage
+    "#{at_nick} calc <calculation> - replies with the result of <calculation>"
+  end
+  
   # Perform the calculation specified in +message+, and send the
   # result back.
   def handle(time, sender_nick, message)
     if sent_to_me?(message) && words(message).first == 'calc'
       calculation = words(message, 'calc').join(' ')
       begin
-        reply("#{calculation} = #{Calc.evaluate(calculation)}")
+        reply("#{calculation} = #{::Calc.evaluate(calculation)}")
       rescue
         reply("Can't calculate that.")
       end

data/lib/robut/plugin/echo.rb

@@ -1,6 +1,6 @@
-
 # A plugin that tells robut to repeat whatever he's told.
-class Robut::Plugin::Echo < Robut::Plugin::Base
+class Robut::Plugin::Echo
+  include Robut::Plugin
 
   # Responds with +message+ if the command sent to robut is 'echo'.
   def handle(time, sender_nick, message)
@@ -10,5 +10,10 @@ class Robut::Plugin::Echo < Robut::Plugin::Base
       reply(phrase) unless phrase.empty?
     end
   end
-  
+
+  # Returns a description of how to use this plugin
+  def usage
+    "#{at_nick} echo <message> - replies to the channel with <message>"
+  end
+
 end

data/lib/robut/plugin/help.rb

@@ -0,0 +1,24 @@
+# When asked for help, responds with a list of commands supported by
+# all loaded plugins
+class Robut::Plugin::Help
+  include Robut::Plugin
+
+  # Responds with a list of commands supported by all loaded plugins.
+  def handle(time, sender_nick, message)
+    words = words(message)
+    if sent_to_me?(message) && words.first == 'help'
+      reply("Supported commands:")
+      Robut::Plugin.plugins.each do |plugin|
+        plugin_instance = plugin.new(connection, private_sender)
+        Array(plugin_instance.usage).each do |command_usage|
+          reply(command_usage)
+        end
+      end
+    end
+  end
+
+  # Returns a description of how to use this plugin
+  def usage
+    "#{at_nick} help - displays this message"
+  end
+end

data/lib/robut/plugin/later.rb

@@ -12,11 +12,17 @@
 #    @robut in <number> <mins|hrs|secs> [command]
 #
 # Where command is the message you want to send to @robut in the future.  For
-# the time denominations it also recognizes minute, minutes, hour, hours, 
+# the time denominations it also recognizes minute, minutes, hour, hours,
 # second, seconds.
 #
-class Robut::Plugin::Later < Robut::Plugin::Base
+class Robut::Plugin::Later
+  include Robut::Plugin
 
+  # Returns a description of how to use this plugin
+  def usage
+    "#{at_nick} in <number> <mins|hrs|secs> <command> - sends <command> to #{nick} after the specified interval"
+  end
+  
   # Passes +message+ back through the plugin chain if we've been given
   # a time to execute it later.
   def handle(time, sender_nick, message)
@@ -26,17 +32,15 @@ class Robut::Plugin::Later < Robut::Plugin::Base
         count = $1.to_i
         scale = $2
         future_message =  at_nick + ' ' + $3
-        
+
         sleep_time = count * scale_multiplier(scale)
-        
+
         reply("Ok, see you in #{count} #{scale}")
-        
+
         connection = self.connection
         threader do
           sleep sleep_time
-          # TODO: ensure this connection is threadsafe
-          plugins = Robut::Plugin.plugins.map { |p| p.new(connection, private_sender) }
-          connection.handle_message(plugins, Time.now, sender_nick, future_message)
+          fake_message(Time.now, sender_nick, future_message)
         end
         return true
       end
@@ -69,5 +73,5 @@ class Robut::Plugin::Later < Robut::Plugin::Base
       yield
     end
   end
-  
+
 end

data/lib/robut/plugin/lunch.rb

@@ -1,9 +1,20 @@
 # Where should we go to lunch today?
-class Robut::Plugin::Lunch < Robut::Plugin::Base
+class Robut::Plugin::Lunch
+  include Robut::Plugin
+
+  # Returns a description of how to use this plugin
+  def usage
+    [
+      "lunch? / food? - #{nick} will suggest a place to go eat",
+      "#{at_nick} lunch places - lists all the lunch places #{nick} knows about",
+      "#{at_nick} new lunch place <place> - tells #{nick} about a new place to eat",
+      "#{at_nick} remove lunch place <place> - tells #{nick} not to suggest <place> anymore"
+    ]
+  end
 
   # Replies with a random string selected from +places+.
   def handle(time, sender_nick, message)
-    words = words(message)    
+    words = words(message)
     phrase = words.join(' ')
     # lunch?
     if phrase =~ /(lunch|food)\?/i
@@ -53,5 +64,5 @@ class Robut::Plugin::Lunch < Robut::Plugin::Base
   def places=(v)
     store["lunch_places"] = v
   end
-  
+
 end

data/lib/robut/plugin/meme.rb

@@ -1,30 +1,63 @@
-require 'meme'
+require 'cgi'
 
-# A simple plugin that wraps meme_generator. Requires the
-# 'meme_generator' gem.
-class Robut::Plugin::Meme < Robut::Plugin::Base
+# A simple plugin that wraps memecaptain.
+class Robut::Plugin::Meme
+  include Robut::Plugin
+
+  MEMES = {
+    'bear_grylls' => 'http://memecaptain.com/bear_grylls.jpg',
+    'insanity_wolf' => 'http://memecaptain.com/insanity_wolf.jpg',
+    'most_interesting' => 'http://memecaptain.com/most_interesting.jpg',
+    'philosoraptor' => 'http://memecaptain.com/philosoraptor.jpg',
+    'scumbag_steve' => 'http://memecaptain.com/scumbag_steve.jpg',
+    'town_crier' => 'http://memecaptain.com/town_crier.jpg',
+    'troll_face' => 'http://memecaptain.com/troll_face.jpg',
+    'y_u_no' => 'http://memecaptain.com/y_u_no.jpg',
+    'yao_ming' => 'http://memecaptain.com/yao_ming.jpg',
+    'business_cat' => 'http://memecaptain.com/business_cat.jpg',
+    'all_the_things' => 'http://memecaptain.com/all_the_things.jpg',
+    'fry' => 'http://memecaptain.com/fry.png',
+    'sap' => 'http://memecaptain.com/sap.jpg'
+  }
+
+  # Returns a description of how to use this plugin
+  def usage
+    [
+      "#{at_nick} meme list - lists all the memes that #{nick} knows about",
+      "#{at_nick} meme <meme> <line1>;<line2> - responds with a link to a generated <meme> image using <line1> and <line2>"
+    ]
+  end
 
   # This plugin is activated when robut is sent a message starting
   # with the name of a meme. The list of generators can be discovered
   # by running
-  # 
-  #   meme list
+  #
+  #   @robut meme list
   #
   # from the command line. Example:
   #
-  #   @robut h_mermaid look at this stuff, isn't it neat; my vinyl collection is almost complete
+  #   @robut meme all_the_things write; all the plugins
   #
   # Send message to the specified meme generator. If the meme requires
   # more than one line of text, lines should be separated with a semicolon.
   def handle(time, sender_nick, message)
-    word = words(message).first
-    if sent_to_me?(message) && Meme::GENERATORS.has_key?(word.upcase)
-      words = words(message)
-      g = Meme.new(words.shift.upcase)
-      line1, line2 = words.join(' ').split(';')
-    
-      reply(g.generate(line1, line2))
+    return unless sent_to_me?(message)
+    words = words(message)
+    command = words.shift.downcase
+    return unless command == 'meme'
+    meme = words.shift
+
+    if meme == 'list'
+      reply("Memes available: #{MEMES.keys.join(', ')}")
+    elsif MEMES[meme]
+      url = CGI.escape(MEMES[meme])
+      line1, line2 = words.join(' ').split(';').map { |line| CGI.escape(line.strip)}
+      meme_url = "http://memecaptain.com/i?u=#{url}&tt=#{line1}"
+      meme_url += "&tb=#{line2}" if line2
+      reply(meme_url)
+    else
+      reply("Meme not found: #{meme}")
     end
   end
-  
+
 end

data/lib/robut/plugin/ping.rb

@@ -1,11 +1,15 @@
-
 # A simple plugin that replies with "pong" when messaged with ping
-class Robut::Plugin::Ping < Robut::Plugin::Base
+class Robut::Plugin::Ping
+  include Robut::Plugin
+
+  def usage
+    "#{at_nick} ping - responds 'pong'"
+  end
 
   # Responds "pong" if +message+ is "ping"
   def handle(time, sender_nick, message)
     words = words(message)
     reply("pong") if sent_to_me?(message) && words.length == 1 && words.first.downcase == 'ping'
   end
-  
+
 end

data/lib/robut/plugin/rdio.rb

@@ -5,12 +5,13 @@ require 'robut/plugin/rdio/server'
 # HipChat. +key+ and +secret+ must be set before we can deal with any
 # Rdio commands. Additionally, you must call +start_server+ in your
 # Chatfile to start the Rdio web server.
-class Robut::Plugin::Rdio < Robut::Plugin::Base
+class Robut::Plugin::Rdio
+  include Robut::Plugin
 
   class << self
     # Your Rdio API Key
     attr_accessor :key
-    
+
     # Your Rdio API app secret
     attr_accessor :secret
 
@@ -30,7 +31,7 @@ class Robut::Plugin::Rdio < Robut::Plugin::Base
     #
     #   ./rdio-call --consumer-key=YOUR_CONSUMER_KEY --consumer-secret=YOUR_CONSUMER_SECRET getPlaybackToken domain=YOUR_DOMAIN
     attr_accessor :token
-    
+
     # The domain associated with +token+. Defaults to localhost.
     attr_accessor :domain
   end
@@ -44,6 +45,15 @@ class Robut::Plugin::Rdio < Robut::Plugin::Base
     Server.domain = self.domain || "localhost"
   end
 
+  # Returns a description of how to use this plugin
+  def usage
+    [
+      "#{at_nick} play <song> - queues <song> for playing",
+      "#{at_nick} play album <album> - queues <album> for playing",
+      "#{at_nick} play track <track> - queues <track> for playing"
+    ]
+  end
+
   # Queues songs into the Rdio web player. @nick play search query
   # will queue the first search result matching 'search query' into
   # the web player. It can be an artist, album, or song.
@@ -69,8 +79,8 @@ class Robut::Plugin::Rdio < Robut::Plugin::Base
   # 'track', it only searches tracks, same for 'album'. Otherwise,
   # matches both albums and tracks.
   def search(words)
-    api = Rdio::Api.new(self.class.key, self.class.secret)
-    
+    api = ::Rdio::Api.new(self.class.key, self.class.secret)
+
     if words[1] == "album"
       query_string = words[2..-1].join(' ')
       results = api.search(query_string, "Album")
@@ -82,5 +92,5 @@ class Robut::Plugin::Rdio < Robut::Plugin::Base
       results = api.search(query_string, "Album,Track")
     end
   end
-  
+
 end

data/lib/robut/plugin/rdio/server.rb

@@ -1,8 +1,9 @@
 require 'sinatra'
 require 'json'
 
-class Robut::Plugin::Rdio < Robut::Plugin::Base
-  
+class Robut::Plugin::Rdio
+  include Robut::Plugin
+
   # A simple server to communicate new Rdio sources to the Web
   # Playback API. The client will update
   # Robut::Plugin::Rdio::Server.queue with any new sources, and a call
@@ -10,7 +11,7 @@ class Robut::Plugin::Rdio < Robut::Plugin::Base
   class Server < Sinatra::Base
 
     set :root, File.dirname(__FILE__)
-    
+
     class << self
       # A list of items that haven't been fetched by the web playback
       # API yet.

data/lib/robut/plugin/say.rb

@@ -1,4 +1,3 @@
-
 # This is a simple plugin the envokes the "say" command on whatever is passed
 # Example:
 #
@@ -6,15 +5,25 @@
 #
 # *Requires that the "say" command is installed and in the path
 #
-class Robut::Plugin::Say < Robut::Plugin::Base
+class Robut::Plugin::Say
+  include Robut::Plugin
 
+  # Returns a description of how to use this plugin
+  def usage
+    "#{at_nick} say <words> - uses Mac OS X's 'say' command to speak <words>"
+  end
+  
   # Pipes +message+ through the +say+ command
   def handle(time, sender_nick, message)
     words = words(message)
     if sent_to_me?(message) && words.first == "say"
-      phrase = words[1..-1].join(' ')
+      phrase = clean(words[1..-1].join(' '))
       system("say #{phrase}")
     end
   end
-  
+
+  def clean(str)
+    str.gsub("'", "").gsub(/[^A-Za-z0-9\s]+/, " ").gsub(/\s+/, ' ').strip
+  end
+
 end

data/lib/robut/plugin/sayings.rb

@@ -1,5 +1,6 @@
 # A simple regex => response plugin.
-class Robut::Plugin::Sayings < Robut::Plugin::Base
+class Robut::Plugin::Sayings
+  include Robut::Plugin
 
   class << self
     # A list of arrays. The first element is a regex, the second is
@@ -13,6 +14,11 @@ class Robut::Plugin::Sayings < Robut::Plugin::Base
   end
   self.sayings = []
 
+  # Returns a description of how to use this plugin
+  def usage
+    "#{at_nick} <words> - if <words> matches a regular expression defined in the Chatfile, responds with the specified response"
+  end
+
   # For each element in sayings, creates a regex out of the first
   # element, tries to match +message+ to it, and replies with the
   # second element if it found a match. Robut::Plugin::Sayings will

data/lib/robut/plugin/twss.rb

@@ -2,12 +2,18 @@ require 'twss'
 
 # A simple plugin that feeds everything said in the room through the
 # twss gem. Requires the 'twss' gem, obviously.
-class Robut::Plugin::TWSS < Robut::Plugin::Base
+class Robut::Plugin::TWSS
+  include Robut::Plugin
+
+  # Returns a description of how to use this plugin
+  def usage
+    "<words> - responds with \"That's what she said!\" if #{nick} thinks <words> is a valid TWSS"
+  end
 
   # Responds "That's what she said!" if the TWSS gem returns true for
   # +message+. Strips out any reference to our nick in +message+
   # before it stuffs +message+ into the gem.
   def handle(time, sender_nick, message)
-    reply("That's what she said!") if TWSS(words(message).join(" "))
+    reply("That's what she said!") if ::TWSS.classify(words(message).join(" "))
   end
 end

data/lib/robut/plugin/weather.rb

@@ -0,0 +1,126 @@
+require 'open-uri'
+require 'nokogiri'
+
+# What's the current weather forecast?
+class Robut::Plugin::Weather
+  include Robut::Plugin
+
+  class << self
+    attr_accessor :default_location
+  end
+
+  # Returns a description of how to use this plugin
+  def usage
+    [
+      "#{at_nick} weather - returns the weather in the default location for today",
+      "#{at_nick} weather tomorrow - returns the weather in the default location for tomorrow",
+      "#{at_nick} weather <location> - returns the weather for <location> today",
+      "#{at_nick} weather <location> Tuesday - returns the weather for <location> Tuesday"
+    ]
+  end
+  
+  def handle(time, sender_nick, message)
+    # ignore messages that don't end in ?
+    return unless message[message.length - 1, 1] == "?"
+    message = message[0..message.length - 2]
+
+    words = words(message)
+    i = words.index("weather")
+
+    # ignore messages that don't have "weather" in them
+    return if i.nil?
+
+    location = i.zero? ? self.class.default_location : words[0..i-1].join(" ")
+    if location.nil?
+      reply "I don't have a default location!"
+      return
+    end
+
+    day_of_week = nil
+    day_string = words[i+1..-1].join(" ").downcase
+    if day_string != ""
+      day_of_week = parse_day(day_string)
+      if day_of_week.nil?
+        reply "I don't recognize the date: \"#{day_string}\""
+        return
+      end
+    end
+
+    if bad_location?(location)
+      reply "I don't recognize the location: \"#{location}\""
+      return
+    end
+
+    if day_of_week
+      reply forecast(location, day_of_week)
+    else
+      reply current_conditions(location)
+    end
+  end
+
+  def parse_day(day)
+    day_map = {
+      "monday"    =>  "Mon",
+      "mon"       =>  "Mon",
+      "tuesday"   =>  "Tue",
+      "tue"       =>  "Tue",
+      "tues"      =>  "Tue",
+      "wed"       =>  "Wed",
+      "wednesday" =>  "Wed",
+      "thurs"     =>  "Thu",
+      "thu"       =>  "Thu",
+      "thursday"  =>  "Thu",
+      "friday"    =>  "Fri",
+      "fri"       =>  "Fri",
+      "saturday"  =>  "Sat",
+      "sat"       =>  "Sat",
+      "sunday"    =>  "Sun",
+      "sun"       =>  "Sun",
+    }
+    if day_map.has_key?(day)
+      return day_map[day]
+    end
+
+    if day == "tomorrow"
+      return (Time.now + 60*60*24).strftime("%a")
+    end
+
+    if day == "today"
+      return Time.now.strftime("%a")
+    end
+  end
+
+  def current_conditions(location)
+    doc = weather_data(location)
+    condition = doc.search("current_conditions condition").first["data"]
+    temperature = doc.search("current_conditions temp_f").first["data"]
+    normalized_location = doc.search("forecast_information city").first["data"]
+    "Weather for #{normalized_location}: #{condition}, #{temperature}F"
+  end
+
+  def forecast(location, day_of_week)
+    doc = weather_data(location)
+    forecast = doc.search("forecast_conditions").detect{|el| c = el.children.detect{|c| c.name == "day_of_week"}; c && c["data"] == day_of_week}
+    return "Can't find a forecast for #{day_of_week}" if forecast.nil?
+
+    condition = forecast.children.detect{|c| c.name == "condition"}["data"]
+    high = forecast.children.detect{|c| c.name == "high"}["data"]
+    low = forecast.children.detect{|c| c.name == "low"}["data"]
+    normalized_location = doc.search("forecast_information city").first["data"]
+    "Forecast for #{normalized_location} on #{day_of_week}: #{condition}, High: #{high}F, Low: #{low}F"
+  end
+
+  def weather_data(location = "")
+    @weather_data ||= {}
+    @weather_data[location] ||= begin
+      url = "http://www.google.com/ig/api?weather=#{URI.escape(location)}"
+      Nokogiri::XML(open(url))
+    end
+    @weather_data[location]
+  end
+
+  def bad_location?(location = "")
+    weather_data(location).search("forecast_information").empty?
+  end
+
+end