occi 2.2.2 → 2.3.0

data/lib/occi/core/kind.rb

@@ -1,4 +1,4 @@
-require 'json'
+require 'active_support/json'
 require 'occi/core/category'
 require 'occi/core/action'
 require 'occi/core/attribute_properties'
@@ -7,13 +7,22 @@ module OCCI
   module Core
     class Kind < OCCI::Core::Category
 
-      attr_accessor :entities
+      attr_accessor :entities, :related, :actions
 
-      def initialize(kind, default = nil)
+      # @param [String ] scheme
+      # @param [String] term
+      # @param [String] title
+      # @param [OCCI::Core::AttributeProperties] attributes
+      # @param [Array] related
+      # @param [Array] actions
+      def initialize(scheme, term, title=nil, attributes=nil, related=nil, actions=nil)
         @entities = []
-        super(kind, default)
+        @related  = related.to_a
+        @actions  = actions.to_a
+        super(scheme, term, title, attributes)
       end
 
+      # @return [String] name of the OCCI core class the entity is related to
       def entity_type
         case type_identifier
           when "http://schemas.ogf.org/occi/core#resource"
@@ -25,8 +34,26 @@ module OCCI
         end
       end
 
+      # @return [String] string containing location URI of kind
       def location
-        '/' + self[:term] + '/'
+        '/' + @term + '/'
+      end
+
+      def as_json(options={ })
+        kind = Hashie::Mash.new
+        kind.related = @related if @related.any?
+        kind.actions = @actions if @actions.any?
+        kind.merge! super
+        kind
+      end
+
+      def to_text
+        text = super
+        text << ';rel=' + @related.join(' ').inspect if @related.any?
+        text << ';location=' + self.location.inspect
+        text << ';attributes=' + @attributes.combine.join(' ').inspect if @attributes.any?
+        text << ';actions=' + @actions.join(' ').inspect if @actions.any?
+        text
       end
 
     end

data/lib/occi/core/link.rb

@@ -1,5 +1,4 @@
 require 'hashie/mash'
-require 'occi/model'
 require 'occi/core/entity'
 require 'occi/core/kind'
 
@@ -7,60 +6,24 @@ module OCCI
   module Core
     class Link < Entity
 
-      # Define appropriate kind
-      def self.register
-        data = Hashie::Mash.new
-        data[:actions] = []
-        data[:related] = %w{http://schemas.ogf.org/occi/core#entity}
-        data[:term] = "link"
-        data[:scheme] = "http://schemas.ogf.org/occi/core#"
-        data[:title] = "Link"
+      # @return [OCCI::Core::Kind] kind definition of Link type
+      def self.kind_definition
+        kind = OCCI::Core::Kind.new('http://schemas.ogf.org/occi/core#','link')
 
-        data.attributes!.occi!.core!.target!.type = "string"
-        data.attributes!.occi!.core!.target!.pattern = ".*"
-        data.attributes!.occi!.core!.target!.required = false
-        data.attributes!.occi!.core!.target!.mutable = true
+        kind.related = %w{http://schemas.ogf.org/occi/core#entity}
+        kind.title = "Link"
 
-        data.attributes!.occi!.core!.source!.type = "string"
-        data.attributes!.occi!.core!.source!.pattern = ".*"
-        data.attributes!.occi!.core!.source!.required = false
-        data.attributes!.occi!.core!.source!.mutable = true
+        kind.attributes.occi!.core!.target!.type = "string"
+        kind.attributes.occi!.core!.target!.pattern = ".*"
+        kind.attributes.occi!.core!.target!.required = false
+        kind.attributes.occi!.core!.target!.mutable = true
 
-        kind = OCCI::Core::Kind.new(data)
-        OCCI::Model.register(kind)
-      end
-
-      def target
-        return self[:target]
-      end
-
-      def target=(target)
-        self[:target] = target
-        self.attributes!.occi!.core!.target = target
-      end
-
-      def source
-        return self[:source]
-      end
-
-      def source=(source)
-        self[:source] = source
-        self.attributes!.occi!.core!.source = source
-      end
+        kind.attributes.occi!.core!.source!.type = "string"
+        kind.attributes.occi!.core!.source!.pattern = ".*"
+        kind.attributes.occi!.core!.source!.required = false
+        kind.attributes.occi!.core!.source!.mutable = true
 
-      def convert_value(val, duping=false) #:nodoc:
-        case val
-          when self.class
-            val.dup
-          when ::Hash
-            val = val.dup if duping
-            self.class.subkey_class.new.merge(val) unless val.kind_of?(Hashie::Mash)
-            val
-          when Array
-            val.collect { |e| convert_value(e) }
-          else
-            val
-        end
+        kind
       end
 
     end

data/lib/occi/core/mixin.rb

@@ -1,19 +1,45 @@
-require 'json'
+require 'active_support/json'
 require 'occi/core/category'
 
 module OCCI
   module Core
     class Mixin < OCCI::Core::Category
 
-      attr_accessor :entities
+      attr_accessor :entities, :related, :actions
 
-      def initialize(mixin, default = nil)
+      # @param [String ] scheme
+      # @param [String] term
+      # @param [String] title
+      # @param [OCCI::Core::AttributeProperties] attributes
+      # @param [Array] related
+      # @param [Array] actions
+      def initialize(scheme, term, title=nil, attributes=nil, related=nil, actions=nil)
         @entities = []
-        super(mixin, default)
+        @related  = related.to_a
+        @actions  = actions.to_a
+        super(scheme, term, title, attributes)
       end
 
+      # @return [String] string containing location URI of mixin
       def location
-        '/mixin/' + self[:term] + '/'
+        '/mixins/' + @term + '/'
+      end
+
+      def as_json(options={ })
+        mixin = Hashie::Mash.new
+        mixin.related = @related if @related.any?
+        mixin.actions = @actions if @actions.any?
+        mixin.merge! super
+        mixin
+      end
+
+      def to_text
+        text = super
+        text << ';rel=' + @related.join(' ').inspect if @related.any?
+        text << ';location=' + self.location.inspect
+        text << ';attributes=' + @attributes.combine.join(' ').inspect if @attributes.any?
+        text << ';actions=' + @actions.join(' ').inspect if @actions.any?
+        text
       end
 
     end

data/lib/occi/core/resource.rb

@@ -1,5 +1,5 @@
 require 'hashie/mash'
-require 'occi/model'
+require 'active_support/json'
 require 'occi/core/entity'
 require 'occi/core/kind'
 
@@ -7,46 +7,47 @@ module OCCI
   module Core
     class Resource < Entity
 
-      def self.register
-        data = Hashie::Mash.new
-        data[:related] = %w{http://schemas.ogf.org/occi/core#entity}
-        data[:term] = "resource"
-        data[:scheme] = "http://schemas.ogf.org/occi/core#"
-        data[:title] = "Resource"
+      attr_accessor :links
 
-        data.attributes!.occi!.core!.summary!.type = "string"
-        data.attributes!.occi!.core!.summary!.pattern = ".*"
-        data.attributes!.occi!.core!.summary!.required = false
-        data.attributes!.occi!.core!.summary!.mutable = true
+      def initialize(kind, mixins=nil, attributes=nil, links=nil)
+        @href = nil
+        @links = links.to_a
+        super(kind, mixins, attributes)
+      end
+
+      def self.kind_definition
+        kind = OCCI::Core::Kind.new('http://schemas.ogf.org/occi/core#', 'resource')
+
+        kind.related = %w{http://schemas.ogf.org/occi/core#entity}
+        kind.title   = 'Resource'
+
+        kind.attributes.occi!.core!.summary!.type     = 'string'
+        kind.attributes.occi!.core!.summary!.pattern  = '.*'
+        kind.attributes.occi!.core!.summary!.required = false
+        kind.attributes.occi!.core!.summary!.mutable  = true
 
-        kind = OCCI::Core::Kind.new(data)
-        OCCI::Model.register(kind)
+        kind
       end
 
-      def summary
-        self[:summary] ||= self.attributes!.occi!.core!.summary if self.attributes!.occi!.core
-        return self[:summary]
+      # set id for resource and update the the source of all links
+      # @param [UUIDTools::UUID] id
+      def id=(id)
+        super(id)
+        @links.each { |link| link.attributes.occi!.core!.source = self.location }
       end
 
-      def summary=(summary)
-        self[:summary] = summary
-        self.attributes ||= OCCI::Core::Attributes.new
-        self.attributes!.occi!.core!.summary = summary
+      # update the source of all links before returning them
+      # @return [Array] links of resource
+      def links
+        @links.each { |link| link.attributes.occi!.core!.source = self.location }
+        @links
       end
 
-      def convert_value(val, duping=false) #:nodoc:
-        case val
-          when self.class
-            val.dup
-          when ::Hash
-            val = val.dup if duping
-            self.class.subkey_class.new.merge(val) unless val.kind_of?(Hashie::Mash)
-            val
-          when Array
-            val.collect { |e| convert_value(e) }
-          else
-            val
-        end
+      def as_json(options={ })
+        resource = Hashie::Mash.new
+        resource.links = @links if @links.any?
+        resource.merge! super
+        resource
       end
 
     end

data/lib/occi/log.rb

@@ -6,13 +6,17 @@ module OCCI
 
     include Logger::Severity
 
+    attr_reader :logger
+
     # creates a new OCCI logger
     # @param [IO,String] logdev The log device.  This is a filename (String) or IO object (typically +STDOUT+,
     #  +STDERR+, or an open file).
-    # @param [Constant] level Logging severity threshold (e.g. <tt>OCCI::Log::INFO</tt>).
-    def initialize(logdev, level)
-      @logger         = Logger.new(logdev)
-      @logger.level   = level
+    def initialize(logdev)
+      if logdev.kind_of? Logger
+        @logger = logdev
+      else
+        @logger = Logger.new(logdev)
+      end
 
       # subscribe to log messages and send to logger
       @log_subscriber = ActiveSupport::Notifications.subscribe("log") do |name, start, finish, id, payload|
@@ -20,6 +24,14 @@ module OCCI
       end
     end
 
+    def level=(severity)
+      @logger.level = severity
+    end
+
+    def level
+      @logger.level
+    end
+
     # @see info
     def self.debug(message)
       ActiveSupport::Notifications.instrument("log", :level => Logger::DEBUG, :message => message)

data/lib/occi/model.rb

@@ -3,21 +3,28 @@ require 'occi/log'
 
 module OCCI
   class Model
-    @@categories = { }
-    @@locations  = { }
+    attr_accessor :categories
+    attr_accessor :locations
+
+    def initialize(collection=nil)
+      @categories = { }
+      @locations  = { }
+      register_core
+      register_collection collection if collection
+    end
 
     # register OCCI Core categories enitity, resource and link
-    def self.register_core
-      OCCI::Log.info("### Registering OCCI Core categories enitity, resource and link ###")
-      OCCI::Core::Entity.register
-      OCCI::Core::Resource.register
-      OCCI::Core::Link.register
+    def register_core
+      OCCI::Log.info "### Registering OCCI Core categories enitity, resource and link ###"
+      register OCCI::Core::Entity.kind_definition
+      register OCCI::Core::Resource.kind_definition
+      register OCCI::Core::Link.kind_definition
     end
 
     # register OCCI Infrastructure categories
-    def self.register_infrastructure
-      OCCI::Log.info("### Registering OCCI Infrastructure categories ###")
-      self.register_files('etc/model/infrastructure')
+    def register_infrastructure
+      OCCI::Log.info "### Registering OCCI Infrastructure categories ###"
+      register_files 'etc/model/infrastructure'
     end
 
     # register OCCI categories from files
@@ -25,81 +32,80 @@ module OCCI
     # @param [String] path to a folder containing files which include OCCI collections in JSON format. The path is
     #  recursively searched for files with the extension .json .
     # @param [Sting] scheme_base_url base location for provider specific extensions of the OCCI model
-    def self.register_files(path, scheme_base_url='http://localhost')
-      OCCI::Log.info("### Initializing OCCI Model from #{path} ###")
+    def register_files(path, scheme_base_url='http://localhost')
+      OCCI::Log.info "### Initializing OCCI Model from #{path} ###"
       Dir.glob(path + '/**/*.json').each do |file|
         collection = OCCI::Collection.new(JSON.parse(File.read(file)))
         # add location of service provider to scheme if it has a relative location
         collection.kinds.collect { |kind| kind.scheme = scheme_base_url + kind.scheme if kind.scheme.start_with? '/' } if collection.kinds
         collection.mixins.collect { |mixin| mixin.scheme = scheme_base_url + mixin.scheme if mixin.scheme.start_with? '/' } if collection.mixins
         collection.actions.collect { |action| action.scheme = scheme_base_url + action.scheme if action.scheme.start_with? '/' } if collection.actions
-        self.register_collection(collection)
+        register_collection collection
       end
     end
 
     # register OCCI categories from OCCI collection
-    def self.register_collection(collection)
-      collection.kinds.each { |kind| self.register(OCCI::Core::Kind.new(kind)) } if collection.kinds
-      collection.mixins.each { |mixin| self.register(OCCI::Core::Mixin.new(mixin)) } if collection.mixins
-      collection.actions.each { |action| self.register(OCCI::Core::Action.new(action)) } if collection.actions
+    def register_collection(collection)
+      collection.categories.each { |category| register category }
     end
 
-    def self.reset()
-      @@categories.each_value.each { |category| category.entities = [] if category.entities }
+    def reset()
+      @categories.each_value.each { |category| category.entities = [] if category.entities }
     end
 
     # ---------------------------------------------------------------------------------------------------------------------
-    def self.register(category)
-      OCCI::Log.debug("### Registering category #{category.type_identifier}")
-      @@categories[category.type_identifier] = category
-      @@locations[category.location] = category.type_identifier unless category.kind_of?(OCCI::Core::Action)
+    def register(category)
+      OCCI::Log.debug "### Registering category #{category.type_identifier}"
+      @categories[category.type_identifier] = category
+      @locations[category.location] = category.type_identifier unless category.kind_of? OCCI::Core::Action
     end
 
     # ---------------------------------------------------------------------------------------------------------------------
-    def self.unregister(category)
-      OCCI::Log.debug("### Unregistering category #{category.type_identifier}")
-      @@categories.delete(category.type_identifier)
-      @@locations.delete(category.location) unless category.kind_of?(OCCI :Core::Action)
+    def unregister(category)
+      OCCI::Log.debug "### Unregistering category #{category.type_identifier}"
+      @categories.delete category.type_identifier
+      @locations.delete category.location unless category.kind_of? OCCI :Core::Action
     end
 
     # Returns the category corresponding to a given type identifier
     #
     # @param [URI] type identifier of a category
-    def self.get_by_id(id)
-      @@categories.fetch(id) { OCCI::Log.debug("Category with id #{id} not found"); nil }
+    def get_by_id(id)
+      @categories.fetch(id) { OCCI::Log.debug("Category with id #{id} not found"); nil }
     end
 
     # Returns the category corresponding to a given location
     #
     # @param [URI] Location of a category
-    def self.get_by_location(location)
-      id = @@locations.fetch(location) { OCCI::Log.debug("Category with location #{location} not found"); nil }
-      self.get_by_id(id)
+    def get_by_location(location)
+      id = @locations.fetch(location) { OCCI::Log.debug("Category with location #{location} not found"); nil }
+      get_by_id id
     end
 
     # Return all categories from model. If filter is present, return only the categories specified by filter
     #
-    # @param [Hashie:Hash] filter
-    # @return [Hashie::Mash] collection
-    def self.get(filter = [])
-      collection = Hashie::Mash.new({ :kinds => [], :mixins => [], :actions => [] })
+    # @param [OCCI::Collection] filter
+    # @return [OCCI::Collection] collection
+    def get(filter = [])
+      collection = OCCI::Collection.new
       if filter.empty?
-        @@categories.each_value do |category|
+        @categories.each_value do |category|
           collection.kinds << category if category.kind_of? OCCI::Core::Kind
           collection.mixins << category if category.kind_of? OCCI::Core::Mixin
           collection.actions << category if category.kind_of? OCCI::Core::Action
         end
+      else
+        categories = filter.categories
+        OCCI::Log.debug("### Filtering categories #{categories.collect { |c| c.type_identifier }.inspect}")
+        while categories.any? do
+          category = categories.pop
+          categories.concat @categories.each_value.select { |cat| cat.related_to?(category.type_identifier, self) }
+          collection.kinds << get_by_id(category.type_identifier) if category.kind_of? OCCI::Core::Kind
+          collection.mixins << get_by_id(category.type_identifier) if category.kind_of? OCCI::Core::Mixin
+          collection.actions << get_by_id(category.type_identifier) if category.kind_of? OCCI::Core::Action
+        end
       end
-      OCCI::Log.debug("### Filtering categories #{filter.collect{|c| c.type_identifier}.inspect}")
-      while filter.any? do
-        cat = filter.pop
-        filter.concat @@categories.each_value.select { |category| category.related_to?(cat.type_identifier) }
-        category = get_by_id(cat.type_identifier)
-        collection.kinds << category if category.kind_of?(OCCI::Core::Kind)
-        collection.mixins << category if category.kind_of?(OCCI::Core::Mixin)
-        collection.actions << category if category.kind_of?(OCCI::Core::Action)
-      end
-      return collection
+      collection
     end
 
   end