occi 2.4.0 → 2.5.0

data/lib/occi/collection.rb

@@ -41,7 +41,7 @@ module OCCI
       @kinds.empty? && @mixins.empty? && @actions.empty? && @resources.empty? && @links.empty?
     end
 
-    # @return [Hashie::Mash] returns collection as Hashie::Mash which can be converted to json
+    # @return [Hashie::Mash] json representation
     def as_json(options = { })
       collection = Hashie::Mash.new
       collection.kinds = @kinds.collect { |kind| kind.as_json } if @kinds.any?
@@ -52,13 +52,18 @@ module OCCI
       collection
     end
 
+    # @return [String] text representation
     def to_text
-      body = ""
-      body << self.categories.collect { |category| category.to_text }.join("\n")
-      body << "\n" if self.categories.any?
-      raise "Only one entity allowed for rendering to plain text" if body.entities.size > 1
-      body << self.entities.collect {|entity| entity.to_text}.join("\n")
-      body
+      text = ""
+      text << self.categories.collect { |category| category.to_text }.join("\n")
+      text << "\n" if self.categories.any?
+      raise "Only one entity allowed for rendering to plain text" if self.entities.size > 1
+      text << self.entities.collect {|entity| entity.to_text}.join("\n")
+      text
+    end
+
+    def inspect
+      JSON.pretty_generate(JSON.parse(to_json))
     end
 
   end

data/lib/occi/core/action.rb

@@ -4,6 +4,7 @@ module OCCI
   module Core
     class Action < OCCI::Core::Category
 
+      # @return [String] text representation
       def to_text
         text = super
         text << ';attributes=' + @attributes.combine.join(' ').inspect if @attributes.any?

data/lib/occi/core/attribute_properties.rb

@@ -4,6 +4,8 @@ module OCCI
   module Core
     class AttributeProperties < Hashie::Mash
 
+      # @param [Hashie::Mash] attributes
+      # @param [Hash] default
       def initialize(attributes = nil, default = nil)
         if [:Type, :Required, :Mutable, :Pattern, :Default, :Minimum, :Maximum, :Description].any? { |k| attributes.key?(k) }
           attributes[:Type]   ||= "string"
@@ -14,12 +16,10 @@ module OCCI
         super(attributes, default)
       end
 
+      # @return [Array] list of full attribute names
       def combine
         array = []
         self.each_key do |key|
-          #puts "Key :#{key}"
-          #puts self[key].keys
-          #puts self[key].key? 'type'
           if self[key].key? 'Type'
             array << key
           else
@@ -30,6 +30,8 @@ module OCCI
         array
       end
 
+
+      # @return [Hash] key value pairs of attribute names with their defaults set
       def combine_with_defaults
         hash = { }
         self.each_key do |key|
@@ -56,6 +58,7 @@ module OCCI
         end
       end
 
+      # Overrides method of hashie mash to check if one of the attribute properties has been set
       def method_missing(method_name, *args, &blk)
         return self.[](method_name, &blk) if key?(method_name)
         match = method_name.to_s.match(/(.*?)([?=!]?)$/)
@@ -91,6 +94,10 @@ module OCCI
         end
       end
 
+      def inspect
+        JSON.pretty_generate(JSON.parse(to_json))
+      end
+
     end
   end
 end

data/lib/occi/core/attributes.rb

@@ -4,7 +4,8 @@ module OCCI
   module Core
     class Attributes < Hashie::Mash
 
-      def combine
+    # @return [Array] key value pair of full attribute names with their corresponding values
+    def combine
         hash = { }
         self.each_key do |key|
           if self[key].kind_of? OCCI::Core::Attributes
@@ -16,7 +17,9 @@ module OCCI
         hash
       end
 
-      def self.split(attributes)
+    # @param [Hash] attributes key value pair of full attribute names with their corresponding values
+    # @return [OCCI::Core::Attributes]
+    def self.split(attributes)
         attribute = Attributes.new
         attributes.each do |name,value|
           puts name
@@ -31,5 +34,10 @@ module OCCI
       end
 
     end
+
+    def inspect
+      JSON.pretty_generate(JSON.parse(to_json))
+    end
+
   end
 end

data/lib/occi/core/category.rb

@@ -34,6 +34,8 @@ module OCCI
         false
       end
 
+      # @param [Hash] options
+      # @return [Hashie::Mash] json representation
       def as_json(options={ })
         category = Hashie::Mash.new
         category.scheme = @scheme if @scheme
@@ -43,12 +45,17 @@ module OCCI
         category
       end
 
+      # @return [String] text representation
       def to_text
         text = @term + ';scheme=' + @scheme.inspect + ';class=' + self.class.name.demodulize.downcase.inspect
         text << ';title=' + @title.inspect if @title
         text
       end
 
+      def inspect
+        JSON.pretty_generate(JSON.parse(to_json))
+      end
+
     end
   end
 end

data/lib/occi/core/entity.rb

@@ -39,29 +39,25 @@ module OCCI
       def initialize(kind, mixins=nil, attributes=nil, actions=nil)
         @checked = false
         raise "Kind #{kind} not of type String" unless kind.kind_of? String
-        @kind       = kind
-        @mixins     = mixins.to_a
-        @attributes = OCCI::Core::Attributes.new(attributes)
-        @actions    = actions.to_a
-        self.id     = UUIDTools::UUID.timestamp_create.to_s
+        @kind                        = kind
+        @mixins                      = mixins.to_a
+        @attributes                  = OCCI::Core::Attributes.new(attributes)
+        @attributes.occi!.core![:id] ||= UUIDTools::UUID.random_create.to_s
+        @actions                     = actions.to_a
       end
 
+      # @param [Array] mixins
       def mixins=(mixins)
         @checked=false
         @mixins =mixins
       end
 
+      # @param [OCCI::Core::Attributes] attributes
       def attributes=(attributes)
         @checked   =false
         @attributes=attributes
       end
 
-      # set id for entity
-      # @param [UUIDTools::UUID] id
-      def id=(id)
-        @attributes.occi!.core!.id = id
-      end
-
       # @return [UUIDTools::UUID] id of the entity
       def id
         @attributes.occi!.core!.id
@@ -129,12 +125,13 @@ module OCCI
         attributes
       end
 
+      # @return [true,false]
       def checked?
         @checked && @attributes.checked?
       end
 
       # @param [Hash] options
-      # @return [Hashie::Mash] entity as Hashie::Mash to be parsed into a JSON object
+      # @return [Hashie::Mash] json representation
       def as_json(options={ })
         entity = Hashie::Mash.new
         entity.kind = @kind if @kind
@@ -144,6 +141,29 @@ module OCCI
         entity
       end
 
+      # @return [String] text representation
+      def to_text
+        scheme, term = self.kind.split('#')
+        text         = term + ';scheme=' + scheme.inspect + ';class="kind"' + "\n"
+        @mixins.each do |mixin|
+          scheme, term = mixin.split('#')
+          text << term + ';scheme=' + scheme.inspect + ';class="mixin"' + "\n"
+        end
+        @attributes.combine.each_pair do |name, value|
+          name = name.inspect if name.kind_of? String
+          text << 'X-OCCI-Attribute: ' + name + '=' + value + "\n"
+        end
+        @actions.each do |action|
+          _, term = mixin.split('#')
+          text << 'Link: <' + self.location + '?action=' + term + '>;rel=' + action.inspect + "\n"
+        end
+        text
+      end
+
+      def inspect
+        JSON.pretty_generate(JSON.parse(to_json))
+      end
+
     end
   end
 end

data/lib/occi/core/kind.rb

@@ -40,6 +40,8 @@ module OCCI
         '/' + @term + '/'
       end
 
+      # @param [Hash] options
+      # @return [Hashie::Mash] json representation
       def as_json(options={ })
         kind = Hashie::Mash.new
         kind.related = @related if @related.any?
@@ -48,6 +50,7 @@ module OCCI
         kind
       end
 
+      # @return [String] text representation
       def to_text
         text = super
         text << ';rel=' + @related.join(' ').inspect if @related.any?

data/lib/occi/core/link.rb

@@ -6,7 +6,7 @@ module OCCI
   module Core
     class Link < Entity
 
-      attr_reader :rel
+      attr_accessor :rel
 
       # @return [OCCI::Core::Kind] kind definition of Link type
       def self.kind_definition
@@ -28,9 +28,17 @@ module OCCI
         kind
       end
 
+      # @param [String] kind
+      # @param [String] mixins
+      # @param [OCCI::Core::Attributes] attributes
+      def initialize(kind, mixins=nil, attributes=nil, actions=nil, rel=nil)
+        super(kind,mixins,attributes,actions)
+        @rel        = rel
+      end
+
       # @return [String] target attribute of the link
       def target
-        self.attributes.occi!.core!.summary
+        self.attributes.occi!.core!.target
       end
 
       # set target attribute of link
@@ -50,14 +58,14 @@ module OCCI
         self.attributes.occi!.core!.source = source
       end
 
+      # @param [OCCI::Model] model
       def check(model)
-        target = model.get_by_id(self.target)
-        @rel = model.type_identifier if target.kind_of? OCCI::Core::Resource
+        raise "rel must be provided" unless @rel
         super(model)
       end
 
       # @param [Hash] options
-      # @return [Hashie::Mash] link as Hashie::Mash to be parsed into a JSON object
+      # @return [Hashie::Mash] json representation
       def as_json(options={ })
         link = Hashie::Mash.new
         link.kind = @kind if @kind
@@ -67,6 +75,17 @@ module OCCI
         link
       end
 
+      # @return [String] text representation of link reference
+      def to_reference_text
+        OCCI::Log.debug "Test"
+        text = '<' + target + '>'
+        text << ';rel=' + @rel.inspect
+        text << ';self=' + self.location
+        text << ';category=' + @kind
+        @attributes.combine.each_pair { |name, value| text << name + '=' + value + ';' }
+        text
+      end
+
     end
   end
 end

data/lib/occi/core/mixin.rb

@@ -25,6 +25,8 @@ module OCCI
         '/mixins/' + @term + '/'
       end
 
+      # @param [Hash] options
+      # @return [Hashie::Mash] json representation
       def as_json(options={ })
         mixin = Hashie::Mash.new
         mixin.related = @related if @related.any?
@@ -33,6 +35,7 @@ module OCCI
         mixin
       end
 
+      # @return [String] text representation
       def to_text
         text = super
         text << ';rel=' + @related.join(' ').inspect if @related.any?

data/lib/occi/core/resource.rb

@@ -9,11 +9,6 @@ module OCCI
 
       attr_accessor :links
 
-      def initialize(kind, mixins=nil, attributes=nil, links=nil)
-        @links = links.to_a
-        super(kind, mixins, attributes)
-      end
-
       # @return [OCCI::Core::Kind] kind definition of Resource type
       def self.kind_definition
         kind = OCCI::Core::Kind.new('http://schemas.ogf.org/occi/core#', 'resource')
@@ -29,9 +24,17 @@ module OCCI
         kind
       end
 
-      def links=(links)
-        @checked = false
-        @links   = links
+      # @param [String] kind
+      # @param [Array] mixins
+      # @param [OCCI::Core::Attributes,Hash] attributes
+      # @param [Array] links
+      def initialize(kind, mixins=nil, attributes=nil, links=nil)
+        super(kind, mixins, attributes)
+        @links = []
+        links.to_a.each do |link|
+          link = OCCI::Core::Link.new(link.kind,link.mixins,link.attributes,link.actions,link.rel) unless link.kind_of? OCCI::Core::Link
+          @links << link
+        end
       end
 
       # set id for resource and update the the source of all links
@@ -52,13 +55,8 @@ module OCCI
         self.attributes.occi!.core!.summary = summary
       end
 
-      # 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
-
+      # @param [Hash] options
+      # @return [Hashie::Mash] link as Hashie::Mash to be parsed into a JSON object
       def as_json(options={ })
         resource = Hashie::Mash.new
         resource.links = @links if @links.any?
@@ -66,6 +64,13 @@ module OCCI
         resource
       end
 
+      # @return [String] text representation
+      def to_text
+        text = super
+        @links.each { |link| text << 'Link: ' + link.to_reference_text + "\n" }
+        text
+      end
+
     end
   end
 end

data/lib/occi/log.rb

@@ -9,13 +9,13 @@ module OCCI
     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+,
+    # @param [IO,String] log_dev The log device.  This is a filename (String) or IO object (typically +STDOUT+,
     #  +STDERR+, or an open file).
-    def initialize(logdev)
-      if logdev.kind_of? Logger
-        @logger = logdev
+    def initialize(log_dev)
+      if log_dev.kind_of? Logger
+        @logger = log_dev
       else
-        @logger = Logger.new(logdev)
+        @logger = Logger.new(log_dev)
       end
 
       # subscribe to log messages and send to logger
@@ -24,10 +24,12 @@ module OCCI
       end
     end
 
+    # @param [Logger::Severity] severity
     def level=(severity)
       @logger.level = severity
     end
 
+    # @return [Logger::Severity]
     def level
       @logger.level
     end

data/lib/occi/model.rb

@@ -6,11 +6,12 @@ module OCCI
     attr_accessor :categories
     attr_accessor :locations
 
+    # @param [OCCI::Core::Collection] collection
     def initialize(collection=nil)
       @categories = { }
       @locations  = { }
       register_core
-      register_collection collection if collection
+      register_collection collection if collection.kind_of? OCCI::Collection
     end
 
     # register OCCI Core categories enitity, resource and link
@@ -49,11 +50,12 @@ module OCCI
       collection.categories.each { |category| register category }
     end
 
+    # clear all entities from all categories
     def reset()
       @categories.each_value.each { |category| category.entities = [] if category.respond_to? :entities }
     end
 
-    # ---------------------------------------------------------------------------------------------------------------------
+    # @param [OCCI::Core::Category] category
     def register(category)
       OCCI::Log.debug "### Registering category #{category.type_identifier}"
       @categories[category.type_identifier] = category
@@ -62,7 +64,7 @@ module OCCI
       category.model = self
     end
 
-    # ---------------------------------------------------------------------------------------------------------------------
+    # @param [OCCI::Core::Category] category
     def unregister(category)
       OCCI::Log.debug "### Unregistering category #{category.type_identifier}"
       @categories.delete category.type_identifier
@@ -71,14 +73,16 @@ module OCCI
 
     # Returns the category corresponding to a given type identifier
     #
-    # @param [URI] type identifier of a category
+    # @param [URI] id type identifier of a category
+    # @return [OCCI::Core::Category]
     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
+    # @param [URI] location
+    # @return [OCCI::Core::Category]
     def get_by_location(location)
       id = @locations.fetch(location) { OCCI::Log.debug("Category with location #{location} not found"); nil }
       get_by_id id