Sutto-marvin 0.1.20081120 → 0.2.0

data/README.textile

@@ -79,6 +79,14 @@ commands by default:
   
 As defined in handlers/hello_world.rb
 
+h2. Thanks
+
+Thanks goes out to the following people / projects:
+
+* Jeff Rafter - contributed code and doc changes, now one of the co-developers.
+* epitron / halogrium - For the ragel state machine used in Marvin::Parsers::RagelParser
+* The creator of Ruby-IRCD - the server component is heavily influenced by / part derivative of said work.
+
 h2. Marvin::Base - A handler starting point
 
 The first, Marvin::Base provides a base set of methods (e.g. say,

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-patch: 20081120
+patch: 0
 major: 0
-minor: 1
+minor: 2

data/bin/marvin

@@ -1,71 +1,104 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'fileutils'
+require "thor"
 
-LOCATION_ROOT = File.join(File.dirname(__FILE__), "..")
-DEST = ARGV[1] || "./marvin"
-
-def j(*args); File.join(*args); end
-
-def copy(f, t = nil)
-  t = f if t.nil?
-  File.open(j(DEST, t), "w+") do |file|
-    file.puts File.read(j(LOCATION_ROOT, f))
-  end
-end
-
-puts "Marvin - A Ruby IRC Library / Framework"
-if ARGV.include?("-h") || ARGV.include?("--help")
-  puts "Usage: marvin create <name> - Creates a marvin directory at name or ./marvin"
-  puts "       marvin (in a Marvin dir) - Starts it, equiv. to script/marvin"
-  exit
-end
-
-if ARGV.length >= 1 && !["start", "stop", "run", "restart"].include?(ARGV[0])
-  if ARGV[0].to_s.downcase != "create"
-    puts "'#{ARGV[0]}' isn't a valid command. - Please use #{__FILE__} --help"
-    exit(1)
+class Marvin < Thor
+  
+  GEM_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+  
+  attr_accessor :dest
+  
+  # Map default help tasks.
+  map ["-h", "-?", "--help", "-D"] => :help
+  
+  desc "create [PATH]", "creates a new marvin app at the given path"
+  method_options :verbose => :boolean
+  def create(path)
+    @dest    = File.expand_path(path)
+    @verbose = options[:verbose]
+    if File.directory?(@dest)
+      STDOUT.puts "The given directory, \"#{path}\", already exists."
+      exit! 1
+    else
+      say "Creating Marvin app"
+      say " => Making directories"
+      mkdir   @dest
+      mkdir   source(@dest, "script")
+      mkdir   source(@dest, "config")
+      mkdir   source(@dest, "handlers")
+      mkdir_p source(@dest, "tmp/pids")
+      mkdir   source(@dest, "log")
+      mkdir   source(@dest, "lib")
+      say " => Copying files..."
+      copy "config/setup.rb"
+      copy "config/connections.yml.sample", "config/connections.yml"
+      copy "config/settings.yml.sample",    "config/settings.yml"
+      copy "handlers/hello_world.rb"
+      copy "handlers/debug_handler.rb"
+      %w(client console distributed_client ring_server status).each do |c|
+        copy "script/#{c}"
+        FileUtils.chmod 0755, source(@dest, "script/#{c}")
+      end
+      say "Done!"
+    end
   end
-  if File.exist?(DEST) && File.directory?(DEST)
-    puts "The folder '#{DEST}' already exists."
-    exit(1)
+  
+  desc "start [PATH]", "starts client at the given path"
+  def start(path = ".")
+    @dest = File.expand_path(path)
+    if File.exist?(source(@dest, "script/client"))
+      Dir.chdir(@dest) { exec "script/client" }
+    else
+      STDOUT.puts "Woops! #{@dest.gsub(" ", "\\ ")} doesn't look to be a marvin directory."
+      exit!
+    end
   end
-  # Generate it.
-  FileUtils.mkdir(DEST)
-  ["log", "tmp", "config", "handlers", "script"].each do |folder|
-    FileUtils.mkdir(j(DEST, folder))
+  
+  desc "status [PATH]", "shows status of marvin app at a given location"
+  def status(path = ".")
+    @dest = File.expand_path(path)
+    if File.exist?(source(@dest, "script/status"))
+      Dir.chdir(@dest) { exec "script/status" }
+    else
+      STDOUT.puts "Woops! #{@dest.gsub(" ", "\\ ")} doesn't look to be a marvin directory."
+      exit!
+    end
   end
   
-  puts "Writing Settings file"
-  copy "config/settings.yml.sample", "config/settings.yml"
+  private
   
-  puts "Writing Connections file"
-  copy "config/connections.yml.sample", "config/connections.yml"
+  def source(*args)
+    File.expand_path(File.join(*args))
+  end
   
-  puts "Writing setup.rb"
-  copy "config/setup.rb"
+  def copy(from, to = from)
+    s, d = source(GEM_ROOT, from), source(@dest, to)
+    say " --> cp #{s.gsub(" ", "\\ ")} #{d.gsub(" ", "\\ ")}" if @verbose
+    FileUtils.cp_r(s, d)
+  end
   
-  puts "Copying start scripts"
-  copy "script/client"
-  copy "script/daemon-runner"
-  FileUtils.chmod 0755, j(DEST, "script/client")
-  FileUtils.chmod 0755, j(DEST, "script/daemon-runner")
+  def mkdir(path)
+    say " --> mkdir #{path.gsub(" ", "\\ ")}" if @verbose
+    FileUtils.mkdir path
+  end
   
-  puts "Copying example handlers"
-  copy "handlers/hello_world.rb"
-  copy "handlers/debug_handler.rb"
+  def mkdir_p(path)
+    say " --> mkdir #{path.gsub(" ", "\\ ")}" if @verbose
+    FileUtils.mkdir_p path
+  end
   
-  puts "Done!"
-elsif ARGV.length >= 1
-  if !File.exist?("script/daemon-runner")
-    puts "Woops! This isn't a marvin directory."
-    exit(1)
+  def say(text)
+    STDOUT.puts text
   end
-  exec "script/daemon-runner #{ARGV.map {|a| a.include?(" ") ? "\"#{a}\"" : a }.join(" ")}"
+  
+end
+
+# Check if we have arguments, we run the normal
+# thor task otherwise we just print the help
+# message.
+if ARGV.empty?
+  Marvin.new.help
 else
-  if !File.exist?("script/client")
-    puts "Woops! This isn't a marvin directory."
-    exit(1)
-  end
-  exec "script/client"
+  Marvin.start
 end

data/config/settings.yml.sample

@@ -2,7 +2,12 @@ default:
   name: Marvin
   use_logging: false
   datastore_location: tmp/datastore.json
+  nicks:
+    - MarvinBot1000
+    - MarvinBot2000
+    - MarvinBot3000
+    - MarvinusBoticus
 development:
   user: MarvinBot
   name: MarvinBot
-  nick:  Marvin
+  nick: MarvinBot

data/config/setup.rb

@@ -1,14 +1,29 @@
-# Register all of the handlers you wish to use
-# when the clien connects.
-Marvin::Loader.before_connecting do
+# Is loaded on setup / when handlers need to be
+# registered. Use it to register handlers / do
+# any repeatable setup that will happen before
+# any connections are created
+Marvin::Loader.before_run do
   
   # E.G.
   # MyHandler.register! (Marvin::Base subclass) or
   # Marvin::Settings.default_client.register_handler my_handler (a handler instance)
   
-  # Example Handler use.
+  # Register in ruby
+  #
   # LoggingHandler.register! if Marvin::Settings.use_logging
   
+  # Conditional registration - load the distributed dispatcher
+  # if an actual client, otherwise use the normal handlers.
+  #
+  # if Marvin::Loader.distributed_client?
+  #   HelloWorld.register!
+  #   DebugHandler.register!
+  # else
+  #   Marvin::Distributed::DispatchHandler.register!
+  # end
+  
+  # And any other code here that will be run before the client
+  
   HelloWorld.register!
   DebugHandler.register!
   

data/handlers/debug_handler.rb

@@ -1,5 +1,5 @@
-# Used for debugging stuff - trying
-# adding misc stuff to play around with it
+# Use this class to debug stuff as you 
+# go along - e.g. dump events etc.
 class DebugHandler < Marvin::Base
   
 end

data/handlers/hello_world.rb

@@ -3,7 +3,7 @@ class HelloWorld < Marvin::CommandHandler
   exposes :hello
   
   def hello(data)
-    reply "Hola!"
+    reply "Hola from process with pid #{Process.pid}!"
   end
   
 end

data/lib/marvin.rb

@@ -8,8 +8,17 @@ require 'marvin/core_ext'
 require 'marvin/exceptions'
 
 module Marvin
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 20081120
+    
+    STRING = [MAJOR, MINOR, PATCH].join(".")
+  end
+  
   autoload :Util,             'marvin/util'
   autoload :Dispatchable,     'marvin/dispatchable'
+  autoload :Distributed,      'marvin/distributed'
   autoload :AbstractClient,   'marvin/abstract_client'
   autoload :Base,             'marvin/base'
   autoload :ClientMixin,      'marvin/client_mixin'
@@ -23,6 +32,8 @@ module Marvin
   autoload :DataStore,        'marvin/data_store'
   autoload :ExceptionTracker, 'marvin/exception_tracker'
   autoload :Options,          'marvin/options'
+  autoload :Daemon,           'marvin/daemon'
+  autoload :Status,           'marvin/status'
   # Parsers
   autoload :AbstractParser,   'marvin/abstract_parser'
   autoload :Parsers,          'marvin/parsers.rb'
@@ -32,14 +43,8 @@ module Marvin
   
   Settings.setup # Load Settings etc.
   
-end
-
-def p(text)
-  res = Marvin::Parsers::SimpleParser.parse(text)
-  if res.blank?
-    puts "Unrecognized Result"
-  else
-    STDOUT.puts "Event: #{res.to_incoming_event_name}"
-    STDOUT.puts "Args:  #{res.to_hash.inspect}"
+  def self.version
+    VERSION::STRING
   end
+  
 end

data/lib/marvin/abstract_client.rb

@@ -8,6 +8,7 @@ module Marvin
     include Marvin::Dispatchable
     
     def initialize(opts = {})
+      self.original_opts    = opts.dup # Copy the options so we can use them to reconnect.
       self.server           = opts[:server]
       self.port             = opts[:port]
       self.default_channels = opts[:channels]
@@ -16,7 +17,7 @@ module Marvin
     end
     
     cattr_accessor :events, :configuration, :logger, :is_setup, :connections
-    attr_accessor  :channels, :nickname, :server, :port, :nicks, :pass
+    attr_accessor  :channels, :nickname, :server, :port, :nicks, :pass, :disconnect_expected, :original_opts
     
     # Set the default values for the variables
     self.events                 = []
@@ -43,7 +44,12 @@ module Marvin
       logger.info "Handling disconnect for #{self.server}:#{self.port}"
       self.connections.delete(self) if self.connections.include?(self)
       dispatch :client_disconnected
-      Marvin::Loader.stop! if self.connections.blank?
+      unless self.disconnect_expected
+        logger.warn "Lost connection to server - adding reconnect"
+        self.class.add_reconnect self.original_opts
+      else
+        Marvin::Loader.stop! if self.connections.blank?
+      end
     end
     
     # Sets the current class-wide settings of this IRC Client
@@ -185,6 +191,7 @@ module Marvin
     def join(channel)
       channel = Marvin::Util.channel_name(channel)
       # Record the fact we're entering the room.
+      # TODO: Refactor to only add the channel when we receive confirmation we've joined.
       self.channels << channel
       command :JOIN, channel
       logger.info "Joined channel #{channel}"
@@ -203,6 +210,7 @@ module Marvin
     end
     
     def quit(reason = nil)
+      self.disconnect_expected = true
       logger.info "Preparing to part from #{self.channels.size} channels"
       self.channels.to_a.each do |chan|
         logger.info "Parting from #{chan}"

data/lib/marvin/console.rb

@@ -0,0 +1,54 @@
+MARVIN_ROOT = File.join(File.dirname(__FILE__), "../..")
+Marvin::Settings.verbose   = true
+Marvin::Settings.log_level = :debug
+Marvin::Settings.default_client = Marvin::TestClient
+Marvin::Loader.run! :console
+
+def parse(line)
+  Marvin::Settings.default_parser.parse(line)
+end
+
+def logger
+  Marvin::Logger.logger
+end
+
+def client
+  $client ||= Marvin::Settings.default_client.new(:port => 6667, :server => "irc.freenode.net")
+end
+
+class ServerMock < Marvin::IRC::Server::BaseConnection
+  def send_line(line)
+    puts ">> #{line}"
+  end
+  def kill_connection!
+    puts "Killing connection"
+  end
+  
+  def get_peername
+    # Localhost, HTTP
+    "\034\036\000P\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\001\000\000\000\000"
+  end
+  
+  def host
+    "localhost"
+  end
+  
+  def port
+    6667
+  end
+  
+end
+
+def server(reset = false)
+  $server = ServerMock.new(:port => 6667, :host => "localhost") if $server.blank? || reset
+  return $server
+end
+
+def user(reset = false)
+  unless @user_created || reset
+    server.receive_line "NICK SuttoL"
+    server.receive_line "USER SuttoL 0 * :SuttoL"
+    @user_created = true
+  end
+  return server.connection_implementation
+end

data/lib/marvin/daemon.rb

@@ -0,0 +1,71 @@
+module Marvin
+  class Daemon
+    class << self
+      
+      def alive?(pid)
+        return Process.getpgid(pid) != -1
+      rescue Errno::ESRCH
+        return false
+      end
+      
+      def kill_all(type = :all)
+        if type == :all
+          files = Dir[Marvin::Settings.root / "tmp/pids/*.pid"]
+          files.each { |f| kill_all_from f }
+        elsif type.is_a?(Symbol)
+          kill_all_from(pid_file_for(type))
+        end
+        return nil
+      end
+      
+      def daemonize!
+        exit if fork
+        Process.setsid
+        exit if fork
+        self.write_pid
+        File.umask 0000
+        STDIN.reopen  "/dev/null"
+        STDOUT.reopen "/dev/null", "a"
+        STDERR.reopen STDOUT
+        Marvin::Settings.verbose = false
+      end
+      
+      def cleanup!
+        f = Marvin::Settings.root / "tmp/pids/marvin-#{Marvin::Loader.type.to_s.underscore}.pid"
+        FileUtils.rm_f(f) if (pids_from(f) - Process.pid).blank?
+      end
+      
+      def pids_for_type(type)
+        pids_from(pid_file_for(type))
+      end
+      
+      protected
+
+      def kill_all_from(file)
+        pids = pids_from(file)
+        pids.each { |p| Process.kill("TERM", p) unless p == Process.pid }
+        FileUtils.rm_f(file)
+      rescue => e
+        STDOUT.puts e.inspect
+      end
+
+      def pid_file_for(type)
+        Marvin::Settings.root / "tmp/pids/marvin-#{type.to_s.underscore}.pid"
+      end
+
+      def pids_from(file)
+        return [] unless File.exist?(file)
+        pids = File.read(file)
+        pids = pids.split("\n").map { |l| l.strip.to_i(10) }.select { |p| alive?(p) }
+      end
+
+      def write_pid
+        f = pid_file_for(Marvin::Loader.type)
+        pids = pids_from(f)
+        pids << Process.pid unless pids.include?(Process.pid)
+        File.open(f, "w+") { |f| f.puts pids.join("\n") }
+      end
+      
+    end
+  end
+end