sclemmer-robut 0.5.2

data/lib/robut/plugin.rb

@@ -0,0 +1,201 @@
+# Robut plugins implement a simple interface to listen for messages
+# and optionally respond to them. All plugins include the Robut::Plugin
+# 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
+
+    # Allows you to define http methods that this plugin should respond to.
+    # This is useful if you're want to accept generic post data for Robut to
+    # display in all rooms (e.g. Heroku deploy hooks, GitHub post receive
+    # hooks, etc).
+    #
+    #     http do
+    #       post '/heroku' do
+    #         payload = Hashie::Mash.new(params)
+    #         say "#{payload.user} deployed #{payload.head} to #{payload.app}", nil
+    #         halt 200
+    #       end
+    #     end
+    #
+    # The action is run in the context of a Sinatra app (+Robut::Web+). So
+    # anything that Sinatra provides is available within the block.
+    def http(&block)
+      Robut::Web.class_eval &block
+    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
+    # respond to messages.
+    attr_accessor :plugins
+  end
+
+  self.plugins = []
+
+  # A reference to the connection attached to this instance of the
+  # plugin. This is mostly used to communicate back to the server.
+  attr_accessor :connection
+
+  # If we are handling a private message, holds a reference to the
+  # sender of the message. +nil+ if the message was sent to the entire
+  # room.
+  attr_accessor :private_sender
+
+  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
+
+  # Send +message+ back to the HipChat server. If +to+ == +:room+,
+  # replies to the room. If +to+ == nil, responds in the manner the
+  # original message was sent. Otherwise, PMs the message to +to+.
+  def reply(message, to = nil)
+    if to == :room
+      reply_to.reply(message, nil)
+    else
+      reply_to.reply(message, to || private_sender)
+    end
+  end
+
+  # An ordered list of all words in the message with any reference to
+  # the bot's nick stripped out. If +command+ is passed in, it is also
+  # stripped out. This is useful to separate the 'parameters' from the
+  # 'commands' in a message.
+  def words(message, command = nil)
+    reply = at_nick.downcase
+    command = command.downcase if command
+    message.split.reject {|word| word.downcase == reply || word.downcase == command }
+  end
+
+  # Removes the first word in message if it is a reference to the bot's nick
+  # Given "@robut do this thing", Returns "do this thing"
+  def without_nick(message)
+    possible_nick, command = message.split(' ', 2)
+    if possible_nick.casecmp(at_nick) == 0
+      command
+    else
+      message
+    end
+  end
+
+  # The bot's nickname, for @-replies.
+  def nick
+    connection.config.mention_name || connection.config.nick.gsub(/[^0-9a-z]/i, '')
+  end
+
+  # #nick with the @-symbol prepended
+  def at_nick
+    "@#{nick}"
+  end
+
+  # Was +message+ sent to Robut as an @reply?
+  def sent_to_me?(message)
+    message =~ /(^|\s)@#{nick}(\s|$)/i
+  end
+
+  # Do whatever you need to do to handle this message.
+  # If you want to stop the plugin execution chain, return +true+ from this
+  # method.  Plugins are handled in the order that they appear in
+  # Robut::Plugin.plugins
+  def handle(time, sender_nick, message)
+    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(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

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,39 @@
+STARTED = Time.now
+
+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
+
+    time = Time.now
+    return if time < (STARTED + 10)
+    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/storage/base.rb

@@ -0,0 +1,21 @@
+# A Robut::Storage implementation is a simple key-value store
+# accessible to all plugins. Plugins can access the global storage
+# object with the method +store+. All storage implementations inherit
+# from Robut::Storage::Base. All implementations must implement the class
+# methods [] and []=.
+class Robut::Storage::Base
+  
+  class << self
+
+    # Sets the key +k+ to the value +v+ in the current storage system
+    def []=(k,v)
+      raise "Must be implemented"
+    end
+
+    # Returns the value at the key +k+.
+    def [](k)
+      raise "Must be implemented"
+    end
+  end
+
+end

data/lib/robut/storage/hash_store.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+
+# A simple in-memory store backed by a Hash.
+class Robut::Storage::HashStore < Robut::Storage::Base
+    
+  class << self
+
+    # Stores +v+ in the hash.
+    def []=(k, v)
+      internal[k] = v
+    end
+
+    # Returns the value at key +k+.
+    def [](k)
+      internal[k]
+    end
+
+    private
+    # The hash the data is being stored in.
+    def internal
+      @internal ||= {}
+    end
+    
+  end
+    
+end

data/lib/robut/storage/yaml_store.rb

@@ -0,0 +1,57 @@
+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.
+    attr_reader :file
+
+    # Sets the path to the file this store will persist to, and forces
+    # a reload of all of the data.
+    def file=(f)
+      @file = f
+      @internal = nil # force reload
+      @file
+    end
+
+    # Sets the key +k+ to the value +v+
+    def []=(k, v)
+      internal[k] = v
+      persist!
+      v
+    end
+
+    # Returns the value at the key +k+.
+    def [](k)
+      internal[k]
+    end
+
+    private
+
+    # The internal in-memory representation of the yaml file
+    def internal
+      @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
+      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/storage.rb

@@ -0,0 +1,3 @@
+module Robut::Storage # :nodoc:
+  autoload :Base, 'robut/storage/base'
+end

data/lib/robut/version.rb

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

data/lib/robut/web.rb

@@ -0,0 +1,26 @@
+require 'sinatra/base'
+
+module Robut
+  class Web < Sinatra::Base
+    helpers do
+      # Say something to all connected rooms. Delegates to #reply
+      def say(*args)
+        reply(*args)
+      end
+
+      # Easy access to the current connection context.
+      def connection
+        settings.connection
+      end
+
+      # Delegates to Connection#reply
+      def reply(*args)
+        connection.reply(*args)
+      end
+    end
+
+    get '/' do
+      'ok'
+    end
+  end
+end

data/lib/robut.rb

@@ -0,0 +1,9 @@
+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'
+  autoload :Web, 'robut/web'
+end

data/sclemmer-robut.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "robut/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sclemmer-robut"
+  s.version     = Robut::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Justin Weiss"]
+  s.email       = ["justin@uberweiss.org"]
+  s.homepage    = "http://rdoc.info/github/justinweiss/robut/master/frames"
+  s.summary     = %q{A simple plugin-enabled HipChat bot}
+  s.description = %q{A simple plugin-enabled HipChat bot}
+
+  s.rubyforge_project = "robut"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "xmpp4r", "~> 0.5.0"
+  s.add_dependency "sinatra", "~> 1.3"
+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/mocks/connection_mock.rb

@@ -0,0 +1,22 @@
+require 'robut/storage/hash_store'
+
+class Robut::ConnectionMock < Robut::Connection
+
+  attr_accessor :messages
+
+  def initialize(config = nil)
+    self.messages = []
+    self.config = config || self.class.config
+    self.store  = Robut::Storage::HashStore
+    self.client = Jabber::Client.new ''
+  end
+
+  def connect
+    self.rooms = []
+    self
+  end
+
+  def reply(message, to)
+    self.messages << [message, to]
+  end
+end

data/test/mocks/presence_mock.rb

@@ -0,0 +1,25 @@
+require 'robut/storage/hash_store'
+
+class Robut::PresenceMock < Robut::Room
+
+  def initialize(connection)
+    self.connection = connection
+  end
+
+  def replies
+    @replies ||= []
+  end
+  
+  def reply(msg, to = nil)
+    replies << msg
+  end
+  
+  def handle_message(plugins, time, nick, message)
+    messages << [time, nick, message]
+  end
+  
+  def messages
+    @messages ||= []
+  end
+  
+end

data/test/simplecov_helper.rb

@@ -0,0 +1,2 @@
+  require 'simplecov'
+  SimpleCov.start

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'robut'
+require 'test/unit'
+require 'mocks/presence_mock'
+require 'mocks/connection_mock'
+
+Robut::ConnectionMock.configure do |config|
+  config.nick = "Robut t. Robot"
+  config.mention_name = "robut"
+end