spockets 0.0.4 → 0.0.5

data/CHANGELOG

@@ -0,0 +1,8 @@
+0.0.5
+
+    * Added a delete alias
+    * Added an on_close method to set an action
+        to run when a closed socket is detected
+    * Added an include? method to check if a socket
+        is currently being watched
+    * Added clear method to remove all sockets

data/README

@@ -23,8 +23,16 @@ cd spockets
 gem build spockets.gemspec
 gem install spockets-x.x.x.gem
 
-It has RDocs. They are where ever your rubygems installed them.
-They will probably be helpful to look over.
+It has RDocs. They are short, but will be helpful and you
+should really consider giving them a look. If you want to
+view them online, you can see them here:
+
+http://dev.modspox.com/~sine/spockets
+
+There is also a trac site. It has examples as well as
+a bug tracker. It's located at:
+
+http://dev.modspox.com/trac/spockets
 
 Examples are usually helpful, so here we go:
 

data/README~

@@ -14,7 +14,7 @@ action can stay in one local pool.
 
 install (easy):
 
-gem install --source gems.github.com spockets
+gem install spockets
 
 install (less easy):
 
@@ -24,4 +24,50 @@ gem build spockets.gemspec
 gem install spockets-x.x.x.gem
 
 It has RDocs. They are where ever your rubygems installed them.
-They will probably be helpful to look over.
+They will probably be helpful to look over.
+
+Examples are usually helpful, so here we go:
+
+Code:
+
+require 'socket'
+require 'spockets'
+spockets = Spockets::Spockets.new
+
+se = TCPServer.new(3000)
+loop do
+    s = se.accept
+    puts "Socket: #{s}"
+    spockets.add(s){|string| puts "#{s}: #{string}" }
+end
+sleep
+
+
+Connecting:
+
+> telnet 192.168.0.95 3000
+Trying 192.168.0.95...
+Connected to 192.168.0.95.
+Escape character is '^]'.
+goodbyeworld
+^]
+telnet> quit
+Connection closed.
+
+> telnet 192.168.0.95 3000
+Trying 192.168.0.95...
+Connected to 192.168.0.95.
+Escape character is '^]'.
+foobar
+complete
+^]
+telnet> quit
+Connection closed.
+
+Output:
+
+Socket: #<TCPSocket:0x98ec5ac>
+Socket: #<TCPSocket:0x98ec37c>
+#<TCPSocket:0x98ec37c>: foobar
+#<TCPSocket:0x98ec5ac>: goodbyeworld
+#<TCPSocket:0x98ec37c>: complete

data/lib/spockets/Spockets.rb

@@ -21,7 +21,8 @@ module Spockets
         # for processing
         def add(socket, &block)
             raise DuplicateSocket.new(socket) if @sockets.has_key?(socket)
-            @sockets[socket] = [block]
+            @sockets[socket] = {}
+            @sockets[socket][:procs] = [block]
             begin
                 @watcher.sync
             rescue NotRunning
@@ -35,7 +36,7 @@ module Spockets
         # socket to be executed when a new string is received
         def extra(socket, &block)
             raise UnknownSocket.new(socket) unless @sockets.has_key?(socket)
-            @sockets[socket] << block
+            @sockets[socket][:procs] << block
         end
 
         # socket:: socket to remove
@@ -50,6 +51,15 @@ module Spockets
             end
         end
         
+        # socket:: socket to add close action
+        # block:: action to perform on socket close
+        # Executes block when socket has been closed. Ideal
+        # for reconnection needs
+        def on_close(socket, &block)
+            raise UnknownSocket.new(socket) unless @sockets.has_key?(socket)
+            @sockets[socket][:closed] = block
+        end
+        
         # remove all sockets
         def clear
             @sockets.clear

data/lib/spockets/Spockets.rb~

@@ -5,8 +5,6 @@ module Spockets
 
     class Spockets
 
-        alias :delete :remove
-
         # :pool:: ActionPool if you would like to consolidate
         # :clean:: Clean string. Set to true for default or 
         #          provide a block to clean strings
@@ -23,7 +21,7 @@ module Spockets
         # for processing
         def add(socket, &block)
             raise DuplicateSocket.new(socket) if @sockets.has_key?(socket)
-            @sockets[socket] = [block]
+            @sockets[socket][:procs] = [block]
             begin
                 @watcher.sync
             rescue NotRunning
@@ -37,7 +35,7 @@ module Spockets
         # socket to be executed when a new string is received
         def extra(socket, &block)
             raise UnknownSocket.new(socket) unless @sockets.has_key?(socket)
-            @sockets[socket] << block
+            @sockets[socket][:procs] << block
         end
 
         # socket:: socket to remove
@@ -52,6 +50,15 @@ module Spockets
             end
         end
         
+        # socket:: socket to add close action
+        # block:: action to perform on socket close
+        # Executes block when socket has been closed. Ideal
+        # for reconnection needs
+        def on_close(socket, &block)
+            raise UnknownSocket.new(socket) unless @sockets.has_key?(socket)
+            @sockets[socket][:closed] = block
+        end
+        
         # remove all sockets
         def clear
             @sockets.clear
@@ -81,6 +88,8 @@ module Spockets
             @sockets.has_key?(socket)
         end
         
+        alias :delete :remove
+        
     end
 
 end

data/lib/spockets/Watcher.rb

@@ -31,7 +31,7 @@ module Spockets
             @runner.join(0.1)
             @runner.raise Resync.new
             @runner.join(0.1)
-            @runner.kill unless @runner.alive?
+            @runner.kill unless @runner.nil? || @runner.alive?
             @runner = nil
         end
 
@@ -56,15 +56,15 @@ module Spockets
         def watch
             until(@stop)
                 begin
-                puts 'we are watching'
                     resultset = Kernel.select(@sockets.keys, nil, nil, nil)
                     for sock in resultset[0]
                         string = sock.gets
                         if(sock.closed? || string.nil?)
+                            @sockets[sock][:closed].call(sock) if @sockets[sock].has_key?(:closed)
                             @sockets.delete(sock)
                         else
                             string = clean? ? do_clean(string) : string
-                            @sockets[sock].each{|b| @pool.process{ b.call(string)}}
+                            @sockets[sock][:procs].each{|b| @pool.process{ b.call(string)}}
                         end
                     end
                 rescue Resync

data/lib/spockets/Watcher.rb~

@@ -0,0 +1,89 @@
+require 'actionpool'
+require 'actionpool/Exceptions'
+require 'iconv'
+
+module Spockets
+    class Watcher
+
+        # :sockets:: socket list
+        # :clean:: clean UTF8 strings or provide block to run on every read string
+        # :pool:: ActionPool to use
+        # Creates a new watcher for sockets
+        def initialize(args)
+            raise MissingArgument.new(:sockets) unless args[:sockets]
+            @sockets = args[:sockets]
+            @runner = nil
+            @clean = args[:clean] && (args[:clean].is_a?(Proc) || args[:clean].is_a?(TrueClass)) ? args[:clean] : nil
+            @pool = args[:pool] && args[:pool].is_a?(ActionPool::Pool) ? args[:pool] : ActionPool::Pool.new
+            @ic = @clean && @clean.is_a?(TrueClass) ? Iconv.new('UTF-8//IGNORE', 'UTF-8') : nil
+            @stop = true
+        end
+
+        # start the watcher
+        def start
+            @stop = false
+            @runner = Thread.new{watch} if @runner.nil? && @sockets.size > 0
+        end
+
+        # stop the watcher
+        def stop
+            @stop = true
+            @runner.join(0.1)
+            @runner.raise Resync.new
+            @runner.join(0.1)
+            @runner.kill unless @runner.alive?
+            @runner = nil
+        end
+
+        # is the watcher running?
+        def running?
+            !@stop
+        end
+        
+        # clean incoming strings
+        def clean?
+            @clean
+        end
+
+        # Ensure all sockets are being listened to
+        def sync
+            raise NotRunning.new if @runner.nil?
+            @runner.raise Resync.new
+        end
+        
+        private
+        
+        def watch
+            until(@stop)
+                begin
+                    resultset = Kernel.select(@sockets.keys, nil, nil, nil)
+                    for sock in resultset[0]
+                        string = sock.gets
+                        if(sock.closed? || string.nil?)
+                            @sockets[sock][:closed].call(sock) if @sockets[sock].has_key?(:closed)
+                            @sockets.delete(sock)
+                        else
+                            string = clean? ? do_clean(string) : string
+                            @sockets[sock][:procs].each{|b| @pool.process{ b.call(string)}}
+                        end
+                    end
+                rescue Resync
+                    # break select and relisten #
+                end
+            end
+            @runner = nil
+        end
+
+        def do_clean(string)
+            unless(@ic.nil?)
+                return untaint(string)
+            else
+                return @clean.call(string)
+            end
+        end
+        
+        def untaint(s)
+            @ic.iconv(s + ' ')[0..-2]
+        end
+    end
+end

data/spockets.gemspec

@@ -2,7 +2,7 @@ spec = Gem::Specification.new do |s|
     s.name              = 'spockets'
     s.author            = %q(spox)
     s.email             = %q(spox@modspox.com)
-    s.version           = '0.0.4'
+    s.version           = '0.0.5'
     s.summary           = %q(Socket Helper)
     s.platform          = Gem::Platform::RUBY
     s.has_rdoc          = true
@@ -13,4 +13,12 @@ spec = Gem::Specification.new do |s|
     s.add_dependency 'ActionPool'
     s.homepage          = %q(http://dev.modspox.com/trac/spockets)
     description         = []
+    File.open("README") do |file|
+        file.each do |line|
+            line.chomp!
+            break if line.empty?
+            description << "#{line.gsub(/\[\d\]/, '')}"
+        end
+    end
+    s.description = description[1..-1].join(" ")
 end

data/spockets.gemspec~

@@ -2,7 +2,7 @@ spec = Gem::Specification.new do |s|
     s.name              = 'spockets'
     s.author            = %q(spox)
     s.email             = %q(spox@modspox.com)
-    s.version           = '0.0.3'
+    s.version           = '0.0.4'
     s.summary           = %q(Socket Helper)
     s.platform          = Gem::Platform::RUBY
     s.has_rdoc          = true
@@ -13,4 +13,12 @@ spec = Gem::Specification.new do |s|
     s.add_dependency 'ActionPool'
     s.homepage          = %q(http://dev.modspox.com/trac/spockets)
     description         = []
+    File.open("README") do |file|
+        file.each do |line|
+            line.chomp!
+            break if line.empty?
+            description << "#{line.gsub(/\[\d\]/, '')}"
+        end
+    end
+    s.description = description[1..-1].join(" ")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spockets
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - spox
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-24 00:00:00 -07:00
+date: 2009-04-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: 
+description: ""
 email: spox@modspox.com
 executables: []
 
@@ -36,14 +36,18 @@ files:
 - spockets.gemspec~
 - spockets-0.0.3.gem
 - spockets.gemspec
+- CHANGELOG~
 - lib
 - lib/spockets
 - lib/spockets/Spockets.rb~
+- lib/spockets/Watcher.rb~
 - lib/spockets/Exceptions.rb
 - lib/spockets/Watcher.rb
 - lib/spockets/Spockets.rb
 - lib/spockets.rb
+- CHANGELOG
 - LICENSE
+- spockets-0.0.4.gem
 - spockets-0.0.2.gem
 has_rdoc: true
 homepage: http://dev.modspox.com/trac/spockets