omf_common 6.0.2.pre.2 → 6.0.2

data/lib/omf_common/comm/local/local_communicator.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 require 'omf_common/comm/local/local_topic'
 require 'securerandom'
 

data/lib/omf_common/comm/local/local_topic.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 
 
 module OmfCommon

data/lib/omf_common/comm/topic.rb

@@ -1,5 +1,11 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 require 'monitor'
 require 'securerandom'
+require 'openssl'
 
 module OmfCommon
   class Comm
@@ -94,22 +100,35 @@ module OmfCommon
         define_method(mname) do |*args, &message_block|
           warn_deprecation(mname, :on_message, :on_inform)
 
-          add_message_handler(itype, &message_block)
+          add_message_handler(itype, args.first, &message_block)
         end
       end
 
-      def on_message(*args, &message_block)
-        add_message_handler(:message, &message_block)
+      def on_message(key = nil, &message_block)
+        add_message_handler(:message, key, &message_block)
       end
 
-      def on_inform(*args, &message_block)
-        add_message_handler(:inform, &message_block)
+      def on_inform(key = nil, &message_block)
+        add_message_handler(:inform, key, &message_block)
       end
 
-      # Unsubscribe from the underlying comms layer
+      # Remove all registered callbacks for 'key'. Will also unsubscribe from the underlying
+      # comms layer if no callbacks remain.
       #
-      def unsubscribe()
-
+      def unsubscribe(key)
+        @lock.synchronize do
+          @handlers.each do |name, cbks|
+            if cbks.delete(key)
+              # remove altogether if no callback left
+              if cbks.empty?
+                @handlers.delete(name)
+              end
+            end
+          end
+          if @handlers.empty?
+            warn "Should unsubscribe '#{id}'"
+          end
+        end
       end
 
       def on_subscribed(&block)
@@ -157,8 +176,7 @@ module OmfCommon
       # Process a message received from this topic.
       #
       # @param [OmfCommon::Message] msg Message received
-      # @param [Hash] auth_info Authentication information
-      # @option auth_info [Symbol] :signer Id
+      #
       def on_incoming_message(msg)
         type = msg.operation
         debug "(#{id}) Deliver message '#{type}': #{msg.inspect}"
@@ -178,7 +196,7 @@ module OmfCommon
         end
 
         debug "(#{id}) Message type '#{htypes.inspect}' (#{msg.class}:#{msg.cid})"
-        hs = htypes.map { |ht| @handlers[ht] }.compact.flatten
+        hs = htypes.map { |ht| (@handlers[ht] || {}).values }.compact.flatten
         debug "(#{id}) Distributing message to '#{hs.inspect}'"
         hs.each do |block|
           block.call msg
@@ -190,11 +208,12 @@ module OmfCommon
         end
       end
 
-      def add_message_handler(handler_name, &message_block)
+      def add_message_handler(handler_name, key, &message_block)
         raise ArgumentError, 'Missing message callback' if message_block.nil?
         debug "(#{id}) register handler for '#{handler_name}'"
         @lock.synchronize do
-          (@handlers[handler_name] ||= []) << message_block
+          key ||= OpenSSL::Digest::SHA1.new(message_block.source_location.to_s).to_s
+          (@handlers[handler_name] ||= {})[key] = message_block
         end
         self
       end

data/lib/omf_common/comm/xmpp/communicator.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 require 'blather/client/dsl'
 
 require 'omf_common/comm/xmpp/xmpp_mp'
@@ -20,7 +25,8 @@ class Comm
         :fields => [
           { :var => "FORM_TYPE", :type => 'hidden', :value => "http://jabber.org/protocol/pubsub#node_config" },
           { :var => "pubsub#persist_items", :value => "0" },
-          { :var => "pubsub#max_items", :value => "0" },
+          { :var => "pubsub#purge_offline", :value => "1" },
+          { :var => "pubsub#send_last_published_item", :value => "never" },
           { :var => "pubsub#notify_retract",  :value => "0" },
           { :var => "pubsub#publish_model", :value => "open" }]
       })
@@ -160,6 +166,10 @@ class Comm
         raise StandardError, "Invalid message" unless message.valid?
 
         message = message.marshall[1] unless message.kind_of? String
+        if message.nil?
+          debug "Cannot publish empty message, using authentication and not providing a proper cert?"
+          return nil
+        end
 
         new_block = proc do |stanza|
           published_messages << OpenSSL::Digest::SHA1.new(message.to_s)

data/lib/omf_common/comm/xmpp/topic.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 module OmfCommon
 class Comm
 class XMPP

data/lib/omf_common/comm/xmpp/xmpp_mp.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 require 'oml4r'
 
 module OmfCommon

data/lib/omf_common/command.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 require 'open3'
 
 module OmfCommon::Command

data/lib/omf_common/core_ext/string.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 class String
   def ducktype
     Integer(self) rescue Float(self) rescue self

data/lib/omf_common/default_logging.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 require 'logging'
 
 module OmfCommon
@@ -14,28 +19,35 @@ module OmfCommon
     Logging.logger.root.level = :info
 
     # Alias logging method using default logger
+    #
+    # @example
+    #
+    #   info 'Information'
+    #   # Additional logger name will generate a new child logger in the context of default logger
+    #   info 'Information', 'logger name'
+    #
     def info(*args, &block)
-      logger.info(*args, &block)
+      get_logger(args[1]).info(args[0], &block)
     end
 
     # @see #info
     def debug(*args, &block)
-      logger.debug(*args, &block)
+      get_logger(args[1]).debug(args[0], &block)
     end
 
     # @see #info
     def error(*args, &block)
-      logger.error(*args, &block)
+      get_logger(args[1]).error(args[0], &block)
     end
 
     # @see #info
     def fatal(*args, &block)
-      logger.fatal(*args, &block)
+      get_logger(args[1]).fatal(args[0], &block)
     end
 
     # @see #info
     def warn(*args, &block)
-      logger.warn(*args, &block)
+      get_logger(args[1]).warn(args[0], &block)
     end
 
     # Log a warning message for deprecated methods
@@ -48,5 +60,11 @@ module OmfCommon
         logger.warn "[DEPRECATION] '#{deprecated_name}' is deprecated and not supported. Please do not use it."
       end
     end
+
+    private
+
+    def get_logger(name = nil)
+      name.nil? ? logger : Logging::Logger["#{logger.name}::#{name.to_s}"]
+    end
   end
 end

data/lib/omf_common/eventloop.rb

@@ -1,7 +1,12 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 module OmfCommon
   # Providing event loop support.
   class Eventloop
-    
+
     @@providers = {
       em: {
         require: 'omf_common/eventloop/em',
@@ -13,7 +18,8 @@ module OmfCommon
       }
     }
     @@instance = nil
-    
+    @@on_stop_proc = []
+
     #
     # opts:
     #   :type - eventloop provider
@@ -43,66 +49,77 @@ module OmfCommon
       @@instance = inst
       inst
     end
-    
+
     def self.instance
       @@instance
     end
-    
+
     # Execute block after some time
     #
-    # @param [float] delay in sec
-    # @param [block] block to execute
+    # @param [Float] delay_sec in sec
     #
     def after(delay_sec, &block)
       raise "Missing implementation 'after'"
     end
-    
+
     # Periodically call block every interval_sec
     #
-    # @param [float] interval in sec
-    # @param [block] block to execute
+    # @param [Float] interval_sec in sec
     #
     def every(interval_sec, &block)
       raise "Missing implementation 'every'"
     end
-    
+
+    # Call 'block' in the context of a separate thread.
+    #
+    def defer(&block)
+      raise "Missing implementation 'defer'"
+    end
+
     # Block calling thread until eventloop exits
     def join()
       raise "Missing implementation 'join'"
     end
-    
+
     def run()
-      raise "Missing implementation 'run'"      
+      raise "Missing implementation 'run'"
     end
-    
+
     def stop()
-      raise "Missing implementation 'stop'"      
-    end      
-    
+      @@on_stop_proc.each do |block|
+        begin
+          block.call()
+        rescue  => ex
+          error "Exception '#{ex}'"
+          debug "#{ex}\n\t#{ex.backtrace.join("\n\t")}"
+        end
+      end
+    end
+
     # Calling 'block' before stopping eventloop
     #
     def on_stop(&block)
-      warn "Missing implementation 'on_stop'" 
+      @@on_stop_proc << block
     end
-    
+
     # Calling 'block' when having trapped an INT signal
     #
     def on_int_signal(&block)
       # trap(:INT)
-      warn "Missing implementation 'on_int_signal'" 
+      warn "Missing implementation 'on_int_signal'"
     end
 
     # Calling 'block' when having trapped a TERM signal
     #
     def on_term_signal(&block)
       # trap(:TERM) {}
-      warn "Missing implementation 'on_term_signal'" 
+      warn "Missing implementation 'on_term_signal'"
     end
-       
+
     private
     def initialize(opts = {}, &block)
       #run(&block) if block
     end
-    
+
   end
-end
+end

data/lib/omf_common/eventloop/em.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 require 'eventmachine'
 
 module OmfCommon
@@ -14,13 +19,20 @@ module OmfCommon
 
       # Execute block after some time
       #
-      # @param [Float] delay in sec
+      # @param [Float] delay_sec in sec
       def after(delay_sec, &block)
         if EM.reactor_running?
-          EM.add_timer(delay_sec, &block)
+          EM.add_timer(delay_sec) do
+            begin
+              block.call()
+            rescue  => ex
+              error "Exception '#{ex}'"
+              debug "#{ex}\n\t#{ex.backtrace.join("\n\t")}"
+            end
+          end
         else
           @deferred << lambda do
-            EM.add_timer(delay_sec, &block)
+            after(delay_sec, &block)
           end
         end
       end
@@ -41,7 +53,7 @@ module OmfCommon
 
       # Periodically call block every interval_sec
       #
-      # @param [Float] interval in sec
+      # @param [Float] interval_sec in sec
       def every(interval_sec, &block)
         # to allow canceling the periodic timer we need to
         # hand back a reference to it which responds to 'cancel'
@@ -82,7 +94,8 @@ module OmfCommon
       end
 
       def stop()
-        EM.stop
+        super
+        EM.next_tick { EM.stop }
       end
     end # class
   end

data/lib/omf_common/eventloop/local_evl.rb

@@ -1,3 +1,8 @@
+# Copyright (c) 2012 National ICT Australia Limited (NICTA).
+# This software may be used and distributed solely under the terms of the MIT license (License).
+# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
+# By downloading or using this software you accept the terms and the liability disclaimer in the License.
+
 
 
 module OmfCommon
@@ -5,32 +10,30 @@ module OmfCommon
     # Implements a simple eventloop which only deals with timer events
     #
     class Local < Eventloop
-      
+
       def initialize(opts = {}, &block)
         super
         @tasks =  []
         @running = false
         after(0, &block) if block
       end
-      
+
       # Execute block after some time
       #
-      # @param [float] delay in sec
-      # @param [block] block to execute
+      # @param [Float] delay_sec in sec
       #
       def after(delay_sec, &block)
         @tasks << [Time.now + delay_sec, block]
       end
-      
+
       # Periodically call block every interval_sec
       #
-      # @param [float] interval in sec
-      # @param [block] block to execute
+      # @param [Float] interval_sec in sec
       #
       def every(interval_sec, &block)
         @tasks << [Time.now + interval_sec, block, :periodic => interval_sec]
       end
-      
+
       # Call 'block' in the context of a separate thread.
       #
       def defer(&block)
@@ -44,17 +47,17 @@ module OmfCommon
           end
         end
       end
-      
-      
-      def stop 
+
+
+      def stop
         @running = false
       end
-      
+
       def run(&block)
         after(0, &block) if block
         return if @running
         @running = true
-              
+
         while @running do
           now = Time.now
           @tasks = @tasks.sort
@@ -86,8 +89,8 @@ module OmfCommon
             end
           end
         end
-      end      
+      end
     end # class
   end
 end
-      
+