omf_common 6.0.0.pre.1 → 6.0.0.pre.2

data/lib/omf_common/comm.rb

@@ -1,6 +1,7 @@
 require 'omf_common/dsl/xmpp_blather'
 
 module OmfCommon
+  # PubSub communication class, can be extended with different implementations
   class Comm
     def initialize(pubsub_implementation)
       self.extend("OmfCommon::DSL::#{pubsub_implementation.to_s.camelcase}".constant)

data/lib/omf_common/command.rb

@@ -5,7 +5,7 @@ module OmfCommon::Command
   #
   # @example
   #
-  #   OmfRc::Command.execute("uname -a")
+  #   OmfCommon::Command.execute("uname -a")
   def self.execute(*cmd, &block)
     result = nil
     begin

data/lib/omf_common/message.rb

@@ -38,6 +38,8 @@ module OmfCommon
       end
     end
 
+    # Construct a property node
+    #
     def property(key, value = nil, &block)
       key_node = Message.new('property')
       key_node.write_attr('key', key)
@@ -58,6 +60,8 @@ module OmfCommon
       self
     end
 
+    # Validate against relaxng schema
+    #
     def valid?
       validation = Nokogiri::XML::RelaxNG(File.open(SCHEMA_FILE)).validate(document)
       if validation.empty?
@@ -68,6 +72,8 @@ module OmfCommon
       end
     end
 
+    # Short cut for adding xml node
+    #
     def element(key, value)
       key_node = Niceogiri::XML::Node.new(key)
       key_node.content = value
@@ -80,6 +86,7 @@ module OmfCommon
       element_name.to_sym
     end
 
+    # 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)
     end

data/lib/omf_common/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omf_common
 version: !ruby/object:Gem::Version
-  version: 6.0.0.pre.1
+  version: 6.0.0.pre.2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-28 00:00:00.000000000 Z
+date: 2012-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest