robut 0.3.0 → 0.4.0

data/lib/robut/plugin/echo.rb

@@ -2,18 +2,8 @@
 class Robut::Plugin::Echo
   include Robut::Plugin
 
-  # Responds with +message+ if the command sent to robut is 'echo'.
-  def handle(time, sender_nick, message)
-    words = words(message)
-    if sent_to_me?(message) && words.first == 'echo'
-      phrase = words[1..-1].join(' ')
-      reply(phrase) unless phrase.empty?
-    end
+  desc "echo <message> - replies to the channel with <message>"
+  match /^echo (.*)/, :sent_to_me => true do |phrase|
+    reply(phrase) unless phrase.empty?
   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/google_images.rb

@@ -0,0 +1,17 @@
+require 'google-search'
+
+# Responds with the first google image search result matching a query.
+class Robut::Plugin::GoogleImages
+  include Robut::Plugin
+
+  desc "image <query> - responds with the first image from a Google Images search for <query>"
+  match /^image (.*)/, :sent_to_me => true do |query|
+    image = Google::Search::Image.new(:query => query).first
+
+    if image
+      reply image.uri
+    else
+      reply "Couldn't find an image"
+    end
+  end
+end

data/lib/robut/plugin/help.rb

@@ -3,22 +3,14 @@
 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
+  desc "help - displays this message"
+  match /^help$/, :sent_to_me => true do
+    reply("Supported commands:")
+    Robut::Plugin.plugins.each do |plugin|
+      plugin_instance = plugin.new(reply_to, private_sender)
+      Array(plugin_instance.usage).each do |command_usage|
+        reply(command_usage)
       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/meme.rb

@@ -1,63 +1,32 @@
 require 'cgi'
 
 # A simple plugin that wraps memecaptain.
+# 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
+#
+#   @robut meme list
+#
+# from the command line. Example:
+#
+#   @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.
 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
-  #
-  #   @robut meme list
-  #
-  # from the command line. Example:
-  #
-  #   @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)
-    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)
+  desc "meme <meme> <line1>;<line2> - responds with a link to a generated <meme> image using <line1> and <line2>.  " +
+    "See http://memecaptain.com/ for a list of memes.  You can also pass a link to your own image as the meme."
+  match /^meme (\S+) (.*)$/, :sent_to_me => true do |meme, text|
+    if meme.include?("://")
+      url = meme
     else
-      reply("Meme not found: #{meme}")
+      url = "http://memecaptain.com/#{meme}.jpg"
     end
+    line1, line2 = text.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)
   end
-
 end

data/lib/robut/plugin/pick.rb

@@ -0,0 +1,18 @@
+require 'calc'
+
+# Let fate decide!
+class Robut::Plugin::Pick
+  include Robut::Plugin
+
+  desc "pick <a>, <b>, <c>, ...  - randomly selects one of the options"
+  match /^pick (.*)/, :sent_to_me => true do |message|
+    options = message.split(',').map { |s| s.strip }
+    rsp = options[random(options.length)]
+    reply("And the winner is... #{rsp}") if rsp
+  end
+
+  def random(c)
+    rand(c)
+  end
+
+end

data/lib/robut/plugin/ping.rb

@@ -2,14 +2,8 @@
 class Robut::Plugin::Ping
   include Robut::Plugin
 
-  def usage
-    "#{at_nick} ping - responds 'pong'"
+  desc "ping - responds 'pong'"
+  match /^ping$/, :sent_to_me => true do
+    reply("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/quips.rb

@@ -0,0 +1,60 @@
+# Stores quotes and replies with a random stored quote.
+class Robut::Plugin::Quips
+  include Robut::Plugin
+
+  desc "add quip <text> - adds a quip to the quip database"
+  match /^add quip (.+)/, :sent_to_me => true do |new_quip|
+    if add_quip(new_quip)
+      reply "I added the quip to the quip database"
+    else
+      reply "I didn't add the quip, since it was already added"
+    end
+  end
+
+  desc "remove quip <text> - removes a quip from the quip database"
+  match /^remove quip (.+)/, :sent_to_me => true do |quip|
+    if remove_quip(quip)
+      reply "I removed the quip from the quip database"
+    else
+      reply "I couldn't remove the quip, since it wasn't in the quip database"
+    end
+  end
+
+  desc "quip - returns a random quip"
+  match /^quip$/, :sent_to_me => true do
+    quip = random_quip
+    if quip
+      reply quip
+    else
+      reply "I don't know any quips"
+    end
+  end
+
+  # The list of quips stored in the quip database
+  def quips
+    # I'd love to use a set here, but it doesn't serialize right to yaml
+    store["quips"] ||= []
+  end
+
+  # Update the list of quips stored in the quip database
+  def quips=(new_quips)
+    # I'd love to use a set here, but it doesn't serialize right to yaml
+    store["quips"] = new_quips
+  end
+
+  # Adds +quip+ to the quip database
+  def add_quip(quip)
+    self.quips = (quips + Array(quip)) unless quips.include?(quip)
+  end
+
+  # Removes +quip+ from the quip database
+  def remove_quip(quip)
+    self.quips = (quips - Array(quip)) if quips.include?(quip)
+  end
+
+  # Returns a random quip
+  def random_quip
+    quips[rand(quips.length)] unless quips.empty?
+  end
+
+end

data/lib/robut/plugin/say.rb

@@ -8,20 +8,14 @@
 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 = clean(words[1..-1].join(' '))
-      system("say #{phrase}")
-    end
+  desc "say <words> - uses Mac OS X's 'say' command to speak <words>"
+  match "^say (.*)$", :sent_to_me => true do |phrase|
+    phrase = clean(phrase)
+    system("say #{phrase}")
   end
 
+  private
+
   def clean(str)
     str.gsub("'", "").gsub(/[^A-Za-z0-9\s]+/, " ").gsub(/\s+/, ' ').strip
   end

data/lib/robut/plugin/stock.rb

@@ -0,0 +1,45 @@
+begin
+  require 'yahoofinance' # require yahoofinance gem
+rescue LoadError
+  puts "You must install the yahoofinance gem in order to use the Stock plugin"
+  raise $!
+end
+
+class Robut::Plugin::Stock
+  include Robut::Plugin
+
+  desc "stock <symbol> - Returns a stock data from Yahoo Finance"
+  match /^stock (.*)/, :sent_to_me => true do |phrase|
+    stock_data = get_stock_data(format_stock_symbols(phrase))
+    reply format_reply(stock_data)
+  end
+
+  private
+
+  def format_reply(stock_data)
+    r = []
+    stock_data.keys.sort.each do |sym|
+      sd = stock_data[sym]
+      r << "#{sym}: #{format_number(sd.changePoints)} / #{format_number(sd.changePercent)}%,\tbid: #{pad_number(sd.bid)},\task: #{pad_number(sd.ask)},\tprevious close: #{pad_number(sd.previousClose)}"
+    end
+    r.join("\n")
+  end
+
+  def format_number(n)
+    n > 0 ? "+" + pad_number(n) : pad_number(n)
+  end
+
+  def pad_number(n)
+    sprintf("%.2f", n)
+  end
+
+  def format_stock_symbols(phrase)
+    phrase.downcase.split(/[\s,;]+/).join(',')
+  end
+
+  def get_stock_data(symbols)
+    YahooFinance::get_quotes(YahooFinance::StandardQuote, symbols)
+  end
+
+
+end

data/lib/robut/pm.rb

@@ -0,0 +1,40 @@
+class Robut::PM < Robut::Presence
+
+  def initialize(connection, rooms)
+    # Add the callback from direct messages. Turns out the
+    # on_private_message callback doesn't do what it sounds like, so I
+    # have to go a little deeper into xmpp4r to get this working.
+    self.connection = connection
+    connection.client.add_message_callback(200, self) do |message|
+      from_room = rooms.any? {|room| room.muc.from_room?(message.from)}
+      if !from_room && message.type == :chat && message.body
+        time = Time.now # TODO: get real timestamp? Doesn't seem like
+                        # jabber gives it to us
+        sender_jid = message.from
+        plugins = Robut::Plugin.plugins.map { |p| p.new(self, sender_jid) }
+        handle_message(plugins, time, connection.roster[sender_jid].iname, message.body)
+        true
+      else
+        false
+      end
+    end
+  end
+
+  def reply(message, to)
+    unless to.kind_of?(Jabber::JID)
+      to = find_jid_by_name(to)
+    end
+
+    msg = Jabber::Message.new(to, message)
+    msg.type = :chat
+    connection.client.send(msg)
+  end
+
+  private
+
+  # Find a jid in the roster with the given name, case-insensitively
+  def find_jid_by_name(name)
+    name = name.downcase
+    connection.roster.items.detect {|jid, item| item.iname.downcase == name}.first
+  end
+end

data/lib/robut/presence.rb

@@ -0,0 +1,35 @@
+class Robut::Presence
+
+  # The Robut::Connection that has all the connection info.
+  attr_accessor :connection
+
+  def initialize(connection)
+    self.connection = connection
+  end
+
+  # Sends the chat message +message+ through +plugins+.
+  def handle_message(plugins, time, nick, message)
+    # ignore all messages sent by robut. If you really want robut to
+    # reply to itself, you can use +fake_message+.
+    return if nick == connection.config.nick
+
+    plugins.each do |plugin|
+      begin
+        rsp = plugin.handle(time, nick, message)
+        break if rsp == true
+      rescue => e
+        error = "UH OH! #{plugin.class.name} just crashed!"
+
+        if nick
+          reply(error, nick) # Connection#reply
+        else
+          reply(error)       # Room#reply
+        end
+        if connection.config.logger
+          connection.config.logger.error e
+          connection.config.logger.error e.backtrace.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/robut/room.rb

@@ -0,0 +1,30 @@
+# Handles connections and responses to different rooms. 
+class Robut::Room < Robut::Presence
+
+  # The MUC that wraps the Jabber Chat protocol.
+  attr_accessor :muc
+
+  # The room jid
+  attr_accessor :name
+
+  def initialize(connection, room_name)
+    self.muc        = Jabber::MUC::SimpleMUCClient.new(connection.client)
+    self.connection = connection
+    self.name       = room_name
+  end
+
+  def join
+    # Add the callback from messages that occur inside the room
+    muc.on_message do |time, nick, message|
+      plugins = Robut::Plugin.plugins.map { |p| p.new(self) }
+      handle_message(plugins, time, nick, message)
+    end
+
+    muc.join(self.name + '/' + connection.config.nick)
+  end
+
+  # Send +message+ to the room we're currently connected to
+  def reply(message, to)
+    muc.send(Jabber::Message.new(muc.room, message))
+  end
+end

data/lib/robut/version.rb

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