viking-biobot 0.0.1

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/redgreen'

data/.gitignore

@@ -0,0 +1,7 @@
+.*swp
+old
+pkg
+test/db.sqlite3
+test.rb
+Session.vim
+config/biobot.yml

data/README

@@ -0,0 +1 @@
+Biobot is an XMPP bot! :P

data/README.daemonize

@@ -0,0 +1,24 @@
+
+        Daemonize Library
+
+        August. 2, 2005 Travis Whitton <whitton@atlantic.net>
+
+Daemonize allows you to easily modify any existing Ruby program to run
+as a daemon. See README.rdoc for more details.
+
+[How to install]
+1. su to root
+2. ruby setup.rb or ruby setup.rb --help for more options
+build the docs if you want to
+3. rdoc --main README.rdoc lib/daemonize.rb README.rdoc
+
+[Copying]
+The Daemonize extension module is copywrited free software by Travis Whitton
+<whitton@atlantic.net>. You can redistribute it under the terms specified in
+the COPYING file of the Ruby distribution.
+
+[WARRANTY]
+THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |spec|
+    spec.name = "biobot"
+    spec.summary = "An XMPP bot for Vanderbilt Biostatistics"
+    spec.description = "An XMPP bot for Vanderbilt Biostatistics"
+    spec.email = "viking415@gmail.com"
+    spec.homepage = "http://biostat.mc.vanderbilt.edu"
+    spec.authors = ["Jeremy Stephens"]
+    spec.add_dependency('activerecord')
+    spec.add_dependency('xmpp4r')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/biobot

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'yaml'
+require 'biobot'
+require 'daemonize'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: biobot -c <filename>"
+
+  opts.on("-c", "--config FILENAME", "Specify the configuration file") do |c|
+    options[:config] = c
+  end
+
+  opts.on("-d", "--daemonize", "Daemonize the process") do
+    options[:daemon] = true
+  end
+end.parse!
+
+unless options[:config]
+  puts "No configuration file specified; see --help"
+  exit
+end
+raise Errno::ENOENT   unless File.exist?(options[:config])
+
+biobot = Biobot::Base.new(YAML.load_file(options[:config]))
+biobot.start
+Signal.trap("TERM") do
+  puts "Stopping biobot..."
+  biobot.stop
+end
+
+Daemonize.daemonize   if options[:daemon]
+loop do
+end

data/biobot.gemspec

@@ -0,0 +1,71 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{biobot}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Stephens"]
+  s.date = %q{2009-06-11}
+  s.default_executable = %q{biobot}
+  s.description = %q{An XMPP bot for Vanderbilt Biostatistics}
+  s.email = %q{viking415@gmail.com}
+  s.executables = ["biobot"]
+  s.extra_rdoc_files = [
+    "README",
+     "README.daemonize"
+  ]
+  s.files = [
+    ".autotest",
+     ".gitignore",
+     "README",
+     "README.daemonize",
+     "Rakefile",
+     "VERSION",
+     "bin/biobot",
+     "biobot.gemspec",
+     "config/biobot.yml-example",
+     "lib/biobot.rb",
+     "lib/biobot/base.rb",
+     "lib/biobot/commands.rb",
+     "lib/biobot/commands/greeting.rb",
+     "lib/biobot/periodicals.rb",
+     "lib/biobot/periodicals/notify.rb",
+     "lib/daemonize.rb",
+     "test/biobot/commands/test_greeting.rb",
+     "test/biobot/periodicals/test_notify.rb",
+     "test/biobot/test_base.rb",
+     "test/biobot/test_commands.rb",
+     "test/biobot/test_periodicals.rb",
+     "test/helper.rb"
+  ]
+  s.homepage = %q{http://biostat.mc.vanderbilt.edu}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{An XMPP bot for Vanderbilt Biostatistics}
+  s.test_files = [
+    "test/biobot/test_commands.rb",
+     "test/biobot/test_periodicals.rb",
+     "test/biobot/periodicals/test_notify.rb",
+     "test/biobot/test_base.rb",
+     "test/biobot/commands/test_greeting.rb",
+     "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<xmpp4r>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<xmpp4r>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<xmpp4r>, [">= 0"])
+  end
+end

data/config/biobot.yml-example

@@ -0,0 +1,8 @@
+xmpp:
+  server: localhost.localdomain
+  username: biobot
+  password: biobot
+
+database:
+  adapter: sqlite3
+  database: test/db.sqlite3

data/lib/biobot.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'xmpp4r'
+require 'active_record'
+
+require File.dirname(__FILE__) + '/biobot/base'
+require File.dirname(__FILE__) + '/biobot/commands'
+require File.dirname(__FILE__) + '/biobot/periodicals'

data/lib/biobot/base.rb

@@ -0,0 +1,60 @@
+module Biobot
+  class Base
+    @@command_chain = []
+    def self.register_command(method)
+      @@command_chain << method
+    end
+
+    @@periodicals = []
+    def self.register_periodical(method, delay)
+      @@periodicals << [method, delay]
+    end
+
+    def initialize(config)
+      @username, @password, @server = config['xmpp'].values_at('username', 'password', 'server')
+      @jid = @username + "@" + @server
+
+      # setup active record if database is specified
+      if config['database']
+        ActiveRecord::Base.establish_connection(config['database'])
+      end
+
+      @client = Jabber::Client.new(@jid)
+      @presence = Jabber::Presence.new
+
+      @client.add_message_callback do |message|
+        process(message) if message.body
+      end
+
+      @threads = []
+    end
+
+    def process(message)
+      result = nil
+      @@command_chain.each do |method|
+        result = send(method, message)
+        break if result
+      end
+      result ||= "Huh?"
+      message  = Jabber::Message.new(message.from, result)
+      @client.send(message)
+    end
+
+    def start
+      @client.connect(@server)
+      @client.auth(@password)
+      @client.send(@presence)
+
+      @@periodicals.each do |(method, delay)|
+        thread = Thread.new { loop { self.send(method); sleep(delay) } }
+        @threads << thread
+      end
+    end
+
+    def stop
+      @threads.each { |t| t.exit }
+      @threads.clear
+      @client.close!
+    end
+  end
+end

data/lib/biobot/commands.rb

@@ -0,0 +1,10 @@
+module Biobot
+  module Commands
+  end
+end
+
+Dir[File.dirname(__FILE__) + "/commands/*.rb"].each do |filename|
+  require filename
+  klass = File.basename(filename, '.rb').capitalize
+  Biobot::Base.send(:include, Biobot::Commands.const_get(klass))
+end

data/lib/biobot/commands/greeting.rb

@@ -0,0 +1,18 @@
+module Biobot
+  module Commands
+    module Greeting
+      def self.included(base)
+        base.register_command(:handle_greeting)
+      end
+
+      def handle_greeting(message)
+        case message.body.downcase
+        when /^hello/, /^hey/, /^hi/, /^sup/, /^greetings/
+          'Hello there!'
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/biobot/periodicals.rb

@@ -0,0 +1,10 @@
+module Biobot
+  module Periodicals
+  end
+end
+
+Dir[File.dirname(__FILE__) + "/periodicals/*.rb"].each do |filename|
+  require filename
+  klass = File.basename(filename, '.rb').capitalize
+  Biobot::Base.send(:include, Biobot::Periodicals.const_get(klass))
+end

data/lib/biobot/periodicals/notify.rb

@@ -0,0 +1,23 @@
+module Biobot
+  module Periodicals
+    module Notify
+      class Notification < ActiveRecord::Base
+        set_table_name 'notifications'
+      end
+
+      def self.included(base)
+        base.register_periodical(:handle_notifications, 60)
+      end
+
+      def handle_notifications
+        if Notification.count > 0
+          Notification.all.each do |notification|
+            message = Jabber::Message.new(notification.to, notification.body)
+            @client.send(message)
+          end
+          Notification.delete_all
+        end
+      end
+    end
+  end
+end

data/lib/daemonize.rb

@@ -0,0 +1,56 @@
+module Daemonize
+  VERSION = "0.1.2"
+
+  # Try to fork if at all possible retrying every 5 sec if the
+  # maximum process limit for the system has been reached
+  def safefork
+    tryagain = true
+
+    while tryagain
+      tryagain = false
+      begin
+        if pid = fork
+          return pid
+        end
+      rescue Errno::EWOULDBLOCK
+        sleep 5
+        tryagain = true
+      end
+    end
+  end
+
+  # This method causes the current running process to become a daemon
+  # If closefd is true, all existing file descriptors are closed
+  def daemonize(oldmode=0, closefd=false)
+    srand # Split rand streams between spawning and daemonized process
+    safefork and exit # Fork and exit from the parent
+
+    # Detach from the controlling terminal
+    unless sess_id = Process.setsid
+      raise 'Cannot detach from controlled terminal'
+    end
+
+    # Prevent the possibility of acquiring a controlling terminal
+    if oldmode.zero?
+      trap 'SIGHUP', 'IGNORE'
+      exit if pid = safefork
+    end
+
+    Dir.chdir "/"   # Release old working directory
+    File.umask 0000 # Insure sensible umask
+
+    if closefd
+      # Make sure all file descriptors are closed
+      ObjectSpace.each_object(IO) do |io|
+        unless [STDIN, STDOUT, STDERR].include?(io)
+          io.close rescue nil
+        end
+      end
+    end
+
+    STDIN.reopen "/dev/null"       # Free file descriptors and
+    STDOUT.reopen "/dev/null", "a" # point them somewhere sensible
+    STDERR.reopen STDOUT           # STDOUT/STDERR should go to a logfile
+    return oldmode ? sess_id : 0   # Return value is mostly irrelevant
+  end
+end

data/test/biobot/commands/test_greeting.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/../../helper"
+
+class TestGreeting < Test::Unit::TestCase
+  include Biobot::Commands::Greeting
+
+  def test_handle_message
+    %w{hello hi hey sup greetings}.each do |msg|
+      incoming = mock_message('dude@localhost', msg)
+      assert_equal 'Hello there!', handle_greeting(incoming)
+    end
+
+    incoming = mock_message('dude@localhost', 'unmatching')
+    assert_equal false, handle_greeting(incoming)
+  end
+end

data/test/biobot/periodicals/test_notify.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + "/../../helper"
+
+class TestNotify < Test::Unit::TestCase
+  include Biobot::Periodicals::Notify
+
+  def setup
+    @model = Biobot::Periodicals::Notify::Notification
+    @model.stubs(:inspect).returns('Notification')
+    @client = stub('Jabber::Client')
+  end
+
+  def test_handling_notifications
+    notification = mock("notification", :to => 'foo@localhost', :body => 'huge')
+    @model.expects(:count).returns(1)
+    @model.expects(:all).returns([notification])
+    outgoing = mock_message('biobot@localhost', 'huge')
+    Jabber::Message.expects(:new).with('foo@localhost', 'huge').returns(outgoing)
+    @client.expects(:send).with(outgoing)
+    @model.expects(:delete_all)
+
+    handle_notifications
+  end
+end

data/test/biobot/test_base.rb

@@ -0,0 +1,100 @@
+require File.dirname(__FILE__) + "/../helper"
+
+class TestBase < Test::Unit::TestCase
+  def setup
+    @client = stub('jabber client', {
+      :connect => @client, :auth => nil, :send => nil,
+      :add_message_callback => nil
+    })
+    Jabber::Client.stubs(:new).returns(@client)
+
+    @presence = stub('jabber presence')
+    Jabber::Presence.stubs(:new).returns(@presence)
+
+    @config = YAML.load(<<-EOF)
+      xmpp:
+        server: localhost
+        username: biobot
+        password: secret
+    EOF
+  end
+
+  def test_creates_client
+    Jabber::Client.expects(:new).with('biobot@localhost').returns(@client)
+    Biobot::Base.new(@config)
+  end
+
+  def test_connects_and_authenticates_on_start
+    @client.expects(:connect).with('localhost').returns(@client)
+    @client.expects(:auth).with('secret')
+    Biobot::Base.new(@config).start
+  end
+
+  def test_sends_presence_on_start
+    Jabber::Presence.expects(:new).returns(@presence)
+    @client.expects(:send).with(@presence)
+    Biobot::Base.new(@config).start
+  end
+
+  def test_registers_callback
+    @client.expects(:add_message_callback)
+    Biobot::Base.new(@config)
+  end
+
+  def test_message_processing_chain
+    clear_commands
+    Biobot::Base.register_command(:leetsaurus)
+    Biobot::Base.register_command(:leetceritops)
+    biobot = Biobot::Base.new(@config)
+    incoming = mock_message('dude@localhost', 'leetsaurus')
+    outgoing = mock_message('biobot@localhost', 'foo')
+    biobot.expects(:leetsaurus).with(incoming).returns('foo')
+    biobot.expects(:leetceritops).never
+    Jabber::Message.expects(:new).with('dude@localhost', 'foo').returns(outgoing)
+    @client.expects(:send).with(outgoing)
+    biobot.process(incoming)
+    clear_commands
+  end
+
+  def test_default_message
+    clear_commands
+    biobot = Biobot::Base.new(@config)
+    incoming = mock_message('dude@localhost', 'leetsaurus')
+    outgoing = mock_message('biobot@localhost', 'Huh?')
+    Jabber::Message.expects(:new).with('dude@localhost', "Huh?").returns(outgoing)
+    @client.expects(:send).with(outgoing)
+    biobot.process(incoming)
+    clear_commands
+  end
+
+  # can't unstub
+#  def test_ignore_composing
+#    biobot = Biobot::Base.new(@config)
+#    incoming = mock_message('dude@localhost', nil)
+#    biobot.expects(:send).never
+#    biobot.process(incoming)
+#  end
+
+  def test_timers_for_periodicals_on_start
+    clear_periodicals
+    Biobot::Base.register_periodical(:leetsaurus, 0.3)
+    Thread.expects(:new).once
+    Biobot::Base.new(@config).start
+  end
+
+  def test_active_record_usage
+    @config['database'] = {
+      "adapter" => "sqlite3",
+      "database" => "foo.sqlite3"
+    }
+    assert ActiveRecord::Base
+    ActiveRecord::Base.expects(:establish_connection).with(@config['database'])
+    Biobot::Base.new(@config)
+  end
+
+  def test_stop
+    @client.expects(:close!)
+    biobot = Biobot::Base.new(@config)
+    biobot.stop
+  end
+end

data/test/biobot/test_commands.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + "/../helper"
+
+class TestCommands < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/test/biobot/test_periodicals.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + "/../helper"
+
+class TestPeriodicals < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/test/helper.rb

@@ -0,0 +1,31 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require 'ruby-debug'
+require 'activerecord'
+require File.dirname(__FILE__) + '/../lib/biobot'
+
+module TestHelpers
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def register_command(*args); end
+    def register_periodical(*args); end
+  end
+
+  def mock_message(from, body)
+    stub('jabber message', :from => from, :body => body)
+  end
+
+  def clear_commands
+    Biobot::Base.send(:class_variable_get, '@@command_chain').clear
+  end
+
+  def clear_periodicals
+    Biobot::Base.send(:class_variable_get, '@@periodicals').clear
+  end
+end
+
+Test::Unit::TestCase.send(:include, TestHelpers)

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: viking-biobot
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeremy Stephens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-11 00:00:00 -07:00
+default_executable: biobot
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An XMPP bot for Vanderbilt Biostatistics
+email: viking415@gmail.com
+executables: 
+- biobot
+extensions: []
+
+extra_rdoc_files: 
+- README
+- README.daemonize
+files: 
+- .autotest
+- .gitignore
+- README
+- README.daemonize
+- Rakefile
+- VERSION
+- bin/biobot
+- biobot.gemspec
+- config/biobot.yml-example
+- lib/biobot.rb
+- lib/biobot/base.rb
+- lib/biobot/commands.rb
+- lib/biobot/commands/greeting.rb
+- lib/biobot/periodicals.rb
+- lib/biobot/periodicals/notify.rb
+- lib/daemonize.rb
+- test/biobot/commands/test_greeting.rb
+- test/biobot/periodicals/test_notify.rb
+- test/biobot/test_base.rb
+- test/biobot/test_commands.rb
+- test/biobot/test_periodicals.rb
+- test/helper.rb
+has_rdoc: false
+homepage: http://biostat.mc.vanderbilt.edu
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: An XMPP bot for Vanderbilt Biostatistics
+test_files: 
+- test/biobot/test_commands.rb
+- test/biobot/test_periodicals.rb
+- test/biobot/periodicals/test_notify.rb
+- test/biobot/test_base.rb
+- test/biobot/commands/test_greeting.rb
+- test/helper.rb