omf_common 6.0.8.pre.2 → 6.0.8.pre.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDY5YWU0MWI3YjNmMGE5M2IyM2M3OThiOGViYjFiN2VjYjM2ODliMw==
-  data.tar.gz: !binary |-
-    NGM5NmZlYjlmYjUxZGY3YjY5ODkwYzZmYjhlZWRjNTU1ODhmYjFkMw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NzFjOWU5MzY2OWE3NjkzM2RjMjQ3MGUyMzYwOTUxOTQxNDg5OTU4Njc5NTFi
-    YjNlOTI1YjY0YTY1ZjRhZTRjMmY1MjE5OWIyZjYxNDU3MzA5ODg5MTk0MDRj
-    MTQ0ODkyMjYxMDA0YzY4ZjYyYjRmYzkxNDk1ZDBiM2Y0ZTE0MDk=
-  data.tar.gz: !binary |-
-    MDRlYWRiYzQ2NWMyMDFjNTc2NmM5NjJjNDBjODg4NzYxMGEwZWZjNDM0YmY2
-    MzI2NWUwM2NkOGQzZTcwMjgyZmU1MmQ2Mjc0ZDFhZjU1YzFjNTMxZDRjZGE0
-    MzhjMGUyMTUzOWVmZjc4MDI2NTRlODVlOWY3NTc2YjEwMDg3NWI=
+SHA1:
+  metadata.gz: 2935646d99805e1bfee37d54048dc9f38d86ac95
+  data.tar.gz: 08a166445c5f9416791daa78a9d81568a8037149
+SHA512:
+  metadata.gz: 95d4412b66bd738b92fc5ea47a773b8028d64e11a4455f159740961a6ab187d48a4b04c717499fa57fef2edcfc505aa4f677076254a1e8dd8647339fcb6f3093
+  data.tar.gz: 05d54b318b582a550429e0d2fee26d93dc35bc079a7bd36f4683dd35ca345b433bae5cda0b97b1687e86d7f06ed491fb56b56ba0382166511795bec590488429

data/lib/omf_common.rb

@@ -317,11 +317,11 @@ module OmfCommon
   # @param [String] file_path of the logging config file
   def self.load_logging_config(file_path)
     unless file_path.nil?
-      l_cfg_mime_type = `file --mime-type -b #{file_path}`.strip rescue nil
+      l_cfg_mime_type = File.extname(file_path)
       case l_cfg_mime_type
-      when /ruby/
+      when /rb/
         load file_path
-      when /plain/
+      when /yml|yaml/
         Logging::Config::YamlConfigurator.load(file_path)
       else
         warn "Invalid config file format for logging, please use Ruby or Yaml."

data/lib/omf_common/comm.rb

@@ -132,10 +132,14 @@ module OmfCommon
       { proto: nil, user: nil, domain: nil }
     end
 
-    # Return a valid address for this type of communicator
+    # Take a string and use it to generate a valid topic address for this type of communicator
     # Must be implemented by subclasses
     #
-    def string_to_address(a_string)
+    # This may be used when we construct an FRCP Configure message, which requests some
+    # resources to subscribe to a topic, which has not yet been created at the time of this
+    # message's construction, but which will be created before this message is published.
+    # (an example of such case can be found in OMF EC Group handling code)
+    def string_to_topic_address(a_string)
       raise NotImplementedError
     end
 

data/lib/omf_common/comm/amqp/amqp_communicator.rb

@@ -32,7 +32,7 @@ module OmfCommon
           unless (@url = @opts.delete(:url))
             raise "Missing 'url' option for AQMP layer"
           end
-          @address_prefix = @url + '/'
+          @address_prefix = @url + '/frcp.'
           _connect()
           super
         end
@@ -41,14 +41,13 @@ module OmfCommon
           { proto: :amqp, user: ::AMQP.settings[:user], domain: ::AMQP.settings[:host] }
         end
 
-        def string_to_address(a_string)
-          @address_prefix+a_string 
+        def string_to_topic_address(a_string)
+          @address_prefix+a_string
         end
 
         # Shut down comms layer
         def disconnect(opts = {})
           info "Disconnecting..."
-          OmfCommon.eventloop.stop
         end
 
         # TODO: Should be thread safe and check if already connected

data/lib/omf_common/comm/topic.rb

@@ -117,17 +117,8 @@ module OmfCommon
       #
       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
+          @handlers.clear
+          @@name2inst.delete_if { |k, v| k == id.to_sym || k == address.to_sym}
         end
       end
 

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

@@ -57,7 +57,7 @@ class Comm
         { proto: :xmpp, user: jid.node, domain: jid.domain }
       end
 
-      def string_to_address(a_string)
+      def string_to_topic_address(a_string)
         "xmpp://#{a_string}@#{jid.domain}"
       end
 
@@ -212,7 +212,8 @@ class Comm
         pubsub.create(topic, pubsub_host, PUBSUB_CONFIGURE, &callback_logging(__method__, topic, &block))
       end
 
-      # Un-subscribe all existing subscriptions from all pubsub topics.
+      # Un-subscribe all existing subscriptions from all pubsub topics
+      #
       def unsubscribe(pubsub_host = default_host)
         pubsub.subscriptions(pubsub_host) do |m|
           m[:subscribed] && m[:subscribed].each do |s|
@@ -222,6 +223,18 @@ class Comm
         end
       end
 
+      # Un-subscribe one single topic by topic address
+      #
+      def _unsubscribe_one(topic_id, pubsub_host = default_host)
+        pubsub.subscriptions(pubsub_host) do |m|
+          m[:subscribed] && m[:subscribed].each do |s|
+            if s[:node] == topic_id.to_s
+              pubsub.unsubscribe(s[:node], nil, s[:subid], pubsub_host, &callback_logging(__method__, s[:node], s[:subid]))
+            end
+          end
+        end
+      end
+
       def affiliations(pubsub_host = default_host, &block)
         pubsub.affiliations(pubsub_host, &callback_logging(__method__, &block))
       end
@@ -263,7 +276,7 @@ class Comm
         end
 
         mblock = proc do |stanza|
-          OmfCommon::DSL::Xmpp::MPReceived.inject(Time.now.to_f, jid, stanza.node, stanza.to_s[/mid="(.{36})/, 1]) if OmfCommon::Measure.enabled? 
+          OmfCommon::DSL::Xmpp::MPReceived.inject(Time.now.to_f, jid, stanza.node, stanza.to_s[/mid="(.{36})/, 1]) if OmfCommon::Measure.enabled?
           block.call(stanza) if block
         end
         pubsub_event(guard_block, &callback_logging(__method__, &mblock))

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

@@ -26,6 +26,11 @@ class XMPP
       end
     end
 
+    def unsubscribe(key)
+      super
+      OmfCommon.comm._unsubscribe_one(self.id)
+    end
+
     private
 
     def pubsub_domain_addr

data/lib/omf_common/message/json/json_message.rb

@@ -185,7 +185,7 @@ module OmfCommon
           if @content[:src].is_a? OmfCommon::Comm::Topic
             @content[:src] = @content[:src].address
           end
-          @content[:itype] = self.itype(:frcp)
+          @content[:itype] = self.itype(:frcp) unless self.itype(:frcp).nil?
 
           #raise 'local/local' if @content[:src].id.match 'local:/local'
           #puts @content.inspect
@@ -259,4 +259,4 @@ module OmfCommon
       end # class
     end
   end
-end
+end

data/lib/omf_common/message/xml/message.rb

@@ -138,11 +138,6 @@ class XML
       end
     end
 
-    def resource
-      r_id = _get_property(:res_id)
-      OmfCommon::Comm::XMPP::Topic.create(r_id)
-    end
-
     def marshall
       build_xml
 
@@ -469,6 +464,8 @@ class XML
         'integer'
       when /hash|mash/
         'hash'
+      when /symbol/
+        'string'
       else
         v_type
       end

data/lib/omf_common/protocol/6.0.rnc

@@ -2,41 +2,81 @@ default namespace = "http://schema.mytestbed.net/omf/6.0/protocol"
 
 start = (create | configure | request | release | inform | env)
 
-common_elements = attribute mid { text }?
+# Shared elements among all types of messages
+common_elements =
+  # Message ID (optional)
+  attribute mid { text }?
+  # Time stamp
   & element ts { text }
+  # Source (who sends it) (optional)
   & element src { text }?
+  # Reply address (who sends it) (optional)
   & element replyto { text }?
-  & element props { property * }?
+  # Resource properties (optional)
+  & element props { core_props, property * }?
+  # Guard with filtering properties (optional)
   & element guard { property * }?
 
-anything = ( text | element * { (attribute type { text })?, (text | anything) * })
+property = element * { valid_content? }
 
-property = element * { (attribute type { text })?, anything * }
+# Valid content type
+boolean_content = attribute type { "boolean" }, text
+integer_content = attribute type { "integer" }, text
+float_content = attribute type { "float" }, text
+string_content = attribute type { "string" }, text
+array_content = attribute type { "array" }
+  & element it { valid_content? | property * } *
+hash_content = attribute type { "hash" }
+  & property *
 
+valid_content = boolean_content | integer_content | float_content | string_content | array_content | hash_content
+
+# Core Resource Proxy Properties
+res_id = element res_id { string_content }
+reason = element reason { string_content }
+membership = element membership { array_content | string_content }
+uid = element uid { string_content }
+type = element type { string_content }
+hrn = element hrn { string_content }
+name = element name { string_content }
+child_resources= element child_resources { array_content }
+available_properties= element available_properties { hash_content }
+supported_children_type= element supported_children_type { array_content }
+certificate = element certificate { string_content }
+
+core_props = (res_id | reason | hrn | membership | uid | type | name | child_resources | available_properties | supported_children_type | certificate ) *
+
+# Create message
 create = element create {
   common_elements
+  # Resource type is required
   & element rtype { text }
 }
 
+# Configure message
 configure = element configure {
   common_elements
 }
 
+# Request message
 request = element request {
   common_elements
 }
 
+# Release message
 release = element release {
   common_elements
   & element res_id { text }?
 }
 
+# Inform message
 inform = element inform {
   common_elements
   & element cid { text }?
   & element itype { "CREATION.OK" | "CREATION.FAILED" | "STATUS" | "RELEASED" | "ERROR" | "WARN" }
 }
 
+# Message can be wrapped in env(elope)
 env = element env {
- create | configure | request | release | inform
+  create | configure | request | release | inform
 }

data/lib/omf_common/protocol/6.0.rng

@@ -10,32 +10,40 @@
       <ref name="env"/>
     </choice>
   </start>
+  <!-- Shared elements among all types of messages -->
   <define name="common_elements">
     <interleave>
       <optional>
+        <!-- Message ID (optional) -->
         <attribute name="mid"/>
       </optional>
+      <!-- Time stamp -->
       <element name="ts">
         <text/>
       </element>
       <optional>
+        <!-- Source (who sends it) (optional) -->
         <element name="src">
           <text/>
         </element>
       </optional>
       <optional>
+        <!-- Reply address (who sends it) (optional) -->
         <element name="replyto">
           <text/>
         </element>
       </optional>
       <optional>
+        <!-- Resource properties (optional) -->
         <element name="props">
+          <ref name="core_props"/>
           <zeroOrMore>
             <ref name="property"/>
           </zeroOrMore>
         </element>
       </optional>
       <optional>
+        <!-- Guard with filtering properties (optional) -->
         <element name="guard">
           <zeroOrMore>
             <ref name="property"/>
@@ -44,54 +52,179 @@
       </optional>
     </interleave>
   </define>
-  <define name="anything">
-    <choice>
-      <text/>
-      <element>
-        <anyName/>
-        <optional>
-          <attribute name="type"/>
-        </optional>
-        <zeroOrMore>
-          <choice>
-            <text/>
-            <ref name="anything"/>
-          </choice>
-        </zeroOrMore>
-      </element>
-    </choice>
-  </define>
   <define name="property">
     <element>
       <anyName/>
       <optional>
-        <attribute name="type"/>
+        <ref name="valid_content"/>
       </optional>
+    </element>
+  </define>
+  <!-- Valid content type -->
+  <define name="boolean_content">
+    <attribute name="type">
+      <value>boolean</value>
+    </attribute>
+    <text/>
+  </define>
+  <define name="integer_content">
+    <attribute name="type">
+      <value>integer</value>
+    </attribute>
+    <text/>
+  </define>
+  <define name="float_content">
+    <attribute name="type">
+      <value>float</value>
+    </attribute>
+    <text/>
+  </define>
+  <define name="string_content">
+    <attribute name="type">
+      <value>string</value>
+    </attribute>
+    <text/>
+  </define>
+  <define name="array_content">
+    <interleave>
+      <attribute name="type">
+        <value>array</value>
+      </attribute>
       <zeroOrMore>
-        <ref name="anything"/>
+        <element name="it">
+          <choice>
+            <optional>
+              <ref name="valid_content"/>
+            </optional>
+            <zeroOrMore>
+              <ref name="property"/>
+            </zeroOrMore>
+          </choice>
+        </element>
       </zeroOrMore>
+    </interleave>
+  </define>
+  <define name="hash_content">
+    <interleave>
+      <attribute name="type">
+        <value>hash</value>
+      </attribute>
+      <zeroOrMore>
+        <ref name="property"/>
+      </zeroOrMore>
+    </interleave>
+  </define>
+  <define name="valid_content">
+    <choice>
+      <ref name="boolean_content"/>
+      <ref name="integer_content"/>
+      <ref name="float_content"/>
+      <ref name="string_content"/>
+      <ref name="array_content"/>
+      <ref name="hash_content"/>
+    </choice>
+  </define>
+  <!-- Core Resource Proxy Properties -->
+  <define name="res_id">
+    <element name="res_id">
+      <ref name="string_content"/>
+    </element>
+  </define>
+  <define name="reason">
+    <element name="reason">
+      <ref name="string_content"/>
+    </element>
+  </define>
+  <define name="membership">
+    <element name="membership">
+      <choice>
+        <ref name="array_content"/>
+        <ref name="string_content"/>
+      </choice>
+    </element>
+  </define>
+  <define name="uid">
+    <element name="uid">
+      <ref name="string_content"/>
+    </element>
+  </define>
+  <define name="type">
+    <element name="type">
+      <ref name="string_content"/>
+    </element>
+  </define>
+  <define name="hrn">
+    <element name="hrn">
+      <ref name="string_content"/>
     </element>
   </define>
+  <define name="name">
+    <element name="name">
+      <ref name="string_content"/>
+    </element>
+  </define>
+  <define name="child_resources">
+    <element name="child_resources">
+      <ref name="array_content"/>
+    </element>
+  </define>
+  <define name="available_properties">
+    <element name="available_properties">
+      <ref name="hash_content"/>
+    </element>
+  </define>
+  <define name="supported_children_type">
+    <element name="supported_children_type">
+      <ref name="array_content"/>
+    </element>
+  </define>
+  <define name="certificate">
+    <element name="certificate">
+      <ref name="string_content"/>
+    </element>
+  </define>
+  <define name="core_props">
+    <zeroOrMore>
+      <choice>
+        <ref name="res_id"/>
+        <ref name="reason"/>
+        <ref name="hrn"/>
+        <ref name="membership"/>
+        <ref name="uid"/>
+        <ref name="type"/>
+        <ref name="name"/>
+        <ref name="child_resources"/>
+        <ref name="available_properties"/>
+        <ref name="supported_children_type"/>
+        <ref name="certificate"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <!-- Create message -->
   <define name="create">
     <element name="create">
       <interleave>
         <ref name="common_elements"/>
+        <!-- Resource type is required -->
         <element name="rtype">
           <text/>
         </element>
       </interleave>
     </element>
   </define>
+  <!-- Configure message -->
   <define name="configure">
     <element name="configure">
       <ref name="common_elements"/>
     </element>
   </define>
+  <!-- Request message -->
   <define name="request">
     <element name="request">
       <ref name="common_elements"/>
     </element>
   </define>
+  <!-- Release message -->
   <define name="release">
     <element name="release">
       <interleave>
@@ -104,6 +237,7 @@
       </interleave>
     </element>
   </define>
+  <!-- Inform message -->
   <define name="inform">
     <element name="inform">
       <interleave>
@@ -126,6 +260,7 @@
       </interleave>
     </element>
   </define>
+  <!-- Message can be wrapped in env(elope) -->
   <define name="env">
     <element name="env">
       <choice>

data/omf_common.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |s|
   s.add_development_dependency "mocha"
 
   s.add_runtime_dependency "eventmachine", "= 1.0.3"
-  s.add_runtime_dependency "blather", "= 0.8.7"
+  s.add_runtime_dependency "blather", "= 0.8.8"
   s.add_runtime_dependency "logging", "~> 1.7.1"
-  s.add_runtime_dependency "hashie", "~> 1.2.0"
+  s.add_runtime_dependency "hashie"
   s.add_runtime_dependency "oml4r", "~> 2.9.5"
-  s.add_runtime_dependency "json", "~> 1.7.7"
+  s.add_runtime_dependency "json"
   s.add_runtime_dependency "json-jwt"
   s.add_runtime_dependency "amqp"
   s.add_runtime_dependency "uuidtools"

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: omf_common
 version: !ruby/object:Gem::Version
-  version: 6.0.8.pre.2
+  version: 6.0.8.pre.3
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -42,42 +42,42 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +126,16 @@ dependencies:
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oml4r
   requirement: !ruby/object:Gem::Requirement
@@ -154,56 +154,56 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json-jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: amqp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Common library of OMF, a generic framework for controlling and managing
@@ -307,12 +307,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>'
+  - - '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []