net-yail 1.4.0 → 1.4.2

data/examples/logger/logger_bot.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/ruby
 
 require 'rubygems'
-require 'net/yail/IRCBot'
+require 'net/yail/irc_bot'
 require 'date'
 
 class LoggerBot < IRCBot

data/lib/net/yail.rb

@@ -1,6 +1,7 @@
 require 'socket'
 require 'thread'
 require 'yaml'
+require 'logger'
 
 # To make this library seem smaller, a lot of code has been split up and put
 # into semi-logical files.  I don't really like this hacky solution, but I
@@ -242,11 +243,28 @@ class YAIL
     :socket             # TCPSocket instance
   )
   attr_accessor(
-    :silent,
-    :loud,
-    :throttle_seconds
+    :throttle_seconds,
+    :log
   )
 
+  def silent
+    @log.warn '[DEPRECATED] - Net::YAIL#silent is deprecated as of 1.4.1'
+    return @log_silent
+  end
+  def silent=(val)
+    @log.warn '[DEPRECATED] - Net::YAIL#silent= is deprecated as of 1.4.1'
+    @log_silent = val
+  end
+
+  def loud
+    @log.warn '[DEPRECATED] - Net::YAIL#loud is deprecated as of 1.4.1'
+    return @log_loud
+  end
+  def loud=(val)
+    @log.warn '[DEPRECATED] - Net::YAIL#loud= is deprecated as of 1.4.1'
+    @log_loud = val
+  end
+
   # Makes a new instance, obviously.
   #
   # Note: I haven't done this everywhere, but for the constructor, I felt
@@ -259,15 +277,19 @@ class YAIL
   # * <tt>:username</tt>: Username reported to server
   # * <tt>:realname</tt>: Real name reported to server
   # * <tt>:nicknames</tt>: Array of nicknames to cycle through
-  # * <tt>:silent</tt>: Don't report output messages from this object,
-  #   defaults to false
-  # * <tt>:loud</tt>: Report a whole lot of stuff that's normally silenced and
-  #   is generally very annoying.  Defaults to false, thankfully.
+  # * <tt>:silent</tt>: DEPRECATED - Sets Logger level to FATAL and silences most non-Logger
+  #   messages.
+  # * <tt>:loud</tt>: DEPRECATED - Sets Logger level to DEBUG. Spits out too many messages for your own good,
+  #   and really is only useful when debugging YAIL.  Defaults to false, thankfully.
   # * <tt>:throttle_seconds</tt>: Seconds between a cycle of privmsg sends.
   #   Defaults to 1.  One "cycle" is defined as sending one line of output to
   #   *all* targets that have output buffered.
   # * <tt>:server_password</tt>: Very optional.  If set, this is the password
   #   sent out to the server before USER and NICK messages.
+  # * <tt>:log</tt>: Optional, if set uses this logger instead of the default (Ruby's Logger).
+  #   If set, :loud and :silent options are ignored.
+  # * <tt>:log_io</tt>: Optional, ignored if you specify your own :log - sends given object to
+  #   Logger's constructor.  Must be filename or IO object.
   def initialize(options = {})
     @me                 = ''
     @nicknames          = options[:nicknames]
@@ -276,11 +298,27 @@ class YAIL
     @realname           = options[:realname]
     @address            = options[:address]
     @port               = options[:port] || 6667
-    @silent             = options[:silent] || false
-    @loud               = options[:loud] || false
+    @log_silent         = options[:silent] || false
+    @log_loud           = options[:loud] || false
     @throttle_seconds   = options[:throttle_seconds] || 1
     @password           = options[:server_password]
 
+    # Special handling to avoid mucking with Logger constants if we're using a different logger
+    if options[:log]
+      @log = options[:log]
+    else
+      @log = Logger.new(options[:log_io] || STDERR)
+      @log.level = Logger::WARN
+ 
+      # Convert old-school options into logger stuff
+      @log.level = Logger::DEBUG if @log_loud
+      @log.level = Logger::FATAL if @log_silent
+    end
+
+    if (options[:silent] || options[:loud])
+      @log.warn '[DEPRECATED] - passing :silent and :loud options to constructor are deprecated as of 1.4.1'
+    end
+
     # Read in map of event numbers and names.  Yes, I stole this event map
     # file from RubyIRC and made very minor changes....  They stole it from
     # somewhere else anyway, so it's okay.
@@ -294,7 +332,7 @@ class YAIL
     begin
       @socket = TCPSocket.new(@address, @port)
     rescue StandardError => boom
-      report "+++ERROR: Unable to open socket connection in Net::YAIL.initialize: #{boom.inspect}"
+      @log.fatal "+++ERROR: Unable to open socket connection in Net::YAIL.initialize: #{boom.inspect}"
       @dead_socket = true
       raise
     end
@@ -387,7 +425,7 @@ class YAIL
       line = @socket.gets
     rescue StandardError => boom
       @dead_socket = true
-      report "+++ERROR in read_incoming_data -> @socket.gets: #{boom.inspect}" if @loud
+      @log.fatal "+++ERROR in read_incoming_data -> @socket.gets: #{boom.inspect}"
       raise
     end
 
@@ -399,7 +437,7 @@ class YAIL
 
     line.chomp!
 
-    report "+++INCOMING: #{line}" if @loud
+    @log.debug "+++INCOMING: #{line}"
 
     # Only synchronize long enough to push our incoming string onto the
     # input buffer
@@ -562,10 +600,13 @@ class YAIL
       when :incoming_nick
         handle(event.type, event.fullname, event.nick, event.text)
 
+      when :incoming_error
+        handle(event.type, event.text)
+
       # Unknown line!
       else
-        # This should really never happen, so reporting is forced here for now
-        report('Unknown line: %s!' % line.inspect)
+        # This should really never happen, but isn't technically an error per se
+        @log.warn 'Unknown line: %s!' % line.inspect
         handle(:incoming_miscellany, line)
     end
   end
@@ -608,7 +649,7 @@ class YAIL
     # Don't bother with anything if there are no handlers registered.
     return unless Array === @handlers[event]
 
-    report "+++EVENT HANDLER: Handling event #{event} via #{@handlers[event].inspect}:" if @loud
+    @log.debug "+++EVENT HANDLER: Handling event #{event} via #{@handlers[event].inspect}:"
 
     # Call all hooks in order until one breaks the chain.  For incoming
     # events, we want something to break the chain or else it'll likely
@@ -633,7 +674,7 @@ class YAIL
       handle(base_event, text, args)
     else
       # No handler = report and don't worry about it
-      report "Unknown raw #{number.to_s} from #{fullactor}: #{text}"
+      @log.info "Unknown raw #{number.to_s} from #{fullactor}: #{text}"
     end
   end
 

data/lib/net/yail/IRCBot.rb

@@ -1,154 +1,7 @@
+# This is a deprecated file!
+warn '[DEPRECATED] Requiring "net/yail/IRCBot" is deprecated!  Use "net/yail/irc_bot" instead.'
+
+# Wrapper for irc_bot for backward-compatibility
 require 'rubygems'
 require 'net/yail'
-
-# My abstraction from adapter to a real bot.
-class IRCBot
-  attr_reader :irc
-
-  public
-
-  # Creates a new bot yay.  Note that due to my laziness, the options here
-  # are almost exactly the same as those in Net::YAIL.  But at least there
-  # are more defaults here.
-  #
-  # Options:
-  # * <tt>:irc_network</tt>: Name/IP of the IRC server
-  # * <tt>:channels</tt>: Channels to automatically join on connect
-  # * <tt>:port</tt>: Port number, defaults to 6667
-  # * <tt>:username</tt>: Username reported to server
-  # * <tt>:realname</tt>: Real name reported to server
-  # * <tt>:nicknames</tt>: Array of nicknames to cycle through
-  # * <tt>:silent</tt>: Silence a lot of reports
-  # * <tt>:loud</tt>: Lots more verbose reports
-  def initialize(options = {})
-    @start_time = Time.now
-
-    @channels = options[:channels] || []
-    @irc_network = options[:irc_network]
-    @port = options[:port] || 6667
-    @username = options[:username] || 'IRCBot'
-    @realname = options[:realname] || 'IRCBot'
-    @nicknames = options[:nicknames] || ['IRCBot1', 'IRCBot2', 'IRCBot3']
-    @silent = options[:silent] || false
-    @loud = options[:loud] || false
-  end
-
-  # Returns a string representing uptime
-  def get_uptime_string
-    uptime = (Time.now - @start_time).to_i
-    seconds = uptime % 60
-    minutes = (uptime / 60) % 60
-    hours = (uptime / 3600) % 24
-    days = (uptime / 86400)
-
-    str = []
-    str.push("#{days} day(s)") if days > 0
-    str.push("#{hours} hour(s)") if hours > 0
-    str.push("#{minutes} minute(s)") if minutes > 0
-    str.push("#{seconds} second(s)") if seconds > 0
-
-    return str.join(', ')
-  end
-
-  # Creates the socket connection and registers the (very simple) default
-  # welcome handler.  Subclasses should build their hooks in
-  # add_custom_handlers to allow auto-creation in case of a restart.
-  def connect_socket
-    @irc = Net::YAIL.new(
-      :address    => @irc_network,
-      :port       => @port,
-      :username   => @username,
-      :realname   => @realname,
-      :nicknames  => @nicknames,
-      :silent     => @silent,
-      :loud       => @loud
-    )
-
-    # Simple hook for welcome to allow auto-joining of the channel
-    @irc.prepend_handler :incoming_welcome, self.method(:welcome)
-
-    add_custom_handlers
-  end
-
-  # To be subclassed - this method is a nice central location to allow the
-  # bot to register its handlers before this class takes control and hits
-  # the IRC network.
-  def add_custom_handlers
-    raise "You must define your handlers in add_custom_handlers, or else " +
-        "explicitly override with an empty method."
-  end
-
-  # Enters the socket's listening loop(s)
-  def start_listening
-    # If socket's already dead (probably couldn't connect to server), don't
-    # try to listen!
-    if @irc.dead_socket
-      $stderr.puts "Dead socket, can't start listening!"
-    end
-
-    @irc.start_listening
-  end
-
-  # Tells us the main app wants to just wait until we're done with all
-  # thread processing, or get a kill signal, or whatever.  For now this is
-  # basically an endless loop that lets the threads do their thing until
-  # the socket dies.  If a bot wants, it can handle :irc_loop to do regular
-  # processing.
-  def irc_loop
-    while true
-      until @irc.dead_socket
-        sleep 15
-        @irc.handle(:irc_loop)
-        Thread.pass
-      end
-
-      # Disconnected?  Wait a little while and start up again.
-      sleep 30
-      @irc.stop_listening
-      self.connect_socket
-      start_listening
-    end
-  end
-
-  private
-  # Basic handler for joining our channels upon successful registration
-  def welcome(text, args)
-    @channels.each {|channel| @irc.join(channel) }
-    # Let the default welcome stuff still happen
-    return false
-  end
-
-  ################
-  # Helpful wrappers
-  ################
-
-  # Wraps Net::YAIL.me
-  def bot_name
-    @irc.me
-  end
-
-  # Wraps Net::YAIL.msg
-  def msg(*args)
-    @irc.msg(*args)
-  end
-
-  # Wraps Net::YAIL.act
-  def act(*args)
-    @irc.act(*args)
-  end
-
-  # Wraps Net::YAIL.join
-  def join(*args)
-    @irc.join(*args)
-  end
-
-  # Wraps Net::YAIL.report
-  def report(*args)
-    @irc.report(*args)
-  end
-
-  # Wraps Net::YAIL.nick
-  def nick(*args)
-    @irc.nick(*args)
-  end
-end
+require 'net/yail/irc_bot'

data/lib/net/yail/irc_bot.rb

@@ -0,0 +1,155 @@
+require 'rubygems'
+require 'net/yail'
+
+# My abstraction from adapter to a real bot.
+class IRCBot
+  attr_reader :irc
+
+  public
+
+  # Creates a new bot.  Options are anything you can pass to the Net::YAIL constructor:
+  # * <tt>:irc_network</tt>: Name/IP of the IRC server - backward-compatibility hack, and is
+  #   ignored if :address is passed in
+  # * <tt>:address</tt>: Name/IP of the IRC server
+  # * <tt>:port</tt>: Port number, defaults to 6667
+  # * <tt>:username</tt>: Username reported to server
+  # * <tt>:realname</tt>: Real name reported to server
+  # * <tt>:nicknames</tt>: Array of nicknames to cycle through
+  # * <tt>:throttle_seconds</tt>: Seconds between a cycle of privmsg sends.
+  #   Defaults to 1.  One "cycle" is defined as sending one line of output to
+  #   *all* targets that have output buffered.
+  # * <tt>:server_password</tt>: Very optional.  If set, this is the password
+  #   sent out to the server before USER and NICK messages.
+  # * <tt>:log</tt>: Optional, if set uses this logger instead of the default (Ruby's Logger).
+  #   If set, :loud and :silent options are ignored.
+  # * <tt>:log_io</tt>: Optional, ignored if you specify your own :log - sends given object to
+  #   Logger's constructor.  Must be filename or IO object.
+  def initialize(options = {})
+    @start_time = Time.now
+    @options = options
+
+    # Set up some friendly defaults
+    @options[:address]    ||= @options.delete(:irc_network)
+    @options[:channels]   ||= []
+    @options[:port]       ||= 6667
+    @options[:username]   ||= 'IRCBot'
+    @options[:realname]   ||= 'IRCBot'
+    @options[:nicknames]  ||= ['IRCBot1', 'IRCBot2', 'IRCBot3']
+  end
+
+  # Returns a string representing uptime
+  def get_uptime_string
+    uptime = (Time.now - @start_time).to_i
+    seconds = uptime % 60
+    minutes = (uptime / 60) % 60
+    hours = (uptime / 3600) % 24
+    days = (uptime / 86400)
+
+    str = []
+    str.push("#{days} day(s)") if days > 0
+    str.push("#{hours} hour(s)") if hours > 0
+    str.push("#{minutes} minute(s)") if minutes > 0
+    str.push("#{seconds} second(s)") if seconds > 0
+
+    return str.join(', ')
+  end
+
+  # Creates the socket connection and registers the (very simple) default
+  # welcome handler.  Subclasses should build their hooks in
+  # add_custom_handlers to allow auto-creation in case of a restart.
+  def connect_socket
+    @irc = Net::YAIL.new(@options)
+
+    # Simple hook for welcome to allow auto-joining of the channel
+    @irc.prepend_handler :incoming_welcome, self.method(:welcome)
+
+    add_custom_handlers
+  end
+
+  # To be subclassed - this method is a nice central location to allow the
+  # bot to register its handlers before this class takes control and hits
+  # the IRC network.
+  def add_custom_handlers
+    raise "You must define your handlers in add_custom_handlers, or else " +
+        "explicitly override with an empty method."
+  end
+
+  # Enters the socket's listening loop(s)
+  def start_listening
+    # If socket's already dead (probably couldn't connect to server), don't
+    # try to listen!
+    if @irc.dead_socket
+      $stderr.puts "Dead socket, can't start listening!"
+    end
+
+    @irc.start_listening
+  end
+
+  # Tells us the main app wants to just wait until we're done with all
+  # thread processing, or get a kill signal, or whatever.  For now this is
+  # basically an endless loop that lets the threads do their thing until
+  # the socket dies.  If a bot wants, it can handle :irc_loop to do regular
+  # processing.
+  def irc_loop
+    while true
+      until @irc.dead_socket
+        sleep 15
+        @irc.handle(:irc_loop)
+        Thread.pass
+      end
+
+      # Disconnected?  Wait a little while and start up again.
+      sleep 30
+      @irc.stop_listening
+      self.connect_socket
+      start_listening
+    end
+  end
+
+  private
+  # Basic handler for joining our channels upon successful registration
+  def welcome(text, args)
+    @options[:channels].each {|channel| @irc.join(channel) }
+    # Let the default welcome stuff still happen
+    return false
+  end
+
+  ################
+  # Helpful wrappers
+  ################
+
+  # Wraps Net::YAIL.log
+  def log
+    @irc.log
+  end
+
+  # Wraps Net::YAIL.me
+  def bot_name
+    @irc.me
+  end
+
+  # Wraps Net::YAIL.msg
+  def msg(*args)
+    @irc.msg(*args)
+  end
+
+  # Wraps Net::YAIL.act
+  def act(*args)
+    @irc.act(*args)
+  end
+
+  # Wraps Net::YAIL.join
+  def join(*args)
+    @irc.join(*args)
+  end
+
+  # Wraps Net::YAIL.report
+  def report(*args)
+    @irc.report(*args)
+  end
+
+  # Wraps Net::YAIL.nick
+  def nick(*args)
+    @irc.nick(*args)
+  end
+end

data/lib/net/yail/output_api.rb

@@ -69,7 +69,7 @@ module IRCOutputAPI
 
     handle(:outgoing_msg, target, text)
 
-    report_string = @silent ? '' : "{#{target}} <#{@me}> #{text}"
+    report_string = @log_silent ? '' : "{#{target}} <#{@me}> #{text}"
     privmsg(target, text, report_string)
   end
 
@@ -81,7 +81,7 @@ module IRCOutputAPI
 
     handle(:outgoing_ctcp, target, text)
 
-    report_string = @silent ? '' :  "{#{target}}  [#{@me} #{text}]"
+    report_string = @log_silent ? '' :  "{#{target}}  [#{@me} #{text}]"
     privmsg(target, "\001#{text}\001", report_string)
   end
 
@@ -105,7 +105,7 @@ module IRCOutputAPI
 
     handle(:outgoing_notice, target, text)
 
-    report "{#{target}} -#{@me}- #{text}" unless @silent
+    report "{#{target}} -#{@me}- #{text}" unless @log_silent
     raw("NOTICE #{target} :#{text}", false)
   end
 
@@ -118,7 +118,7 @@ module IRCOutputAPI
 
     handle(:outgoing_ctcpreply, target, text)
 
-    report "{#{target}} [Reply: #{@me} #{text}]" unless @silent
+    report "{#{target}} [Reply: #{@me} #{text}]" unless @log_silent
     notice(target, "\001#{text}\001")
   end
 

data/lib/net/yail/yail-version.rb

@@ -1,5 +1,5 @@
 module Net
   class YAIL
-    VERSION = '1.4.0'
+    VERSION = '1.4.2'
   end
 end

data/tests/tc_event.rb

@@ -224,4 +224,11 @@ class MessageParserEventTest < Test::Unit::TestCase
     assert_equal ['foo'], event.targets
     assert_equal '+k', event.text
   end
+
+  # Simple test of error event
+  def test_error
+    event = Net::YAIL::IncomingEvent.parse 'ERROR :Closing Link: nerdbucket.com (Quit: Terminated by user)'
+    assert_equal :incoming_error, event.type
+    assert_equal 'Closing Link: nerdbucket.com (Quit: Terminated by user)', event.text
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 4
-  - 0
-  version: 1.4.0
+  - 2
+  version: 1.4.2
 platform: ruby
 authors: 
 - Jeremy Echols
@@ -14,7 +14,7 @@ autorequire: net/yail
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 -04:00
+date: 2010-09-08 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -40,6 +40,7 @@ files:
 - lib/net/yail/output_api.rb
 - lib/net/yail/event.rb
 - lib/net/yail/yail-version.rb
+- lib/net/yail/irc_bot.rb
 - tests/net_yail.rb
 - tests/tc_message_parser.rb
 - tests/tc_event.rb