occi-core 4.0.0.alpha.1

data/lib/occi/core/entity.rb

@@ -0,0 +1,264 @@
+module Occi
+  module Core
+    class Entity
+
+      include Occi::Helpers::Inspect
+
+      attr_accessor :mixins, :attributes, :actions, :id, :model, :kind, :location
+
+      class_attribute :kind, :mixins, :attributes, :actions
+
+      self.mixins = Occi::Core::Mixins.new
+
+      self.attributes = Occi::Core::Attributes.new
+      self.attributes['occi.core.id'] = {:pattern => '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'}
+      self.attributes['occi.core.title'] = {:mutable => true}
+
+      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/core#',
+                                       term='entity',
+                                       title='entity',
+                                       attributes=self.attributes
+
+      # @return [String]
+      def self.type_identifier
+        self.kind.type_identifier
+      end
+
+      # @param [Array] args list of arguments
+      # @return [Object] new instance of this class
+      def self.new(*args)
+        if args.size > 0
+          type_identifier = args[0].to_s
+          related = [self.kind]
+        else
+          type_identifier = self.kind.type_identifier
+          related = nil
+        end
+        scheme, term = type_identifier.split '#'
+
+        klass = Occi::Core::Kind.get_class scheme, term, related
+
+        object = klass.allocate
+        object.send :initialize, *args
+        object
+      end
+
+      def self.attribute_properties
+        attributes = Occi::Core::Attributes.new self.attributes
+        attributes.merge! Occi::Core::Attributes.new(self.superclass.attribute_properties) if self < Occi::Core::Entity
+        attributes
+      end
+
+      def attribute_properties
+        attributes = self.class.attribute_properties
+        @mixins.collect {|mixin| attributes.merge! Occi::Core::Attributes.new(mixin.attributes)}
+        attributes
+      end
+
+      # @param [String] kind
+      # @param [String] mixins
+      # @param [Occi::Core::Attributes] attributes
+      # @param [Occi::Core::Actions] actions
+      # @return [Occi::Core::Entity]
+      def initialize(kind = self.kind, mixins=[], attributes={}, actions=[], location=nil)
+        @kind = self.class.kind.clone
+        @mixins = Occi::Core::Mixins.new mixins
+        @mixins.entity = self
+        attributes = self.class.attribute_properties if attributes.blank?
+        if attributes.kind_of? Occi::Core::Attributes
+          @attributes = attributes.convert
+        else
+          @attributes = Occi::Core::Attributes.new attributes
+        end
+        @actions = Occi::Core::Actions.new actions
+        @location = location
+      end
+
+      # @return [Occi::Core::Kind]
+      def kind
+        @kind
+      end
+
+      # @param [Occi::Core::Kind,String] kind
+      # @return [Occi::Core::Kind]
+      def kind=(kind)
+        if kind.kind_of? String
+          scheme, term = kind.split '#'
+          kind = Occi::Core::Category.get_class scheme, term
+        end
+        @kind = kind
+      end
+
+      # @param [Array] mixins
+      def mixins=(mixins)
+        @mixins = Occi::Core::Mixins.new mixins
+        @mixins.entity = self
+        @mixins
+      end
+
+      # @param [Occi::Core::Attributes] attributes
+      def attributes=(attributes)
+        @attributes = Occi::Core::Attributes.new attributes
+      end
+
+      # @param [Occi::Core::Actions] actions
+      def actions=(actions)
+        @actions = Occi::Core::Actions.new actions
+      end
+
+      # set id for entity
+      # @param [UUIDTools::UUID] id
+      def id=(id)
+        @attributes.occi!.core!.id = id
+        @id = id
+      end
+
+      # @return [UUIDTools::UUID] id of the entity
+      def id
+        @id ||= @attributes.occi.core.id if @attributes.occi.core if @attributes.occi
+        @id
+      end
+
+      # set title attribute for entity
+      # @param [String] title
+      def title=(title)
+        @attributes.occi!.core!.title = title
+      end
+
+      # @return [String] title attribute of entity
+      def title
+        @attributes.occi.core.title if @attributes.occi.core if @attributes.occi
+      end
+
+      # @param [Occi::Model] model
+      # @return [Occi::Model]
+      def model=(model)
+        @model = model
+        @kind = (model.get_by_id(@kind.type_identifier) || @kind)
+        @kind.entities << self
+        @mixins.model = model
+        @mixins.each { |mixin| mixin.entities << self }
+        @actions.model = model
+      end
+
+      # set location attribute of entity
+      # @param [String] location
+      def location=(location)
+        @location = location
+      end
+
+      # @return [String] location of the entity
+      def location
+        return @location if @location
+        kind.location + id.gsub('urn:uuid:', '') if id
+      end
+
+      # check attributes against their definitions and set defaults
+      # @param [Occi::Model] model representation of the Occi model to check the attributes against
+      def check
+        raise "No model associated" unless @model
+        definitions = model.get_by_id(@kind.to_s).attributes
+        @mixins.each do |mixin_id|
+          mixin = model.get_by_id(mixin_id)
+          next if mixin.nil?
+          definitions.merge!(mixin.attributes) if mixin.attributes
+        end if @mixins
+
+        @attributes = Entity.check(@attributes, definitions) if definitions
+      end
+
+      # @param [Occi::Core::Attributes] attributes
+      # @param [Occi::Core::Attributes] definitions
+      # @param [true,false] set_defaults
+      # @return [Occi::Core::Attributes] attributes with their defaults set
+      def self.check(attributes, definitions, set_defaults=false)
+        attributes = Occi::Core::Attributes.new(attributes)
+        definitions.each_key do |key|
+          next if definitions.key?(key[1..-1])
+          if definitions[key].kind_of? Occi::Core::Attributes
+            attributes[key] = check(attributes[key], definitions[key])
+          else
+            properties = definitions[key]
+            value = attributes[key]
+            value ||= properties.default if set_defaults or properties.required?
+            raise "required attribute #{key} not found" if value.nil? && properties.required?
+            next if value.blank? and not properties.required?
+            case properties.type
+              when 'number'
+                raise "attribute #{key} value #{value} from class #{value.class.name} does not match attribute property type #{properties.type}" unless value.kind_of?(Numeric)
+              when 'boolean'
+                raise "attribute #{key} value #{value} from class #{value.class.name} does not match attribute property type #{properties.type}" unless !!value == value
+              when 'string'
+                raise "attribute #{key} with value #{value} from class #{value.class.name} does not match attribute property type #{properties.type}" unless value.kind_of?(String)
+              else
+                raise "property type #{properties.type} is not one of the allowed types number, boolean or string"
+            end
+            Occi::Log.warn "attribute #{key} with value #{value} does not match pattern #{properties.pattern}" if value.to_s.scan(Regexp.new(properties.pattern)).blank? if properties.pattern
+            attributes[key] = value
+          end
+        end
+        attributes.delete_if { |_, v| v.blank? } # remove empty attributes
+        attributes
+      end
+
+      # @param [Hash] options
+      # @return [Hashie::Mash] json representation
+      def as_json(options={})
+        entity = Hashie::Mash.new
+        entity.kind = @kind.to_s if @kind
+        entity.mixins = @mixins.join(' ').split(' ') if @mixins.any?
+        entity.actions = @actions if @actions.any?
+        entity.attributes = @attributes.as_json if @attributes.as_json.any?
+        entity.id = id.to_s if id
+        entity
+      end
+
+      # @return [String] text representation
+      def to_text
+        text = 'Category: ' + self.kind.term + ';scheme=' + self.kind.scheme.inspect + ';class="kind"'
+        @mixins.each do |mixin|
+          scheme, term = mixin.to_s.split('#')
+          scheme << '#'
+          text << "\n" + 'Category: ' + term + ';scheme=' + scheme.inspect + ';class="mixin"'
+        end
+        @attributes.names.each_pair do |name, value|
+          value = value.inspect
+          text << "\n" + 'X-OCCI-Attribute: ' + name + '=' + value
+        end
+        @actions.each do |action|
+          _, term = action.split('#')
+          text << "\n" + 'Link: <' + self.location + '?action=' + term + '>;rel=' + action.inspect
+        end
+        text
+      end
+
+      # @return [Hash] hash containing the HTTP headers of the text/occi rendering
+      def to_header
+        header = Hashie::Mash.new
+        header['Category'] = self.kind.term + ';scheme=' + self.kind.scheme.inspect + ';class="kind"'
+        @mixins.each do |mixin|
+          scheme, term = mixin.to_s.split('#')
+          scheme << '#'
+          header['Category'] += ',' + term + ';scheme=' + scheme.inspect + ';class="mixin"'
+        end
+        attributes = []
+        @attributes.names.each_pair do |name, value|
+          attributes << name + '=' + value.inspect
+        end
+        header['X-OCCI-Attribute'] = attributes.join(',') if attributes.any?
+        links = []
+        @actions.each do |action|
+          _, term = action.split('#')
+          links << self.location + '?action=' + term + '>;rel=' + action.inspect
+        end
+        header
+      end
+
+      # @return [String] string representation of entity is its location
+      def to_s
+        self.location
+      end
+
+    end
+  end
+end

data/lib/occi/core/kind.rb

@@ -0,0 +1,58 @@
+module Occi
+  module Core
+    class Kind < Occi::Core::Category
+
+      attr_accessor :entities, :related, :actions, :location
+
+      # @param [String ] scheme
+      # @param [String] term
+      # @param [String] title
+      # @param [Hash] attributes
+      # @param [Array] related
+      # @param [Array] actions
+      def initialize(scheme='http://schemas.ogf.org/occi/core#',
+          term='kind',
+          title=nil,
+          attributes=Occi::Core::Attributes.new,
+          related=Occi::Core::Related.new,
+          actions=Occi::Core::Actions.new,
+          location=nil)
+        super(scheme, term, title, attributes)
+        @related = Occi::Core::Related.new(related)
+        @actions = Occi::Core::Actions.new(actions)
+        @entities = Occi::Core::Entities.new
+        location.blank? ? @location = '/' + term + '/' : @location = location
+      end
+
+      def entity_type
+        self.class.get_class @scheme, @term, @related
+      end
+
+      def location
+        @location.clone
+      end
+
+      # @param [Hash] options
+      # @return [Hashie::Mash] json representation
+      def as_json(options={})
+        kind = Hashie::Mash.new
+        kind.related = @related.join(' ').split(' ') if @related.any?
+        kind.actions = @actions.join(' ').split(' ') if @actions.any?
+        kind.location = @location if @location
+        kind.merge! super
+        kind
+      end
+
+      # @return [String] string representation of the kind
+      def to_string
+        string = super
+        string << ';rel=' + @related.join(' ').inspect if @related.any?
+        string << ';location=' + self.location.inspect
+        string << ';attributes=' + @attributes.names.keys.join(' ').inspect if @attributes.any?
+        string << ';actions=' + @actions.join(' ').inspect if @actions.any?
+        string
+      end
+
+    end
+  end
+end

data/lib/occi/core/kinds.rb

@@ -0,0 +1,22 @@
+module Occi
+  module Core
+    class Kinds < Occi::Core::Categories
+
+      private
+
+      def convert(category)
+        category = super category
+
+        if category.kind_of? String
+          scheme, term = category.split '#'
+          scheme       += '#'
+
+          klass    = Occi::Core::Category.get_class scheme, term, [Occi::Core::Kind.new]
+          category = klass.kind
+        end
+        category
+      end
+
+    end
+  end
+end

data/lib/occi/core/link.rb

@@ -0,0 +1,95 @@
+module Occi
+  module Core
+    class Link < Occi::Core::Entity
+
+      attr_accessor :rel, :source, :target
+
+      self.attributes['occi.core.target'] = {:mutable => true}
+      self.attributes['occi.core.source'] = {:mutable => true}
+
+      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/core#',
+                                       term='link',
+                                       title='link',
+                                       attributes=self.attributes,
+                                       related=Occi::Core::Related.new << Occi::Core::Entity.kind
+
+      # @param [String] kind
+      # @param [String] mixins
+      # @param [Occi::Core::Attributes] attributes
+      # @param [Array] actions
+      # @param [String] rel
+      # @param [String,Occi::Core::Entity] target
+      # @param [String,Occi::Core::Entity] source
+      def initialize(kind=self.kind, mixins=[], attributes={}, actions=[], rel=Occi::Core::Link.type_identifier, target=nil, source=nil, location=nil)
+        super(kind, mixins, attributes, actions, location)
+        scheme, term = rel.to_s.split('#')
+        @rel = Occi::Core::Category.get_class(scheme, term).kind if scheme && term
+        @source = source if source
+        @target = target
+      end
+
+      # @return [String] target attribute of the link
+      def target
+        @target ||= self.attributes.occi.core.target if @attributes.occi.core if @attributes.occi
+        @target
+      end
+
+      # set target attribute of link
+      # @param [String] target
+      def target=(target)
+        @target = target
+      end
+
+      # @return [String] source attribute of the link
+      def source
+        @source ||= self.attributes.occi.core.source if @attributes.occi.core if @attributes.occi
+        @source
+      end
+
+      # set source attribute of link
+      # @param [String] source
+      def source=(source)
+        @source = source
+      end
+
+      # @param [Occi::Model] model
+      def check
+        raise "rel must be provided" unless @rel
+        super
+      end
+
+      # @param [Hash] options
+      # @return [Hashie::Mash] json representation
+      def as_json(options={})
+        link = super
+        link.rel = @rel.to_s if @rel
+        link.source = self.source.to_s if self.source.to_s
+        link.target = self.target.to_s if self.target
+        link
+      end
+
+      # @return [String] text representation of link reference
+      def to_string
+        string = '<' + self.target.to_s + '>'
+        string << ';rel=' + @rel.to_s.inspect
+        string << ';self=' + self.location.inspect if self.location
+        categories = [@kind] + @mixins.join(',').split(',')
+        string << ';category=' + categories.join(' ').inspect
+        @attributes.names.each_pair do |name, value|
+          value = value.inspect
+          string << ';' + name + '=' + value
+        end
+        string << ';occi.core.target=' + self.target.to_s.inspect
+        string << ';occi.core.source=' + self.source.to_s.inspect unless self.source.blank?
+
+        string
+      end
+
+      # @return [String] text representation of link
+      def to_text_link
+        'Link: ' + self.to_string
+      end
+
+    end
+  end
+end

data/lib/occi/core/links.rb

@@ -0,0 +1,34 @@
+module Occi
+  module Core
+    class Links < Occi::Core::Entities
+
+      def initialize(links=[])
+        links.collect! {|link| convert link} if links
+        super links
+      end
+
+      def <<(link)
+        super convert link
+      end
+
+      def create(*args)
+        link       = Occi::Core::Link.new(*args)
+        link.model = @model
+        self << link
+        link
+      end
+
+      private
+
+      def convert(link)
+        if link.kind_of? String
+          target      = link
+          link        = Occi::Core::Link.new
+          link.target = target
+        end
+        link
+      end
+
+    end
+  end
+end

data/lib/occi/core/mixin.rb

@@ -0,0 +1,55 @@
+module Occi
+  module Core
+    class Mixin < Occi::Core::Category
+
+      attr_accessor :entities, :related, :actions, :location
+
+      # @param [String ] scheme
+      # @param [String] term
+      # @param [String] title
+      # @param [Occi::Core::Attributes,Hash,NilClass] attributes
+      # @param [Occi::Core::Categories,Hash,NilClass] related
+      # @param [Occi::Core::Actions,Hash,NilClass] actions
+      def initialize(scheme='http://schemas.ogf.org/occi/core#',
+          term='mixin',
+          title=nil,
+          attributes=Occi::Core::Attributes.new,
+          related=Occi::Core::Related.new,
+          actions=Occi::Core::Actions.new,
+          location='')
+
+        super(scheme, term, title, attributes)
+        @related  = Occi::Core::Related.new(related)
+        @actions  = Occi::Core::Actions.new(actions)
+        @entities = Occi::Core::Entities.new
+        location.blank? ? @location = '/mixins/' + term + '/' : @location = location
+      end
+
+      def location
+        @location.clone
+      end
+
+      # @param [Hash] options
+      # @return [Hashie::Mash] json representation
+      def as_json(options={ })
+        mixin = Hashie::Mash.new
+        mixin.related = @related.join(' ').split(' ') if @related.any?
+        mixin.actions = @actions if @actions.any?
+        mixin.location = @location if @location
+        mixin.merge! super
+        mixin
+      end
+
+      # @return [String] text representation
+      def to_string
+        string = super
+        string << ';rel=' + @related.join(' ').inspect if @related.any?
+        string << ';location=' + self.location.inspect
+        string << ';attributes=' + @attributes.names.keys.join(' ').inspect if @attributes.any?
+        string << ';actions=' + @actions.join(' ').inspect if @actions.any?
+        string
+      end
+
+    end
+  end
+end

data/lib/occi/core/mixins.rb

@@ -0,0 +1,41 @@
+module Occi
+  module Core
+    class Mixins < Occi::Core::Categories
+
+      attr_accessor :entity
+
+      def entity=(entity)
+        self.each { |mixin| entity.attributes.merge! mixin.attributes.convert }
+        @entity = entity
+      end
+
+      def remove(mixin)
+        mixin = convert mixin
+        @entity.attributes.remove mixin.attributes
+        self.delete mixin
+      end
+
+      def <<(mixin)
+        mixin = convert mixin
+        @entity.attributes.merge! mixin.attributes.convert if @entity
+        super mixin
+      end
+
+      private
+
+      def convert(category)
+        category = super category
+
+        if category.kind_of? String
+          scheme, term = category.split '#'
+          scheme += '#'
+
+          klass = Occi::Core::Category.get_class scheme, term, [Occi::Core::Mixin.new]
+          category = klass.new(scheme, term)
+        end
+        category
+      end
+
+    end
+  end
+end

data/lib/occi/core/properties.rb

@@ -0,0 +1,35 @@
+module Occi
+  module Core
+    class Properties
+
+      include Occi::Helpers::Inspect
+
+      attr_accessor :default, :type, :required, :mutable, :pattern, :description
+      alias_method :required?, :required
+      alias_method :mutable?, :mutable
+
+      # @param [Hash] properties
+      # @param [Hash] default
+      def initialize(properties={})
+        self.default = properties[:default]
+        self.type = properties[:type] ||= 'string'
+        self.required = properties[:required] ||= false
+        self.mutable = properties[:mutable] ||= false
+        self.pattern = properties[:pattern] ||= '.*'
+        self.description = properties[:description]
+      end
+
+      def as_json(options={})
+        hash = Hashie::Mash.new
+        hash.default = self.default if self.default
+        hash.type = self.type if self.type
+        hash.required = self.required if self.required
+        hash.mutable = self.mutable if self.mutable
+        hash.pattern = self.pattern if self.pattern
+        hash.description = self.description if self.description
+        hash
+      end
+
+    end
+  end
+end

data/lib/occi/core/related.rb

@@ -0,0 +1,7 @@
+module Occi
+  module Core
+    class Related < Occi::Core::Categories
+
+    end
+  end
+end

data/lib/occi/core/resource.rb

@@ -0,0 +1,78 @@
+module Occi
+  module Core
+    class Resource < Occi::Core::Entity
+
+      attr_accessor :links
+
+      self.attributes = Occi::Core::Attributes.new
+
+      self.attributes['occi.core.summary'] = {:mutable => true}
+
+      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/core#',
+                                       term='resource',
+                                       title='resource',
+                                       attributes=self.attributes,
+                                       related=Occi::Core::Related.new << Occi::Core::Entity.kind
+
+      # @param [String] kind
+      # @param [Array] mixins
+      # @param [Occi::Core::Attributes,Hash] attributes
+      # @param [Array] links
+      # @return [Occi::Core::Resource]
+      def initialize(kind=self.kind, mixins=[], attributes={}, actions=[], links=[], location=nil)
+        super(kind, mixins, attributes, actions, location)
+        @links = Occi::Core::Links.new(links)
+      end
+
+      def model=(model)
+        super model
+        @links.model = model
+      end
+
+      # @return [String] summary attribute of the resource
+      def summary
+        self.attributes.occi.core.summary if @attributes.occi.core if @attributes.occi
+      end
+
+      # set summary attribute of resource
+      # @param [String] summary
+      def summary=(summary)
+        self.attributes.occi!.core!.summary = summary
+      end
+
+      def link(target, kind=Occi::Core::Link.kind, mixins=[], attributes=Occi::Core::Attributes.new, rel=Occi::Core::Resource.type_identifier)
+        link = kind.entity_type.new
+        link.rel = rel
+        link.attributes = attributes
+        link.target = target
+        link.source = self
+        link.mixins = mixins
+        @links << link
+        link
+      end
+
+      # @return [String] text representation
+      def to_text
+        text = super
+        @links.each { |link| text << "\n" + link.to_text_link }
+        text
+      end
+
+      # @return [Hash] hash containing the HTTP headers of the text/occi rendering
+      def to_header
+        header = super
+        header['Links'] = @links.join(',')
+      end
+
+      # @param [Hash] options
+      # @return [Hashie::Mash] link as Hashie::Mash to be parsed into a JSON object
+      def as_json(options={})
+        resource = super
+        link_strings = @links.collect { |link| link.to_s if link.to_s }.compact
+        resource.links = link_strings unless link_strings.empty?
+        resource
+      end
+
+    end
+  end
+end