ruote 0.9.19 → 0.9.20

data/lib/openwfe/extras/participants/{csvparticipants.rb → decision_participants.rb}

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 #require 'rubygems'
 require 'rufus/decision' # gem 'rufus-decision'

data/lib/openwfe/extras/participants/jabber_participants.rb

@@ -0,0 +1,147 @@
+#--
+# Copyright (c) 2008-2009, Kenneth Kalmer, opensourcery.co.za
+#
+# 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 Africa. Kenneth Kalmer of opensourcery.co.za
+#++
+
+
+require 'yaml'
+
+require 'openwfe/util/xml'
+require 'openwfe/util/json'
+
+require 'openwfe/extras/misc/jabber_common'
+
+if defined?( ActiveSupport )
+  # Fix broken ActiveSupport Time#to_json notation
+  class Time
+    def to_json(*a)
+      if ActiveSupport.use_standard_json_time_format
+        xmlschema.inspect
+      else
+        %("#{strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)}")
+      end
+    end
+  end
+end
+
+module OpenWFE
+  module Extras
+
+    #
+    # Use Jabber (XMPP) during a workflow to communicate with people/processes
+    # outside the running engine in an asynchrous fashion.
+    #
+    # The JabberParticipant will send a JSON encoded InFlowWorkItem to a Jabber
+    # ID specified in the 'target_id' attribute of the workitem's attributes.
+    # To change the format sent, use the 'message_format' attribute of the
+    # workitem, and set it to either 'XML' or 'YAML' (defaults to 'JSON').
+    #
+    # You can specify the JID, password and JID resource names on class level
+    # or by passing the :jabber_id, :password, or :resource keys to the
+    # construct. By default the 'participant' resoure is used.
+    #
+    # The roster management is currently dynamic as well. It will clear the
+    # roster when it starts, except for a hard coded list of contacts. As
+    # messages are sent out the roster will be populated with those JID's,
+    # making sure that the listener will respond to replies.
+    #
+    # Configuration example:
+    #
+    #   engine.register_participant(
+    #     :jabber,
+    #     OpenWFE::Extras::JabberParticipant.new( :jabber_id => 'ruote@devbox', :password => 'secret', :contacts => ['kenneth@devbox'] )
+    #   )
+    #
+    # Process example:
+    #
+    #   class JabberProcess < OpenWFE::ProcessDefinition
+    #     sequence do
+    #       jabber :wait_for_reply => true
+    #     end
+    #
+    #     set :f => 'target_jid', :val => 'kenneth.kalmer@gmail.com'
+    #   end
+    #
+    # Passing the 'wait_for_reply' parameter to the participant
+    # prevents it from replying to the engine, and thus expects the
+    # JabberListener to pick up the reply and let the process
+    # continue. By default the JabberParticipant will send the message
+    # and reply to the engine, letting the workflow continue.
+    class JabberParticipant
+      include LocalParticipant
+      include OpenWFE::Extras::JabberCommon
+
+      def initialize( options = {} )
+        configure_jabber!( options )
+        connect!
+        setup_roster!
+      end
+
+      def consume( workitem )
+        ldebug { "consuming workitem" }
+
+        if target_jid = workitem.attributes['target_jid']
+
+          unless self.connection.subscribed_to?( target_jid )
+            self.connection.add( target_jid )
+            self.connection.roster.accept_subscription( target_jid )
+          end
+
+          # Message or workitem?
+          if message = ( workitem.attributes['message'] || workitem.params['message'] )
+            self.connection.deliver( target_jid, message )
+            
+          else
+            # Sensible defaults
+            workitem.attributes.reverse_merge!({ 'format' => 'JSON' })
+
+            ldebug { "sending workitem to jid: #{target_jid}" }
+            self.connection.deliver(
+              target_jid,
+              encode_workitem( workitem, workitem.attributes['format'] )
+            )
+          end
+        else
+          lerror { "no target_jid in workitem attributes!" }
+        end
+        
+        unless workitem.params['wait-for-reply'] == true
+          reply_to_engine( workitem )
+        end
+      end
+
+      protected
+
+      def encode_workitem( wi, format = 'JSON' )
+        if format.downcase == 'xml'
+           wi.to_xml
+        elsif format.downcase == 'yaml'
+          YAML.dump( wi )
+        else
+          wi.to_h.to_json
+        end
+
+      end
+
+    end
+  end
+end

data/lib/openwfe/extras/participants/jabberparticipants.rb

@@ -0,0 +1,3 @@
+
+require File.dirname(__FILE__) + '/jabber_participants'
+

data/lib/openwfe/extras/participants/sqs_participants.rb

@@ -0,0 +1,108 @@
+#--
+# Copyright (c) 2007-2009, 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 'yaml'
+require 'base64'
+
+#require 'rubygems'
+require 'rufus/sqs' # gem 'rufus-sqs'
+
+require 'openwfe/participants/participant'
+
+
+module OpenWFE
+module Extras
+
+  #
+  # This participant dispatches its workitem to an Amazon SQS queue.
+  #
+  # If the queue doesn't exist, the participant will create it.
+  #
+  # a small example :
+  #
+  #   # ...
+  #   engine.register_participant(:sqs0, SqsParticipant.new("workqueue0"))
+  #   # ...
+  #
+  # For more details about SQS :
+  # http://aws.amazon.com
+  #
+  class SqsParticipant
+    include LocalParticipant
+
+    attr_reader :queue, :queue_service
+
+    #
+    # Builds an SqsParticipant instance pointing to a given queue.
+    # (Refer to the SQS service on how to set up AWS key ids).
+    #
+    # By default the host_name is 'queue.amazonaws.com'
+    #
+    def initialize (queue_name, host_name=nil)
+
+      @queue_name = queue_name
+
+      @queue_service = Rufus::SQS::QueueService.new(host_name)
+
+      @queue_service.create_queue @queue_name
+        # make sure the queue exists
+
+      @queue = @queue_service.get_queue @queue_name
+    end
+
+    #
+    # The method called by the engine when it has a workitem for this
+    # participant.
+    #
+    def consume (workitem)
+
+      msg = encode_workitem(workitem)
+
+      msg_id = @queue_service.put_message(@queue, msg)
+
+      ldebug { "consume() msg sent to queue #{@queue.path} id is #{msg_id}" }
+    end
+
+    protected
+
+      #
+      # Turns the workitem into a Hash, pass it through YAML and
+      # encode64 the result.
+      #
+      # Override this method as needed.
+      #
+      # Something of 'text/plain' flavour should be returned.
+      #
+      def encode_workitem (wi)
+
+        msg = wi.to_h
+        msg = YAML.dump(msg)
+        msg = Base64.encode64(msg)
+        msg
+      end
+  end
+
+end
+end

data/lib/openwfe/extras/participants/{twitterparticipants.rb → twitter_participants.rb}

@@ -1,49 +1,35 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
-
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
-#
+#--
 # this participant requires the twitter4r gem
 #
 # http://rubyforge.org/projects/twitter4r/
 #
 # atom-tools' license is X11/MIT
-#
+#++
+
 
 #require 'rubygems'
 #gem 'twitter4r', '0.2.3'

data/lib/openwfe/extras/singlecon.rb

@@ -0,0 +1,56 @@
+#--
+# Copyright (c) 2009, 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_gem 'activerecord'
+gem 'activerecord'; require 'active_record'
+
+
+module OpenWFE
+module Extras
+
+  #
+  # Dumber connection management for records that need to be manipulated outside
+  # of the HTTP request circuit (where Rails takes care of everything).
+  #
+  module SingleConnectionMixin
+
+    def self.included (target_module)
+
+      target_module.module_eval do
+
+        def self.connection
+          ActiveRecord::Base.verify_active_connections!
+          @@connection ||= ActiveRecord::Base.connection_pool.checkout
+          @@connection.active? || @@connection.reconnect!
+          @@connection
+        end
+      end
+    end
+
+  end
+
+end
+end
+

data/lib/openwfe/filterdef.rb

@@ -1,43 +1,27 @@
-#
 #--
-# Copyright (c) 2007, John Mettraux OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/utils'
 
@@ -64,6 +48,31 @@ module OpenWFE
       @fields = []
     end
 
+    #
+    # Turning a FilterDefinition instance into a hash
+    #
+    def to_h
+      {
+        'class' => self.class.name,
+        'closed' => @closed,
+        'add_ok' => @add_ok,
+        'remove_ok' => @remove_ok,
+        'fields' => @fields.collect { |f| f.to_h }
+      }
+    end
+
+    #
+    # Rebuilding a FilterDefinition from a hash
+    #
+    def self.from_h (h)
+      fd = self.new
+      fd.closed = h['closed'] || false
+      fd.add_ok = h['add_ok'] || false
+      fd.remove_ok = h['remove_ok'] || false
+      fd.fields = (h['fields'] || []).collect { |hh| Field.from_h(hh) }
+      fd
+    end
+
     def add_allowed= (b)
       @add_ok = b
     end
@@ -72,20 +81,20 @@ module OpenWFE
     end
 
     def may_add?
-      return @add_ok
+      @add_ok
     end
     def may_remove?
-      return @remove_ok
+      @remove_ok
     end
 
     #
     # Adds a field to the filter definition
     #
-    #   filterdef.add_field("readonly", "r")
-    #   filterdef.add_field("hidden", nil)
-    #   filterdef.add_field("writable", :w)
-    #   filterdef.add_field("read_write", :rw)
-    #   filterdef.add_field("^toto_.*", :r)
+    #   filterdef.add_field('readonly', 'r')
+    #   filterdef.add_field('hidden", nil)
+    #   filterdef.add_field('writable', :w)
+    #   filterdef.add_field('read_write', :rw)
+    #   filterdef.add_field('^toto_.*', :r)
     #
     def add_field (regex, permissions)
       f = Field.new
@@ -103,24 +112,24 @@ module OpenWFE
     #
     #   f0 = OpenWFE::FilterDefinition.new
     #   f0.closed = true
-    #   f0.add_field("a", "r")
-    #   f0.add_field("b", "rw")
-    #   f0.add_field("c", "")
+    #   f0.add_field('a', 'r')
+    #   f0.add_field('b', 'rw')
+    #   f0.add_field('c', '')
     #
     #   m0 = {
-    #     "a" => "A",
-    #     "b" => "B",
-    #     "c" => "C",
-    #     "d" => "D",
+    #     'a' => 'A',
+    #     'b' => 'B',
+    #     'c' => 'C',
+    #     'd' => 'D',
     #   }
     #
     #   m1 = f0.filter_in m0
-    #   assert_equal m1, { "a" => "A", "b" => "B" }
+    #   assert_equal m1, { 'a' => 'A', 'b' => 'B' }
     #
     #   f0.closed = false
     #
     #   m2 = f0.filter_in m0
-    #   assert_equal m2, { "a" => "A", "b" => "B", "d" => "D" }
+    #   assert_equal m2, { 'a' => 'A', 'b' => 'B', 'd' => 'D' }
     #
     def filter_in (map)
 
@@ -208,7 +217,7 @@ module OpenWFE
     # Returns a deep copy of this filter instance.
     #
     def dup
-      OpenWFE::fulldup self
+      OpenWFE::fulldup(self)
     end
 
     protected
@@ -219,40 +228,49 @@ module OpenWFE
       def build_out_map (original_map, map)
 
         keys = {}
-        keys.merge! original_map
-        keys.merge! map
-
-        m = {}
-        keys.keys.each do |k|
-          m[k] = [ get_field(k), original_map[k], map[k] ]
-        end
+        keys.merge!(original_map)
+        keys.merge!(map)
 
-        #require 'pp'; pp m
-        m
+        keys.keys.inject({}) { |h, k|
+          h[k] = [ get_field(k), original_map[k], map[k] ]; h
+        }
       end
 
       #
       # Returns the first field mapping a given key
       #
       def get_field (key)
-        @fields.detect do |f|
-          key.match f.regex
-        end
+        @fields.detect { |f| key.match(f.regex) }
       end
 
       class Field
         attr_accessor :regex, :permissions
 
+        def to_h
+          {
+            'class' => self.class.name,
+            'regex' => YAML.dump(@regex),
+            'permissions' => @permissions
+          }
+        end
+
+        def self.from_h (h)
+          f = Field.new
+          f.regex = YAML.load(h['regex'])
+          f.permissions = h['permissions']
+          f
+        end
+
         def may_read?
-          @permissions.to_s.index("r") != nil
+          @permissions.to_s.index('r') != nil
         end
 
         def may_write?
-          @permissions.to_s.index("w") != nil
+          @permissions.to_s.index('w') != nil
         end
 
         def no_rights?
-          @permissions.to_s == ""
+          @permissions.to_s == ''
         end
       end
   end