spox-processmailer 0.0.2

data/LICENSE

@@ -0,0 +1,165 @@
+           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.rdoc

@@ -0,0 +1,89 @@
+= Important note
+
+This library is in an alpha state and still being developed and tested
+
+= ProcessMailer
+
+The idea is simple. Mail data to processes.
+
+== What?
+
+The ProcessMailer mails data. To processes. (Oh, it also allows you to send data to hooks, which uses a thread pool and doesn't restrict memory access, but that's not the point of this library!) So, the better question might be, why? Well, for one, you can make things faster. See, what's great about this library is that you encapsulate your logic in little processes that have been forked. Data is then packaged up and sent to these processes where the processes can then do what ever they please to that piece of data. This simple design, though some what more complicated in use, allows you to make use of multiple cpus/cores where using something like a thread pool would keep you limited to a single core.
+
+== How does it work?
+
+Well, the general overview is something like this:
+
+    Main<||>---------PostOffice<>----------*Postbox
+
+In crappy, texty, UMLy fashion, what we have is a Main program composed of a PostOffice. That PostOffice has an aggregation of zero or more Postboxes it knows about. That's the basic structure.
+
+== How about an example?
+
+Sure, lets make something simple. We will start out using blocks:
+
+    require 'processmailer'
+    
+    po = ProcessMailer::PostOffice.new
+    po.register{|a| puts "Decrement: #{a}"; a -= 1; a}
+    po.register{|a| puts "Increment: #{a}"; a += 1; a}
+
+    po.deliver(1)
+    sleep(2)
+    po.clean
+
+First, we create our PostOffice. Next, we register two Postboxes using blocks. The argument is the Object that will be delivered via the PostOffice. After registering two Postboxes, we deliver a Fixnum. The PostOffice delivers messages to registered Postboxes using a thread pool, so our main line of execution will continue. So, lets sleep for a couple seconds to see some output generated. Finally, we clean the PostOffice which removes all registered Postboxes.
+
+== Blocks suck
+
+Well, not really, but they can be a bit restrictive. For something a little more robust, we create a class that's a subclass of Postbox, and let it do the work:
+
+    require 'processmailer'
+
+    class Test < ProcessMailer::Postbox
+        def initialize(args)
+            super
+            @foo = 2
+        end
+        def process(obj)
+            puts "Decrement: #{obj}"
+            obj -= @foo
+        end
+    end
+
+    po = ProcessMailer::PostOffice.new
+    po.register(Test)
+    po.register{|a| puts "Increment: #{a}"; a += 1; a}
+
+    po.deliver(1)
+    sleep(2)
+    po.clean
+
+This is doing the same basic thing we did in the blocks. The Test class is simply a subclass of Postbox, and the process method is overridden to do the grunt work. The reason we send in a Class type, and not the instantiated object, is to allow the PostOffice to do the proper creation and forking. That's pretty much it.
+
+== One last thing
+
+The result of the process method or block for a given Postbox will be returned to the PostOffice for delivery. That is why the examples run
+continuously. Returning a nil value will stop delivery. This means that the example below will only output two lines:
+
+    require 'processmailer'
+
+    po = ProcessMailer::PostOffice.new
+    po.register{|a| puts "Decrement: #{a}"; nil}
+    po.register{|a| puts "Increment: #{a}"; nil}
+
+    po.deliver(1)
+    sleep(2)
+    po.clean
+
+
+== ASCII Representation:
+
+                [PostOffice]------[message]---->[Postbox]
+                      ^                             |
+                      -----------[return val]-------'
+                      
+== Informations
+
+    Author: spox <spox@modspox.com>
+    License: LGPLv3

data/lib/processmailer.rb

@@ -0,0 +1 @@
+require 'processmailer/PostOffice'

data/lib/processmailer/Actions.rb

@@ -0,0 +1,8 @@
+module ProcessMailer
+    module Actions
+        class Unregister
+        end
+        class Register
+        end
+    end
+end

data/lib/processmailer/Exceptions.rb

@@ -0,0 +1,22 @@
+module ProcessMailer
+    module Exceptions
+        class InvalidType < Exception
+            attr_reader :expected
+            attr_reader :received
+            def initialize(e,r)
+                @expected = e
+                @received = r
+            end
+            def to_s
+                "Expected type: #{e}. Received type: #{r}"
+            end
+        end
+        class EmptyParameters < Exception
+            def to_s
+                'Parameters passed are empty'
+            end
+        end
+        class Resync < Exception
+        end
+    end
+end

data/lib/processmailer/LogHelper.rb

@@ -0,0 +1,32 @@
+require 'logger'
+
+module ProcessMailer
+
+    class LogHelper
+    
+        def initialize(logger=nil)
+            @logger = logger
+        end
+
+        def info(m)
+            @logger.info(m) unless @logger.nil?
+        end
+
+        def warn(m)
+            @logger.warn(m) unless @logger.nil?
+        end
+
+        def fatal(m)
+            @logger.fatal(m) unless @logger.nil?
+        end
+
+        def error(m)
+            @logger.error(m) unless @logger.nil?
+        end
+
+        def raw
+            return @logger
+        end
+    end
+
+end

data/lib/processmailer/PostOffice.rb

@@ -0,0 +1,175 @@
+require 'actionpool'
+require 'processmailer/Postbox'
+require 'processmailer/Exceptions'
+require 'processmailer/LogHelper'
+
+module ProcessMailer
+    # The PostOffice is the driver of the
+    # process mailer. Its job is to accept
+    # objects which are then passed off to
+    # each Postbox, which may or may not process
+    # the object. Messages returned to the 
+    # PostOffice by a Postbox will then be
+    # sent to any proc that has hooked into
+    # the type.
+    class PostOffice
+        # args:: setup hash
+        # :max_threads:: default number of threads per Postbox
+        # :min_threads:: minimum number of threads per Postbox
+        # :thread_to:: maximum time thread is allowed to idle
+        # :action_to:: maximum time a thread may work on an action
+        # :logger:: Logger to use
+        # :pool:: ActionPool for PostOffice to utilize (not used by Postboxes)
+        # Sets up a PostOffice to handle message delivery.
+        def initialize(args={})
+            default_args(args)
+            @max_workers = args[:max_threads]
+            @min_workers = args[:min_threads]
+            @logger = LogHelper.new(args[:logger])
+            @thread_to = args[:thread_to]
+            @action_to = args[:action_to]
+            @postboxes = {} # {PID => {:read => rd, :write => wr}}
+            @hooks = {} # {Some::Class => []}
+            @readers = []
+            @close_postoffice = false
+            @processor = Thread.new{listen}
+            @pool = args[:pool] ? args[:pool] : nil
+        end
+        # obj:: Serializable object for delivery
+        # Delivers object to Postboxes for processing
+        def deliver(obj)
+            s = [Marshal.dump(obj)].pack('m')
+            @postboxes.each_value{|pipes| pipes[:write].puts s}
+            call_hooks(obj)
+        end
+        # pb:: Class name of custom Postbox
+        # Registers a new Postbox with the PostOffice. Returns Postbox process ID
+        def register(pb=nil, &block)
+            raise Exceptions::InvalidType.new(Class, pb.class) unless pb.nil? || pb.is_a?(Class)
+            raise Exceptions::EmptyParameters.new if pb.nil? && !block_given?
+            r,w = IO.pipe
+            pid = nil
+            if(block_given?)
+                pid = Kernel.fork do
+                    box = Postbox.new(:proc => block, :read_pipe => r, :write_pipe => w, :max_threads => @max_workers,
+                                      :min_threads => @min_workers, :thread_to => @thread_to, :action_to => @action_to,
+                                      :logger => @logger.raw)
+                    Signal.trap('HUP'){ box.close }
+                    box.listen
+                end
+            else
+                pid = Kernel.fork do
+                    box = pb.new(:read_pipe => r, :write_pipe => w, :max_threads => @max_workers,
+                                 :min_threads => @min_workers, :thread_to => @thread_to,
+                                 :action_to => @action_to, :logger => @logger.raw)
+                    Signal.trap('HUP'){ box.close }
+                    box.listen
+                end
+            end
+            if(pid)
+                @postboxes[pid] = {:read => r, :write => w}
+                @readers << r
+                @processor.raise Exceptions::Resync.new
+                return pid
+            end
+        end
+        # pid:: Postbox delivery address (Process ID)
+        # Removes a Postbox from the PostOffice
+        def unregister(pid)
+            pid = pid.to_i
+            raise Exception.new('Failed to locate process') unless @postboxes.has_key?(pid)
+            pipes = @postboxes.delete(pid)
+            Process.kill('HUP', pid)
+            @readers.delete(pipes[:read])
+            @processor.raise Exceptions::Resync.new
+            pipes[:write].puts "stop"
+            Process.waitpid(pid)
+        end
+        # c:: Class
+        # action:: callable block (Proc/lambda)
+        # block:: code block
+        # Add a hook to a given object type. When
+        # the PostOffice receives the object, the
+        # block will be called. Return an ID to be
+        # used when unhooking
+        # 
+        # Example:
+        #   po.hook(Array){|obj| puts obj.join(', ')}
+        def hook(c, action=nil, &block)
+            b = action.nil? ? block : action
+            raise Exceptions::EmptyParameters.new if b.nil?
+            raise Exceptions::InvalidType.new(Class, c.class) unless c.is_a?(Class)
+            @hooks[c] = Array.new unless @hooks[c]
+            @hooks[c] << b
+            @pool = ActionPool::Pool.new(1, 5, nil, nil, @logger.raw) if @pool.nil?
+            return @hooks[c].index(b)
+        end
+        # c:: Class
+        # hid:: ID from hook()
+        # Unhook a block from object delivery
+        def unhook(c, hid)
+            raise Exceptions::EmptyParameters.new unless c.is_a?(Class)
+            raise Exceptions::EmptyParameters.new unless hid.is_a?(Integer)
+            @hooks[c].delete_at(hid)
+            @hooks.delete(c) if @hooks[c].empty?
+        end
+
+        # Returns hash of hooks currently in the PostOffice
+        def hooks
+            @hooks
+        end
+
+        # Returns hash of PostBoxes currently in the PostOffice
+        def postboxes
+            @postboxes
+        end
+        # Stop all processes
+        def clean
+            @postboxes.each_key{|k| unregister(k)}
+        end
+        private
+        def listen
+            until(@close_postoffice) do
+                begin
+                    s = Kernel.select(@readers, nil, nil, nil)
+                    for sock in s[0] do
+                        if(sock.closed?)
+                            close_on_socket(sock)
+                        else
+                            string = sock.gets
+                            deliver(Marshal.load(string.unpack('m')[0])) unless string.nil?
+                        end
+                    end
+                rescue Exceptions::Resync
+                    # resync sockets #
+                rescue Object => boom
+                    @logger.error("PostOffice error encountered reading message: #{boom}")
+                end
+            end
+        end
+        def call_hooks(obj)
+            obj.class.ancestors.each do |klass|
+                if(@hooks[klass])
+                    @hooks[klass].each do |hook|
+                        @pool.process do
+                            result = nil
+                            begin
+                                result = hook.call(obj)
+                            rescue Object => boom
+                                @logger.warn("Hook generated an error: #{boom}")
+                                result = boom
+                            ensure
+                                deliver(result) unless result.nil?
+                            end
+                        end
+                    end
+                end
+            end
+        end
+        def default_args(args)
+            {:max_threads => 5, :min_threads => 1, :thread_to => nil, :action_to => nil, :logger => nil}.each_pair{|k,v|
+                args[k] = v unless args.has_key?(k)
+            }
+        end
+    end
+end

data/lib/processmailer/Postbox.rb

@@ -0,0 +1,91 @@
+require 'actionpool'
+require 'processmailer/Exceptions'
+require 'processmailer/LogHelper'
+
+module ProcessMailer
+    class Postbox
+        # Initialize the Postbox. Subclasses should
+        # super(), preferably first thing
+        def initialize(args)
+            default_args(args)
+            @pipes = {:read => args[:read_pipe], :write => args[:write_pipe]}
+            @proc = args[:proc] ? args[:proc] : lambda{nil}
+            @pool = ActionPool::Pool.new(args[:min_threads], args[:max_threads], args[:thread_to], args[:action_to], args[:logger])
+            @logger = LogHelper.new(args[:logger])
+            @stop = false
+        end
+        # Close the postbox for delivery
+        def close
+            @stop = true
+        end
+        # read:: read IO.pipe
+        # write:: write IO.pipe
+        # Install pipes for Postbox (Generally
+        # used by the PostOffice)
+        def install_pipe(read, write)
+            @pipes[:read] = read
+            @pipes[:write] = write
+        end
+        # obj:: object to be processed
+        # Process an object. This method should
+        # be overridden in subclasses.
+        def process(obj)
+            return @proc.call(obj)
+        end
+        # Listen for incoming messages from PostOffice
+        def listen
+            until(@stop) do
+                begin
+                    Kernel.select([@pipes[:read]], nil, nil, nil)
+                    receive
+                rescue Exceptions::Resync
+                    # resync sockets #
+                rescue Object => boom
+                    @logger.error("Postbox encountered error on listen: #{boom}")
+                end
+            end
+        end
+        private
+        def receive
+            @logger.info("Postbox (#{self}) has message waiting")
+            begin
+                s = @pipes[:read].gets
+                @logger.info("Postbox (#{self}) received an empty message") if s.nil? || s.empty?
+                return if s.nil? || s.empty?
+                if(s.strip == 'stop')
+                    @logger.info("Postbox (#{self}) received a stop instruction")
+                    return
+                end
+                @logger.info("Postbox (#{self}) message: #{s}")
+                obj = s.size > 0 ? Marshal.load(s.unpack('m')[0]) : nil
+                @logger.info("Postbox (#{self}) message reconstructed: #{obj}")
+                run_process(obj)
+            rescue Object => boom
+                @logger.error("Postbox encountered error on receive: #{boom}")
+            end
+            
+        end
+        def send(obj)
+            return if obj.nil?
+            @pipes[:write].puts [Marshal.dump(obj)].pack('m')
+        end
+        def run_process(obj)
+            @pool.process do
+                result = nil
+                begin
+                    result = process(obj)
+                rescue Object => boom
+                    @logger.warn("Postbox contents generated exception on call: #{boom}")
+                    result = boom
+                end
+                send(result)
+            end
+        end
+        def default_args(args)
+            {:read_pipe => nil, :write_pipe => nil, :proc => nil, :max_threads => 5,
+             :min_threads => 1, :thread_to => nil, :action_to => nil, :logger => nil}.each_pair{|k,v|
+                args[k] = v unless args.has_key?(k)
+            }
+        end
+    end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: spox-processmailer
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- spox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ActionPool
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ProcessMailer for concurrent data processing
+email: spox@modspox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- LICENSE
+- lib/processmailer.rb
+- lib/processmailer/Actions.rb
+- lib/processmailer/Exceptions.rb
+- lib/processmailer/LogHelper.rb
+- lib/processmailer/Postbox.rb
+- lib/processmailer/PostOffice.rb
+has_rdoc: true
+homepage: http://github.com/spox/processmailer
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --title
+- ProcessMailer
+- --main
+- README.rdoc
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Process Post Office
+test_files: []
+