omf_common 6.0.0.pre.8 → 6.0.0.pre.10

data/lib/omf_common.rb

@@ -1,25 +1,17 @@
-require 'logging'
-require 'active_support/inflector'
-
-require "omf_common/version"
+require 'active_support/core_ext'
+require 'omf_common/default_logging'
+require 'omf_common/version'
 require 'omf_common/measure'
-require "omf_common/message"
-require "omf_common/comm"
-require "omf_common/command"
-require "omf_common/topic"
-require "omf_common/topic_message"
-require "omf_common/core_ext/string"
-require "omf_common/core_ext/object"
-
-# Use global default logger from logging gem
-include Logging.globally
+require 'omf_common/message'
+require 'omf_common/comm'
+require 'omf_common/command'
+require 'omf_common/topic'
+require 'omf_common/topic_message'
+require 'omf_common/key'
+require 'omf_common/core_ext/string'
+require 'omf_common/core_ext/object'
 
-Logging.appenders.stdout('stdout',
-                         :layout => Logging.layouts.pattern(:date_pattern => '%F %T %z',
-                                                            :pattern => '[%d] %-5l %m\n',
-                                                            :color_scheme => 'default'))
-Logging.logger.root.appenders = 'stdout'
-Logging.logger.root.level = :info
+include OmfCommon::DefaultLogging
 
 module OmfCommon
 end

data/lib/omf_common/comm.rb

@@ -5,8 +5,61 @@ require 'omf_common/dsl/xmpp_mp'
 module OmfCommon
   # PubSub communication class, can be extended with different implementations
   class Comm
+    attr_accessor :published_messages
+
     def initialize(pubsub_implementation)
+      @published_messages = []
       self.extend("OmfCommon::DSL::#{pubsub_implementation.to_s.camelize}".constantize)
     end
+
+    # Generate OMF related message
+    %w(create configure request inform release).each do |m_name|
+      define_method("#{m_name}_message") do |*args, &block|
+        message =
+          if block
+            Message.send(m_name, *args, &block)
+          elsif args[0].kind_of? Array
+            Message.send(m_name) do |v|
+              args[0].each do |opt|
+                if opt.kind_of? Hash
+                  opt.each_pair do |key, value|
+                    v.property(key, value)
+                  end
+                else
+                  v.property(opt)
+                end
+              end
+            end
+          else
+            Message.send(m_name)
+          end
+
+        OmfCommon::TopicMessage.new(message, self)
+      end
+    end
+
+    %w(created status released failed).each do |inform_type|
+      define_method("on_#{inform_type}_message") do |*args, &message_block|
+        msg_id = args[0].msg_id if args[0]
+        event_block = proc do |event|
+          message_block.call(Message.parse(event.items.first.payload))
+        end
+        guard_block = proc do |event|
+          (event.items?) && (!event.delayed?) &&
+            event.items.first.payload &&
+            (omf_message = Message.parse(event.items.first.payload)) &&
+            omf_message.operation == :inform &&
+            omf_message.read_content(:inform_type) == inform_type.upcase &&
+            (msg_id ? (omf_message.context_id == msg_id) : true)
+        end
+        topic_event(guard_block, &callback_logging(__method__, &event_block))
+      end
+    end
+
+    # Return a topic object represents pubsub topic
+    #
+    def get_topic(topic_id)
+      OmfCommon::Topic.new(topic_id, self)
+    end
   end
 end

data/lib/omf_common/default_logging.rb

@@ -0,0 +1,41 @@
+require 'logging'
+
+module OmfCommon
+  module DefaultLogging
+    # Use global default logger from logging gem
+    include Logging.globally
+
+    Logging.appenders.stdout(
+      'default_stdout',
+      :layout => Logging.layouts.pattern(:date_pattern => '%F %T %z',
+                                         :pattern => '[%d] %-5l %c: %m\n',
+                                         :color_scheme => 'default'))
+    Logging.logger.root.appenders = 'default_stdout'
+    Logging.logger.root.level = :info
+
+    # Alias logging method using default logger
+    def info(*args, &block)
+      logger.info(*args, &block)
+    end
+
+    # @see #info
+    def debug(*args, &block)
+      logger.debug(*args, &block)
+    end
+
+    # @see #info
+    def error(*args, &block)
+      logger.error(*args, &block)
+    end
+
+    # @see #info
+    def fatal(*args, &block)
+      logger.fatal(*args, &block)
+    end
+
+    # @see #info
+    def warn(*args, &block)
+      logger.warn(*args, &block)
+    end
+  end
+end

data/lib/omf_common/dsl/xmpp.rb

@@ -27,8 +27,31 @@ module OmfCommon
       end
 
       # Shut down XMPP connection
-      def disconnect
-        shutdown
+      def disconnect(opts = {})
+        if opts[:delete_affiliations]
+          affiliations do |a|
+            # owner means topics created, owned
+            owner_topics = a[:owner] ? a[:owner].size : 0
+            # none means... topics subscribed to
+            none_topics = a[:none] ? a[:none].size : 0
+
+            if none_topics > 0
+              info "Unsubscribing #{none_topics} pubsub topic(s)"
+              unsubscribe
+            end
+
+            if owner_topics > 0
+              info "Deleting #{owner_topics} pubsub topic(s) in 2 seconds"
+              EM.add_timer(2) do
+                a[:owner].each { |topic| delete_topic(topic) }
+              end
+            end
+
+            shutdown if none_topics == 0 && owner_topics == 0
+          end
+        else
+          shutdown
+        end
         OmfCommon::DSL::Xmpp::MPConnection.inject(Time.now.to_f, jid, 'disconnect') if OmfCommon::Measure.enabled?
       end
 
@@ -49,8 +72,22 @@ module OmfCommon
       # Subscribe to a pubsub topic
       #
       # @param [String] topic Pubsub topic name
-      def subscribe(topic, &block)
-        pubsub.subscribe(topic, nil, default_host, &callback_logging(__method__, topic, &block))
+      # @param [Hash] opts
+      # @option opts [Boolean] :create_if_non_existent create the topic if non-existent, use this option with caution
+      def subscribe(topic, opts = {}, &block)
+        if opts[:create_if_non_existent]
+          affiliations do |a|
+            if a[:owner] && a[:owner].include?(topic)
+              pubsub.subscribe(topic, nil, default_host, &callback_logging(__method__, topic, &block))
+            else
+              create_topic(topic) do
+                pubsub.subscribe(topic, nil, default_host, &callback_logging(__method__, topic, &block))
+              end
+            end
+          end
+        else
+          pubsub.subscribe(topic, nil, default_host, &callback_logging(__method__, topic, &block))
+        end
         MPSubscription.inject(Time.now.to_f, jid, 'join', topic) if OmfCommon::Measure.enabled?
       end
 
@@ -74,34 +111,14 @@ module OmfCommon
       # @param [String] message Any XML fragment to be sent as payload
       def publish(topic, message, &block)
         raise StandardError, "Invalid message" unless message.valid?
-        pubsub.publish(topic, message, default_host, &callback_logging(__method__, topic, message.operation, &block))
-        MPPublished.inject(Time.now.to_f, jid, topic, message.to_s.gsub("\n",'')) if OmfCommon::Measure.enabled?
-      end
-
-      # Generate OMF related message
-      %w(create configure request inform release).each do |m_name|
-        define_method("#{m_name}_message") do |*args, &block|
-          message =
-            if block
-              Message.send(m_name, *args, &block)
-            elsif args[0].kind_of? Array
-              Message.send(m_name) do |v|
-                args[0].each do |opt|
-                  if opt.kind_of? Hash
-                    opt.each_pair do |key, value|
-                      v.property(key, value)
-                    end
-                  else
-                    v.property(opt)
-                  end
-                end
-              end
-            else
-              Message.send(m_name)
-            end
 
-          OmfCommon::TopicMessage.new(message, self)
+        new_block = proc do |stanza|
+          published_messages << OpenSSL::Digest::SHA1.new(message.to_s)
+          block.call(stanza) if block
         end
+
+        pubsub.publish(topic, message, default_host, &callback_logging(__method__, topic, &new_block))
+        MPPublished.inject(Time.now.to_f, jid, topic, message.to_s.gsub("\n",'')) if OmfCommon::Measure.enabled?
       end
 
       # Event machine related method delegation
@@ -111,50 +128,42 @@ module OmfCommon
         end
       end
 
-      %w(created status released failed).each do |inform_type|
-        define_method("on_#{inform_type}_message") do |*args, &message_block|
-          context_id = args[0].context_id if args[0]
-          event_block = proc do |event|
-            message_block.call(Message.parse(event.items.first.payload))
-          end
-          guard_block = proc do |event|
-            (event.items?) && (!event.delayed?) &&
-              event.items.first.payload &&
-              (omf_message = Message.parse(event.items.first.payload)) &&
-              omf_message.operation == :inform &&
-              omf_message.read_content(:inform_type) == inform_type.upcase &&
-              (context_id ? (omf_message.context_id == context_id) : true)
-          end
-          pubsub_event(guard_block, &callback_logging(__method__, &event_block))
-        end
-      end
-
       # Event callback for pubsub topic event(item published)
       #
-      def topic_event(&block)
+      def topic_event(additional_guard = nil, &block)
         guard_block = proc do |event|
-          passed = (event.items?) && (!event.delayed?) && event.items.first.payload
+          passed = (event.items?) && (!event.delayed?) && event.items.first.payload &&
+            !published_messages.include?(OpenSSL::Digest::SHA1.new(event.items.first.payload))
+
           MPReceived.inject(Time.now.to_f, jid, event.node, event.items.first.payload.to_s.gsub("\n",'')) if OmfCommon::Measure.enabled? && passed
-          passed
+
+          if additional_guard
+            passed && additional_guard.call(event)
+          else
+            passed
+          end
         end
         pubsub_event(guard_block, &callback_logging(__method__, &block))
       end
 
-      # Return a topic object represents pubsub topic
-      #
-      def get_topic(topic_id)
-        OmfCommon::Topic.new(topic_id, self)
-      end
-
       private
 
       # Provide a new block wrap to automatically log errors
       def callback_logging(*args, &block)
         m = args.empty? ? "OPERATION" : args.map {|v| v.to_s.upcase }.join(" ")
-        proc do |callback|
-          logger.error callback if callback.respond_to?(:error?) && callback.error?
-          logger.debug "#{m} SUCCEED" if callback.respond_to?(:result?) && callback.result?
-          block.call(callback) if block
+        proc do |stanza|
+          if stanza.respond_to?(:error?) && stanza.error?
+            e_stanza = Blather::StanzaError.import(stanza)
+            if [:unexpected_request].include? e_stanza.name
+              logger.debug e_stanza
+            elsif e_stanza.name == :conflict 
+              logger.debug e_stanza
+            else
+              logger.warn "#{e_stanza} Original: #{e_stanza.original}"
+            end
+          end
+          logger.debug "#{m} SUCCEED" if stanza.respond_to?(:result?) && stanza.result?
+          block.call(stanza) if block
         end
       end
 

data/lib/omf_common/key.rb

@@ -0,0 +1,14 @@
+require 'openssl'
+require 'singleton'
+
+module OmfCommon
+  class Key
+    include Singleton
+
+    attr_accessor :private_key
+
+    def import(filename)
+      self.private_key = OpenSSL::PKey.read(File.read(filename))
+    end
+  end
+end

data/lib/omf_common/message.rb

@@ -2,6 +2,8 @@ require 'niceogiri'
 require 'hashie'
 require 'securerandom'
 require 'openssl'
+require 'cgi'
+require 'omf_common/relaxng_schema'
 
 module OmfCommon
 
@@ -24,10 +26,9 @@ module OmfCommon
   #   end
   #
   class Message < Niceogiri::XML::Node
-    OMF_NAMESPACE = "http://schema.mytestbed.net/#{OmfCommon::PROTOCOL_VERSION}/protocol"
-    SCHEMA_FILE = "#{File.dirname(__FILE__)}/protocol/#{OmfCommon::PROTOCOL_VERSION}.rng"
+    OMF_NAMESPACE = "http://schema.mytestbed.net/omf/#{OmfCommon::PROTOCOL_VERSION}/protocol"
     OPERATION = %w(create configure request release inform)
-    # When OML instrumentation is enabled, we do not want to send a the same 
+    # When OML instrumentation is enabled, we do not want to send a the same
     # measurement twice, once when a message is created for publishing to T,
     # and once when this message comes back (as we are also a subscriber of T)
     # Thus we keep track of message IDs here (again only when OML is enabled)
@@ -38,12 +39,11 @@ module OmfCommon
         define_method(operation) do |*args, &block|
           xml = new(operation, nil, OMF_NAMESPACE)
           if operation == 'inform'
-            xml.element('context_id', args[1] || SecureRandom.uuid)
+            xml.element('context_id', args[1]) if args[1]
             xml.element('inform_type', args[0])
           else
-            xml.element('context_id', SecureRandom.uuid)
+            xml.element('publish_to', args[0]) if args[0]
           end
-          xml.element('publish_to', args[0]) if operation == 'request'
           block.call(xml) if block
           xml.sign
         end
@@ -54,9 +54,9 @@ module OmfCommon
         xml_root = Nokogiri::XML(xml).root
         result = new(xml_root.element_name, nil, xml_root.namespace.href).inherit(xml_root)
         if OmfCommon::Measure.enabled? && !@@msg_id_list.include?(result.msg_id)
-          MPMessage.inject(Time.now.to_f, result.operation.to_s, result.msg_id, result.context_id, result.to_s.gsub("\n",'')) 
+          MPMessage.inject(Time.now.to_f, result.operation.to_s, result.msg_id, result.context_id, result.to_s.gsub("\n",''))
         end
-        result 
+        result
       end
     end
 
@@ -112,10 +112,10 @@ module OmfCommon
         end
       else
         if key.nil?
-          value.to_s
+          string_value(value)
         else
           n = Message.new(key)
-          n.add_child(value.to_s)
+          n.add_child(string_value(value))
         end
       end
     end
@@ -123,7 +123,17 @@ module OmfCommon
     # Generate SHA1 of canonicalised xml and write into the ID attribute of the message
     #
     def sign
-      write_attr('msg_id', OpenSSL::Digest::SHA1.new(canonicalize)) if read_attr('id').nil? || read_attr('id').empty?
+      write_attr('msg_id', SecureRandom.uuid)
+      write_attr('timestamp', Time.now.utc.iso8601)
+      canonical_msg = self.canonicalize
+
+      priv_key =  OmfCommon::Key.instance.private_key
+      digest = OpenSSL::Digest::SHA512.new(canonical_msg)
+
+      signature = Base64.encode64(priv_key.sign(digest, canonical_msg)).encode('utf-8') if priv_key
+      write_attr('digest', digest)
+      write_attr('signature', signature) if signature
+
       if OmfCommon::Measure.enabled?
         MPMessage.inject(Time.now.to_f, operation.to_s, msg_id, context_id, self.to_s.gsub("\n",''))
         @@msg_id_list << msg_id
@@ -141,7 +151,7 @@ module OmfCommon
     # Validate against relaxng schema
     #
     def valid?
-      validation = Nokogiri::XML::RelaxNG(File.open(SCHEMA_FILE)).validate(self.document)
+      validation = RelaxNGSchema.instance.schema.validate(self.document)
       if validation.empty?
         true
       else
@@ -171,7 +181,7 @@ module OmfCommon
 
     # Short cut for grabbing a group of nodes using xpath, but with default namespace
     def element_by_xpath_with_default_namespace(xpath_without_ns)
-      xpath(xpath_without_ns.gsub(/(\/+)(\w+)/, '\1xmlns:\2'), :xmlns => OMF_NAMESPACE)
+      xpath(xpath_without_ns.gsub(/(^|\/{1,2})(\w+)/, '\1xmlns:\2'), :xmlns => OMF_NAMESPACE)
     end
 
     # In case you think method :element_by_xpath_with_default_namespace is too long
@@ -181,7 +191,7 @@ module OmfCommon
     # We just want to know the content of an non-repeatable element
     #
     def read_content(element_name)
-      element_content = read_element("//#{element_name}").first.content rescue nil
+      element_content = read_element("#{element_name}").first.content rescue nil
       unless element_content.nil?
         element_content.empty? ? nil : element_content
       else
@@ -212,35 +222,42 @@ module OmfCommon
     # @param [String] key name of the property element
     # @return [Object] the content of the property, as string, integer, float, or mash(hash with indifferent access)
     #
-    def read_property(key)
+    def read_property(key, data_binding = nil)
       key = key.to_s
-      e = read_element("//property[@key='#{key}']").first
-      reconstruct_data(e) if e
+      e = read_element("property[@key='#{key}']").first
+      reconstruct_data(e, data_binding) if e
     end
 
-    def reconstruct_data(node)
-      case node.attr('type')
+    def reconstruct_data(node, data_binding = nil)
+      node_type =  node.attr('type')
+      case node_type
       when 'array'
         node.element_children.map do |child|
-          reconstruct_data(child)
+          reconstruct_data(child, data_binding)
         end
       when /hash/
         mash ||= Hashie::Mash.new
         node.element_children.each do |child|
-          mash[child.attr('key') || child.element_name] ||= reconstruct_data(child)
+          mash[child.attr('key') || child.element_name] ||= reconstruct_data(child, data_binding)
         end
         mash
       when /boolean/
         node.content == "true"
       else
-        node.content.empty? ? nil : node.content.ducktype
+        if node.content.empty?
+          nil
+        elsif data_binding && node_type == 'string'
+          ERB.new(node.content).result(data_binding)
+        else
+          node.content.ducktype
+        end
       end
     end
 
     # Iterate each property element
     #
     def each_property(&block)
-      read_element("//property").each { |v| block.call(v) }
+      read_element("property").each { |v| block.call(v) }
     end
 
     # Pretty print for application event message
@@ -253,11 +270,24 @@ module OmfCommon
 
     def ruby_type_2_prop_type(ruby_class_type)
       v_type = ruby_class_type.to_s.downcase
-      if %w(trueclass falseclass).include?(v_type)
+      case v_type
+      when *%w(trueclass falseclass)
         'boolean'
+      when *%w(fixnum bignum)
+        'integer'
       else
         v_type
       end
     end
+
+    # Get string of a value object, escape if object is string
+    def string_value(value)
+      if value.kind_of? String
+        value = CGI::escape_html(value)
+      else
+        value = value.to_s
+      end
+      value
+    end
   end
 end

data/lib/omf_common/protocol/6.0.rnc

@@ -1,61 +1,48 @@
-default namespace = "http://schema.mytestbed.net/6.0/protocol"
+default namespace = "http://schema.mytestbed.net/omf/6.0/protocol"
 
 start = (create | configure | request | release | inform)
 
+common_elements = attribute msg_id { text }, attribute timestamp { text }, attribute digest { text }, attribute signature { text }?
+
 anything = ( text | element * { (attribute type { text })?, (text | anything) * })
 
+prop_content = attribute key { text }, (attribute type { text })?, anything *
+
 create = element create {
-  attribute msg_id { text },
-  element context_id { text },
-  element property {
-    attribute key { text },
-    (attribute type { text })?,
-    anything *
-  } *
+  common_elements
+  & element publish_to { text }?
+  & element guard { element property { prop_content } * }?
+  & element property { prop_content } *
 }
 
 configure = element configure {
-  attribute msg_id { text },
-  element context_id { text },
-  element property {
-    attribute key { text },
-    (attribute type { text })?,
-    anything *
-  } *
+  common_elements
+  & element publish_to { text }?
+  & element guard { element property { prop_content } * }?
+  & element property { prop_content } *
 }
 
 request = element request {
-  attribute msg_id { text },
-  element context_id { text },
-  element publish_to { text }?,
-  element property {
-    (attribute key { text }),
-    (attribute type { text })?,
-    anything *
-  }*
+  common_elements
+  & element publish_to { text }?
+  & element guard { element property { prop_content } * }?
+  & element property { prop_content } *
 }
 
 release = element release {
-  attribute msg_id { text },
-  element context_id { text },
-  element resource_id { text },
-  element property {
-    (attribute key { text }),
-    (attribute type { text })?,
-    anything *
-  }*
+  common_elements
+  & element publish_to { text }?
+  & element resource_id { text }
+  & element guard { element property { prop_content } * }?
+  & element property { prop_content } *
 }
 
 inform = element inform {
-  attribute msg_id { text },
-  element context_id { text },
-  element inform_type { "CREATED" | "FAILED" | "STATUS" | "RELEASED" | "ERROR" | "WARN"},
-  element resource_id { text }?,
-  element resource_address { text }?,
-  element reason { text }?,
-  element property {
-    attribute key { text },
-    (attribute type { text })?,
-    anything *
-  } *
+  common_elements
+  & element context_id { text }?
+  & element inform_type { "CREATED" | "FAILED" | "STATUS" | "RELEASED" | "ERROR" | "WARN"}
+  & element resource_id { text }?
+  & element resource_address { text }?
+  & element reason { text }?
+  & element property { prop_content } *
 }

data/lib/omf_common/protocol/6.0.rng

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar ns="http://schema.mytestbed.net/6.0/protocol" xmlns="http://relaxng.org/ns/structure/1.0">
+<grammar ns="http://schema.mytestbed.net/omf/6.0/protocol" xmlns="http://relaxng.org/ns/structure/1.0">
   <start>
     <choice>
       <ref name="create"/>
@@ -9,6 +9,14 @@
       <ref name="inform"/>
     </choice>
   </start>
+  <define name="common_elements">
+    <attribute name="msg_id"/>
+    <attribute name="timestamp"/>
+    <attribute name="digest"/>
+    <optional>
+      <attribute name="signature"/>
+    </optional>
+  </define>
   <define name="anything">
     <choice>
       <text/>
@@ -26,132 +34,162 @@
       </element>
     </choice>
   </define>
+  <define name="prop_content">
+    <attribute name="key"/>
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="anything"/>
+    </zeroOrMore>
+  </define>
   <define name="create">
     <element name="create">
-      <attribute name="msg_id"/>
-      <element name="context_id">
-        <text/>
-      </element>
-      <zeroOrMore>
-        <element name="property">
-          <attribute name="key"/>
-          <optional>
-            <attribute name="type"/>
-          </optional>
-          <zeroOrMore>
-            <ref name="anything"/>
-          </zeroOrMore>
-        </element>
-      </zeroOrMore>
+      <interleave>
+        <ref name="common_elements"/>
+        <optional>
+          <element name="publish_to">
+            <text/>
+          </element>
+        </optional>
+        <optional>
+          <element name="guard">
+            <zeroOrMore>
+              <element name="property">
+                <ref name="prop_content"/>
+              </element>
+            </zeroOrMore>
+          </element>
+        </optional>
+        <zeroOrMore>
+          <element name="property">
+            <ref name="prop_content"/>
+          </element>
+        </zeroOrMore>
+      </interleave>
     </element>
   </define>
   <define name="configure">
     <element name="configure">
-      <attribute name="msg_id"/>
-      <element name="context_id">
-        <text/>
-      </element>
-      <zeroOrMore>
-        <element name="property">
-          <attribute name="key"/>
-          <optional>
-            <attribute name="type"/>
-          </optional>
-          <zeroOrMore>
-            <ref name="anything"/>
-          </zeroOrMore>
-        </element>
-      </zeroOrMore>
+      <interleave>
+        <ref name="common_elements"/>
+        <optional>
+          <element name="publish_to">
+            <text/>
+          </element>
+        </optional>
+        <optional>
+          <element name="guard">
+            <zeroOrMore>
+              <element name="property">
+                <ref name="prop_content"/>
+              </element>
+            </zeroOrMore>
+          </element>
+        </optional>
+        <zeroOrMore>
+          <element name="property">
+            <ref name="prop_content"/>
+          </element>
+        </zeroOrMore>
+      </interleave>
     </element>
   </define>
   <define name="request">
     <element name="request">
-      <attribute name="msg_id"/>
-      <element name="context_id">
-        <text/>
-      </element>
-      <optional>
-        <element name="publish_to">
-          <text/>
-        </element>
-      </optional>
-      <zeroOrMore>
-        <element name="property">
-          <attribute name="key"/>
-          <optional>
-            <attribute name="type"/>
-          </optional>
-          <zeroOrMore>
-            <ref name="anything"/>
-          </zeroOrMore>
-        </element>
-      </zeroOrMore>
+      <interleave>
+        <ref name="common_elements"/>
+        <optional>
+          <element name="publish_to">
+            <text/>
+          </element>
+        </optional>
+        <optional>
+          <element name="guard">
+            <zeroOrMore>
+              <element name="property">
+                <ref name="prop_content"/>
+              </element>
+            </zeroOrMore>
+          </element>
+        </optional>
+        <zeroOrMore>
+          <element name="property">
+            <ref name="prop_content"/>
+          </element>
+        </zeroOrMore>
+      </interleave>
     </element>
   </define>
   <define name="release">
     <element name="release">
-      <attribute name="msg_id"/>
-      <element name="context_id">
-        <text/>
-      </element>
-      <element name="resource_id">
-        <text/>
-      </element>
-      <zeroOrMore>
-        <element name="property">
-          <attribute name="key"/>
-          <optional>
-            <attribute name="type"/>
-          </optional>
-          <zeroOrMore>
-            <ref name="anything"/>
-          </zeroOrMore>
+      <interleave>
+        <ref name="common_elements"/>
+        <optional>
+          <element name="publish_to">
+            <text/>
+          </element>
+        </optional>
+        <element name="resource_id">
+          <text/>
         </element>
-      </zeroOrMore>
+        <optional>
+          <element name="guard">
+            <zeroOrMore>
+              <element name="property">
+                <ref name="prop_content"/>
+              </element>
+            </zeroOrMore>
+          </element>
+        </optional>
+        <zeroOrMore>
+          <element name="property">
+            <ref name="prop_content"/>
+          </element>
+        </zeroOrMore>
+      </interleave>
     </element>
   </define>
   <define name="inform">
     <element name="inform">
-      <attribute name="msg_id"/>
-      <element name="context_id">
-        <text/>
-      </element>
-      <element name="inform_type">
-        <choice>
-          <value>CREATED</value>
-          <value>FAILED</value>
-          <value>STATUS</value>
-          <value>RELEASED</value>
-          <value>ERROR</value>
-          <value>WARN</value>
-        </choice>
-      </element>
-      <optional>
-        <element name="resource_id">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="resource_address">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="reason">
-          <text/>
-        </element>
-      </optional>
-      <zeroOrMore>
-        <element name="property">
-          <attribute name="key"/>
-          <optional>
-            <attribute name="type"/>
-          </optional>
-          <zeroOrMore>
-            <ref name="anything"/>
-          </zeroOrMore>
+      <interleave>
+        <ref name="common_elements"/>
+        <optional>
+          <element name="context_id">
+            <text/>
+          </element>
+        </optional>
+        <element name="inform_type">
+          <choice>
+            <value>CREATED</value>
+            <value>FAILED</value>
+            <value>STATUS</value>
+            <value>RELEASED</value>
+            <value>ERROR</value>
+            <value>WARN</value>
+          </choice>
         </element>
-      </zeroOrMore>
+        <optional>
+          <element name="resource_id">
+            <text/>
+          </element>
+        </optional>
+        <optional>
+          <element name="resource_address">
+            <text/>
+          </element>
+        </optional>
+        <optional>
+          <element name="reason">
+            <text/>
+          </element>
+        </optional>
+        <zeroOrMore>
+          <element name="property">
+            <ref name="prop_content"/>
+          </element>
+        </zeroOrMore>
+      </interleave>
     </element>
   </define>
 </grammar>

data/lib/omf_common/relaxng_schema.rb

@@ -0,0 +1,17 @@
+require 'singleton'
+
+module OmfCommon
+  class RelaxNGSchema
+    include Singleton
+
+    SCHEMA_FILE = "#{File.dirname(__FILE__)}/protocol/#{OmfCommon::PROTOCOL_VERSION}.rng"
+
+    attr_accessor :schema
+
+    def initialize
+      File.open(SCHEMA_FILE) do |f|
+        self.schema = Nokogiri::XML::RelaxNG(f.read)
+      end
+    end
+  end
+end

data/lib/omf_common/topic.rb

@@ -22,7 +22,7 @@ module OmfCommon
           event.node == self.id &&
           (valid_guard?(message_guard_proc) ? message_guard_proc.call(omf_message) : true)
       end
-      comm.pubsub_event(guard_block, &event_block)
+      comm.topic_event(guard_block, &event_block)
     end
 
     private

data/lib/omf_common/version.rb

@@ -1,4 +1,4 @@
 module OmfCommon
-  VERSION = "6.0.0.pre.8"
+  VERSION = "6.0.0.pre.10"
   PROTOCOL_VERSION = "6.0"
 end

data/omf_common.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "em-minitest-spec", "~> 1.1.1"
   s.add_development_dependency "simplecov"
   s.add_runtime_dependency "eventmachine", "~> 0.12.10"
-  s.add_runtime_dependency "blather", "~> 0.8.0"
+  s.add_runtime_dependency "blather", "= 0.8.0"
   s.add_runtime_dependency "logging", "~> 1.7.1"
   s.add_runtime_dependency "hashie", "~> 1.2.0"
   s.add_runtime_dependency "oml4r", "~> 2.8.0"

data/test/fixture/pubsub.rb

@@ -172,7 +172,7 @@ def omf_created_xml
   <event xmlns="http://jabber.org/protocol/pubsub#event">
     <items node="mclaren">
       <item id="4JMgcKzxFDLsP74">
-        <inform xmlns="http://schema.mytestbed.net/6.0/protocol" msg_id="a2b6aba9f11dc5bb88306a32d0720641f5020c1f">
+        <inform xmlns="http://schema.mytestbed.net/omf/6.0/protocol" msg_id="a2b6aba9f11dc5bb88306a32d0720641f5020c1f">
           <context_id>bf840fe9-c176-4fae-b7de-6fc27f183f76</context_id>
           <inform_type>CREATED</inform_type>
           <resource_id>444f17fb-546e-4685-a0d0-63e64fa046c8</resource_id>
@@ -194,7 +194,7 @@ def omf_status_xml
   <event xmlns="http://jabber.org/protocol/pubsub#event">
     <items node="mclaren">
       <item id="4JMgcKzxFDLsP74">
-        <inform xmlns="http://schema.mytestbed.net/6.0/protocol" msg_id="a2b6aba9f11dc5bb88306a32d0720641f5020c1f">
+        <inform xmlns="http://schema.mytestbed.net/omf/6.0/protocol" msg_id="a2b6aba9f11dc5bb88306a32d0720641f5020c1f">
           <context_id>bf840fe9-c176-4fae-b7de-6fc27f183f76</context_id>
           <inform_type>STATUS</inform_type>
           <property key="bob">bob</property>
@@ -215,7 +215,7 @@ def omf_failed_xml
   <event xmlns="http://jabber.org/protocol/pubsub#event">
     <items node="mclaren">
       <item id="4JMgcKzxFDLsP74">
-        <inform xmlns="http://schema.mytestbed.net/6.0/protocol" msg_id="a2b6aba9f11dc5bb88306a32d0720641f5020c1f">
+        <inform xmlns="http://schema.mytestbed.net/omf/6.0/protocol" msg_id="a2b6aba9f11dc5bb88306a32d0720641f5020c1f">
           <context_id>bf840fe9-c176-4fae-b7de-6fc27f183f76</context_id>
           <inform_type>FAILED</inform_type>
           <reason>No idea</reason>
@@ -236,7 +236,7 @@ def omf_released_xml
   <event xmlns="http://jabber.org/protocol/pubsub#event">
     <items node="mclaren">
       <item id="4JMgcKzxFDLsP74">
-        <inform xmlns="http://schema.mytestbed.net/6.0/protocol" msg_id="a2b6aba9f11dc5bb88306a32d0720641f5020c1f">
+        <inform xmlns="http://schema.mytestbed.net/omf/6.0/protocol" msg_id="a2b6aba9f11dc5bb88306a32d0720641f5020c1f">
           <context_id>bf840fe9-c176-4fae-b7de-6fc27f183f76</context_id>
           <inform_type>RELEASED</inform_type>
           <resource_id>444f17fb-546e-4685-a0d0-63e64fa046c8</resource_id>

data/test/omf_common/dsl/xmpp_spec.rb

@@ -8,7 +8,7 @@ describe OmfCommon::DSL::Xmpp do
     @stream = MiniTest::Mock.new
     @stream.expect(:send, true, [Blather::Stanza])
     @client.post_init @stream, Blather::JID.new('n@d/r')
-    @xmpp = Class.new { include OmfCommon::DSL::Xmpp }.new
+    @xmpp = OmfCommon::Comm.new(:xmpp)
   end
 
   describe "when communicating to xmpp server (via mocking)" do
@@ -177,8 +177,8 @@ describe OmfCommon::DSL::Xmpp do
       m1.must_be_kind_of OmfCommon::TopicMessage
       m2.must_be_kind_of OmfCommon::TopicMessage
       m1.body.name.must_equal 'configure'
-      m1.body.to_xml.must_match /<property key="throttle" type="fixnum">50<\/property>/
-      m2.body.to_xml.must_match /<property key="throttle" type="fixnum">50<\/property>/
+      m1.body.to_xml.must_match /<property key="throttle" type="integer">50<\/property>/
+      m2.body.to_xml.must_match /<property key="throttle" type="integer">50<\/property>/
     end
 
     it "must generate omf inform xml fragment" do
@@ -201,8 +201,8 @@ describe OmfCommon::DSL::Xmpp do
       m1.must_be_kind_of OmfCommon::TopicMessage
       m2.must_be_kind_of OmfCommon::TopicMessage
       m1.body.name.must_equal 'release'
-      m1.body.to_xml.must_match /<property key="resource_id" type="fixnum">100<\/property>/
-      m2.body.to_xml.must_match /<property key="resource_id" type="fixnum">100<\/property>/
+      m1.body.to_xml.must_match /<property key="resource_id" type="integer">100<\/property>/
+      m2.body.to_xml.must_match /<property key="resource_id" type="integer">100<\/property>/
     end
 
     it "must generate omf request xml fragment" do
@@ -230,7 +230,7 @@ describe OmfCommon::DSL::Xmpp do
     it "must react to omf created message" do
       Blather::Client.stub :new, @client do
         omf_create = OmfCommon::Message.create { |v| v.property('type', 'engine') }
-        omf_create.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+        omf_create.stub :msg_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
           omf_created = Blather::XMPPNode.parse(omf_created_xml)
           @client.receive_data omf_created
           @xmpp.on_created_message(omf_create) do |n|
@@ -245,7 +245,7 @@ describe OmfCommon::DSL::Xmpp do
     it "must react to omf status message" do
       Blather::Client.stub :new, @client do
         omf_request = OmfCommon::Message.request { |v| v.property('bob') }
-        omf_request.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+        omf_request.stub :msg_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
           omf_status = Blather::XMPPNode.parse(omf_status_xml)
           @client.receive_data omf_status
           @xmpp.on_status_message(omf_request) do |n|
@@ -260,7 +260,7 @@ describe OmfCommon::DSL::Xmpp do
     it "must react to omf release message" do
       Blather::Client.stub :new, @client do
         omf_release = OmfCommon::Message.release { |v| v.property('resource_id', '100') }
-        omf_release.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+        omf_release.stub :msg_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
           omf_released = Blather::XMPPNode.parse(omf_released_xml)
           @client.receive_data omf_released
           @xmpp.on_released_message(omf_release) do |n|
@@ -275,7 +275,7 @@ describe OmfCommon::DSL::Xmpp do
     it "must react to omf failed message" do
       Blather::Client.stub :new, @client do
         omf_create = OmfCommon::Message.create { |v| v.property('type', 'engine') }
-        omf_create.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+        omf_create.stub :msg_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
           omf_failed = Blather::XMPPNode.parse(omf_failed_xml)
           @client.receive_data omf_failed
           @xmpp.on_failed_message(omf_create) do |n|

data/test/omf_common/message_spec.rb

@@ -9,6 +9,7 @@ describe OmfCommon::Message do
     it "must return a create or configure XML element without failing" do
       %w(create configure).each do |msg_name|
         message = Message.__send__(msg_name) do |m|
+
           PROP_ELEMENTS.each_with_index do |prop_element, index|
             if index == 0
               m.property(prop_element, rand(100))
@@ -17,8 +18,15 @@ describe OmfCommon::Message do
                 p.element('unit', 'test')
                 p.element('precision', 'test')
               end
+
             end
           end
+
+          # Guard element optional
+          m.element(:guard) do |g|
+            g.property('p1', 1)
+            g.property('p2', 2)
+          end
         end
         message.valid?.must_equal true
       end
@@ -57,6 +65,17 @@ describe OmfCommon::Message do
       m.context_id.must_equal '9012c3bc-68de-459a-ac9f-530cc7168e22'
     end
 
+    it "must escape erb code in property" do
+      m = Message.inform('CREATED', '9012c3bc-68de-459a-ac9f-530cc7168e22') do |m|
+        m.property('bob', "hello <%= world %>")
+        m.property('alice', "hello <%= 1 % 2 %>")
+      end
+      m.read_property('bob').must_equal "hello <%= world %>"
+      world = 'world'
+      m.read_property('bob', binding).must_equal "hello world"
+      m.read_property('alice', binding).must_equal "hello 1"
+    end
+
     it "must be able to pretty print an app_event message" do
       Message.inform('STATUS') do |m|
         m.property('status_type', 'APP_EVENT')
@@ -84,9 +103,9 @@ describe OmfCommon::Message do
 
       message.must_be_kind_of Message
       message.operation.must_equal :create
-      message.read_element("//property").size.must_equal 7
-      message.read_content("unit").must_equal 'mb'
-      message.read_element("/create/property").size.must_equal 7
+      message.read_element("property").size.must_equal 7
+      message.read_content("property[@key='memory']/unit").must_equal 'mb'
+      message.read_element("property").size.must_equal 7
       message.read_property("type").must_equal 'vm'
       message.read_property(:type).must_equal 'vm'
 

data/test/omf_common/topic_message_spec.rb

@@ -10,7 +10,7 @@ describe OmfCommon::Topic do
     @stream = MiniTest::Mock.new
     @stream.expect(:send, true, [Blather::Stanza])
     @client.post_init @stream, Blather::JID.new('n@d/r')
-    @comm = Class.new { include OmfCommon::DSL::Xmpp }.new
+    @comm = Comm.new(:xmpp)
     @topic = @comm.get_topic('mclaren')
     @message = @comm.request_message([:bob])
   end
@@ -50,7 +50,7 @@ describe OmfCommon::Topic do
     it "must react to omf created message" do
       Blather::Client.stub :new, @client do
         omf_create = @comm.create_message { |v| v.property('type', 'engine') }
-        omf_create.body.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+        omf_create.body.stub :msg_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
           omf_created = Blather::XMPPNode.parse(omf_created_xml)
           @client.receive_data omf_created
           omf_create.on_inform_created do |n|
@@ -66,7 +66,7 @@ describe OmfCommon::Topic do
     it "must react to omf status message" do
       Blather::Client.stub :new, @client do
         omf_request = @comm.request_message { |v| v.property('bob') }
-        omf_request.body.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+        omf_request.body.stub :msg_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
           omf_status = Blather::XMPPNode.parse(omf_status_xml)
           @client.receive_data omf_status
           omf_request.on_inform_status do |n|
@@ -82,7 +82,7 @@ describe OmfCommon::Topic do
     it "must react to omf release message" do
       Blather::Client.stub :new, @client do
         omf_release = @comm.release_message { |v| v.property('resource_id', '100') }
-        omf_release.body.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+        omf_release.body.stub :msg_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
           omf_released = Blather::XMPPNode.parse(omf_released_xml)
           @client.receive_data omf_released
           omf_release.on_inform_released do |n|
@@ -98,7 +98,7 @@ describe OmfCommon::Topic do
     it "must react to omf failed message" do
       Blather::Client.stub :new, @client do
         omf_create = @comm.create_message { |v| v.property('type', 'engine') }
-        omf_create.body.stub :context_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
+        omf_create.body.stub :msg_id, "bf840fe9-c176-4fae-b7de-6fc27f183f76" do
           omf_failed = Blather::XMPPNode.parse(omf_failed_xml)
           @client.receive_data omf_failed
           omf_create.on_inform_failed do |n|

data/test/omf_common/topic_spec.rb

@@ -10,7 +10,7 @@ describe OmfCommon::Topic do
     @stream = MiniTest::Mock.new
     @stream.expect(:send, true, [Blather::Stanza])
     @client.post_init @stream, Blather::JID.new('n@d/r')
-    @comm = Class.new { include OmfCommon::DSL::Xmpp }.new
+    @comm = Comm.new(:xmpp)
     @topic = @comm.get_topic('mclaren')
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omf_common
 version: !ruby/object:Gem::Version
-  version: 6.0.0.pre.8
+  version: 6.0.0.pre.10
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2013-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -80,7 +80,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
@@ -88,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
@@ -155,13 +155,16 @@ files:
 - lib/omf_common/command.rb
 - lib/omf_common/core_ext/object.rb
 - lib/omf_common/core_ext/string.rb
+- lib/omf_common/default_logging.rb
 - lib/omf_common/dsl/xmpp.rb
 - lib/omf_common/dsl/xmpp_mp.rb
 - lib/omf_common/exec_app.rb
+- lib/omf_common/key.rb
 - lib/omf_common/measure.rb
 - lib/omf_common/message.rb
 - lib/omf_common/protocol/6.0.rnc
 - lib/omf_common/protocol/6.0.rng
+- lib/omf_common/relaxng_schema.rb
 - lib/omf_common/topic.rb
 - lib/omf_common/topic_message.rb
 - lib/omf_common/version.rb
@@ -199,4 +202,13 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Common library of OMF
-test_files: []
+test_files:
+- test/fixture/pubsub.rb
+- test/omf_common/comm_spec.rb
+- test/omf_common/command_spec.rb
+- test/omf_common/core_ext/string_spec.rb
+- test/omf_common/dsl/xmpp_spec.rb
+- test/omf_common/message_spec.rb
+- test/omf_common/topic_message_spec.rb
+- test/omf_common/topic_spec.rb
+- test/test_helper.rb