ruote-beanstalk 2.1.10 → 2.1.11

data/lib/ruote/beanstalk/participant.rb

@@ -1,147 +1,3 @@
-#--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# Made in Japan.
-#++
 
-require 'beanstalk-client'
-
-#require 'ruote/part/local_participant'
-
-
-module Ruote
-module Beanstalk
-
-  #
-  # This participant emits workitems towards a beanstalk queue.
-  #
-  #   engine.register_participant(
-  #     :heavy_labour,
-  #     :reply_by_default => true, :beanstalk => '127.0.0.1:11300')
-  #
-  #
-  # == workitem format
-  #
-  # Workitems are encoded in the format
-  #
-  #   [ 'workitem', workitem.to_h ]
-  #
-  # and then serialized as JSON strings.
-  #
-  #
-  # == cancel items
-  #
-  # Like workitems, but the format is
-  #
-  #   [ 'cancelitem', fei.to_h, flavour.to_s ]
-  #
-  # where fei is the FlowExpressionId of the expression getting cancelled
-  # (and whose workitems are to be retired) and flavour is either 'cancel' or
-  # 'kill'.
-  #
-  #
-  # == extending this participant
-  #
-  # Extend and overwrite encode_workitem and encode_cancelitem or
-  # simply re-open the class and change those methods.
-  #
-  #
-  # == :beanstalk
-  #
-  # Indicates which beanstalk to talk to
-  #
-  #   engine.register_participant(
-  #     'alice'
-  #     Ruote::Beanstalk::BsParticipant,
-  #     'beanstalk' => '127.0.0.1:11300')
-  #
-  #
-  # == :tube
-  #
-  # Most of the time, you want the workitems (or the cancelitems) to be
-  # emitted over/in a specific tube
-  #
-  #   engine.register_participant(
-  #     'alice'
-  #     Ruote::Beanstalk::BsParticipant,
-  #     'beanstalk' => '127.0.0.1:11300',
-  #     'tube' => 'ruote-workitems')
-  #
-  #
-  # == :reply_by_default
-  #
-  # If the participant is configured with 'reply_by_default' => true, the
-  # participant will dispatch the workitem over to Beanstalk and then
-  # immediately reply to its ruote engine (letting the flow resume).
-  #
-  #   engine.register_participant(
-  #     'alice'
-  #     Ruote::Beanstalk::BsParticipant,
-  #     'beanstalk' => '127.0.0.1:11300',
-  #     'reply_by_default' => true)
-  #
-  class BsParticipant
-
-    include Ruote::LocalParticipant
-
-    def initialize (opts)
-
-      @opts = opts
-    end
-
-    def consume (workitem)
-
-      connection.put(encode_workitem(workitem))
-
-      reply(workitem) if @opts['reply_by_default']
-    end
-
-    def cancel (fei, flavour)
-
-      connection.put(encode_cancelitem(fei, flavour))
-    end
-
-    def encode_workitem (workitem)
-
-      Rufus::Json.encode([ 'workitem', workitem.to_h ])
-    end
-
-    def encode_cancelitem (fei, flavour)
-
-      Rufus::Json.encode([ 'cancelitem', fei.to_h, flavour.to_s ])
-    end
-
-    protected
-
-    def connection
-
-      con = ::Beanstalk::Connection.new(@opts['beanstalk'])
-
-      if tube = @opts['tube']
-        con.use(tube)
-      end
-
-      con
-    end
-  end
-end
-end
+require 'ruote/beanstalk/participant_proxy'
 

data/lib/ruote/beanstalk/participant_proxy.rb

@@ -0,0 +1,157 @@
+#--
+# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+require 'beanstalk-client'
+
+#require 'ruote/part/local_participant'
+
+
+module Ruote
+module Beanstalk
+
+  #
+  # This participant emits workitems towards a beanstalk queue.
+  #
+  #   engine.register_participant(
+  #     :heavy_labour,
+  #     :reply_by_default => true, :beanstalk => '127.0.0.1:11300')
+  #
+  #
+  # == workitem format
+  #
+  # Workitems are encoded in the format
+  #
+  #   [ 'workitem', workitem.to_h ]
+  #
+  # and then serialized as JSON strings.
+  #
+  #
+  # == cancel items
+  #
+  # Like workitems, but the format is
+  #
+  #   [ 'cancelitem', fei.to_h, flavour.to_s ]
+  #
+  # where fei is the FlowExpressionId of the expression getting cancelled
+  # (and whose workitems are to be retired) and flavour is either 'cancel' or
+  # 'kill'.
+  #
+  #
+  # == extending this participant
+  #
+  # Extend and overwrite encode_workitem and encode_cancelitem or
+  # simply re-open the class and change those methods.
+  #
+  #
+  # == :beanstalk
+  #
+  # Indicates which beanstalk to talk to
+  #
+  #   engine.register_participant(
+  #     'alice'
+  #     Ruote::Beanstalk::ParticipantProxy,
+  #     'beanstalk' => '127.0.0.1:11300')
+  #
+  #
+  # == :tube
+  #
+  # Most of the time, you want the workitems (or the cancelitems) to be
+  # emitted over/in a specific tube
+  #
+  #   engine.register_participant(
+  #     'alice'
+  #     Ruote::Beanstalk::ParticipantProxy,
+  #     'beanstalk' => '127.0.0.1:11300',
+  #     'tube' => 'ruote-workitems')
+  #
+  #
+  # == :reply_by_default
+  #
+  # If the participant is configured with 'reply_by_default' => true, the
+  # participant will dispatch the workitem over to Beanstalk and then
+  # immediately reply to its ruote engine (letting the flow resume).
+  #
+  #   engine.register_participant(
+  #     'alice'
+  #     Ruote::Beanstalk::ParticipantProxy,
+  #     'beanstalk' => '127.0.0.1:11300',
+  #     'reply_by_default' => true)
+  #
+  class ParticipantProxy
+
+    include Ruote::LocalParticipant
+
+    def initialize(opts)
+
+      @opts = opts
+    end
+
+    def consume(workitem)
+
+      con = new_connection
+
+      con.put(encode_workitem(workitem))
+
+      reply(workitem) if @opts['reply_by_default']
+
+    ensure
+      con.close rescue nil
+    end
+
+    def cancel(fei, flavour)
+
+      con = new_connection
+
+      con.put(encode_cancelitem(fei, flavour))
+
+    ensure
+      con.close rescue nil
+    end
+
+    def encode_workitem(workitem)
+
+      Rufus::Json.encode([ 'workitem', workitem.to_h ])
+    end
+
+    def encode_cancelitem(fei, flavour)
+
+      Rufus::Json.encode([ 'cancelitem', fei.to_h, flavour.to_s ])
+    end
+
+    protected
+
+    def new_connection
+
+      con = ::Beanstalk::Connection.new(@opts['beanstalk'])
+
+      if tube = @opts['tube']
+        con.use(tube)
+      end
+
+      con
+    end
+  end
+end
+end
+

data/lib/ruote/beanstalk/receiver.rb

@@ -33,29 +33,29 @@ module Beanstalk
   #
   # An error class for error emitted by the "remote side" and received here.
   #
-  class BsReceiveError < RuntimeError
+  class ReceiveError < RuntimeError
 
     attr_reader :fei
 
-    def initialize (fei)
+    def initialize(fei)
       @fei = fei
       super("for #{Ruote::FlowExpressionId.to_storage_id(fei)}")
     end
   end
 
   #
-  # Whereas BsParticipant emits workitems (and cancelitems) to a Beanstalk
+  # Whereas ParticipantProxy emits workitems(and cancelitems) to a Beanstalk
   # queue, the receiver watches a Beanstalk queue/tube.
   #
   # An example initialization :
   #
-  #   Ruote::Beanstalk::BsReceiver.new(
+  #   Ruote::Beanstalk::Receiver.new(
   #     engine, '127.0.0.1:11300', :tube => 'out')
   #
   #
   # == workitem format
   #
-  # BsParticipant and BsReceiver share the same format :3
+  # ParticipantProxy and Receiver share the same format :3
   #
   #   [ 'workitem', workitem_as_a_hash ]
   #     # or
@@ -72,14 +72,14 @@ module Beanstalk
   #
   # Indicates to the receiver which beanstalk tube it should listen to.
   #
-  #   Ruote::Beanstalk::BsReceiver.new(
+  #   Ruote::Beanstalk::Receiver.new(
   #     engine, '127.0.0.1:11300', :tube => 'out')
   #
-  class BsReceiver < Ruote::Receiver
+  class Receiver < ::Ruote::Receiver
 
     # cwes = context, worker, engine or storage
     #
-    def initialize (cwes, beanstalk, options={})
+    def initialize(cwes, beanstalk, options={})
 
       super(cwes, options)
 
@@ -90,7 +90,7 @@ module Beanstalk
 
     protected
 
-    def listen (beanstalk, tube)
+    def listen(beanstalk, tube)
 
       con = ::Beanstalk::Connection.new(beanstalk)
       con.watch(tube)
@@ -108,31 +108,31 @@ module Beanstalk
     end
 
     # Is meant to return a hash with a first element that is either
-    # 'workitem', 'error' or 'launchitem' (a type).
+    # 'workitem', 'error' or 'launchitem'(a type).
     # The second element depends on the type.
-    # It's mappend on Ruote::Beanstalk::BsParticipant anyway.
+    # It's mappend on Ruote::Beanstalk::ParticipantProxy anyway.
     #
-    def decode (job)
+    def decode(job)
 
       Rufus::Json.decode(job.body)
     end
 
-    def process (job)
+    def process(job)
 
       type, data = decode(job)
 
       if type == 'workitem'
 
-        # data holds a workitem (as a Hash)
+        # data holds a workitem(as a Hash)
 
         reply(data)
 
       elsif type == 'error'
 
-        # data holds a fei (FlowExpressionId) (as a Hash)
+        # data holds a fei(FlowExpressionId) (as a Hash)
 
         @context.error_handler.action_handle(
-          'dispatch', data, BsReceiveError.new(data))
+          'dispatch', data, ReceiveError.new(data))
 
       elsif type == 'launchitem'
 

data/lib/ruote/beanstalk/storage.rb

@@ -33,7 +33,7 @@ module Beanstalk
   #
   # An error class just for BsStorage.
   #
-  class BsStorageError < RuntimeError
+  class StorageError < RuntimeError
   end
 
   #
@@ -47,9 +47,9 @@ module Beanstalk
   #
   #   engine = Ruote::Engine.new(
   #     Ruote::Worker.new(
-  #       Ruote::Beanstalk::BsStorage.new('127.0.0.1:11300', opts)))
+  #       Ruote::Beanstalk::Storage.new('127.0.0.1:11300', opts)))
   #
-  # All the operations (put, get, get_many, ...) of the storage are done
+  # All the operations(put, get, get_many, ...) of the storage are done
   # by a server, connected to the same beanstalk queue.
   #
   # == server
@@ -57,7 +57,7 @@ module Beanstalk
   # The storage point to a beanstalk queue and receives orders from clients
   # via the queue.
   #
-  #   Ruote::Beanstalk::BsStorage.new(':11300', 'ruote_work', :fork => true)
+  #   Ruote::Beanstalk::Storage.new(':11300', 'ruote_work', :fork => true)
   #
   # Note the directory passed as a string. When in server mode, this storage
   # uses an embedded Ruote::FsStorage for the actual storage.
@@ -66,11 +66,11 @@ module Beanstalk
   # the Beanstalk server. The storage takes care of stopping the beanstalk
   # server when the Ruby process exits.
   #
-  class BsStorage
+  class Storage
 
     include Ruote::StorageBase
 
-    def initialize (uri, directory=nil, options=nil)
+    def initialize(uri, directory=nil, options=nil)
 
       @uri, address, port = split_uri(uri)
 
@@ -113,7 +113,21 @@ module Beanstalk
       serve if @cloche
     end
 
-    def put (doc, opts={})
+    # One catch : will return [] in case of [network] error
+    #
+    def get_msgs
+
+      super rescue []
+    end
+
+    # One catch : will return true (failure) in case of [network] error
+    #
+    def reserve(doc)
+
+      super(doc) rescue true
+    end
+
+    def put(doc, opts={})
 
       doc.merge!('put_at' => Ruote.now_to_utc_s)
 
@@ -123,33 +137,40 @@ module Beanstalk
 
       return r unless r.nil?
 
-      doc['_rev'] = (doc['_rev'] || -1) + 1 if opts[:update_rev]
+      doc['_rev'] =(doc['_rev'] || -1) + 1 if opts[:update_rev]
 
       nil
     end
 
-    def get (type, key)
+    def get(type, key)
 
       return @cloche.get(type, key) if @cloche
 
       operate('get', [ type, key ])
     end
 
-    def delete (doc)
+    def delete(doc)
 
       return @cloche.delete(doc) if @cloche
 
       operate('delete', [ doc ])
     end
 
-    def get_many (type, key=nil, opts={})
+    def get_many(type, key=nil, opts={})
 
-      return @cloche.get_many(type, key, opts) if @cloche
+      return operate('get_many', [ type, key, opts ]) unless @cloche
+
+      if key
+        key = Array(key).collect { |k|
+          k[0..6] == '(?-mix:' ? Regexp.new(k[7..-2]) : "!#{k}"
+        } if key
+      end
+        # assuming /!#{wfid}$/...
 
-      operate('get_many', [ type, key, opts ])
+      @cloche.get_many(type, key, opts)
     end
 
-    def ids (type)
+    def ids(type)
 
       return @cloche.ids(type) if @cloche
 
@@ -165,7 +186,7 @@ module Beanstalk
       end
     end
 
-    def dump (type)
+    def dump(type)
 
       get_many(type)
     end
@@ -174,23 +195,28 @@ module Beanstalk
 
       Thread.list.each do |t|
         t.keys.each do |k|
-          next unless k.match(/^BeanstalkConnection\_/)
+          next unless k.to_s.match(CONN_KEY)
           t[k].close
           t[k] = nil
         end
       end
     end
 
+    def close
+
+      shutdown
+    end
+
     # Mainly used by ruote's test/unit/ut_17_storage.rb
     #
-    def add_type (type)
+    def add_type(type)
 
       # nothing to do
     end
 
-    # Nukes a db type and reputs it (losing all the documents that were in it).
+    # Nukes a db type and reputs it(losing all the documents that were in it).
     #
-    def purge_type! (type)
+    def purge_type!(type)
 
       if @cloche
         @cloche.purge_type!(type)
@@ -201,10 +227,10 @@ module Beanstalk
 
     protected
 
-    CONN_KEY = '__ruote_beanstalk_connection'
+    CONN_KEY = 'ruote-beanstalk-connection'
     TUBE_NAME = 'ruote-storage-commands'
 
-    def split_uri (uri)
+    def split_uri(uri)
 
       uri = ':' if uri == ''
 
@@ -218,6 +244,15 @@ module Beanstalk
     def connection
 
       c = Thread.current[CONN_KEY]
+
+      #begin
+      #  c.stats
+      #  return c
+      #rescue Exception => e
+      #  c = nil
+      #end if c
+        # keeping around the idea around
+
       return c if c
 
       c = ::Beanstalk::Connection.new(@uri, TUBE_NAME)
@@ -237,7 +272,7 @@ module Beanstalk
       put({ '_id' => 'engine', 'type' => 'configurations' }.merge(@options))
     end
 
-    def operate (command, params)
+    def operate(command, params)
 
       client_id = "BsStorage-#{Thread.current.object_id}-#{$$}"
       timestamp = Time.now.to_f.to_s
@@ -251,11 +286,15 @@ module Beanstalk
 
       result = nil
 
-      # NOTE : what about a timeout ?
-
       loop do
 
-        job = con.reserve
+        job = nil
+        begin
+          job = con.reserve
+        rescue Exception => e
+          # probably our timeout
+          break
+        end
         job.delete
 
         result, ts = Rufus::Json.decode(job.body)
@@ -265,7 +304,7 @@ module Beanstalk
 
       if result.is_a?(Array) && result.first == 'error'
         raise ArgumentError.new(result.last) if result[1] == 'ArgumentError'
-        raise BsStorageError.new(result.last)
+        raise StorageError.new(result.last)
       end
 
       result

data/lib/ruote/beanstalk/version.rb

@@ -1,7 +1,7 @@
 
 module Ruote
 module Beanstalk
-  VERSION = '2.1.10'
+  VERSION = '2.1.11'
 end
 end
 

data/readme.rdoc

@@ -0,0 +1,5 @@
+
+This is the rdoc for ruote-beanstalk.
+
+For an overview, see http://github.com/jmettraux/ruote-beanstalk
+