rhuidean 1.0.0 → 1.1.0

data/lib/rhuidean.rb

@@ -8,7 +8,7 @@
 module Rhuidean
     # Version number
     V_MAJOR  = 1
-    V_MINOR  = 0
+    V_MINOR  = 1
     V_PATCH  = 0
 
     VERSION  = "#{V_MAJOR}.#{V_MINOR}.#{V_PATCH}"

data/lib/rhuidean/client.rb

@@ -8,15 +8,19 @@
 # Import required Ruby modules
 %w(logger socket).each { |m| require m }
 
+# Import required application modules
+%w(loggable).each { |m| require 'rhuidean/' + m }
+
 module IRC
 
 # The IRC::Client class acts as an abstract interface to the IRC protocol.
 class Client
     include Rhuidean # Version info and such
+    include Loggable # Magic logging stuff
 
     ##
     # instance attributes
-    attr_accessor :server,   :port,     :password, :debug, :thread,
+    attr_accessor :server,   :port,     :password, :thread,
                   :nickname, :username, :realname, :bind_to
 
     # Our TCPSocket.
@@ -40,7 +44,7 @@ class Client
     #     c.bind_to  = '10.0.1.20'
     #
     #     c.logger    = Logger.new($stderr)
-    #     c.debug     = false
+    #     c.log_level = :debug
     # end
     #
     # client.thread = Thread.new { client.io_loop }
@@ -65,9 +69,15 @@ class Client
         # Our event queue.
         @eventq = EventQueue.new
 
+        # Local IP to bind to
+        @bind_to = nil
+
+        # Password to login to the server
+        @password = nil
+
         # Our Logger object.
-        @logger  = Logger.new($stderr)
-        @debug   = false
+        @logger        = Logger.new($stderr)
+        self.log_level = :info
 
         # If we have a block let it set up our instance attributes.
         yield(self) if block_given?
@@ -80,7 +90,7 @@ class Client
         on(:dead) { self.dead = true }
 
         on(:exit) do |from|
-            log("exiting via #{from}...")
+            log(:fatal, "exiting via #{from}...")
             Thread.exit
         end
 
@@ -108,8 +118,14 @@ class Client
     # returns:: +self+
     #
     def set_default_handlers
+        # Append random numbers if our nick is in use
+        on(Numeric::ERR_NICKNAMEINUSE) do |m|
+            @nickname = m.params[0] + rand(100).to_s
+            nick(@nickname)
+        end
+
         # Consider ourselves connected on 001
-        on(Numeric::RPL_WELCOME) { log("connected to #@server:#@port") }
+        on(Numeric::RPL_WELCOME) { log(:info, "connected to #@server:#@port") }
 
         # Track our nickname...
         on(:NICK) { |m| @nickname = m.target if m.origin_nick == @nickname }
@@ -162,7 +178,7 @@ class Client
     #
     def dead=(bool)
         if bool == true
-            log("lost connection to #@server:#@port")
+            log(:info, "lost connection to #@server:#@port")
             @dead      = Time.now.to_i
             @socket    = nil
             @connected = false
@@ -217,7 +233,7 @@ class Client
             # Use shift because we need it to fall off immediately.
             while line = @sendq.shift
                 line += "\r\n"
-                debug(line)
+                log(:debug, line)
                 @socket.write(line)
             end
         rescue Errno::EAGAIN
@@ -265,7 +281,7 @@ class Client
         @recvq.each do |line|
             line.chomp!
 
-            debug(line)
+            log(:debug, line)
 
             m = IRC_RE.match(line)
 
@@ -291,53 +307,10 @@ class Client
         self
     end
 
-    #
-    # Logs a regular message.
-    # ---
-    # message:: the string to log
-    # returns:: +self+
-    #
-    def log(message)
-        @logger.info(caller[0].split('/')[-1]) { message } if @logger
-    end
-
-    #
-    # Logs a debug message.
-    # ---
-    # message:: the string to log
-    # returns:: +self+
-    #
-    def debug(message)
-        return unless @logger
-
-        @logger.debug(caller[0].split('/')[-1]) { message } if @debug
-    end
-
     ######
     public
     ######
 
-    #
-    # Sets the logging object to use.
-    # If it quacks like a Logger object, it should work.
-    # ---
-    # logger:: the Logger to use
-    # returns:: +self+
-    #
-    def logger=(logger)
-        @logger = logger
-
-        # Set to false/nil to disable logging...
-        return unless @logger
-
-        @logger.progname        = 'irc'
-        @logger.datetime_format = '%b %d %H:%M:%S '
-
-        # We only have 'logging' and 'debugging', so just set the
-        # object to show all levels. I might change this someday.
-        @logger.level = Logger::DEBUG
-    end
-
     #
     # Registers Event handlers with our EventQueue.
     # ---
@@ -424,7 +397,7 @@ class Client
     def connect
         verify_attributes
 
-        log("connecting to #@server:#@port")
+        log(:info, "connecting to #@server:#@port")
 
         begin
             @socket = TCPSocket.new(@server, @port, @bind_to)

data/lib/rhuidean/loggable.rb

@@ -0,0 +1,59 @@
+#
+# rhuidean: a small, lightweight IRC client library
+# lib/rhuidean/loggable.rb: a mixin for easy logging
+#
+# Copyright (c) 2003-2010 Eric Will <rakaur@malkier.net>
+#
+# encoding: utf-8
+
+module Loggable
+    ##
+    # Logs a regular message.
+    # ---
+    # message:: the string to log
+    # returns:: +self+
+    #
+    def log(level, message)
+        return unless level.to_s =~ /(fatal|error|warning|info|debug)/
+
+        @logger.send(level, caller[0].split('/')[-1]) { message } if @logger
+    end
+
+    ##
+    # Sets the logging object to use.
+    # If it quacks like a Logger object, it should work.
+    # ---
+    # logger:: the Logger to use
+    # returns:: +self+
+    #
+    def logger=(logger)
+        logger.level = @logger.level if @logger and logger
+
+        @logger = logger
+
+        # Set to false/nil to disable logging...
+        return unless @logger
+
+        @logger.datetime_format = '%m/%d %H:%M:%S '
+    end
+
+    def log_level=(level)
+        case level
+        when :none
+            @logger = nil
+        when :fatal
+            @logger.level = Logger::FATAL
+        when :error
+            @logger.level = Logger::ERROR
+        when :warning
+            @logger.level = Logger::WARN
+        when :info
+            @logger.level = Logger::INFO
+        when :debug
+            @logger.level = Logger::DEBUG
+        else
+            @logger.level = Logger::WARN
+        end
+    end
+end # module Loggable
+

data/lib/rhuidean/methods.rb

@@ -43,11 +43,25 @@ class Client
         @sendq << "PRIVMSG #{to} :#{message}"
     end
 
+    # Sends a CTCP
+    def ctcp(to, type, params = nil)
+        if params
+            @sendq << "PRIVMSG #{to} :\1#{type} #{params}\1"
+        else
+            @sendq << "PRIVMSG #{to} :\1#{type}\1"
+        end
+    end
+
     # Sends an IRC NOTICE command.
     def notice(to, message)
         @sendq << "NOTICE #{to} :#{message}"
     end
 
+    # Sends a CTCP reply
+    def ctcp_reply(to, type, params = '')
+        @sendq << "NOTICE #{to} :\1#{type} #{params}\1"
+    end
+
     # Sends an IRC JOIN command.
     def join(channel, key = '')
         @sendq << "JOIN #{channel} #{key}"

data/lib/rhuidean/stateful_client.rb

@@ -179,7 +179,7 @@ class StatefulClient < Client
             @users[user.nickname] ||= user
 
             @channels[m.target].add_user(user)
-            debug("join: #{user} -> #{m.target}")
+            log(:info, "join: #{user} -> #{m.target}")
         end
     end
 
@@ -196,12 +196,12 @@ class StatefulClient < Client
 
             @channels.delete(chan.name)
 
-            debug("parted: #{chan.name}")
+            log(:info, "parted: #{chan.name}")
         else
             user = @users[m.origin_nick]
 
             @channels[m.target].delete_user(user)
-            debug("part: #{user.nickname} -> #{m.origin_nick}")
+            log(:info, "part: #{user.nickname} -> #{m.origin_nick}")
 
             delete_user(user) if user.channels.empty?
         end
@@ -222,7 +222,7 @@ class StatefulClient < Client
             channel.users.delete(m.origin_nick)
         end
 
-        debug("nick: #{m.origin_nick} -> #{m.target}")
+        log(:info, "nick: #{m.origin_nick} -> #{m.target}")
     end
 
     def do_kick(m)
@@ -238,12 +238,12 @@ class StatefulClient < Client
 
             @channels.delete(chan.name)
 
-            debug("kicked: #{chan.name}")
+            log(:info, "kicked: #{chan.name}")
         else
             user = @users[m.params[0]]
 
             @channels[m.target].delete_user(user)
-            debug("kick: #{user.nickname} -> #{m.origin_nick}")
+            log(:info, "kick: #{user.nickname} -> #{m.origin_nick}")
 
             delete_user(user) if user.channels.empty?
         end
@@ -258,7 +258,7 @@ class StatefulClient < Client
             user.channels.each { |name, chan| chan.delete_user(user) }
 
             delete_user(user)
-            debug("quit: #{user.nickname}")
+            log(:info, "quit: #{user.nickname}")
         end
     end
 
@@ -273,7 +273,7 @@ class StatefulClient < Client
         names[0] = names[0][1..-1] # Get rid of leading ':'
         modes    = @status_modes.keys
         prefixes = @status_modes.values
-        name_re  = /^([#{prefixes}])*(.+)/
+        name_re  = /^([#{prefixes.join('')}])*(.+)/
 
         names.each do |name|
             m      = name_re.match(name)
@@ -294,7 +294,7 @@ class StatefulClient < Client
             end
 
             chan.add_user(user)
-            debug("names: #{user} -> #{chan}")
+            log(:debug, "names: #{user} -> #{chan}")
         end
     end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Eric Will
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 -05:00
+date: 2010-11-11 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -38,6 +38,7 @@ files:
 - lib/rhuidean/stateful_channel.rb
 - lib/rhuidean/stateful_client.rb
 - lib/rhuidean/stateful_user.rb
+- lib/rhuidean/loggable.rb
 - test/tc_client.rb
 - test/ts_rhuidean.rb
 has_rdoc: true