Sutto-marvin 0.3.0 → 0.3.2

data/VERSION.yml

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

data/handlers/debug_handler.rb

@@ -1,10 +1,5 @@
 # Use this class to debug stuff as you 
 # go along - e.g. dump events etc.
 class DebugHandler < Marvin::CommandHandler
-  
-  exposes :about
-  def about(*args)
-    reply "Marvin v#{Marvin::VERSION::STRING} running on Ruby #{RUBY_VERSION} (#{RUBY_PLATFORM})"
-  end
     
 end

data/handlers/logging_handler.rb

@@ -21,6 +21,7 @@ class LoggingHandler < Marvin::CommandHandler
   
   exposes :listen, :earmuffs
   
+  desc "Makes me listen up and take not of what you're saying."
   def listen(data)
     unless listening?
       @listening = true
@@ -30,6 +31,7 @@ class LoggingHandler < Marvin::CommandHandler
     end
   end
   
+  desc "Sends me off into a corner with my ear muffs so you can have your discussions in peace"
   def earmuffs(data)
     if listening?
       @listening = false

data/handlers/simple_logger.rb

@@ -0,0 +1,24 @@
+# A reference logger example
+class SimpleLogger < Marvin::LoggingHandler
+  
+  def setup_logging
+    logger.warn "Setting up the client"
+  end
+  
+  def teardown_logging
+    logger.warn "Tearing down the logger"
+  end
+  
+  def log_incoming(server, nick, target, message)
+    logger.fatal "[INCOMING] #{server} (#{target}) #{nick}: #{message}"
+  end
+
+  def log_outgoing(server, nick, target, message)
+    logger.fatal "[OUTGOING] #{server} (#{target}) #{nick}: #{message}"
+  end
+
+  def log_message(server, nick, target, message)
+    logger.fatal "[MESSAGE]  #{server} (#{target}) #{nick}: #{message}"
+  end
+  
+end

data/lib/marvin.rb

@@ -11,7 +11,7 @@ module Marvin
   module VERSION
     MAJOR = 0
     MINOR = 3
-    PATCH = 0
+    PATCH = 2
     
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end
@@ -26,6 +26,7 @@ module Marvin
   autoload :ClientMixin,      'marvin/client_mixin'
   autoload :Settings,         'marvin/settings'
   autoload :Logger,           'marvin/logger'
+  autoload :LoggingHandler,   'marvin/logging_handler'
   autoload :IRC,              'marvin/irc'
   autoload :TestClient,       'marvin/test_client'
   autoload :Loader,           'marvin/loader'

data/lib/marvin/abstract_client.rb

@@ -114,6 +114,10 @@ module Marvin
       @default_channels = channels.to_a.map { |c| c.to_s }
     end
     
+    def host_with_port
+      @host_with_port ||= "#{self.server}:#{self.port}"
+    end
+    
     def nicks
       if @nicks.blank? && !@nicks_loaded
         logger.info "Setting default nick list"

data/lib/marvin/core_commands.rb

@@ -0,0 +1,31 @@
+module Marvin
+  class CoreCommands < CommandHandler
+    
+    exposes :help
+    desc "Generates this usage statement"
+    def help(methods)
+      method_names     = exposed_method_names.map { |n| n.to_s }
+      documented_names = descriptions.keys.map { |k| k.to_s } & method_names 
+      if methods.empty?
+        width            = documented_names.map { |s| s.length }.max
+        say "Hello there, I know the following commands:"
+        documented_names.each { |name| say "#{name.ljust(width)} - #{descriptions[name.to_sym]}" }
+        say "As well as the following undescribed commands: #{(method_names - documented_names).sort.join(", ")}"
+      else
+        m = methods.first
+        if documented_names.include? m.to_s
+          reply "#{m}: #{descriptions[m.to_sym]}"
+        else
+          reply "I'm sorry, I can't help with #{m} - it seems to be undocumented."
+        end
+      end
+    end
+    
+    exposes :about
+    desc "Displays the current marvin and ruby versions."
+    def about(*args)
+      reply "Marvin v#{Marvin::VERSION::STRING} running on Ruby #{RUBY_VERSION} (#{RUBY_PLATFORM})"
+    end
+    
+  end
+end

data/lib/marvin/daemon.rb

@@ -31,7 +31,7 @@ module Marvin
       end
       
       def cleanup!
-        f = Marvin::Settings.root / "tmp/pids/marvin-#{Marvin::Loader.type.to_s.underscore}.pid"
+        f = pids_file_for(Marvin::Loader.type)
         FileUtils.rm_f(f) if (pids_from(f) - Process.pid).blank?
       end
       
@@ -50,7 +50,7 @@ module Marvin
       end
 
       def pid_file_for(type)
-        Marvin::Settings.root / "tmp/pids/marvin-#{type.to_s.underscore}.pid"
+        Marvin::Settings.root / "tmp" / "pids" / "marvin-#{type.to_s.underscore}.pid"
       end
 
       def pids_from(file)

data/lib/marvin/irc/server.rb

@@ -39,7 +39,7 @@ module Marvin
       autoload :VirtualUserConnection, 'marvin/irc/server/virtual_user_connection'
       autoload :AbstractConnection,    'marvin/irc/server/abstract_connection'
       autoload :UserConnection,        'marvin/irc/server/user_connection'
-      autoload :ServerConnection,      'marvin/irc/server/server_connection'
+      # autoload :ServerConnection,      'marvin/irc/server/server_connection'
       # Extensions for each part
       autoload :User,                  'marvin/irc/server/user'
       

data/lib/marvin/logger.rb

@@ -34,7 +34,7 @@ module Marvin
       :error => 33, # yellow
       :warn  => 35, # magenta
       :info  => 32, # green
-      :debug => 34   # white
+      :debug => 34  # white
     }
   
     attr_accessor :level, :file, :verbose

data/lib/marvin/logging_handler.rb

@@ -0,0 +1,76 @@
+module Marvin
+  # A generic class to make it easy to implement loggers
+  # in marvin. Users only need to implement 1 method for simple
+  # logging but have control to do more. Please note that
+  # if you want it correctly log the order of messages, it
+  # needs to be the first registered handler, otherwise
+  # outgoing messages will be processed before incoming ones.
+  class LoggingHandler < CommandHandler
+    
+    on_event :incoming_message do
+      if should_log?
+        log_incoming(@server, options.nick, options.target, options.message)
+        log_message(@server, options.nick, options.target, options.message)
+      end
+    end
+    
+    on_event :outgoing_message do
+      if should_log?
+        log_outgoing(@server, @nick, options.target, options.message)
+        log_message(@server, @nick, options.target, options.message)
+      end
+    end
+    
+    on_event :client_connected do
+      @server = self.client.host_with_port
+      @nick   = self.client.nickname
+      setup_logging
+    end
+
+    on_event :client_disconnected do
+      teardown_logging
+    end
+    
+    on_event :outgoing_nick do
+      @nick = options.new_nick
+    end
+    
+    # Called when the client connects, over ride it to
+    # do any of your specific setup.
+    def setup_logging
+      # NOP
+    end
+    
+    # Called when the client disconnects, over ride it to
+    # do any of your specific teardown.
+    def teardown_logging
+      # NOP
+    end
+    
+    # Called before logging a message for conditional logging.
+    # Override with your implementation specific version.
+    def should_log?
+      true
+    end
+    
+    # Log an incoming message (i.e. from another user)
+    # Note that +server+ is in the port host:port, 
+    # nick is the origin nick and target is either
+    # a channel or the bots nick (if PM'ed)
+    def log_incoming(server, nick, target, message)
+    end
+    
+    # Log an outgoing message (i.e. from this user)
+    # Note that +server+ is in the port host:port, 
+    # nick is the bots nick and target is either
+    # a channel or the user the bot is replying to.
+    def log_outgoing(server, nick, target, message)
+    end
+    
+    # Logs a message - used when you want to log
+    # both incoming and outgoing messages
+    def log_message(server, nick, target, message)
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Sutto-marvin
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-17 00:00:00 -08:00
+date: 2009-04-05 00:00:00 -07:00
 default_executable: marvin
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,8 +58,8 @@ executables:
 - marvin
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.textile
 files: 
 - README.textile
 - TUTORIAL.textile
@@ -71,6 +71,7 @@ files:
 - lib/marvin/base.rb
 - lib/marvin/command_handler.rb
 - lib/marvin/console.rb
+- lib/marvin/core_commands.rb
 - lib/marvin/core_ext.rb
 - lib/marvin/daemon.rb
 - lib/marvin/data_store.rb
@@ -83,7 +84,6 @@ files:
 - lib/marvin/exception_tracker.rb
 - lib/marvin/exceptions.rb
 - lib/marvin/handler.rb
-- lib/marvin/hookable.rb
 - lib/marvin/irc
 - lib/marvin/irc/client.rb
 - lib/marvin/irc/event.rb
@@ -103,6 +103,7 @@ files:
 - lib/marvin/irc.rb
 - lib/marvin/loader.rb
 - lib/marvin/logger.rb
+- lib/marvin/logging_handler.rb
 - lib/marvin/middle_man.rb
 - lib/marvin/options.rb
 - lib/marvin/parsers
@@ -138,16 +139,19 @@ files:
 - handlers/debug_handler.rb
 - handlers/hello_world.rb
 - handlers/logging_handler.rb
+- handlers/powwow_handler.rb
+- handlers/simple_logger.rb
 - handlers/tweet_tweet.rb
 - config/setup.rb
 - config/boot.rb
 - config/settings.yml.sample
 - config/connections.yml.sample
-has_rdoc: false
+has_rdoc: true
 homepage: http://blog.ninjahideout.com/
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement