messagefactory 0.0.1 → 0.0.2

data/Rakefile

@@ -13,17 +13,18 @@ require 'spec/rake/spectask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'messagefactory'
-  s.version = '0.0.1'
+  s.version = '0.0.2'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README.rdoc', 'LICENSE']
-  s.summary = 'Your summary here'
+  s.summary = 'Objectifies content from an IRC server'
   s.description = s.summary
-  s.author = ''
-  s.email = ''
+  s.author = 'spox'
+  s.email = 'spox@modspox.com'
   # s.executables = ['your_executable_here']
   s.files = %w(LICENSE README.rdoc Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
   s.require_path = "lib"
   s.bindir = "bin"
+  s.required_ruby_version = '>= 1.8.7'
 end
 
 Rake::GemPackageTask.new(spec) do |p|

data/lib/messagefactory.rb

@@ -0,0 +1 @@
+require 'messagefactory/Factory'

data/lib/{Factory.rb → messagefactory/Factory.rb}

@@ -21,18 +21,24 @@ module MessageFactory
             rescue
                 raise 'Failed to determine message type'
             end
-            t
+            t.to_sym
         end
 
         # string:: String from IRC server to process
         # Process the given string and return parsed
         # message or nil
-        def process(string)
+        def process(string, do_require=true)
             s = nil
-            if(@handlers[type(string)])
+            mtype = type(string)
+            if(@handlers[mtype])
                 s = @handlers.process(string)
             else
-                raise NoMethodError.new("No handler found to process string: #{string}")
+                if(do_require)
+                    require "messagefactory/handlers/#{mtype}"
+                    s = process(string, false)
+                else
+                    raise NoMethodError.new("No handler found to process string: #{string}")
+                end
             end
             s
         end

data/lib/{Handler.rb → messagefactory/Handler.rb}

@@ -8,6 +8,11 @@ unless(OpenStruct.new.type.nil?)
     end
 end
 
+module MessageFactory
+    class Message < OpenStruct
+    end
+end
+
 module MessageFactory
 module Handlers
     class Handler
@@ -28,7 +33,7 @@ module Handlers
         # orig:: Original message string
         # Helper to generate the message struct
         def mk_struct(orig=nil)
-            m = OpenStruct.new
+            m = Message.new
             m.direction = :incoming
             m.received = Time.now
             m.raw = orig.dup

data/lib/messagefactory/handlers/311.rb

@@ -0,0 +1,140 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module MessageFactory
+module Handlers
+    class Whois < Handler
+        def initialize
+            @cache = {}
+        end
+        def clear_cache
+            @cache.clear
+        end
+        def types_process
+            [:'311', :'319', :'312', :'307', :'330', :'317', :'318', :'378']
+        end
+        # string:: string to process
+        # Create a new Mode message
+        # OpenStruct will contain:
+        # #type #direction #raw #received #source #target #channels #voice #ops 
+        # #irc_host #idle #signon #nickserv
+        def process(string)
+            string = string.dup
+            orig = string.dup
+            m = nil
+            begin
+                string.slice!(0)
+                server = string.slice!(0, string.index(' '))
+                string.slice!(0)
+                action = string.slice!(0, string.index(' '))
+                raise unless types_process.include?(action.to_sym)
+                string.slice!(0)
+                action = ('process_'+action)
+                if(self.methods.include?(action))
+                    m = self.send(action, string, orig)
+                else
+                    m = store_raw(string, orig)
+                end
+                m.source = server if m
+            rescue => boom
+                raise "Failed to parse Whois message: #{orig}"
+            end
+            m
+        end
+
+        def store_raw(string, orig)
+            parts = string.split
+            m = @cache[parts[1]]
+            raise unless m
+            m.raw << orig
+            nil
+        end
+
+        #:swiftco.wa.us.dal.net 311 spox spox ~spox pool-96-225-201-176.ptldor.dsl-w.verizon.net * :spox
+        def process_311(string, orig)
+            m = mk_struct(orig)
+            m.raw = [orig]
+            m.type = :whois
+            parts = string.split
+            m.target = parts[1]
+            m.username = parts[2]
+            m.host = parts[3]
+            parts[5].slice!(0)
+            m.real_name = parts[5]
+            @cache[m.target] = m
+            nil
+        end
+        #:swiftco.wa.us.dal.net 319 spox spox :+#php #ruby #mysql @#mod_spox
+        def process_319(string, orig)
+            parts = string.split
+            parts.shift
+            m = @cache[parts.shift]
+            raise unless m
+            m.raw << orig
+            parts[0].slice!(0)
+            parts.each do |chan|
+                start = chan[0,1]
+                case start
+                when '+'
+                    chan.slice!(0)
+                    m.voice ||= []
+                    m.voice << chan
+                when '@'
+                    chan.slice!(0)
+                    m.ops ||= []
+                    m.ops << chan
+                end
+                m.channels ||= []
+                m.channels << chan
+            end
+            nil
+        end
+        #:swiftco.wa.us.dal.net 317 spox spox 529 1265393189 :seconds idle, signon time
+        def process_317(string, orig)
+            parts = string.split
+            parts.shift
+            m = @cache[parts.shift]
+            raise unless m
+            m.raw << orig
+            m.idle = parts.shift.to_i
+            m.signon = parts.shift.to_i
+            nil
+        end
+        #:swiftco.wa.us.dal.net 312 spox spox swiftco.wa.us.dal.net :www.swiftco.net - Swift Communications
+        def process_312(string, orig)
+            parts = string.split
+            parts.shift
+            m = @cache[parts.shift]
+            raise unless m
+            m.raw << orig
+            m.irc_host = parts.shift
+            nil
+        end
+        #:swiftco.wa.us.dal.net 307 spox spox :has identified for this nick
+        def process_307(string, orig)
+            parts = string.split
+            parts.shift
+            m = @cache[parts.shift]
+            raise unless m
+            m.nickserv = :identified
+            m.raw << orig
+            nil
+        end
+        #:wolfe.freenode.net 330 spox spox spox :is logged in as
+        def process_330(string, orig)
+            process_307(string, orig)
+        end
+        #:wolfe.freenode.net 318 spox spox :End of /WHOIS list.
+        def process_318(string, orig)
+            parts = string.split
+            parts.shift
+            target = parts.shift
+            m = @cache[target]
+            raise unless m
+            m.raw << orig
+            @cache.delete(target)
+            m
+        end
+    end
+end
+end

data/lib/messagefactory/handlers/352.rb

@@ -0,0 +1,99 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module MessageFactory
+module Handlers
+    class Who < Handler
+        def initialize
+            @cache = {}
+        end
+        def types_process
+            [:'352', :'315']
+        end
+        # string:: string to process
+        # Create a new Who message
+        # OpenStruct will contain:
+        # #type #direction #raw #received #source #channel #message
+        # :nodoc:   Nick style:
+        # :swiftco.wa.us.dal.net 352 spox * ~metallic codemunkey.net punch.va.us.dal.net metallic H :2 Sean Grimes
+        # :swiftco.wa.us.dal.net 315 spox metallic :End of /WHO list.
+        #           Channel style:
+        # :swiftco.wa.us.dal.net 352 spox #php ~chendo 24.47.233.220.static.exetel.com.au punch.va.us.dal.net chendo H@ :2 chendo
+        # :swiftco.wa.us.dal.net 315 spox #php :End of /WHO list.
+        def process(string)
+            string = string.dup
+            orig = string.dup
+            m = nil
+            begin
+                server = string.slice!(0, string.index(' '))
+                string.slice!(0)
+                action = string.slice!(0, string.index(' ')).to_sym
+                string.slice!(0)
+                string.slice!(0, string.index(' ')+1)
+                if(action == :'352')
+                    m = who_content(string, orig)
+                elsif(action == :'315')
+                    m = who_end(string, orig)
+                else
+                    raise
+                end
+            rescue
+                raise "Failed to parse Who message: #{orig}"
+            end
+            m
+        end
+
+        def who_content(string, orig)
+            name = string.slice!(0, string.index(' '))
+            string.slice!(0)
+            nick = OpenStruct.new
+            nick.username = string.slice!(0, string.index(' '))
+            string.slice!(0)
+            nick.host = string.slice!(0, string.index(' '))
+            string.slice!(0)
+            nick.irc_host = string.slice!(0, string.index(' '))
+            string.slice!(0)
+            nick.nick = string.slice!(0, string.index(' '))
+            string.slice!(0)
+            status = string.slice!(0, string.index(' '))
+            string.slice!(0, string.index(':')+1)
+            nick.hops = string.slice!(0, string.index(' ')).to_i
+            string.slice!(0)
+            nick.real_name = string
+            target = name == '*' ? nick.nick : name
+            m = fetch_target(target, orig, name != '*')
+            m.nicks << nick
+            m.ops.push nick if status.index('@')
+            m.voice.push nick if status.index('+')
+            m.raw << orig
+            nil
+        end
+
+        def fetch_target(target, orig, channel=true)
+            unless(@cache[target])
+                m = mk_struct(orig)
+                m.type = :who
+                m.raw = []
+                m.nicks = []
+                if(channel)
+                    m.ops = []
+                    m.voice = []
+                    m.channel = target
+                end
+                @cache[target] = m
+            end
+            @cache[target]
+        end
+
+        def who_end(string, orig)
+            name = string.slice!(0, string.index(' '))
+            m = @cache[name]
+            if(m)
+                @cache.delete(name)
+                m.raw << orig
+            end
+            m
+        end
+    end
+end
+end

data/lib/{handlers/Mode.rb → messagefactory/handlers/MODE.rb}

@@ -41,6 +41,7 @@ module Handlers
                     m.modes = string.slice!(0, string.index(' '))
                     string.slice!(0)
                     m.target = string
+                    m.nick_mode = Hash[m.target.split.zip(m.modes.split(''))]
                 end
             rescue
                 raise "Failed to parse Mode message: #{orig}"

data/lib/messagefactory/handlers/PING.rb

@@ -0,0 +1,41 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module MessageFactory
+module Handlers
+    class Ping < Handler
+        def types_process
+            :PING
+        end
+        # string:: string to process
+        # Create a new Ping message
+        # OpenStruct will contain:
+        # #type #direction #raw #received #server #message
+        # :nodoc: PING :not.configured
+        # :nodoc: :not.configured PING :test
+        def process(string)
+            string = string.dup
+            m = mk_struct(string)
+            begin
+                m.type = :ping
+                if(string.slice(0).chr == ':')
+                    string.slice!(0)
+                    m.server = string.slice!(0, string.index(' '))
+                    string.slice!(0)
+                    raise 'error' unless string.slice!(0, string.index(' ')).to_sym == :PING
+                    string.slice!(0, string.index(':')+1)
+                    m.message = string
+                else
+                    raise 'error' unless string.slice!(0, string.index(' ')).to_sym == :PING
+                    string.slice!(0, string.index(':')+1)
+                    m.server = string
+                    m.message = string
+                end
+            rescue
+                raise "Failed to parse Ping message: #{m.raw}"
+            end
+            m
+        end
+    end
+end
+end

data/lib/messagefactory/handlers/PONG.rb

@@ -0,0 +1,37 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module MessageFactory
+module Handlers
+    class Pong < Handler
+        def types_process
+            :PONG
+        end
+        # string:: string to process
+        # Create a new Ping message
+        # OpenStruct will contain:
+        # #type #direction #raw #received #server #message
+        # :nodoc: :swiftco.wa.us.dal.net PONG swiftco.wa.us.dal.net :FOO
+        def process(string)
+            string = string.dup
+            m = mk_struct(string)
+            begin
+                m.type = :pong
+                string.slice!(0)
+                m.server = string.slice!(0, string.index(' '))
+                string.slice!(0)
+                raise 'error' unless string.slice!(0, string.index(' ')).to_sym == :PONG
+                if(string.index(':'))
+                    string.slice!(0, string.index(':')+1)
+                    m.message = string
+                else
+                    m.message = ''
+                end
+            rescue
+                raise "Failed to parse Pong message: #{m.raw}"
+            end
+            m
+        end
+    end
+end
+end

data/lib/messagefactory/handlers/PRIVMSG.rb

@@ -0,0 +1,40 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module MessageFactory
+module Handlers
+    class Privmsg < Handler
+        def types_process
+            :PRIVMSG
+        end
+        # string:: string to process
+        # Create a new Privmsg message
+        # OpenStruct will contain:
+        # #type #direction #raw #received #source #target #message
+        # :nodoc: I thoguht about adding in #public and #private methods and
+        # something for the nick a message is addressing, but we want
+        # to keep this stuff simple, so we will let the implementation program
+        # worry about extras like that.
+        # :nodoc: :spox!~spox@host PRIVMSG #m :foobar
+        # :nodoc: :spox!~spox@host PRIVMSG mod_spox :foobar
+        def process(string)
+            string = string.dup
+            m = mk_struct(string)
+            begin
+                m.type = :privmsg
+                string.slice!(0)
+                m.source = string.slice!(0, string.index(' '))
+                string.slice!(0)
+                raise 'error' unless string.slice!(0, string.index(' ')).to_sym == :PRIVMSG
+                string.slice!(0)
+                m.target = string.slice!(0, string.index(' '))
+                string.slice!(0, string.index(':')+1)
+                m.message = string
+            rescue
+                raise "Failed to parse Privmsg message: #{m.raw}"
+            end
+            m
+        end
+    end
+end
+end

data/lib/messagefactory/handlers/QUIT.rb

@@ -0,0 +1,40 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module MessageFactory
+module Handlers
+    class Quit < Handler
+        def types_process
+            :QUIT
+        end
+        # string:: string to process
+        # Create a new Quit message
+        # OpenStruct will contain:
+        # #type #direction #raw #received #source #message
+        # :nodoc: :spox!~spox@host QUIT :Ping timeout
+        #         :spox!~spox@host QUIT :
+        def process(string)
+            string = string.dup
+            m = mk_struct(string)
+            begin
+                m.type = :quit
+                string.slice!(0)
+                m.source = string.slice!(0, string.index(' '))
+                string.slice!(0)
+                idx = string.index(' ')
+                idx ||= string.length
+                raise unless string.slice!(0, idx).to_sym == :QUIT
+                if(string.index(':'))
+                    string.slice!(0, string.index(':')+1)
+                    m.message = string
+                else
+                    m.message = ''
+                end
+            rescue
+                raise "Failed to parse Quit message: #{m.raw}"
+            end
+            m
+        end
+    end
+end
+end

data/lib/messagefactory/handlers/Raw.rb

@@ -0,0 +1,12 @@
+module Handlers
+    class Raw < Handler
+        def types_process
+            :UNKNOWN
+        end
+        def process(string)
+            m = mk_struct(string)
+            m.type = :raw
+            m
+        end
+    end
+end

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: messagefactory
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
-  - ""
+  - spox
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 Z
+date: 2010-04-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Your summary here
-email: ""
+description: Objectifies content from an IRC server
+email: spox@modspox.com
 executables: []
 
 extensions: []
@@ -26,23 +26,31 @@ files:
   - LICENSE
   - README.rdoc
   - Rakefile
-  - lib/Factory.rb
-  - lib/Handler.rb
-  - lib/handlers/Inviting.rb
-  - lib/handlers/Created.rb
-  - lib/handlers/Kick.rb
-  - lib/handlers/Nick.rb
-  - lib/handlers/Mode.rb
-  - lib/handlers/Names.rb
-  - lib/handlers/YourHost.rb
-  - lib/handlers/Join.rb
-  - lib/handlers/Invite.rb
-  - lib/handlers/Welcome.rb
-  - lib/handlers/Bounce.rb
-  - lib/handlers/BadNick.rb
-  - lib/handlers/LuserChannels.rb
-  - lib/handlers/Part.rb
-  - lib/handlers/Notice.rb
+  - lib/messagefactory.rb
+  - lib/messagefactory/Factory.rb
+  - lib/messagefactory/Handler.rb
+  - lib/messagefactory/handlers/001.rb
+  - lib/messagefactory/handlers/002.rb
+  - lib/messagefactory/handlers/003.rb
+  - lib/messagefactory/handlers/005.rb
+  - lib/messagefactory/handlers/254.rb
+  - lib/messagefactory/handlers/311.rb
+  - lib/messagefactory/handlers/341.rb
+  - lib/messagefactory/handlers/352.rb
+  - lib/messagefactory/handlers/353.rb
+  - lib/messagefactory/handlers/432.rb
+  - lib/messagefactory/handlers/INVITE.rb
+  - lib/messagefactory/handlers/JOIN.rb
+  - lib/messagefactory/handlers/KICK.rb
+  - lib/messagefactory/handlers/MODE.rb
+  - lib/messagefactory/handlers/NICK.rb
+  - lib/messagefactory/handlers/NOTICE.rb
+  - lib/messagefactory/handlers/PART.rb
+  - lib/messagefactory/handlers/PING.rb
+  - lib/messagefactory/handlers/PONG.rb
+  - lib/messagefactory/handlers/PRIVMSG.rb
+  - lib/messagefactory/handlers/QUIT.rb
+  - lib/messagefactory/handlers/Raw.rb
   - spec/dummy.rb
 has_rdoc: true
 homepage: 
@@ -57,7 +65,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.8.7
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
@@ -71,6 +79,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Your summary here
+summary: Objectifies content from an IRC server
 test_files: []