kirby 4.1 → 4.2

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v4.2. Add channel logging; clean up options handling; fix docs.
+
 v4.1. Watch atom feeds for git commits [lifo].
 
 v4. Documentation; Rakefile. Shouldn't have bumped the version, but all right.

data/README

@@ -25,20 +25,26 @@ Kirby is considered feature-locked.
 
 == Usage
 
-Run <tt>kirby [nick] [channel] [server] [delicious_name] [delicious_password]</tt>. 
+To start a basic Kirby from the command line:
 
-Optional parameters:
-<tt>-d</tt>:: Daemonize.
-<tt>-no-d</tt>:: Don't daemonize.
+  cd working/directory
+  kirby mynick mychannel myserver.org [delicious_user] [delicious_pass] [--options]
+  
+Logs and repository histories get saved to the working directory.
+
+Available post-parameters are:
+<tt>--daemon</tt>:: Daemonize.
 <tt>--silent</tt>:: Never speak, even for errors.
+<tt>--log</tt>:: Log channel chatter to a file.
+<tt>--debug</tt>:: Debug mode.
 
-See the Kirby class for commands.
+See the Kirby class for in-channel commands.
 
 == Crontab example
 
-You can use a crontask to keep Kirby alive at all times.
+You can use a crontask to keep Kirby alive at all times. For example: 
 
-  * * * * * bash -c 'cd /working/directory; kirby -d [options...] &> /dev/null' 
+  * * * * * bash -c 'cd /working/directory; kirby mynick mychannel irc.freenode.net --daemon --log --silent &> /dev/null' 
 
 == Reporting problems
 

data/bin/kirby

@@ -1,22 +1,47 @@
 #!/usr/bin/env ruby
 
 =begin rdoc
-Run <tt>kirby [nick] [channel] [server] [delicious_name] [delicious_password]</tt>. 
+Run <tt>kirby [nick] [channel] [server] [optional del.icio.us name] [optional del.icio.us password]</tt>. 
 
-Optional parameters:
-<tt>-d</tt>:: Daemonize.
-<tt>-no-d</tt>:: Don't daemonize.
+Optional post-parameters:
+<tt>--daemon</tt>:: Daemonize.
 <tt>--silent</tt>:: Never speak, even for errors.
+<tt>--log</tt>:: Log channel chatter to a file.
+<tt>--debug</tt>:: Debug mode.
 =end
 
 require 'rubygems'
-require 'kirby'
+require 'daemons'
 
-pid = open(Kirby::PIDFILE).gets.chomp rescue nil
+begin
+  require "#{File.dirname(__FILE__)}/../lib/kirby"
+rescue LoadError
+  require 'kirby'
+end
+
+def option?(opt)
+  ARGV.include?("--#{opt}")
+end
+
+def param(arg)
+  arg unless arg =~ /^--/
+end
+
+@kirby = Kirby.new(
+  :nick => param(ARGV[0]), 
+  :channel => param(ARGV[1]), 
+  :server => param(ARGV[2]), 
+  :delicious_user => param(ARGV[3]), 
+  :delicious_pass => param(ARGV[4]),
+  :silent => option?("silent"),
+  :debug => option?("debug"),
+  :log => option?("log")
+)
+
+pid = open(@kirby.config[:pidfile]).gets.chomp rescue nil
 
 if !pid or `ps #{pid}`.split("\n").size < 2
-  puts "Starting"
-  Daemons.daemonize if ARGV[0] == '-d'  #:ontop => true
-  open(Kirby::PIDFILE, 'w') {|f| f.puts $$}
-  Kirby.instance.restart
+  Daemons.daemonize if option? "daemon" 
+  open(@kirby.config[:pidfile], 'w') {|f| f.puts $$}  
+  @kirby.restart
 end

data/kirby.gemspec

@@ -1,16 +1,16 @@
 
-# Gem::Specification for Kirby-4.1
+# Gem::Specification for Kirby-4.2
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{kirby}
-  s.version = "4.1"
+  s.version = "4.2"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [""]
-  s.date = %q{2007-12-15}
+  s.date = %q{2007-12-31}
   s.default_executable = %q{kirby}
   s.description = %q{A super-clean IRC bot with sandboxed Ruby evaluation, svn watching, and link-logging to del.icio.us.}
   s.email = %q{}
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/kirby/}
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{0.9.5}
+  s.rubygems_version = %q{1.0.1}
   s.summary = %q{A super-clean IRC bot with sandboxed Ruby evaluation, svn watching, and link-logging to del.icio.us.}
 
   s.add_dependency(%q<hpricot>, [">= 0"])

data/lib/kirby.rb

@@ -2,60 +2,94 @@
 
 =begin rdoc
 In-channel commands:
-<tt>>> [string of code]</tt>:: Evaluate some Ruby code.
-<tt>reset_irb</tt>:: Reset the <tt>irb</tt> session.
-<tt>add_svn [repository_url]</tt>:: Watch an svn repository for changes.
+<tt>>> CODE</tt>:: evaluate code in IRB.
+<tt>reset_irb</tt>:: get a clean IRB session.
+<tt>add_svn [repository_url]</tt>:: watch an SVN repository.
+<tt>add_atom [atom_feed_url]</tt>:: watch an atom feed, such as a Git repository
+
+To remove a repository, manually kill the bot and delete the line from <tt>nick.svns</tt> or <tt>nick.atoms</tt> in the bot's working directory. Then restart the bot.
 =end
 
 class Kirby
-  include Singleton
 
-  PATH = Pathname.new(".").dirname.realpath.to_s
-  STORE = PATH + '/kirby.repositories'
-  ATOM  = PATH + '/kirby.atoms'
-  PIDFILE = PATH + '/kirby.pid'
+  attr_reader :config  
   
-  NICK = (ARGV[1] or "kirby-dev")
-  CHANNEL = ("#" + (ARGV[2] or "kirby-dev"))
-  SERVER = (ARGV[3] or "irc.freenode.org")
-  DELICIOUS_USER, DELICIOUS_PASS = ARGV[4], ARGV[5]
-  SILENT = ARGV[6] == "--silent"
+  # Make a new Kirby. Will not connect to the server until you call connect().
+  def initialize(opts = {})
+
+    # Defaults
+    path = File.expand_path(".").to_s
+    nick = opts[:nick] || config[:nick] || "kirby-dev"
+
+    @config ||= {
+      :svns => "#{path}/#{nick}.svns",
+      :atoms => "#{path}/#{nick}.atoms",
+      :pidfile => "#{path}/#{nick}.pid",
+      :nick => nick,
+      :channel => 'kirby-dev',
+      :server => "irc.freenode.org",
+      :delicious_user => nil,
+      :delicious_pass => nil,
+      :silent => false,
+      :log => false,
+      :logfile => "#{path}/#{nick}.log",
+      :time_format => '%Y/%m/%d %H:%M:%S',
+      :debug => false
+    }
+    
+    # Nicely merge current options
+    opts.each do |key, value|
+      config[key] = value if value
+    end
+  end
   
   # Connect and reconnect to the server  
-  def restart
-    $store = (YAML.load_file STORE rescue {})
-    $atom  = (YAML.load_file ATOM rescue {})
+  def restart    
+    log "Restarting"
+    puts config.inspect if config[:debug]
+      
+    @svns = (YAML.load_file config[:svns] rescue {})
+    @atoms  = (YAML.load_file config[:atoms] rescue {})
+
     @socket.close if @socket
     connect
     listen
   end
   
   # Connect to the IRC server.
-  def connect
-    @socket = TCPSocket.new(SERVER, 6667)
-    write "USER #{[NICK]*3*" "} :#{NICK}"
-    write "NICK #{NICK}"
-    write "JOIN #{CHANNEL}"
+  def connect    
+    log "Connecting"
+    @socket = TCPSocket.new(config[:server], 6667)
+    write "USER #{config[:nick]} #{config[:nick]} #{config[:nick]} :#{config[:nick]}"
+    write "NICK #{config[:nick]}"
+    write "JOIN ##{config[:channel]}"
   end
   
   # The event loop. Waits for socket traffic, and then responds to it. The server sends <tt>PING</tt> every 3 minutes, which means we don't need a separate thread to check for svn updates. All we do is wake on ping (or channel talking).
   def listen
     @socket.each do |line|
-#      puts "GOT: #{line.inspect}"
-      poll unless SILENT
+      puts "GOT: #{line.inspect}" if config[:debug]
+      poll if !config[:silent]
       case line.strip
-        when /^PING/ then write line.sub("PING", "PONG")[0..-3]
-        when /^ERROR/, /KICK #{CHANNEL} #{NICK} / then restart unless line =~ /PRIVMSG/
-        else 
-          if msg = line[/ PRIVMSG #{CHANNEL} \:(.+)/, 1]
+        when /^PING/
+          write line.sub("PING", "PONG")[0..-3]
+        when /^ERROR/, /KICK ##{config[:channel]} #{config[:nick]} / 
+          restart unless line =~ /PRIVMSG/
+        when /:(.+?)!.* PRIVMSG ##{config[:channel]} \:\001ACTION (.+)\001/
+          log "* #{$1} #{$2}"
+        when /:(.+?)!.* PRIVMSG ##{config[:channel]} \:(.+)/
+          nick, msg = $1, $2          
+          log "<#{nick}> #{msg}"
+          if !config[:silent]
             case msg
               when /^>>\s*(.+)/ then try $1.chop
-              when /^#{NICK}/ then say "Usage: '>> CODE'. Say 'reset_irb' for a clean session. Say 'add_svn [repository_url]' to watch an svn repository and add_atom [atom_feed_url] to watch an atom feed"
+              when /^#{config[:nick]}:/ 
+                ["Usage:",  "  '>> CODE': evaluate code in IRB", "  'reset_irb': get a clean IRB session", "  'add_svn [repository_url]': watch an SVN repository", "  'add_atom [atom_feed_url]': watch an atom feed, such as a Git repository"].each {|s| say s}
               when /^reset_irb/ then reset_irb
-              when /^add_svn (.+?)(\s|\r|\n|$)/ then $store[$1] = 0 and say $store.inspect
-              when /^add_atom (.+?)(\s|\r|\n|$)/ then $atom[$1] = '' and say $atom.inspect
-            end unless SILENT
-            post($1) if DELICIOUS_PASS and msg =~ /(http:\/\/.*?)(\s|\r|\n|$)/ 
+              when /^add_svn (.+?)(\s|\r|\n|$)/ then @svns[$1] = 0 and say @svns.inspect
+              when /^add_atom (.+?)(\s|\r|\n|$)/ then @atoms[$1] = '' and say @atoms.inspect
+              when /(http:\/\/.*?)(\s|\r|\n|$)/ then post($1) if config[:delicious_pass] 
+            end
           end
       end
     end
@@ -65,60 +99,78 @@ class Kirby
   def write s
     raise RuntimeError, "No socket" unless @socket
     @socket.puts s += "\r\n"
-#    puts "WROTE: #{s.inspect}"
+    puts "WROTE: #{s.inspect}" if config[:debug]
+  end
+  
+  # Write a string to the log, if the logfile is open.
+  def log s
+    # Open log, if necessary
+    if config[:log]
+      puts "LOG: #{s}" if config[:debug]
+      File.open(config[:logfile], 'a') do |f|
+        f.puts "#{Time.now.strftime(config[:time_format])} #{s}"
+      end
+    end
   end
   
   # Eval a piece of code in the <tt>irb</tt> environment.
   def try s
-    reset_irb unless $session
+    reset_irb unless @session
     try_eval(s).select{|e| e !~ /^\s+from .+\:\d+(\:|$)/}.each {|e| say e} rescue say "session error"
   end
   
   # Say something in the channel.
   def say s
-    write "PRIVMSG #{CHANNEL} :#{s[0..450]}"
+    write "PRIVMSG ##{config[:channel]} :#{s[0..450]}"
+    log "<#{config[:nick]}> #{s}"
     sleep 1
   end
     
   # Get a new <tt>irb</tt> session.
   def reset_irb
     say "Began new irb session"
-    $session = try_eval("!INIT!IRB!")
+    @session = try_eval("!INIT!IRB!")
   end
   
   # Inner loop of the try method.
   def try_eval s
     reset_irb and return [] if s.strip == "exit"
     result = open("http://tryruby.hobix.com/irb?cmd=#{CGI.escape(s)}", 
-            {'Cookie' => "_session_id=#{$session}"}).read
+            {'Cookie' => "_session_id=#{@session}"}).read
     result[/^Your session has been closed/] ? (reset_irb and try_eval s) : result.split("\n")
   end
   
-  # Look for svn changes.
+  # Look for SVN changes. Note that Rubyforge polls much better if you use the http:// protocol instead of the svn:// protocol for your repository.
   def poll
-    return unless (Time.now - $last_poll > 15 rescue true)
+    return unless (Time.now - $last_poll > 60 rescue true)
     $last_poll = Time.now    
-    $store.each do |repo, last|
+    @svns.each do |repo, last|
+      puts "POLL: #{repo}" if config[:debug]
       (Hpricot(`svn log #{repo} -rHEAD:#{last} --limit 10 --xml`)/:logentry).reverse[1..-1].each do |ci|
-        $store[repo] = rev = ci.attributes['revision'].to_i
-        say "Commit #{rev} to #{repo.split("/").last} by #{(ci/:author).text}: #{(ci/:msg).text}"
+        @svns[repo] = rev = ci.attributes['revision'].to_i
+        project = repo.split(/\.|\//).reject do |path| 
+          ['trunk', 'rubyforge', 'svn', 'org', 'com', 'net', 'http:', nil].include? path
+        end.last
+        say "Commit #{rev} to #{project || repo} by #{(ci/:author).text}: #{(ci/:msg).text}"
       end rescue nil
     end
-    File.open(STORE, 'w') {|f| f.puts YAML.dump($store)}
+    File.open(config[:svns], 'w') {|f| f.puts YAML.dump(@svns)}
     
-    $atom.each do |feed, last|
+    @atoms.each do |feed, last|
+      puts "POLL: #{feed}" if config[:debug]
       begin
         e = (Hpricot(open(feed))/:entry).first
-        $atom[feed] = link = e.at("link")['href']
-        say "#{(e/:title).text} by #{((e/:author)/:name).text} : #{link}" unless link == last
+        @atoms[feed] = link = e.at("link")['href']
+        say "Commit #{link} by #{((e/:author)/:name).text}: #{(e/:title).text}" unless link == last
       rescue
       end
     end
-    File.open(ATOM, 'w') {|f| f.puts YAML.dump($atom)}
+    File.open(config[:atoms], 'w') {|f| f.puts YAML.dump(@atoms)}
   end
   
   # Post a url to the del.icio.us account.
   def post url
+    puts "POST: #{url}" if config[:debug]
     query = {:url => url,
       :description => (((Hpricot(open(url))/:title).first.innerHTML or url) rescue url),
       :tags => (Hpricot(open("http://del.icio.us/url/check?url=#{CGI.escape(url)}"))/'.alphacloud'/:a).map{|s| s.innerHTML}.join(" "),
@@ -126,11 +178,12 @@ class Kirby
     begin
       http = Net::HTTP.new('api.del.icio.us', 443)         
       http.use_ssl = true      
-      http.start do |http|
+      response = http.start do |http|
         req = Net::HTTP::Get.new('/v1/posts/add?' + query.map{|k,v| "#{k}=#{CGI.escape(v)}"}.join('&'))
-        req.basic_auth DELICIOUS_USER, DELICIOUS_PASS
+        req.basic_auth config[:delicious_user], config[:delicious_pass]
         http.request(req)
       end.body
+      puts "POST: #{response.inspect}" if config[:debug]
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kirby
 version: !ruby/object:Gem::Version 
-  version: "4.1"
+  version: "4.2"
 platform: ruby
 authors: 
 - ""
@@ -30,7 +30,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2007-12-15 00:00:00 -05:00
+date: 2007-12-31 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fauna
-rubygems_version: 0.9.5
+rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
 summary: A super-clean IRC bot with sandboxed Ruby evaluation, svn watching, and link-logging to del.icio.us.

metadata.gz.sig

@@ -1,2 +1,2 @@
-�Ӝ`g~xs���08��#��
-�B����T&����Eeɋ���y?XW��`#�N��}7�e6��wQ��ޑ�^�3(��u�������b�L_S4K����q����9`�;��g����U�ߡ��J5#��0;q�BU6Gc��m��ic	��(9��<m�(�/ �`�R���b��>2fp��
jH��?\�M1-
+R�{p^"���p
�$|Rx�(���J��%Ȗ���ia�
+�