marvin 0.8.1 → 0.8.2

data/handlers/raw_connection_logger.rb

@@ -0,0 +1,53 @@
+class RawConnectionLogger < Marvin::Base
+
+  on_event :client_connected, :setup_logging
+  on_event :reloaded, :setup_logging
+
+  on_event :client_disconnected, :teardown_logging
+  on_event :reloaded, :teardown_logging
+
+  @@files = {}
+
+  def setup_logging
+    logger.info "Setting up logging"
+    @@files[client.host_with_port] = nil
+    self.file # Access the ivar to load it
+  end
+
+  def teardown_logging
+    logger.info "Stopping logging"
+    if @@files[client.host_with_port].present?
+      @@files[client.host_with_port].puts ""
+      @@files[client.host_with_port].close
+      @@files.delete client.host_with_port
+    end
+  end
+
+  on_event :incoming_line do
+    log_line true
+  end
+
+  on_event :outgoing_line do
+    log_line false
+  end
+
+  def log_line(incoming = true)
+    color = incoming ? :green : :blue
+    prefix = incoming ? "<< " : ">> "
+    file.puts Marvin::ANSIFormatter.format(color, "#{prefix}#{options.line}".strip)
+  end
+
+  def file
+    @@files[client.host_with_port] ||= begin
+      logger.info "Loading Logger..."
+      uri = URI.parse("irc://#{client.host_with_port}")
+      log_path = File.join(Marvin::Settings.root, "log", "connections", "#{uri.host}-#{uri.port}-#{Time.now.to_i}.log")
+      logger.info "Logging to #{log_path}"
+      FileUtils.mkdir_p(File.dirname(log_path))
+      file = File.open(log_path, "a+")
+      file.sync = true if file.respond_to?(:sync=)
+      file
+    end
+  end
+
+end

data/lib/marvin.rb

@@ -5,7 +5,7 @@ require 'perennial'
 module Marvin
   include Perennial
   
-  VERSION = [0, 8, 1, 0]
+  VERSION = [0, 8, 2, 0]
   
   # Client
   autoload :TestClient,       'marvin/test_client'
@@ -39,8 +39,12 @@ module Marvin
     
   end
   
-  def self.version(include_minor = false)
-    VERSION[0, (include_minor ? 4 : 3)].join(".")
+  # Returns a string of the current version,
+  # optionally including a build number.
+  # @param [Boolean] include_build include a build version in the string
+  def self.version(include_build = nil)
+    include_build = VERSION[3].to_i > 0 if include_build.nil?
+    VERSION[0, (include_build ? 4 : 3)].join(".")
   end
   
   has_library :util, :abstract_client, :abstract_parser, :irc, :exception_tracker

data/lib/marvin/abstract_client.rb

@@ -1,6 +1,14 @@
 require "marvin/irc/event"
 
 module Marvin
+  # An abstract class implementing (and mixing in) a lot of
+  # the default functionality involved on handling an irc
+  # connection.
+  #
+  # To provide an implementation, you must subclass and implement
+  # #send_line, .add_reconnect, and any other loader etc methods.
+  #
+  # @see Marvin::IRC::Client
   class AbstractClient
     
     is :dispatchable, :loggable
@@ -29,6 +37,9 @@ module Marvin
     # current connection, dispatching a :client_connected event
     # once it has finished. During this process, it will
     # call #client= on each handler if they respond to it.
+    #
+    # @see Marvin::AbstractClient.setup
+    # @see Marvin::Base#client=
     def process_connect
       self.class.setup
       logger.info "Initializing the current instance"
@@ -38,48 +49,71 @@ module Marvin
       dispatch :client_connected
     end
     
+    # Handles a lost connection / disconnect, stopping the loader if it's the
+    # last connection (purposely terminated) otherwise scheduling a reconnection
+    #
+    # @see Marvin::Loader.stop!
     def process_disconnect
       logger.info "Handling disconnect for #{host_with_port}"
       connections.delete(self)
       dispatch :client_disconnected
-      unless @disconnect_expected
+      if @disconnect_expected
+        Marvin::Loader.stop! if connections.blank?
+      else
         logger.warn "Unexpectly lost connection to server; adding reconnect"
         self.class.add_reconnect @connection_config
-      else
-        Marvin::Loader.stop! if connections.blank?
       end
     end
     
+    # Iterates over handles and calls client= when defined. Used before dispatching
+    # in order to ensure each hander has the correct client. Note that this needs
+    # to be improved soon.
     def setup_handlers
       handlers.each { |h| h.client = self if h.respond_to?(:client=) }
     end
     
+    # If @@development is true, We'll attempt to reload any changed files (namely,
+    # handlers).s
     def process_development
       Marvin::Reloading.reload! if @@development
     end
     
+    # Before dispatching, check if we need to reload and setup handlers correctly.
     def pre_dispatching
       process_development
       setup_handlers
     end
     
-    # Sets the current class-wide settings of this IRC Client
-    # to either an OpenStruct or the results of #to_hash on
-    # any other value that is passed in.
+    # Sets the current class-wide settings of this IRC Client to
+    # an instance of Marvin::Nash with the properties of a hash
+    # / nash passed in.
+    #
+    # The new configuration will be normalized before use (namely,
+    # it will convert nested items to nashes)
+    #
+    # @param [Marvin::Nash, Hash] config the new configuration
     def self.configuration=(config)
       config = Marvin::Nash.new(config.to_hash) unless config.is_a?(Marvin::Nash)
       @@configuration = config.normalized
     end
     
+    # Check if if the cient class has been setup yet
+    # @return [Boolean] is the client class setup
     def self.setup?
       @setup ||= false
     end
     
+    # Conditional configure
     def self.setup
       return if setup?
       configure
     end
     
+    # Configure the class - namely, merge the app-wide configuration
+    # and if given a block, merge the results in.
+    #
+    # @yieldparam [Marvin::Nash] an empty nash
+    # @yieldreturn [Marvin::Nash] any changed settings.
     def self.configure
       config = Marvin::Nash.new
       config.merge! Marvin::Settings.configuration
@@ -88,32 +122,45 @@ module Marvin
         config.merge! nash
       end
       @@configuration = config
-      # Help is only currently available on an instance running
-      # distributed handler.
+      # Help is only currently available on an instance NOT running the distributed handler.
       Marvin::CoreCommands.register! unless Marvin::Distributed::Handler.registered?
       @setup = true
     end
     
     ## Handling all of the the actual client stuff.
     
+    # Receives a raw line (without EOL characters) and dispatch the
+    # incoming_line event. Once that's done, parse the line and
+    # dispatch an event if present.
+    #
+    # @param [String] line the incoming line
     def receive_line(line)
       dispatch :incoming_line, :line => line
       event = Marvin::Settings.parser.parse(line)
       dispatch(event.to_incoming_event_name, event.to_hash) unless event.nil?  
     end
     
+    # Returns a list of default channels to join on connect
+    # @return [Array<String>] an array of channel names that are joined on connect
     def default_channels
       @default_channels ||= []
     end
     
+    # Sets the list of default channels to join
+    # @param [Array<String>] channels the array of channel names
     def default_channels=(channels)
       @default_channels = channels.to_a.map { |c| c.to_s }
     end
     
+    # Returns the irc server and port
+    # @return [String] server port in "server:port" format
     def host_with_port
       @host_with_port ||= "#{server}:#{port}"
     end
     
+    # Returns a list available nicks / nicks to try
+    # on connect.
+    # @return [Array<String>] The array of nicks
     def nicks
       if @nicks.blank? && !@nicks_loaded
         logger.info "Setting default nick list"

data/lib/marvin/abstract_parser.rb

@@ -1,4 +1,5 @@
 module Marvin
+  # Abstract Class for implementing abstract parsers.
   class AbstractParser
     
     attr_accessor :line, :command, :event
@@ -15,6 +16,8 @@ module Marvin
       @event
     end
     
+    # Parses a line and return the associated event.
+    # @return [Marvin::IRC:Event] the parsed event
     def self.parse(line)
       new(line.strip).to_event
     end

data/lib/marvin/client/default_handlers.rb

@@ -42,8 +42,6 @@ module Marvin
           handle_welcome
         when Marvin::IRC::Replies[:ERR_NICKNAMEINUSE]
           handle_nick_taken
-        when Marvin::IRC::Replies[:RPL_TOPIC]
-          handle_channel_topic
       end
       code = opts[:code].to_i
       args = Marvin::Util.arguments(opts[:data])
@@ -73,7 +71,7 @@ module Marvin
         logger.info "Attemping to set nickname to '#{next_nick}'"
         nick next_nick
       else
-        logger.fatal "No Nicknames available - QUITTING"
+        logger.error "No Nicknames available - QUITTING"
         quit
       end
     end
@@ -89,7 +87,7 @@ module Marvin
     # Make sure we show user server errors
     def handle_incoming_error(opts = {})
       if opts[:message].present?
-        logger.info "Got ERROR Message: #{opts[:message]}"
+        logger.error "Server ERROR Message: #{opts[:message]}"
       end
     end
     

data/lib/marvin/command_handler.rb

@@ -64,7 +64,7 @@ module Marvin
         name, command, data = message.split(/\s+/, 2)
         return if name !~ /^#{client.nickname}:/i
       else
-        command, data = message.splt(/\s+/, 2)
+        command, data = message.split(/\s+/, 2)
       end
       data ||= ""
       if (command_name = extract_command_name(command)).present?

data/lib/marvin/distributed/server.rb

@@ -19,7 +19,7 @@ module Marvin
       attr_accessor :processing, :configuration
       
       def initialize(*args)
-        @configuration = args.last.is_a?(Marvin::Nash) ? args.pop : Marvin::nash.new
+        @configuration = args.last.is_a?(Marvin::Nash) ? args.pop : Marvin::Nash.new
         super(*args)
       end
       

data/lib/marvin/irc/client.rb

@@ -85,7 +85,10 @@ module Marvin::IRC
     ## Client specific details
     
     def send_line(*args)
-      @em_connection.send_line(*args)
+      args.each do |line|
+        @em_connection.send_line(line)
+        dispatch :outgoing_line, :line => line
+      end
     end
     
     class << self
@@ -163,7 +166,9 @@ module Marvin::IRC
     
     # Registers a callback handle that will be periodically run.
     def periodically(timing, event_callback)
-      EventMachine.add_periodic_timer(timing) { dispatch(event_callback.to_sym) }
+      EventMachine.add_periodic_timer(timing) do
+        dispatch(event_callback.to_sym)
+      end
     end
     
   end

data/lib/marvin/irc/event.rb

@@ -24,7 +24,7 @@ module Marvin::IRC
     end
     
     def to_event_name(prefix = nil)
-      [prefix, @name].join("_").to_sym
+      [prefix, @name].compact.join("_").to_sym
     end
     
     def to_incoming_event_name

data/lib/marvin/middle_man.rb

@@ -1,29 +1,27 @@
 module Marvin
-  # The middle man is a class you can use to register
-  # other handlers on. e.g. it acts as a way to 'filter'
-  # incoming and outgoing messages. Akin to Rack / WSGI
-  # middleware.
   class MiddleMan
+    is :loggable, :dispatchable
     
-    # Set the logger cattr to the default marvin logger.
-    cattr_accessor :logger
-    self.logger ||= Marvin::Logger
-    
-    # By default, we are *not* setup.
-    @@setup = false
-    
-    # Our list of subhandlers. We make sure
-    # the list is unique to our subclass / class.
-    class_inheritable_accessor :subhandlers
-    self.subhandlers = []
-    
-    # Finally, the client.
     attr_reader :client
   
-    # When we're told to set the client,
-    # not only do we set out own instance
-    # but we also echo the command down
-    # to all of our sub-clients.
+    class << self
+      def setup?
+        @@setup ||= false
+      end
+
+      def setup!
+        Marvin::Settings.client.register_handler self.new
+        @@setup = true
+      end
+
+      # Setup iff setup hasn't been done.
+      def setup
+        setup! unless setup?
+      end
+    end
+
+    # When we're told to set the client, not only do we set out own instance
+    # but we also echo the command down to all of our sub-clients.
     def client=(new_client)
       @client = new_client
       setup_subhandler_clients
@@ -35,68 +33,15 @@ module Marvin
     
     # Filter incoming events.
     def handle(message, options)
-      # Process the current event.
       message, options = process_event(message, options)
-      full_handler_name = "handle_#{message}"
-      self.send(full_handler_name, opts) if respond_to?(full_handler_name)
-      self.subhandlers.each do |sh|
-        forward_message_to_handler(sh, message, options, full_handler_name)
-      end
-    rescue HaltHandlerProcessing
-      logger.info "Asked to halt the filter processing chain inside a middleman."
-    rescue Exception => e
-      logger.fatal "Exception processing handle #{message}"
-      Marvin::ExceptionTracker.log(e)
-    end
-    
-    class << self
-      
-      def setup?
-        @@setup
-      end
-      
-      # Forcefully do the setup routine.
-      def setup!
-        # Register ourselves as a new handler.
-        Marvin::Settings.client.register_handler self.new
-        @@setup = true
-      end
-      
-      # Setup iff setup hasn't been done.
-      def setup
-        return if self.setup?
-        self.setup!
-      end
-      
-      # Register a single subhandler.
-      def register_handler(handler, run_setup = true)
-        self.setup if run_setup
-        self.subhandlers << handler unless handler.blank?
-      end
-      
-      # Registers a group of subhandlers.
-      def register_handlers(*args)
-        self.setup
-        args.each { |h| self.register_handler(h, false) }
-      end
-      
+      dispatch(message, options)
     end
     
     private
     
     def setup_subhandler_clients
-      self.subhandlers.each { |sh| sh.client = self.client if sh.respond_to?(:client=) }
-    end
-    
-    # This should probably be extracted into some sort of Util's library as
-    # it's shared across a couple of classes but I really can't be bothered
-    # at the moment - I just want to test the concept.
-    def forward_message_to_handler(handler, message, options, full_handler_name)
-      if handler.respond_to?(full_handler_name)
-        handler.send(full_handler_name, options)
-      elsif handler.respond_to?(:handle)
-        handler.handle message, options
-      end
+      current_client = self.client
+      handlers.each { |sh| sh.client = current_client if sh.respond_to?(:client=) }
     end
     
   end

data/test/abstract_client_test.rb

@@ -23,7 +23,7 @@ class AbstractClientTest < Test::Unit::TestCase
       assert_dispatched :client_connected, 0, {}
     end
 
-    should "dispatch :client_connected as the first event on process_connect" do
+    should "dispatch the correct events" do
       assert_resets_client
       client.default_channels = ["#awesome", "#rock"]
       client.process_connect

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marvin
 version: !ruby/object:Gem::Version 
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-05 00:00:00 +08:00
+date: 2009-12-08 00:00:00 +08:00
 default_executable: marvin
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: shoulda
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -81,6 +81,7 @@ files:
 - handlers/debug_handler.rb
 - handlers/hello_world.rb
 - handlers/keiki_thwopper.rb
+- handlers/raw_connection_logger.rb
 - handlers/simple_logger.rb
 - handlers/tweet_tweet.rb
 - lib/marvin.rb