occi 2.0.6 → 2.1.0

data/etc/model/infrastructure/storagelink.json

@@ -0,0 +1,38 @@
+{
+    "kinds":[
+        {
+            "term":"storagelink",
+            "scheme":"http://schemas.ogf.org/occi/infrastructure#",
+            "title":"Storage Link",
+            "related":[
+                "http://schemas.ogf.org/occi/core#link"
+            ],
+            "attributes":{
+                "occi":{
+                    "storagelink":{
+                        "deviceid":{
+                            "mutable":true,
+                            "required":false,
+                            "type":"string",
+                            "pattern":".*"
+                        },
+                        "mountpoint":{
+                            "mutable":true,
+                            "required":false,
+                            "type":"string",
+                            "pattern":".*"
+                        },
+                        "state":{
+                            "mutable":false,
+                            "required":false,
+                            "type":"string",
+                            "pattern":"active|inactive",
+                            "default":"inactive"
+                        }
+                    }
+                }
+            },
+            "location":"/storagelink/"
+        }
+    ]
+}

data/lib/occi/collection.rb

@@ -0,0 +1,34 @@
+require 'hashie/mash'
+
+module OCCI
+  class Collection
+    attr_accessor :kinds
+    attr_accessor :mixins
+    attr_accessor :actions
+    attr_accessor :resources
+    attr_accessor :links
+
+    # Initialize a new OCCI Collection by initializing all supplied OCCI objects
+    #
+    # @param [Hash] collection including one or more of the keys kinds, mixins, actions, resources, links
+    def initialize(collection={ })
+      collection = Hashie::Mash.new(collection)
+      @kinds     = @mixins = @actions = @resources = @links = []
+      @kinds = collection.kinds.collect { |kind| OCCI::Core::Kind.new(kind) } if collection.kinds.instance_of? Array
+      @mixins = collection.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) } if collection.mixins.instance_of? Array
+      @actions = collection.actions.collect { |action| OCCI::Core::Action.new(action) } if collection.actions.instance_of? Array
+      @resources = collection.resources.collect { |resource| OCCI::Core::Resource.new(resource) } if collection.resources.instance_of? Array
+      @links = collection.links { |link| OCCI::Core::Link.new(link) } if collection.links.instance_of? Array
+    end
+
+    # @return [Array] categories combined list of all kinds, mixins and actions
+    def categories
+      @kinds + @mixins + @actions
+    end
+
+    # @return [Array] entities combined list of all resources and links
+    def entities
+      @resources + @links
+    end
+  end
+end

data/lib/occi/core/action.rb

@@ -1,24 +1,3 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#  
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#  
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: OCCI Core Action
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
 require 'occi/core/category'
 
 module OCCI

data/lib/occi/core/attribute_properties.rb

@@ -1,24 +1,3 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: storing a single Attribute
-# Author(s): Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
 require 'hashie/mash'
 
 module OCCI

data/lib/occi/core/attributes.rb

@@ -1,23 +1,4 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#  
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#  
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: storing a single Attribute
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
+require 'hashie/mash'
 
 module OCCI
   module Core

data/lib/occi/core/category.rb

@@ -1,24 +1,3 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: OCCI Core Category
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
 require 'json'
 require 'hashie/mash'
 

data/lib/occi/core/entity.rb

@@ -1,28 +1,7 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: OCCI Core Entity
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
 require 'rubygems'
 require 'uuidtools'
-require 'hashie'
-require 'occi/registry'
+require 'hashie/mash'
+require 'occi/model'
 require 'occi/core/attributes'
 require 'occi/core/kind'
 require 'occi/core/attribute_properties'
@@ -47,7 +26,7 @@ module OCCI
         data.attributes!.occi!.core!.title!.mutable = true
 
         kind = OCCI::Core::Kind.new(data)
-        OCCI::Registry.register(kind)
+        OCCI::Model.register(kind)
       end
 
       def initialize(entity=nil, default = nil)
@@ -76,16 +55,16 @@ module OCCI
       end
 
       def location
-        '/' + OCCI::Registry.get_by_id(self.kind).term + '/' + self.id if self.kind
+        '/' + OCCI::Model.get_by_id(self.kind).term + '/' + self.id if self.kind
       end
 
       def type_identifier
-        OCCI::Registry.get_by_id(self.kind).type_identifier
+        OCCI::Model.get_by_id(self.kind).type_identifier
       end
 
       def check
-        definitions = OCCI::Registry.get_by_id(self.kind).attributes if self.kind
-        self.mixins.each { |mixin| definitions.merge!(OCCI::Registry.get_by_id(mixin).attributes) if OCCI::Registry.get_by_id(mixin).attributes } if self.mixins
+        definitions = OCCI::Model.get_by_id(self.kind).attributes if self.kind
+        self.mixins.each { |mixin| definitions.merge!(OCCI::Model.get_by_id(mixin).attributes) if OCCI::Model.get_by_id(mixin).attributes } if self.mixins
         self.attributes = Entity.check(self.attributes, definitions) if definitions
       end
 

data/lib/occi/core/kind.rb

@@ -1,24 +1,3 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#  
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#  
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: OCCI Core Kind
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
 require 'json'
 require 'occi/core/category'
 require 'occi/core/action'
@@ -42,7 +21,7 @@ module OCCI
           when "http://schemas.ogf.org/occi/core#link"
             return OCCI::Core::Link.name
           else
-            OCCI::Registry.get_by_id(self[:related].first).entity_type unless self[:term] == 'entity'
+            OCCI::Model.get_by_id(self[:related].first).entity_type unless self[:term] == 'entity'
         end
       end
 

data/lib/occi/core/link.rb

@@ -1,27 +1,7 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#  
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#  
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: OCCI Core Link
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
+require 'hashie/mash'
+require 'occi/model'
 require 'occi/core/entity'
 require 'occi/core/kind'
-require 'hashie'
 
 module OCCI
   module Core
@@ -47,7 +27,7 @@ module OCCI
         data.attributes!.occi!.core!.source!.mutable = true
 
         kind = OCCI::Core::Kind.new(data)
-        OCCI::Registry.register(kind)
+        OCCI::Model.register(kind)
       end
 
       def target

data/lib/occi/core/mixin.rb

@@ -1,27 +1,5 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#  
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#  
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: OCCI Core Mixin
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
 require 'json'
 require 'occi/core/category'
-require 'occi/core/action'
 
 module OCCI
   module Core

data/lib/occi/core/resource.rb

@@ -1,28 +1,7 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: OCCI Core Resource
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
-require 'occi/registry'
+require 'hashie/mash'
+require 'occi/model'
 require 'occi/core/entity'
 require 'occi/core/kind'
-require 'hashie'
 
 module OCCI
   module Core
@@ -41,7 +20,7 @@ module OCCI
         data.attributes!.occi!.core!.summary!.mutable = true
 
         kind = OCCI::Core::Kind.new(data)
-        OCCI::Registry.register(kind)
+        OCCI::Model.register(kind)
       end
 
       def summary

data/lib/occi/log.rb

@@ -1,45 +1,47 @@
-##############################################################################
-#  Copyright 2011 Service Computing group, TU Dortmund
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##############################################################################
-
-##############################################################################
-# Description: OCCI logger
-# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
 require 'logger'
+require 'active_support/notifications'
 
 module OCCI
   class Log
 
+    include Logger::Severity
+
+    # 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
+
+      # subscribe to log messages and send to logger
+      @log_subscriber = ActiveSupport::Notifications.subscribe("log") do |name, start, finish, id, payload|
+        @logger.log(payload[:level], payload[:message])
+      end
+    end
+
+    # @see info
     def self.debug(message)
-      ActiveSupport::Notifications.instrument("log",:level=>Logger::DEBUG,:message=>message)
+      ActiveSupport::Notifications.instrument("log", :level => Logger::DEBUG, :message => message)
     end
 
+    # Log an +INFO+ message
+    # @param [String] message the message to log; does not need to be a String
     def self.info(message)
       ActiveSupport::Notifications.instrument("log", :level => Logger::INFO, :message => message)
     end
 
+    # @see info
     def self.warn(message)
       ActiveSupport::Notifications.instrument("log", :level => Logger::WARN, :message => message)
     end
 
+    # @see info
     def self.error(message)
       ActiveSupport::Notifications.instrument("log", :level => Logger::ERROR, :message => message)
     end
 
+    # @see info
     def self.fatal(message)
       ActiveSupport::Notifications.instrument("log", :level => Logger::FATAL, :message => message)
     end

data/lib/occi/model.rb

@@ -0,0 +1,102 @@
+require 'hashie/mash'
+require 'occi/log'
+
+module OCCI
+  class Model
+    @@categories = { }
+    @@locations  = { }
+
+    # 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
+    end
+
+    # register OCCI Infrastructure categories
+    def self.register_infrastructure
+      OCCI::Log.info("### Registering OCCI Infrastructure categories ###")
+      self.register_files('etc/model/infrastructure')
+    end
+
+    # register OCCI categories from files
+    #
+    # @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 .
+    def self.register_files(path)
+      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 = self.location + kind.scheme if kind.scheme.start_with? '/' } if collection.kinds
+        collection.mixins.collect { |mixin| mixin.scheme = self.location + mixin.scheme if mixin.scheme.start_with? '/' } if collection.mixins
+        collection.actions.collect { |action| action.scheme = self.location + action.scheme if action.scheme.start_with? '/' } if collection.actions
+        self.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
+    end
+
+    def self.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)
+    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)
+    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 }
+    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)
+    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 => [] })
+      filter.each do |cat|
+        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
+      if filter.empty?
+        @@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
+      end
+      return collection
+    end
+
+  end
+end