rhuidean 0.2.3 → 0.2.4

data/README.markdown

@@ -0,0 +1,63 @@
+rhuidean -- a small, lightweight IRC client library
+===================================================
+
+This program is free but copyrighted software; see the LICENSE file.
+
+Information and repositories can be found on [GitHub][].
+
+[github]: http://github.com/rakaur/rhuidean/
+
+TABLE OF CONTENTS
+-----------------
+  1. Credits
+  2. Installation
+  3. Contact and support
+
+1. CREDITS
+----------
+
+Rhuidean is not based on any other code. I wrote the majority of it in a
+single day as a way to try out a Ruby-based event system and as an exercise
+writing in The Ruby Way. As such, rhuidean's code is very clean and concise,
+and it also offers clever ways of accomplishing basic and advanced tasks.
+
+The current active development/maintenance is done by:
+
+- rakaur, Eric Will <rakaur@malkier.net>
+- sycobuny, Stephen Belcher <sycobuny@malkier.net>
+
+Almost all of the testing was also done by us. I (rakaur) wrote all of the base
+code, and sycobuny has expanded on it with more in-depth classes.
+
+2. INSTALLATION
+---------------
+
+This should be as simple as:
+
+    $ gem install rhuidean
+
+If you're installing from the development repository, you may build a gem
+based on the current code and install it by doing:
+
+    $ rake gem
+    $ gem install pkg/rhuidean-*.gem
+
+There's just not much else to it.
+
+3. CONTACT AND SUPPORT
+----------------------
+
+For bug or feature reports, please use GitHub's [issue tracking][1].
+
+[1]: http://github.com/rakaur/rhuidean/issues/
+
+If you're reporting a bug, please include information on how to reproduce the
+problem. If you can't reproduce it there's probably nothing we can do. If the
+library crashed, be sure to include Ruby's backtrace information.
+
+If your problem requires extensive debugging in a real-time situation, you
+can usually find us on irc.malkier.net in #malkier.
+
+If you've read this far, congratulations. You are among the few elite people
+that actually read documentation. Thank you.
+

data/lib/rhuidean/client.rb

@@ -14,7 +14,7 @@ module IRC
 class Client
     ##
     # constants
-    VERSION = '0.2.3'
+    VERSION = '0.2.4'
 
     ##
     # instance attributes
@@ -77,9 +77,29 @@ class Client
         # If we have a block let it set up our instance attributes.
         yield(self) if block_given?
 
-        # Set up event handlers.
+        # Core events which are needed to work at all.
+        on(:read_ready)  { read  }
+        on(:write_ready) { write }
+        on(:recvq_ready) { parse }
+
+        on(:dead) { self.dead = true }
+
+        on(:exit) do |from|
+            log("exiting via #{from}...")
+            Thread.exit
+        end
+
+        on(:PING) { |m| raw("PONG :#{m.target}") }
+
+        # Set up event handlers. These track some state and such, and can
+        # be overridden for other functionality in any child classes.
         set_default_handlers
 
+        # Special method for default CTCP replies
+        # I use this so they don't get wiped out when someone overrides
+        # the default handlers, but also so that they CAN be wiped out.
+        set_ctcp_handlers
+
         self
     end
 
@@ -93,49 +113,45 @@ class Client
     # returns:: +self+
     #
     def set_default_handlers
-        on(:read_ready)  { read  }
-        on(:write_ready) { write }
-        on(:recvq_ready) { parse }
-        on(:dead) { self.dead = true }
-
         # Consider ourselves connected on 001
         on(Numeric::RPL_WELCOME) { log("connected to #@server:#@port") }
 
-        # Keep alive...
-        on(:PING) { |m| raw("PONG :#{m.target}") }
-
         # Track our nickname...
-        on(:NICK) do |m|
-            if m.origin =~ /^(#{@nickname})\!(.+)\@(.+)$/
-                @nickname = m.params[0]
-            end
-        end
+        on(:NICK) { |m| @nickname = m.target if m.origin_nick == @nickname }
 
         # Track channels
-        on(:JOIN) do |m|
-            @channels << m.target if m.origin =~ /^(#{@nickname})\!(.+)\@(.+)$/
-        end
+        on(:JOIN) { |m| @channels << m.target if m.origin_nick == @nickname }
 
-        # Track channels
         on(:PART) do |m|
-            if m.origin =~ /^(#{@nickname})\!(.+)\@(.+)$/
-                @channels.delete(m.target)
-            end
+            @channels.delete(m.target) if m.origin_nick == @nickname
         end
 
-        # Track channels
-        on(:KICK) do |m|
-            @channels.delete(m.target) if m.params[0] == @nickname
-        end
-
-        on(:exit) do |from|
-            log("exiting via #{from}...")
-            Thread.exit
-        end
+        on(:KICK) { |m| @channels.delete(m.target) if m.params[0] == @nickname }
 
         self
     end
 
+    #
+    # Sets up some default CTCP replies.
+    # ---
+    # returns:: +self+
+    #
+    def set_ctcp_handlers
+        on(:PRIVMSG) do |m|
+            case m.ctcp
+            when :ping
+                notice(m.origin_nick, "\1PING #{m.params.join(' ')}\1")
+            when :version
+                v_str = "rhuidean-#{VERSION}"
+                notice(m.origin_nick, "\1VERSION #{v_str}\1")
+            when :clientinfo
+                notice(m.origin_nick, "\1CLIENTINFO 114 97 107 97 117 114\1")
+            else
+                next
+            end
+        end
+    end
+
     #
     # Verifies all required attributes are set.
     # ---
@@ -294,6 +310,7 @@ class Client
     # Registers Event handlers with our EventQueue.
     # ---
     # <tt>c.on(:PRIVMSG) do |m|
+    #     next if m.params.empty?
     #     if m.params =~ /\.die/ and m.origin == my_master
     #         c.quit(params)
     #         c.exit
@@ -440,17 +457,53 @@ end
 
 # A simple data-holding class.
 class Message
+    ##
+    # constants
+    ORIGIN_RE = /^(.+)\!(.+)\@(.+)$/
+
     ##
     # instance attributes
-    attr_reader :client, :raw, :origin, :target, :params
+    attr_reader :client, :ctcp, :origin, :params, :raw, :target
+    attr_reader :origin_nick
 
     #
     # Creates a new Message. We use these to represent the old
     # style of (char *origin, char *target, char *parv[]) in C.
     #
     def initialize(client, raw, origin, target, params)
-        @client, @raw, @origin = client, raw, origin
-        @target, @params       = target, params
+        @client, @ctcp, @origin = client, nil, origin
+        @params, @raw,  @target = params, raw, target
+
+        # Is the origin a user? Let's make this a little more simple...
+        if m = ORIGIN_RE.match(@origin)
+            @origin_nick = m[1]
+        end
+
+        # Reformat it a bit if it's a CTCP.
+        if @params and not @params.empty? and @params[0][0] == "\1"
+            @params[-1].chop!
+            @ctcp = @params.shift[1 .. -1].downcase.to_sym
+        end
+    end
+
+    ######
+    public
+    ######
+
+    def to_channel?
+        %w(# & !).include?(@target[0])
+    end
+
+    def is_ctcp?
+        @ctcp
+    end
+
+    def is_action?
+        @ctcp == :action
+    end
+
+    def is_dcc?
+        @ctcp == :dcc
     end
 end
 

data/rakefile

@@ -10,6 +10,8 @@
     require 'rake/' + m
 end
 
+VER = '0.2.4'
+
 #
 # Default task - unit tests.
 #
@@ -38,13 +40,13 @@ end
 #
 # $ rake package
 #
-PKG_FILES = FileList['README', 'rakefile',
+PKG_FILES = FileList['README.markdown', 'rakefile',
                      'lib/rhuidean.rb', 'lib/rhuidean/**/*.rb',
                      'test/*.rb']
 
 Rake::PackageTask.new('package') do |p|
     p.name          = 'rhuidean'
-    p.version       = '0.2.3'
+    p.version       = VER
     p.need_tar      = false
     p.need_zip      = false
     p.package_files = PKG_FILES
@@ -52,7 +54,7 @@ end
 
 spec = Gem::Specification.new do |s|
     s.name     = 'rhuidean'
-    s.version  = '0.2.3'
+    s.version  = VER
     s.author   = 'Eric Will'
     s.email    = 'rakaur@malkier.net'
     s.homepage = 'http://github.com/rakaur/rhuidean/'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rhuidean
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Eric Will
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-20 00:00:00 -04:00
+date: 2010-09-24 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -28,11 +28,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.markdown
 - rakefile
 - lib/rhuidean.rb
-- lib/rhuidean/event.rb
 - lib/rhuidean/client.rb
+- lib/rhuidean/event.rb
 - lib/rhuidean/methods.rb
 - lib/rhuidean/numeric.rb
 - lib/rhuidean/timer.rb

data/README

@@ -1,17 +0,0 @@
-#
-# rhuidean: a small, lightweight IRC client library
-# README: at-a-glance documentation
-#
-# Copyright (c) 2004-2009 Eric Will <rakaur@malkier.net>
-# Copyright (c) 2003-2004 shrike development team
-#
-
-This repository contains a simple, quick IRC client library. If you have a
-decent understanding of IRC and want to control most of the IRC events
-yourself this is very easy and quick to pick up. The library handles all of
-the socket code and sets up a simple event handling system for IRC events.
-
-It's not very well documented yet, but I'm still working on it.
-
-The code itself is documented. Run `rake rdoc` and check out the doc/ directory.
-