occi 2.0.6 → 2.1.0

data/lib/occi/{parse.rb → parser.rb}

@@ -1,32 +1,12 @@
-##############################################################################
-#  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.
-##############################################################################
-
-##############################################################################
-# @note OCCI RESTful Web Service
-# @author Florian Feldhaus, Piotr Kasprzak
-##############################################################################
-
 require 'json'
-#require 'nokogiri'
-require 'occi/core/collection'
+require 'nokogiri'
+require 'hashie/mash'
+require 'occi/collection'
 require 'occi/log'
-require 'occi/antlr/OCCIParser'
+require 'occiantlr/OCCIANTLRParser'
 
 module OCCI
-  class Parse
+  class Parser
 
 =begin
           if content_type.includes?('multipart')
@@ -54,16 +34,49 @@ module OCCI
           end
 =end
 
+    # Parses an OCCI message and extracts OCCI relevant information
+    # @param [String] media_type the media type of the OCCI message
+    # @param [String] body the body of the OCCI message
+    # @param [true, false] category for text/plain and text/occi media types information e.g. from the HTTP request location is needed to determine if the OCCI message includes a category or an entity
+    # @param [Hash] header optional header of the OCCI message
+    # @return [Array<Array, OCCI::Core::Collection>] list consisting of an array of locations and the OCCI object collection
+    def self.parse(media_type, body, category=false, header={ })
+      OCCI::Log.debug('### Parsing request data to OCCI data structure ###')
+      collection = OCCI::Collection.new
+      # always check header for locations
+      locations  = self.header_locations(header)
+      category ? collection = self.header_categories(header) : collection = self.header_entity(header) if locations.empty?
+
+      case media_type
+        when 'text/uri-list'
+          body.each_line { |line| locations << URI.parse(line) }
+        when 'text/plain', nil
+          locations = self.text_locations(body)
+          category ? collection = self.text_categories(body) : collection = self.text_entity(body) if locations.empty?
+        when 'application/occi+json', 'application/json'
+          collection = self.json(body)
+        when 'application/occi+xml', 'application/xml'
+          collection = self.xml(body)
+        #when 'application/ovf+xml'
+        #  collection = self.ovf(body)
+        else
+          raise OCCI::ContentTypeNotSupported
+      end
+      return locations, collection
+    end
+
+    private
+
     def self.header_locations(header)
       x_occi_location_strings = header['HTTP_X_OCCI_LOCATION'].to_s.split(',')
-      x_occi_location_strings.collect { |loc| OCCI::Parser.new('X-OCCI-Location: ' + loc).x_occi_location }
+      x_occi_location_strings.collect { |loc| OCCIANTLR::Parser.new('X-OCCI-Location: ' + loc).x_occi_location }
     end
 
     def self.header_categories(header)
-      collection = OCCI::Core::Collection.new
+      collection       = OCCI::Core::Collection.new
       category_strings = header['HTTP_CATEGORY'].to_s.split(',')
       category_strings.each do |cat|
-        category = OCCI::Parser.new('Category: ' + cat).category
+        category = OCCIANTLR::Parser.new('Category: ' + cat).category
         collection.kinds.concat category.kinds.collect { |kind| OCCI::Core::Kind.new(kind) }
         collection.mixins.concat category.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) }
         collection.actions.concat category.actions.collect { |action| OCCI::Core::Action.new(action) }
@@ -72,18 +85,18 @@ module OCCI
     end
 
     def self.header_entity(header)
-      collection = OCCI::Core::Collection.new
-      entity = Hashie::Mash.new
+      collection       = OCCI::Collection.new
+      entity           = Hashie::Mash.new
       category_strings = header['HTTP_CATEGORY'].to_s.split(',')
       return collection if category_strings.empty?
       attribute_strings = header['HTTP_X_OCCI_ATTRIBUTE'].to_s.split(',')
-      categories = Hashie::Mash.new({:kinds => [], :mixins => [], :actions => []})
-      category_strings.each { |cat| categories.merge!(OCCI::Parser.new('Category: ' + cat).category) }
+      categories        = Hashie::Mash.new({ :kinds => [], :mixins => [], :actions => [] })
+      category_strings.each { |cat| categories.merge!(OCCIANTLR::Parser.new('Category: ' + cat).category) }
       return collection if categories.kinds.empty?
       entity.kind = categories.kinds.first.scheme + categories.kinds.first.term
       entity.mixins = categories.mixins.collect { |mixin| mixin.scheme + mixin.term } if categories.mixins.any?
-      attribute_strings.each { |attr| entity.attributes!.merge!(OCCI::Parser.new('X-OCCI-Attribute: ' + attr).x_occi_attribute) }
-      kind = OCCI::Registry.get_by_id(entity.kind)
+      attribute_strings.each { |attr| entity.attributes!.merge!(OCCIANTLR::Parser.new('X-OCCI-Attribute: ' + attr).x_occi_attribute) }
+      kind = OCCI::Model.get_by_id(entity.kind)
       # TODO: error handling
       return collection if kind.nil?
       if kind.entity_type == OCCI::Core::Link.name
@@ -92,20 +105,20 @@ module OCCI
         collection.links << OCCI::Core::Link.new(entity)
       elsif kind.entity_type == OCCI::Core::Resource.name
         link_strings = header['HTTP_LINK'].to_s.split(',')
-        link_strings.each { |link| entity.links << OCCI::Parser.new('Link: ' + link).link }
+        link_strings.each { |link| entity.links << OCCIANTLR::Parser.new('Link: ' + link).link }
         collection.resources << OCCI::Core::Resource.new(entity)
       end
       collection
     end
 
     def self.text_locations(text)
-      text.lines.collect { |line| OCCI::Parser.new(line).x_occi_location if line.include? 'X-OCCI-Location' }.compact
+      text.lines.collect { |line| OCCIANTLR::Parser.new(line).x_occi_location if line.include? 'X-OCCI-Location' }.compact
     end
 
     def self.text_categories(text)
       collection = OCCI::Core::Collection.new
       text.each_line do |line|
-        category = OCCI::Parser.new(line).category
+        category = OCCIANTLR::Parser.new(line).category
         collection.kinds.concat category.kinds.collect { |kind| OCCI::Core::Kind.new(kind) }
         collection.mixins.concat category.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) }
         collection.actions.concat category.actions.collect { |action| OCCI::Core::Action.new(action) }
@@ -114,25 +127,25 @@ module OCCI
     end
 
     def self.text_entity(text)
-      collection = OCCI::Core::Collection.new
-      entity = Hashie::Mash.new
-      links = []
-      categories = Hashie::Mash.new({:kinds => [], :mixins => [], :actions => []})
+      collection = OCCI::Collection.new
+      entity     = Hashie::Mash.new
+      links      = []
+      categories = Hashie::Mash.new({ :kinds => [], :mixins => [], :actions => [] })
       text.each_line do |line|
-        categories.merge!(OCCI::Parser.new(line).category) if line.include? 'Category'
-        entity.attributes!.merge!(OCCI::Parser.new(line).x_occi_attribute) if line.include? 'X-OCCI-Attribute'
-        links << OCCI::Parser.new(line).link if line.include? 'Link'
+        categories.merge!(OCCIANTLR::Parser.new(line).category) if line.include? 'Category'
+        entity.attributes!.merge!(OCCIANTLR::Parser.new(line).x_occi_attribute) if line.include? 'X-OCCI-Attribute'
+        links << OCCIANTLR::Parser.new(line).link if line.include? 'Link'
       end
       entity.kind = categories.kinds.first.scheme + categories.kinds.first.term if categories.kinds.first
       entity.mixins = categories.mixins.collect { |mixin| mixin.scheme + mixin.term } if entity.mixins
-      kind = OCCI::Registry.get_by_id(entity.kind)
+      kind = OCCI::Model.get_by_id(entity.kind)
       # TODO: error handling
       return collection if kind.nil?
-      if OCCI::Registry.get_by_id(entity.kind).entity_type == OCCI::Core::Link.name
+      if OCCI::Model.get_by_id(entity.kind).entity_type == OCCI::Core::Link.name
         entity.target = links.first.attributes.occi!.core!.target
         entity.source = links.first.attributes.occi!.core!.source
         collection.links << OCCI::Core::Link.new(entity)
-      elsif OCCI::Registry.get_by_id(entity.kind).entity_type == OCCI::Core::Resource.name
+      elsif OCCI::Model.get_by_id(entity.kind).entity_type == OCCI::Core::Resource.name
         entity.links = links
         collection.resources << OCCI::Core::Resource.new(entity)
       end unless entity.kind.nil?
@@ -141,7 +154,17 @@ module OCCI
 
     def self.json(json)
       collection = OCCI::Core::Collection.new
-      hash = Hashie::Mash.new(JSON.parse(json))
+      hash       = Hashie::Mash.new(JSON.parse(json))
+      collection.kinds.concat hash.kinds.collect { |kind| OCCI::Core::Kind.new(kind) } if hash.kinds
+      collection.mixins.concat hash.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) } if hash.mixins
+      collection.resources.concat hash.resources.collect { |resource| OCCI::Core::Resource.new(resource) } if hash.resources
+      collection.links.concat hash.links.collect { |link| OCCI::Core::Link.new(link) } if hash.links
+      collection
+    end
+
+    def self.xml(xml)
+      collection = OCCI::Collection.new
+      hash       = Hashie::Mash.new(Hash.from_xml(Nokogiri::XML(xml)))
       collection.kinds.concat hash.kinds.collect { |kind| OCCI::Core::Kind.new(kind) } if hash.kinds
       collection.mixins.concat hash.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) } if hash.mixins
       collection.resources.concat hash.resources.collect { |resource| OCCI::Core::Resource.new(resource) } if hash.resources
@@ -149,14 +172,8 @@ module OCCI
       collection
     end
 
-    #def self.xml(xml)
-    #  collection = OCCI::Core::Collection.new
-    #  hash = Hashie::Mash.new(Hash.from_xml(Nokogiri::XML(xml)))
-    #  collection.kinds.concat hash.kinds.collect { |kind| OCCI::Core::Kind.new(kind) } if hash.kinds
-    #  collection.mixins.concat hash.mixins.collect { |mixin| OCCI::Core::Mixin.new(mixin) } if hash.mixins
-    #  collection.resources.concat hash.resources.collect { |resource| OCCI::Core::Resource.new(resource) } if hash.resources
-    #  collection.links.concat hash.links.collect { |link| OCCI::Core::Link.new(link) } if hash.links
-    # collection
+    #def self.ovf(ovf)
+    # TODO: implement ovf / ova messages
     #end
 
   end

data/lib/occi/version.rb

@@ -1,3 +1,3 @@
 module OCCI
-  VERSION = "2.0.6" unless defined?(::OCCI::VERSION)
+  VERSION = "2.1.0" unless defined?(::OCCI::VERSION)
 end

data/lib/occi.rb

@@ -1,17 +1,17 @@
-module OCCI
-  require 'occi/version'
-  require 'occi/parse'
-  require 'occi/registry'
-  require 'occi/log'
-  require 'occi/exceptions'
-  require 'occi/core/action'
-  require 'occi/core/attribute_properties'
-  require 'occi/core/attributes'
-  require 'occi/core/category'
-  require 'occi/core/collection'
-  require 'occi/core/entity'
-  require 'occi/core/kind'
-  require 'occi/core/link'
-  require 'occi/core/mixin'
-  require 'occi/core/resource'
-end
+require 'occi/version'
+require 'occi/parser'
+require 'occi/model'
+require 'occi/log'
+require 'occi/collection'
+require 'occi/core/action'
+require 'occi/core/attribute_properties'
+require 'occi/core/attributes'
+require 'occi/core/category'
+require 'occi/core/entity'
+require 'occi/core/kind'
+require 'occi/core/link'
+require 'occi/core/mixin'
+require 'occi/core/resource'
+
+require 'occiantlr/OCCIANTLRLexer'
+require 'occiantlr/OCCIANTLRParser'

data/lib/{occi/antlr/OCCI.g → occiantlr/OCCIANTLR.g}

@@ -1,31 +1,4 @@
-/*  
-Copyright (c) 2008-2011, Intel Performance Learning Solutions Ltd.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of Intel Performance Learning Solutions Ltd. nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL Intel Performance Learning Solutions Ltd. BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*/
-
-grammar OCCI;
+grammar OCCIANTLR;
 
 options { 
 	language = Ruby; 
@@ -34,7 +7,7 @@ options {
 @header { 
 	require 'uri' 
 	require 'hashie'
-	ATTRIBUTE = { :mutable => true, :required => false, :type => { :string => {} }, :default => '' }
+	ATTRIBUTE = { :mutable => true, :required => false, :type => "string" }
 }
 
 /*
@@ -73,16 +46,16 @@ category returns [hash]
 	 					  { value = $class_type.text };
 	 category_title returns [value]		: ';' WS? 'title' '=' '"' title '"'
 	 				  	  { value = $title.text };
-	 category_rel returns [value]		: ';' WS? 'rel' '=' '"' rel '"'
-					  	  { value = $rel.text };
-	 category_location returns [value]	: ';' WS? 'location' '=' '"' location '"'
-	 				  	  { value = $location.text };
+	 category_rel returns [value]		: ';' WS? 'rel' '=' '"' uri '"'
+					  	  { value = $uri.text };
+	 category_location returns [value]	: ';' WS? 'location' '=' '"' uri '"'
+	 				  	  { value = $uri.text };
 	 category_attributes  returns [hash] 	@init{hash = Hashie::Mash.new}
 	 					: ';' WS? 'attributes' '=' '"' attr=attribute_name { hash.merge!($attr.hash) }
-	 					  ( WS? next_attr=attribute_name  { hash.merge!($next_attr.hash) } )* '"';
+	 					  ( WS next_attr=attribute_name  { hash.merge!($next_attr.hash) } )* '"';
 	 category_actions  returns [array]     	@init{array = Array.new}
-	 					: ';' WS? 'actions' '=' '"' act=action_location { array << $act.text } 
-	 					  ( WS? next_act=action_location { array << $next_act.text } )* '"'; 
+	 					: ';' WS? 'actions' '=' '"' act=uri { array << $act.text } 
+	 					  ( WS next_act=uri { array << $next_act.text } )* '"'; 
 
 /* e.g.
 Link:
@@ -104,10 +77,10 @@ link returns [hash]
 			  link_attributes { hash[:attributes] = $link_attributes.hash }
 			  ';'?
 			  ;
-	link_target returns [value]	: WS? '<' target '>' { value = $target.text };
-	link_rel  returns [value]	: ';' WS? 'rel' '=' '"' rel '"' { value = $rel.text };
-	link_self  returns [value]	: ';' WS? 'self' '=' '"' self_location '"' { value = $self_location.text };
-	link_category  returns [value]	: ';' WS? 'category' '=' '"' category_name '"' { value = $category_name.text };
+	link_target returns [value]	: WS? '<' uri '>' { value = $uri.text };
+	link_rel  returns [value]	: ';' WS? 'rel' '=' '"' uri '"' { value = $uri.text };
+	link_self  returns [value]	: ';' WS? 'self' '=' '"' uri '"' { value = $uri.text };
+	link_category  returns [value]	: ';' WS? 'category' '=' '"' uri '"' { value = $uri.text };
 	link_attributes  returns [hash] @init { hash = Hashie::Mash.new }
 					: (';' WS? attribute { hash.merge!($attribute.hash) } )*;
 
@@ -130,16 +103,14 @@ X-OCCI-Location: http://example.com/compute/123
 X-OCCI-Location: http://example.com/compute/456
 */
 
-x_occi_location returns [uri]
-	: 'X-OCCI-Location' ':' WS? location ';'? { uri = URI.parse($location.text) } ;
+x_occi_location returns [location]
+	: 'X-OCCI-Location' ':' WS? uri ';'? { location = URI.parse($uri.text) } ;
 
-uri			: ( LOALPHA | UPALPHA | DIGIT | '@' | ':' | '%' | '_' | '\\' | '+' | '.' | '~' | '#' | '?' | '&' | '/' | '=' | '-' | 'action' | 'kind' | 'mixin' )+;
+uri			: ( LOALPHA | UPALPHA | DIGIT | '@' | ':' | '%' | '_' | '\\' | '+' | '.' | '~' | '#' | '?' | '&' | '/' | '=' | '-' | 'action' | 'kind' | 'mixin' | 'location' | 'attributes' | 'rel' | 'title' | 'actions' | 'scheme' | 'term' | 'category' | 'self' | 'Link' )+;
 term			: LOALPHA ( LOALPHA | DIGIT | '-' | '_')*;
 scheme 		        : uri; 
 class_type		: ( 'kind' | 'mixin' | 'action' );
 title			: ( ESC | ~( '\\' | '"' | '\'' ) | '\'' )*;
-rel			: uri;
-location		: uri;
 attribute returns [hash] @init { hash = Hashie::Mash.new }
 			: comp_first=attribute_component { cur_hash = hash; comp = $comp_first.text }
 			  ( '.' comp_next=attribute_component { cur_hash[comp.to_sym] = Hashie::Mash.new; cur_hash = cur_hash[comp.to_sym]; comp = $comp_next.text })*
@@ -152,13 +123,9 @@ attribute_component	: LOALPHA ( LOALPHA | DIGIT | '-' | '_' )*;
 attribute_value returns [value]	: ( string { value = $string.text } | number { value = $number.text.to_i } );
 string			: ( '"' ( ESC | ~( '\\' | '"' | '\'' ) | '\'' )* '"');
 number			: ( DIGIT* ( '.' DIGIT+ )? );
-action_location		: uri;
-target			: uri;
-self_location		: uri;
-category_name		: uri;
 
 LOALPHA : ('a'..'z')+;
 UPALPHA	: ('A'..'Z')+;
 DIGIT   : ('0'..'9');	
 WS      : ( '\t' | ' ' | '\r' | '\n'| '\u000C' )+;
-ESC     : '\\' ( '"' | '\'' );
+ESC     : '\\' ( '"' | '\'' );

data/lib/{occi/antlr/OCCI.tokens → occiantlr/OCCIANTLR.tokens}

@@ -5,8 +5,8 @@ T__26=26
 T__25=25
 T__24=24
 T__23=23
-T__22=22
 ESC=8
+T__22=22
 T__21=21
 T__20=20
 T__9=9
@@ -26,6 +26,7 @@ T__42=42
 T__43=43
 T__40=40
 T__41=41
+T__44=44
 T__30=30
 T__31=31
 T__32=32
@@ -60,9 +61,10 @@ T__39=39
 '"'=14
 'rel'=17
 'actions'=20
+'term'=43
 'location'=18
 'action'=40
-'\''=43
+'\''=44
 '?'=36
 'title'=16
 'mixin'=42