robut 0.3.0 → 0.4.0

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  # - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  # - jruby-18mode # JRuby in 1.8 mode
+  # - jruby-19mode # JRuby in 1.9 mode
+  # - rbx-18mode
+  # - rbx-19mode # currently in active development, may or may not work for your project
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -8,13 +8,12 @@ group :test do
   gem 'simplecov'
   gem 'webmock'
   gem 'time-warp'
+  gem 'mocha'
 end
 
 group :plugin do
   gem 'calc'
   gem 'twss'
-  gem 'rdio', '0.0.91' # .92 is horked
-  gem 'sinatra'
   gem 'meme_generator'
   gem 'nokogiri'
-end
+end

data/README.rdoc

@@ -1,6 +1,16 @@
 = Robut
 
-The friendly plugin-enabled HipChat bot. 
+The friendly plugin-enabled HipChat bot.
+
+== NOTE: Breaking backwards compatibility!
+
+A little while ago, HipChat changed the way their mention names
+work. Instead of just using the first name ('@robut'), they now use
+the full name ('@RobutTRobot'). Starting from v0.4.0, robut uses this
+new format by default. If you prefer the old style, you can set it in
+your Chatfile:
+
+  config.mention_name = 'robut'
 
 == Installation and usage
 
@@ -22,8 +32,11 @@ Some of the included plugins require extra gems to be installed:
 
 [Robut::Plugin::TWSS] requires the <tt>twss</tt> gem.
 [Robut::Plugin::Calc] requires the <tt>calc</tt> gem.
-[Robut::Plugin::Rdio] requires the <tt>rdio</tt> and <tt>sinatra</tt> gems.
 [Robut::Plugin::Weather] requires the <tt>nokogiri</tt> gem.
+[Robut::Plugin::GoogleImages] requires the <tt>google-search</tt> gem.
+
+A list of known 3rd-party plugins is available on the wiki: https://github.com/justinweiss/robut/wiki/Robut-Plugins
+Feel free to add your own creations!
 
 == The Chatfile
 
@@ -53,7 +66,7 @@ kind of configuration they support.
 Some plugins might require storage (like the `lunch` plugin).  You can
 configure the type of storage you want to use based on the need for
 persistence.  The default is the HashStore which is in-memory only.  Below
-is an example of using the YamlStore.  
+is an example of using the YamlStore.
 
   Robut::Connection.configure do |config|
     # ...
@@ -71,13 +84,16 @@ Robut::Connection.configure block:
   Robut::Connection.configure do |config|
     config.jid = '...@chat.hipchat.com/bot'
     config.password = 'password'
-    config.nick = 'My Nick'
-    config.room = '...@conf.hipchat.com'
-    
+    config.nick = 'Bot Nick'
+    config.rooms = ['1234_room_1@conf.hipchat.com', '1234_room_2@conf.hipchat.com']
+
+    # Custom @mention name
+    config.mention_name = 'Bot'
+
     # Example of the YamlStore which uses a yaml file for persistence
     Robut::Storage::YamlStore.file = "~/.robut_store"
     config.store = Robut::Storage::YamlStore
-    
+
     # Add a logger if you want to debug the connection
     # config.logger = Logger.new(STDOUT)
   end
@@ -98,16 +114,19 @@ Robut includes a few plugins that we've found useful:
   @robut lunch? # => "Banh Mi!"
 
 
-[Robut::Plugin::Meme] an interface to memecaptain. 
+[Robut::Plugin::Meme] generates meme images using memecaptain.
 
   @robut meme all_the_things drink; all the beer
 
+[Robut::Plugin::GoogleImages] does a google image search for a query and returns the first result.
 
-[Robut::Plugin::Sayings] a simple regex listener and responder. 
+  @robut image ship it
+
+[Robut::Plugin::Sayings] a simple regex listener and responder.
 
   You're the worst robot ever, @robut. # => I know.
 
-[Robut::Plugin::TWSS] an interface to the TWSS gem. Listens to anything said in the chat room and responds "That's what she said!" where appropriate. 
+[Robut::Plugin::TWSS] an interface to the TWSS gem. Listens to anything said in the chat room and responds "That's what she said!" where appropriate.
 
   well hurry up, you're not going fast enough # => "That's what she said!"
 
@@ -117,12 +136,12 @@ Robut includes a few plugins that we've found useful:
   @robut echo hello world # => "hello world"
 
 
-[Robut::Plugin::Say] invokes the "say" command (text-to-speech). 
+[Robut::Plugin::Say] invokes the "say" command (text-to-speech).
 
   @robut say this rocks # (make sure robut is running on a machine with speakers :)
 
 
-[Robut::Plugin::Ping] responds with "pong". 
+[Robut::Plugin::Ping] responds with "pong".
 
   @robut ping # => "pong"
 
@@ -132,11 +151,6 @@ Robut includes a few plugins that we've found useful:
   @robut in 5 minutes echo @justin wake up! # => (5 minutes later) "@justin wake up!"
 
 
-[Robut::Plugin::Rdio] uses the Rdio[http://www.rdio.com] API and a simple web server to queue and play songs on Rdio.
-
-  @robut play ok computer
-
-
 [Robut::Plugin::Weather] uses Google Weather to fetch for the weather for a given location and day.
 
   @robut seattle weather saturday? # => "Forecast for Seattle, WA on Sat: Sunny, High: 77F, Low: 55F"
@@ -146,6 +160,12 @@ Robut includes a few plugins that we've found useful:
   @robut alias "cowboy" "@robut play bon jovi wanted dead or alive" # Cuz somtimes you need it.
   @robut alias w weather? # less typing for common stuff
 
+[Robut::Plugin::Quips] stores and posts Bugzilla-style quips.
+
+  @robut add quip It was great when I wrote it!
+  @robut quip # => It was great when I wrote it!
+  @robut remove quip It was great when I wrote it!
+
 [Robut::Plugin::Help] lists usage for all the plugins loaded into robut
 
   @robut help # => command usage
@@ -179,5 +199,4 @@ Once your changes are ready:
 
 == Todo
 
-* Support connections to multiple rooms
-* More plugins!
+* More plugins!

data/examples/Chatfile

@@ -8,15 +8,21 @@ Robut::Plugin.plugins << Robut::Plugin::TWSS
 
 # Configure the robut jabber connection and you're good to go!
 Robut::Connection.configure do |config|
+  # Note that the jid must end with /bot if you don't want robut to
+  # spam the channel, as described by the last bullet point on this
+  # page: https://www.hipchat.com/help/category/xmpp
   config.jid = '...@chat.hipchat.com/bot'
   config.password = 'password'
-  config.nick = 'My Nick'
+  config.nick = 'Bot Nick'
   config.room = '...@conf.hipchat.com'
-  
+
+  # Custom @mention name
+  # config.mention_name = 'Bot'
+
   # Some plugins require storage
   Robut::Storage::YamlStore.file = ".robut"
   config.store = Robut::Storage::YamlStore
-  
+
   # Add a logger if you want to debug the connection
   # config.logger = Logger.new(STDOUT)
-end
+end

data/lib/robut.rb

@@ -1,5 +1,8 @@
 module Robut
   autoload :Plugin, 'robut/plugin'
+  autoload :Presence, 'robut/presence'
+  autoload :Room, 'robut/room'
+  autoload :PM, 'robut/pm'
   autoload :Connection, 'robut/connection'
   autoload :Storage, 'robut/storage'
 end

data/lib/robut/connection.rb

@@ -19,7 +19,7 @@ class Robut::Connection
   # [+jid+, +password+, +nick+] The HipChat credentials given on
   #                             https://www.hipchat.com/account/xmpp
   #
-  # [+room+] The chat room to join, in the format <tt>jabber_name</tt>@<tt>conference_server</tt>
+  # [+rooms+] The chat room(s) to join, with each in the format <tt>jabber_name</tt>@<tt>conference_server</tt>
   #
   # [+logger+] a logger instance to use for debug output.
   attr_accessor :config
@@ -27,15 +27,15 @@ class Robut::Connection
   # The Jabber::Client that's connected to the HipChat server.
   attr_accessor :client
 
-  # The MUC that wraps the Jabber Chat protocol.
-  attr_accessor :muc
-
   # The storage instance that's available to plugins
   attr_accessor :store
 
   # The roster of currently available people
   attr_accessor :roster
 
+  # The rooms that robut is connected to.
+  attr_accessor :rooms
+
   class << self
     # Class-level config. This is set by the +configure+ class method,
     # and is used if no configuration is passed to the +initialize+
@@ -65,8 +65,8 @@ class Robut::Connection
     self.config = _config || self.class.config
 
     self.client = Jabber::Client.new(self.config.jid)
-    self.muc = Jabber::MUC::SimpleMUCClient.new(client)
     self.store = self.config.store || Robut::Storage::HashStore # default to in-memory store only
+    self.config.rooms ||= Array(self.config.room) # legacy support?
 
     if self.config.logger
       Jabber.logger = self.config.logger
@@ -74,43 +74,6 @@ class Robut::Connection
     end
   end
 
-  # Send +message+ to the room we're currently connected to, or
-  # directly to the person referenced by +to+. +to+ can be either a
-  # jid or the string name of the person.
-  def reply(message, to = nil)
-    if to
-      unless to.kind_of?(Jabber::JID)
-        to = find_jid_by_name(to)
-      end
-
-      msg = Jabber::Message.new(to || muc.room, message)
-      msg.type = :chat
-      client.send(msg)
-    else
-      muc.send(Jabber::Message.new(muc.room, message))
-    end
-  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 == config.nick
-    
-    plugins.each do |plugin|
-      begin
-        rsp = plugin.handle(time, nick, message)
-        break if rsp == true
-      rescue => e
-        reply("UH OH! #{plugin.class.name} just crashed!")
-        if config.logger
-          config.logger.error e
-          config.logger.error e.backtrace.join("\n")
-        end
-      end
-    end
-  end
-
   # Connects to the specified room with the given credentials, and
   # enters an infinite loop. Any messages sent to the room will pass
   # through all the included plugins.
@@ -122,36 +85,17 @@ class Robut::Connection
     self.roster = Jabber::Roster::Helper.new(client)
     roster.wait_for_roster
 
-    # 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, nil) }
-      handle_message(plugins, time, nick, message)
-    end
-
-    # 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.
-    client.add_message_callback(200, self) do |message|
-      if !muc.from_room?(message.from) && 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, self.roster[sender_jid].iname, message.body)
-        true
-      else
-        false
-      end
+    rooms = self.config.rooms.collect do |room_name|
+      Robut::Room.new(self, room_name).tap {|r| r.join }
     end
 
-    muc.join(config.room + '/' + config.nick)
+    personal_message = Robut::PM.new(self, rooms)
 
     trap_signals
     loop { sleep 1 }
   end
 
-  private
-
+private
   # Since we're entering an infinite loop, we have to trap TERM and
   # INT. If something like the Rdio plugin has started a server that
   # has already trapped those signals, we want to run those signal
@@ -167,10 +111,4 @@ class Robut::Connection
       old_signal_callbacks[sig] = trap(sig) { signal_callback.call(sig) }
     end
   end
-
-  # Find a jid in the roster with the given name, case-insensitively
-  def find_jid_by_name(name)
-    name = name.downcase
-    roster.items.detect {|jid, item| item.iname.downcase == name}.first
-  end
-end
+end

data/lib/robut/plugin.rb

@@ -3,6 +3,45 @@
 # module.
 module Robut::Plugin
 
+  # Contains methods that will be added directly to a class including
+  # Robut::Plugin.
+  module ClassMethods
+
+    # Sets up a 'matcher' that will try to match input being sent to
+    # this plugin with a regular expression. If the expression
+    # matches, +action+ will be performed. +action+ will be passed any
+    # captured groups in the regular expression as parameters. For
+    # example:
+    #
+    #     match /^say hello to (\w+)/ do |name| ...
+    #
+    # The action is run in the context of an instance of a class that
+    # includes Robut::Plugin. Like +handle+, an action explicitly
+    # returning +true+ will stop the plugin chain from matching any
+    # further.
+    #
+    # Supported options:
+    #   :sent_to_me - only try to match this regexp if it contains an @reply to robut.
+    #                 This will also strip the @reply from the message we're trying
+    #                 to match on, so ^ and $ will still do the right thing.
+    def match(regexp, options = {}, &action)
+      matchers << [regexp, options, action, @last_description]
+      @last_description = nil
+    end
+
+    # Provides a description for the next matcher
+    def desc(string)
+      @last_description = string
+    end
+
+    # A list of regular expressions to apply to input being sent to
+    # the plugin, along with blocks of actions to perform. Each
+    # element is a [regexp, options, action, description] array.
+    def matchers
+      @matchers ||= []
+    end
+  end
+
   class << self
     # A list of all available plugin classes. When you require a new
     # plugin class, you should add it to this list if you want it to
@@ -21,10 +60,18 @@ module Robut::Plugin
   # room.
   attr_accessor :private_sender
 
-  # Creates a new instance of this plugin that references the
-  # specified connection.
-  def initialize(connection, private_sender = nil)
-    self.connection = connection
+  attr_accessor :reply_to
+
+  # :nodoc:
+  def self.included(klass)
+    klass.send(:extend, ClassMethods)
+  end
+
+  # Creates a new instance of this plugin to reply to a particular
+  # object over that object's connection
+  def initialize(reply_to, private_sender = nil)
+    self.reply_to = reply_to
+    self.connection = reply_to.connection
     self.private_sender = private_sender
   end
 
@@ -33,9 +80,9 @@ module Robut::Plugin
   # original message was sent. Otherwise, PMs the message to +to+.
   def reply(message, to = nil)
     if to == :room
-      connection.reply(message, nil)
+      reply_to.reply(message, nil)
     else
-      connection.reply(message, to || private_sender)
+      reply_to.reply(message, to || private_sender)
     end
   end
 
@@ -44,7 +91,7 @@ module Robut::Plugin
   # stripped out. This is useful to separate the 'parameters' from the
   # 'commands' in a message.
   def words(message, command = nil)
-    reply = at_nick
+    reply = at_nick.downcase
     command = command.downcase if command
     message.split.reject {|word| word.downcase == reply || word.downcase == command }
   end
@@ -53,7 +100,7 @@ module Robut::Plugin
   # Given "@robut do this thing", Returns "do this thing"
   def without_nick(message)
     possible_nick, command = message.split(' ', 2)
-    if possible_nick == at_nick
+    if possible_nick.casecmp(at_nick) == 0
       command
     else
       message
@@ -62,12 +109,12 @@ module Robut::Plugin
 
   # The bot's nickname, for @-replies.
   def nick
-    connection.config.nick.split.first
+    connection.config.mention_name || connection.config.nick.gsub(/[^0-9a-z]/i, '')
   end
 
   # #nick with the @-symbol prepended
   def at_nick
-    "@#{nick.downcase}"
+    "@#{nick}"
   end
 
   # Was +message+ sent to Robut as an @reply?
@@ -80,22 +127,56 @@ module Robut::Plugin
   # method.  Plugins are handled in the order that they appear in
   # Robut::Plugin.plugins
   def handle(time, sender_nick, message)
-    raise NotImplementedError, "Implement me in #{self.class.name}!"
+    if matchers.empty?
+      raise NotImplementedError, "Implement me in #{self.class.name}!"
+    else
+      find_match(message)
+    end
   end
 
   # Returns a list of messages describing the commands this plugin
   # handles.
   def usage
+    matchers.map do |regexp, options, action, description|
+      next unless description
+      if options[:sent_to_me]
+        at_nick + " " + description
+      else
+        description
+      end
+    end.compact
   end
 
   def fake_message(time, sender_nick, msg)
     # TODO: ensure this connection is threadsafe
-    plugins = Robut::Plugin.plugins.map { |p| p.new(connection, private_sender) }
-    connection.handle_message(plugins, time, sender_nick, msg)
+    plugins = Robut::Plugin.plugins.map { |p| p.new(reply_to, private_sender) }
+    reply_to.handle_message(plugins, time, sender_nick, msg)
   end
 
   # Accessor for the store instance
   def store
     connection.store
   end
+
+  private
+
+  # Find and run all the actions associated with matchers that match
+  # +message+.
+  def find_match(message)
+    matchers.each do |regexp, options, action, description|
+      if options[:sent_to_me] && !sent_to_me?(message)
+        next
+      end
+
+      if match_data = without_nick(message).match(regexp)
+        # Return true explicitly if this matcher explicitly returned true
+        break true if instance_exec(*match_data[1..-1], &action) == true
+      end
+    end
+  end
+
+  # The matchers defined by this plugin's class
+  def matchers
+    self.class.matchers
+  end
 end