jeffrafter-marvin 0.1.20081115 → 0.1.20081120

data/lib/marvin/abstract_parser.rb

@@ -7,12 +7,24 @@ module Marvin
       return self.new(line.strip).to_event
     end
     
+    attr_accessor :line, :command, :event
+    
+    # Instantiates a parser instance, attempts to 
+    # parse it for it's command and it's event.
     def initialize(line)
-      raise NotImplementedError, "Not implemented in an abstract parser"
+      self.line = line
+      self.command = self.class.parse!(line)
+      self.event = self.command.to_event unless self.command.blank?
     end
     
     def to_event
-      raise NotImplementedError, "Not implemented in an abstract parser"
+      self.event
+    end
+    
+    private
+    
+    def self.parse!(line)
+      raise NotImplementedError, "Must be implemented in a subclass"
     end
     
   end

data/lib/marvin/base.rb

@@ -33,10 +33,42 @@ module Marvin
         end
       end
       
-      def on_event(name, &blk)
+      # Registers a block or method to be called when
+      # a given event is occured.
+      # == Examples
+      #
+      #   on_event :incoming_message, :process_commands
+      # 
+      # Will call process_commands the current object
+      # every time incoming message is called.
+      #
+      #   on_event :incoming_message do
+      #     Marvin::Logger.debug ">> #{options.inspect}"
+      #   end
+      #
+      # Will invoke the block every time an incoming message
+      # is processed.
+      def on_event(name, method_name = nil, &blk)
+        # If the name is set and it responds to :to_sym
+        # and no block was passed in.
+        blk = proc { self.send(method_name.to_sym) } if method_name.respond_to?(:to_sym) && blk.blank?
         self.event_handlers_for(name, false) << blk
       end
       
+      def on_numeric(value, method_name = nil, &blk)
+        if value.is_a?(Numeric)
+          new_value = "%03d" % value
+        else
+          new_value = Marvin::IRC::Replies[value]
+        end
+        if new_value.nil?
+          logger.error "The numeric '#{value}' was undefined"
+        else
+          blk = proc { self.send(method_name.to_sym) } if method_name.respond_to?(:to_sym) && blk.blank?
+          self.event_handlers_for(:"incoming_numeric_#{new_value}", false) << blk
+        end
+      end
+      
       # Register's in the IRC Client callback chain.
       def register!(parent = Marvin::Settings.default_client)
         return if self == Marvin::Base # Only do it for sub-classes.
@@ -57,15 +89,21 @@ module Marvin
       begin
         self.setup_defaults(options)
         h = self.class.event_handlers_for(message)
-        h.each do |handle|
-          self.instance_eval &handle
-        end
+        h.each { |handle| self.instance_eval(&handle) }
       rescue Exception => e
         logger.fatal "Exception processing handle #{message}"
         Marvin::ExceptionTracker.log(e)
       end
     end
     
+    def handle_incoming_numeric(opts)
+      self.handle(:incoming_numeric, opts)
+      name = :"incoming_numeric_#{options.code}"
+      events = self.class.event_handlers_for(name)
+      logger.debug "Dispatching #{events.size} events for #{name}"
+      events.each { |eh| self.instance_eval(&eh) }
+    end
+    
     def say(message, target = self.target)
       client.msg target, message
     end
@@ -97,11 +135,11 @@ module Marvin
     
     # Determines whether the previous message was inside a channel.
     def from_channel?
-      self.target && self.target[0] == ?#
+      self.target && [?#, ?&].include?(self.target[0])
     end
     
     def addressed?
-      self.from_user? || options.message.split(" ").first.downcase == "#{self.client.nickname.downcase}:"
+      self.from_user? || options.message =~ /^#{self.client.nickname.downcase}:\s+/i
     end
     
     def setup_defaults(options)

data/lib/marvin/dispatchable.rb

@@ -26,9 +26,11 @@ module Marvin
     module InstanceMethods
       
       # Returns the handlers registered on this class,
-      # used inside +dispatch+.
+      # used inside +dispatch+. Note that it will call
+      # dup on each of the objects to get a new instance.
+      # please ensure your object acts accordingly.
       def handlers
-        self.class.handlers
+        @handlers ||= self.class.handlers.map { |h| h.dup }
       end
       
       # Dispatch an 'event' with a given name to the handlers
@@ -53,7 +55,7 @@ module Marvin
         # call.
         self.handlers.each do |handler|
           if handler.respond_to?(full_handler_name)
-            handler.sent(full_handler_name, opts)
+            handler.send(full_handler_name, opts)
           else
             handler.handle name, opts
           end
@@ -62,7 +64,10 @@ module Marvin
       # catch it and continue on our way. In essence, we
       # stop the dispatch of events to the next set of the
       # handlers.
-      rescue HaltHandlerProcessing
+      rescue HaltHandlerProcessing => e
+        Marvin::Logger.info "Halting processing chain"
+      rescue Exception => e
+        Marvin::ExceptionTracker.log(e)
       end
       
     end

data/lib/marvin/exception_tracker.rb

@@ -2,7 +2,7 @@ module Marvin
   class ExceptionTracker
   
     cattr_accessor :logger
-    self.logger = Marvin::Logger.logger
+    self.logger = Marvin::Logger
   
     def self.log(e)
       logger.fatal "Exception raised inside Marvin Instance."

data/lib/marvin/exceptions.rb

@@ -5,4 +5,7 @@ module Marvin
   # Used to stop the flow of handler chains.
   class HaltHandlerProcessing < Error; end
   
+  # Used for when an expression can't be parsed
+  class UnparseableMessage < Error; end
+  
 end

data/lib/marvin/irc.rb

@@ -1,9 +1,8 @@
 module Marvin
   module IRC
-    autoload :Client,         'marvin/irc/client'
-    autoload :Event,          'marvin/irc/event'
-    autoload :SocketClient,   'marvin/irc/socket_client'
-    autoload :AbstractServer, 'marvin/irc/abstract_server'
-    autoload :BaseServer,     'marvin/irc/base_server'
+    autoload :Client,  'marvin/irc/client'
+    autoload :Event,   'marvin/irc/event'
+    autoload :Server,  'marvin/irc/server'
+    autoload :Replies, 'marvin/irc/replies'
   end
 end

data/lib/marvin/irc/client.rb

@@ -45,32 +45,38 @@ module Marvin::IRC
   # the class method, register_handler with the
   # handler as the only argument.
   class Client < Marvin::AbstractClient
+    cattr_accessor :stopped
     attr_accessor :em_connection
     
     class EMConnection < EventMachine::Protocols::LineAndTextProtocol
-      attr_accessor :client
+      attr_accessor :client, :server, :port
       
-      def initialize
-        super
-        self.client = Marvin::IRC::Client.new
+      def initialize(*args)
+        opts = args.extract_options!
+        super(*args)
+        self.client = Marvin::IRC::Client.new(opts)
         self.client.em_connection = self
       end
       
       def post_init
         client.process_connect
+        super
       end
 
       def unbind
         client.process_disconnect
+        super
       end
       
       def receive_line(line)
+        Marvin::Logger.debug "<< #{line.strip}"
         self.client.receive_line(line)
       end
       
     end
 
     def send_line(*args)
+      args.each { |line| Marvin::Logger.debug ">> #{line.strip}" }
       em_connection.send_data *args
     end
     
@@ -80,18 +86,44 @@ module Marvin::IRC
     # networking portion of the IRC Client.
     def self.run
       self.setup # So we have options etc
-      EventMachine::run do
-        logger.debug "Connecting to #{self.configuration.server}:#{self.configuration.port}"
-        EventMachine::connect self.configuration.server, self.configuration.port, Marvin::IRC::Client::EMConnection
+      settings = YAML.load_file(Marvin::Settings.root / "config/connections.yml")
+      if settings.is_a?(Hash)
+        EventMachine.epoll
+        EventMachine::run do
+          settings.each do |name, options|
+            settings = options.symbolize_keys!
+            settings[:server] ||= name
+            settings.reverse_merge!(:port => 6667, :channels => [])
+            connect settings
+          end
+        end
+      else
+        logger.fatal "config/connections.yml couldn't be loaded. Exiting"
       end
     end
     
+    def self.connect(opts = {})
+      logger.info "Connecting to #{opts[:server]}:#{opts[:port]} - Channels: #{opts[:channels].join(", ")}"
+      EventMachine::connect(opts[:server], opts[:port], EMConnection, opts)
+      logger.info "Connection created for #{opts[:server]}:#{opts[:port]}"
+    end
+    
     def self.stop
+      return if self.stopped
       logger.debug "Telling all connections to quit"
       self.connections.dup.each { |connection| connection.quit }
       logger.debug "Telling Event Machine to Stop"
       EventMachine::stop_event_loop
       logger.debug "Stopped."
+      self.stopped = true
+    end
+    
+    def self.add_reconnect(opts = {})
+      Marvin::Logger.warn "Adding entry to reconnect to #{opts[:server]}:#{opts[:port]} in 15 seconds"
+      EventMachine::add_timer(15) do
+        Marvin::Logger.warn "Attempting to reconnect to #{opts[:server]}:#{opts[:port]}"
+        Marvin::IRC::Client.connect(opts)
+      end
     end
     
     # Registers a callback handle that will be periodically run.

data/lib/marvin/irc/event.rb

@@ -1,6 +1,6 @@
 module Marvin::IRC
   class Event
-    attr_accessor :keys, :name, :raw_arguments
+    attr_accessor :keys, :name, :raw_arguments, :prefix
     
     def initialize(name, *args)
       self.name = name.to_sym
@@ -8,23 +8,28 @@ module Marvin::IRC
     end
     
     def to_hash
-      return {} unless self.raw_arguments
+      return @hash_value unless @hash_value.blank?
       results = {}
       values = self.raw_arguments.to_a
       last_index = self.keys.size - 1
       self.keys.each_with_index do |key, i|
         results[key] = (i == last_index ? values.join(" ").strip : values.shift)
       end
-      return results
+      results.merge!(prefix.to_hash) unless prefix.blank?
+      return (@hash_value = results)
     end
     
     def inspect
-      "#<Marvin::IRC::Event name=#{self.name} attributes=[#{keys * ","}] >"
+      "#<Marvin::IRC::Event name=#{self.name} attributes=#{self.to_hash.inspect} >"
     end
     
     def to_incoming_event_name
       :"incoming_#{self.name}"
     end
     
+    def to_outgoing_event_name
+      :"outgoing_#{self.name}"
+    end
+    
   end
 end

data/lib/marvin/irc/replies.rb

@@ -0,0 +1,154 @@
+module Marvin
+  module IRC
+    module Replies
+      
+      def self.[](key)
+        key = key.to_s.upcase
+        if const_defined?(key)
+          value = const_get(key)
+          return "%03d" % value
+        else
+          return nil
+        end
+      end
+      
+      # Common response codes.
+      RPL_WELCOME           = 001
+      RPL_YOURHOST          = 002
+      RPL_CREATED           = 003
+      RPL_MYINFO            = 004
+      RPL_BOUNCE            = 005
+      RPL_TRACELINK         = 200
+      RPL_TRACECONNECTING   = 201
+      RPL_TRACEHANDSHAKE    = 202
+      RPL_TRACEUNKNOWN      = 203
+      RPL_TRACEOPERATOR     = 204
+      RPL_TRACEUSER         = 205
+      RPL_TRACESERVER       = 206
+      RPL_TRACESERVICE      = 207
+      RPL_TRACENEWTYPE      = 208
+      RPL_TRACECLASS        = 209
+      RPL_TRACERECONNECT    = 210
+      RPL_TRACELOG          = 261
+      RPL_TRACEEND          = 262
+      RPL_STATSLINKINFO     = 211
+      RPL_STATSCOMMANDS     = 212
+      RPL_ENDOFSTATS        = 219
+      RPL_STATSUPTIME       = 242
+      RPL_STATSOLINE        = 243
+      RPL_UMODEIS           = 221
+      RPL_SERVLIST          = 234
+      RPL_SERVLISTEND       = 235
+      RPL_LUSERCLIENT       = 251
+      RPL_LUSEROP           = 252
+      RPL_LUSERUNKNOWN      = 253
+      RPL_LUSERCHANNELS     = 254
+      RPL_LUSERME           = 255
+      RPL_ADMINME           = 256
+      RPL_ADMINEMAIL        = 259
+      RPL_TRYAGAIN          = 263
+      RPL_USERHOST          = 302
+      RPL_ISON              = 303
+      RPL_AWAY              = 301
+      RPL_UNAWAY            = 305
+      RPL_NOWAWAY           = 306
+      RPL_WHOISUSER         = 311
+      RPL_WHOISSERVER       = 312
+      RPL_WHOISOPERATOR     = 313
+      RPL_WHOISIDLE         = 317
+      RPL_ENDOFWHOIS        = 318
+      RPL_WHOISCHANNELS     = 319
+      RPL_WHOWASUSER        = 314
+      RPL_ENDOFWHOWAS       = 369
+      RPL_LISTSTART         = 321
+      RPL_LIST              = 322
+      RPL_LISTEND           = 323
+      RPL_UNIQOPIS          = 325
+      RPL_CHANNELMODEIS     = 324
+      RPL_NOTOPIC           = 331
+      RPL_TOPIC             = 332
+      RPL_INVITING          = 341
+      RPL_SUMMONING         = 342
+      RPL_INVITELIST        = 346
+      RPL_ENDOFINVITELIST   = 347
+      RPL_EXCEPTLIST        = 348
+      RPL_ENDOFEXCEPTLIST   = 349
+      RPL_VERSION           = 351
+      RPL_WHOREPLY          = 352
+      RPL_ENDOFWHO          = 315
+      RPL_NAMREPLY          = 353
+      RPL_ENDOFNAMES        = 366
+      RPL_LINKS             = 364
+      RPL_ENDOFLINKS        = 365
+      RPL_BANLIST           = 367
+      RPL_ENDOFBANLIST      = 368
+      RPL_INFO              = 371
+      RPL_ENDOFINFO         = 374
+      RPL_MOTDSTART         = 375
+      RPL_MOTD              = 372
+      RPL_ENDOFMOTD         = 376
+      RPL_YOUREOPER         = 381
+      RPL_REHASHING         = 382
+      RPL_YOURESERVICE      = 383
+      RPL_TIME              = 391
+      RPL_USERSSTART        = 392
+      RPL_USERS             = 393
+      RPL_ENDOFUSERS        = 394
+      RPL_NOUSERS           = 395
+      ERR_NOSUCHNICK        = 401
+      ERR_NOSUCHSERVER      = 402
+      ERR_NOSUCHCHANNEL     = 403
+      ERR_CANNOTSENDTOCHAN  = 404
+      ERR_TOOMANYCHANNELS   = 405
+      ERR_WASNOSUCHNICK     = 406
+      ERR_TOOMANYTARGETS    = 407
+      ERR_NOSUCHSERVICE     = 408
+      ERR_NOORIGIN          = 409
+      ERR_NORECIPIENT       = 411
+      ERR_NOTEXTTOSEND      = 412
+      ERR_NOTOPLEVEL        = 413
+      ERR_WILDTOPLEVEL      = 414
+      ERR_BADMASK           = 415
+      ERR_UNKNOWNCOMMAND    = 421
+      ERR_NOMOTD            = 422
+      ERR_NOADMININFO       = 423
+      ERR_FILEERROR         = 424
+      ERR_NONICKNAMEGIVEN   = 431
+      ERR_ERRONEUSNICKNAME  = 432
+      ERR_NICKNAMEINUSE     = 433
+      ERR_NICKCOLLISION     = 436
+      ERR_UNAVAILRESOURCE   = 437
+      ERR_USERNOTINCHANNEL  = 441
+      ERR_NOTONCHANNEL      = 442
+      ERR_USERONCHANNEL     = 443
+      ERR_NOLOGIN           = 444
+      ERR_SUMMONDISABLED    = 445
+      ERR_USERSDISABLED     = 446
+      ERR_NOTREGISTERED     = 451
+      ERR_NEEDMOREPARAMS    = 461
+      ERR_ALREADYREGISTRED  = 462
+      ERR_NOPERMFORHOST     = 463
+      ERR_PASSWDMISMATCH    = 464
+      ERR_YOUREBANNEDCREEP  = 465
+      ERR_YOUWILLBEBANNED   = 466
+      ERR_KEYSET            = 467
+      ERR_CHANNELISFULL     = 471
+      ERR_UNKNOWNMODE       = 472
+      ERR_INVITEONLYCHAN    = 473
+      ERR_BANNEDFROMCHAN    = 474
+      ERR_BADCHANNELKEY     = 475
+      ERR_BADCHANMASK       = 476
+      ERR_NOCHANMODES       = 477
+      ERR_BANLISTFULL       = 478
+      ERR_NOPRIVILEGES      = 481
+      ERR_CHANOPRIVSNEEDED  = 482
+      ERR_CANTKILLSERVER    = 483
+      ERR_RESTRICTED        = 484
+      ERR_UNIQOPPRIVSNEEDED = 485
+      ERR_NOOPERHOST        = 491
+      ERR_UMODEUNKNOWNFLAG  = 501
+      ERR_USERSDONTMATCH    = 502
+    end
+    
+  end
+end