meimei 0.1.1 → 0.1.2

data/CHANGES

@@ -1,5 +1,8 @@
 = meimei Changelog
 
+=== Version 0.1.2
+* Added autoping
+
 === Version 0.1.1
 * Fixed bug with plugins
 

data/README

@@ -3,6 +3,8 @@
 == DESCRIPTION
 Meimei is a simple IRC bot framework. It is designed to be easily extensible. In the interest of simplicity it only implements a subset RFC 1459, mainly those dealing with PRIVMSGs.
 
+See the documentation for Meimei::Client for help on creating new client instances.
+
 === Usage
 
   require 'meimei'
@@ -23,6 +25,6 @@ Meimei is a simple IRC bot framework. It is designed to be easily extensible. In
     say("localhost", "#meimei", "One hour has passed.")
   end
 
-=== Thread Safety
+=== Architecture
 
-Meimei does not use any global or class variables, so a single client instance should be thread safe. Obviously Meimei does make use of instance variables, so using threads from within a single client may cause issues.
+Meimei uses a single select loop to handle multiple TCP sockets. This eliminates the need to use threads and all the synchronicity issues that result. However, Meimei does not use any global or class variables, so it should be thread-safe.

data/lib/meimei/client.rb

@@ -7,12 +7,12 @@ module Meimei
   class Client
     # === Parameters
     # - nick: The nickname your bot will use.
-    # - options[:username]: The username of your bot (will default to nick).
-    # - options[:realname]: The real name of your bot (will default to nick).
+    # - options[:username]: The username of your bot (defaults to nick).
+    # - options[:realname]: The real name of your bot (defaults to nick).
     # - options[:password]: The password for your bot's account.
-    # - options[:plugin_dir]: An absolute path to the directory where Meimei plugins will be stored.
-    # - options[:log_dir]: An absolute path to where log files will be stored.
-    # - options[:log_level]: The log level. Can be: :error, :info, :debug.
+    # - options[:plugin_dir]: A path to the directory where Meimei plugins will be stored (defaults to plugins).
+    # - options[:log_dir]: A path to where log files will be stored (defaults to .).
+    # - options[:log_level]: The log level. Can be: :error, :info, :debug. Defaults to :info.
     def initialize(nick, options = {})
       @servers = []
       @running = false
@@ -27,6 +27,7 @@ module Meimei
       @log_level = options[:log_level] || :info
       @logger = Logger.new(open("#{@log_dir}/#{@nick}-#{Time.now.strftime('%Y%m%d-%H%M')}.log", "w"))
       @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+      @last_saw_traffic_at = Time.now
     end
     
     # Registers a server with the client. This method will not open a connection.
@@ -45,6 +46,18 @@ module Meimei
       end
     end
     
+    # Autopings any server that hasn't seen traffic in over 5 minutes
+    def autoping
+      @servers.each do |server|
+        if server.last_saw_traffic_at + 300 < Time.now
+          server.write("PING #{server.hostname}")
+          
+          # Artificially set the last_saw_traffic_at value to now so that we don't flood the server
+          server.last_saw_traffic_at = Time.now
+        end
+      end
+    end
+    
     # Creates a new plugin.
     #
     # === Parameters
@@ -151,6 +164,7 @@ module Meimei
             end
           end
 
+          self.autoping()
           self.check_timer_plugins()
           
           @current_server = self.select()

data/lib/meimei/gemspec.rb

@@ -34,11 +34,11 @@ module Meimei
     spec.platform           = Gem::Platform::RUBY
 
     spec.local_rdoc_dir     = "doc/rdoc"
-    spec.remote_rdoc_dir    = "#{spec.name}/rdoc"
+    spec.remote_rdoc_dir    = "rdoc"
     spec.local_coverage_dir = "doc/coverage"
-    spec.remote_coverage_dir= "#{spec.name}/coverage"
+    spec.remote_coverage_dir= "coverage"
 
-    spec.remote_site_dir    = "#{spec.name}/"
+    spec.remote_site_dir    = "/"
   end
 end
 

data/lib/meimei/server.rb

@@ -1,12 +1,13 @@
 module Meimei
   class Server
-    attr_accessor :socket, :hostname, :port, :is_connected, :logger, :autojoin
+    attr_accessor :socket, :hostname, :port, :is_connected, :logger, :autojoin, :last_saw_traffic_at
     
     def initialize(hostname, port, autojoin, options = {})
       @hostname, @port, @is_connected = hostname, port, false
       @log_dir = options[:log_dir] || "."
       @logger = Logger.new(open("#{@log_dir}/#{@hostname}-#{Time.now.strftime('%Y%m%d-%H%M')}.log", "w"))
       @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+      @last_saw_traffic_at = Time.now
       
       case options[:log_level]
       when :fatal
@@ -73,6 +74,7 @@ module Meimei
     def read
       begin      
         msg = @socket.gets
+        @last_saw_traffic_at = Time.now
         @logger.debug "> #{msg}"
         return msg
       rescue Errno::ECONNRESET => x

data/lib/meimei/specification.rb

@@ -48,7 +48,7 @@ module Meimei
 
 
         def initialize
-            @remote_user = nil
+            @remote_user = "r888888888"
             @remote_host = "rubyforge.org"
 
             @rdoc_main              = "README"

data/lib/meimei/version.rb

@@ -2,7 +2,7 @@ module Meimei
     class Version
         MAJOR   = 0
         MINOR   = 1
-        BUILD   = 1
+        BUILD   = 2
 
         class << self
             def to_a

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: meimei
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2008-02-06 00:00:00 -05:00
+  version: 0.1.2
+date: 2008-03-04 00:00:00 -05:00
 summary: A simple IRC bot framework.
 require_paths: 
 - lib