spockets 0.0.5 → 0.0.6

data/CHANGELOG

@@ -1,3 +1,6 @@
+0.0.6
+    * Fixed bug exposed when extremely fast input
+      is received.
 0.0.5
 
     * Added a delete alias

data/README.rdoc

@@ -0,0 +1,86 @@
+== Spockets ==
+
+Spockets is a simple library for dealing with multiple sockets.
+You supply a socket, and one or more blocks to
+execute, and Spockets will make sure those blocks get
+executed when something comes in over the wire. It's just
+that simple.
+
+There is one requirement for spockets and that is the ActionPool.
+This just allows spockets to use a thread pool for executing
+blocks so you don't end up having to wait on slow blocks. You
+can even provide your own pool for spockets to use, so all the
+action can stay in one local pool.
+
+install (stable):
+
+    gem install spockets
+
+install (unstable):
+
+    gem sources -a http://gems.github.com
+    gem install spox-spockets
+
+or
+
+    git clone http://github.com/spox/spockets.git
+    cd spockets
+    gem build spockets.gemspec
+    gem install ./
+
+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:
+
+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/Watcher.rb

@@ -64,7 +64,7 @@ module Spockets
                             @sockets.delete(sock)
                         else
                             string = clean? ? do_clean(string) : string
-                            @sockets[sock][:procs].each{|b| @pool.process{ b.call(string)}}
+                            process(string.dup, sock)
                         end
                     end
                 rescue Resync
@@ -74,6 +74,10 @@ module Spockets
             @runner = nil
         end
 
+        def process(string, sock)
+            @sockets[sock][:procs].each{|b| @pool.process{ b.call(string)}}
+        end
+
         def do_clean(string)
             unless(@ic.nil?)
                 return untaint(string)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spockets
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - spox
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-25 00:00:00 -07:00
+date: 2009-06-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,33 +22,21 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: ""
+description: Socket helper library
 email: spox@modspox.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
-- README
-- README~
-- spockets.gemspec~
-- spockets-0.0.3.gem
-- spockets.gemspec
-- CHANGELOG~
-- lib
-- lib/spockets
-- lib/spockets/Spockets.rb~
-- lib/spockets/Watcher.rb~
+- README.rdoc
+- CHANGELOG
+- lib/spockets.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
+- lib/spockets/Watcher.rb
 has_rdoc: true
 homepage: http://dev.modspox.com/trac/spockets
 post_install_message: 
@@ -56,7 +44,7 @@ rdoc_options:
 - --title
 - Spockets
 - --main
-- README
+- README.rdoc
 - --line-numbers
 require_paths: 
 - lib

data/LICENSE

@@ -1,165 +0,0 @@
-           GNU LESSER GENERAL PUBLIC LICENSE
-                Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.

data/README

@@ -1,81 +0,0 @@
-== Spockets ==
-
-Spockets is a simple library for dealing with multiple sockets.
-You supply a socket, and one or more blocks to
-execute, and Spockets will make sure those blocks get
-executed when something comes in over the wire. It's just
-that simple.
-
-There is one requirement for spockets and that is the ActionPool.
-This just allows spockets to use a thread pool for executing
-blocks so you don't end up having to wait on slow blocks. You
-can even provide your own pool for spockets to use, so all the
-action can stay in one local pool.
-
-install (easy):
-
-gem install spockets
-
-install (less easy):
-
-git clone http://github.com/spox/spockets.git
-cd spockets
-gem build spockets.gemspec
-gem install spockets-x.x.x.gem
-
-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:
-
-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/README~

@@ -1,73 +0,0 @@
-== Spockets ==
-
-Spockets is a simple library for dealing with multiple sockets.
-You supply a socket, and one or more blocks to
-execute, and Spockets will make sure those blocks get
-executed when something comes in over the wire. It's just
-that simple.
-
-There is one requirement for spockets and that is the ActionPool.
-This just allows spockets to use a thread pool for executing
-blocks so you don't end up having to wait on slow blocks. You
-can even provide your own pool for spockets to use, so all the
-action can stay in one local pool.
-
-install (easy):
-
-gem install spockets
-
-install (less easy):
-
-git clone http://github.com/spox/spockets.git
-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.
-
-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~

@@ -1,95 +0,0 @@
-require 'spockets/Exceptions'
-require 'spockets/Watcher'
-
-module Spockets
-
-    class Spockets
-
-        # :pool:: ActionPool if you would like to consolidate
-        # :clean:: Clean string. Set to true for default or 
-        #          provide a block to clean strings
-        # creates a new holder
-        def initialize(args={})
-            @sockets = {}
-            @watcher = Watcher.new(:sockets => @sockets, :clean => args[:clean], :pool => args[:pool])
-        end
-
-        # socket:: socket to listen to
-        # block:: block to execute when activity is received
-        # Adds a socket to the list to listen to. When a string
-        # is received on the socket, it will send it to the block
-        # for processing
-        def add(socket, &block)
-            raise DuplicateSocket.new(socket) if @sockets.has_key?(socket)
-            @sockets[socket][:procs] = [block]
-            begin
-                @watcher.sync
-            rescue NotRunning
-                start
-            end
-        end
-
-        # socket:: socket in list
-        # block:: additional block to execute
-        # This will add additional blocks to the associated
-        # 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][:procs] << block
-        end
-
-        # socket:: socket to remove
-        # Removes socket from list
-        def remove(socket)
-            raise UnknownSocket.new(socket) unless @sockets.has_key?(socket)
-            @sockets.delete(socket)
-            begin
-                @watcher.sync
-            rescue NotRunning
-                start
-            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
-            stop
-        end
-
-        # start spockets
-        def start
-            raise AlreadyRunning.new if @watcher.running?
-            @watcher.start
-        end
-
-        # stop spockets
-        def stop
-            raise NotRunning.new unless @watcher.running?
-            @watcher.stop
-        end
-
-        # currently watching sockets
-        def running?
-            !@watcher.nil? && @watcher.running?
-        end
-        
-        # socket:: a socket
-        # check if the given socket is being watched
-        def include?(socket)
-            @sockets.has_key?(socket)
-        end
-        
-        alias :delete :remove
-        
-    end
-
-end

data/lib/spockets/Watcher.rb~

@@ -1,89 +0,0 @@
-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

@@ -1,24 +0,0 @@
-spec = Gem::Specification.new do |s|
-    s.name              = 'spockets'
-    s.author            = %q(spox)
-    s.email             = %q(spox@modspox.com)
-    s.version           = '0.0.5'
-    s.summary           = %q(Socket Helper)
-    s.platform          = Gem::Platform::RUBY
-    s.has_rdoc          = true
-    s.rdoc_options      = %w(--title Spockets --main README --line-numbers)
-    s.extra_rdoc_files  = %w(README)
-    s.files             = Dir['**/*']
-    s.require_paths     = %w(lib)
-    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~

@@ -1,24 +0,0 @@
-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.summary           = %q(Socket Helper)
-    s.platform          = Gem::Platform::RUBY
-    s.has_rdoc          = true
-    s.rdoc_options      = %w(--title Spockets --main README --line-numbers)
-    s.extra_rdoc_files  = %w(README)
-    s.files             = Dir['**/*']
-    s.require_paths     = %w(lib)
-    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