occi-core 4.1.3 → 4.2.0

data/.gitignore

@@ -13,3 +13,4 @@ coverage
 vendor
 collection
 Gemfile.lock
+doc

data/Gemfile

@@ -4,4 +4,12 @@ gemspec
 
 group :development do
   gem 'rubygems-tasks', :git => 'git://github.com/postmodern/rubygems-tasks.git'
+  gem 'json_spec', :git => "https://github.com/collectiveidea/json_spec", :branch => "master"
+  gem 'rspec'
+  gem 'rake'
+  gem 'builder'
+  gem 'simplecov'
+  gem 'yard'
+  gem 'yard-rspec'
+  gem 'debugger', :platforms => :ruby
 end

data/README.md

@@ -14,20 +14,30 @@ Requirements
 * RubyGems have to be installed
 * Rake has to be installed (e.g., `gem install rake`)
 
-### Libraries/packages
-* libxslt1-dev/libxslt-devel
-* libxml2-dev/libxml2-devel
+### Dependencies
+* `libxslt1-dev` or `libxslt-devel`
+* `libxml2-dev`or `libxml2-devel`
 
 ### Examples
-For distros based on Debian:
+#### For distros based on Debian:
 ~~~
 apt-get install ruby rubygems ruby-dev libxslt1-dev libxml2-dev
 ~~~
+~~~
+ruby -v
+~~~
+
+**Unless you have Ruby >= 1.9.3, please, go to [rOCCI-core#RVM](#rvm) and install RVM with a newer Ruby version.**
 
-For distros based on RHEL:
+#### For distros based on RHEL:
 ~~~
 yum install libxml2-devel libxslt-devel ruby-devel openssl-devel gcc gcc-c++ ruby rubygems
 ~~~
+~~~
+ruby -v
+~~~
+
+**Unless you have Ruby >= 1.9.3, please, go to [rOCCI-core#RVM](#rvm) and install RVM with a newer Ruby version.**
 
 Installation
 ------------
@@ -47,12 +57,8 @@ To install the most recent beta version
 ### From source (dev)
 
 **Installation from source should never be your first choice! Especially, if you are not familiar with RVM, Bundler, Rake and other dev tools for Ruby!**
-**However, if you wish to contribute to our project, this is the right way to start.**
-
-To use rOCCI from source it is very much recommended to use RVM. [Install RVM](https://rvm.io/rvm/install/) with
 
-    curl -L https://get.rvm.io | bash -s stable --ruby
-    rvm install 1.9.3
+**However, if you wish to contribute to our project, this is the right way to start.**
 
 To build and install the bleeding edge version from master
 
@@ -63,9 +69,29 @@ To build and install the bleeding edge version from master
     bundle exec rake test
     rake install
 
+### RVM
+
+**Notice:** Follow the RVM installation guide linked below, we recommend using the default 'Single-User installation'.
+
+**Warning:** NEVER install RVM as root! If you choose the 'Multi-User installation', use a different user account with sudo access instead!
+
+* [Installing RVM](https://rvm.io/rvm/install#explained)
+* Install Ruby
+
+~~~
+rvm requirements
+rvm install 1.9.3
+rvm use 1.9.3 --default
+~~~
+~~~
+ruby -v
+~~~
+
 Usage
 -----
-#### Logging
+Detailed documentation is available in our [Wiki](https://github.com/gwdg/rOCCI-core/wiki).
+
+### Logging
 
 The OCCI gem includes its own logging mechanism using a message queue. By default, no one is listening to that queue.
 A new OCCI Logger can be initialized by specifying the log destination (either a filename or an IO object like
@@ -80,7 +106,7 @@ You can always, even if there is no logger defined, log output using the class m
 
     Occi::Log.info("Test message")
 
-#### Registering categories in the OCCI Model
+### Registering categories in the OCCI Model
 
 Before the parser may be used, the available categories have to be registered in the OCCI Model.
 
@@ -89,16 +115,16 @@ For categories already specified by the OCCI WG a method exists in the OCCI Mode
     model = Occi::Model.new
     model.register_infrastructure
 
-Further categories can either be registered from files which include OCCI collections in JSON formator or from parsed
+Further categories can either be registered from files which include OCCI collections in JSON format or or from parsed
  JSON objects (e.g. from the query interface of an OCCI service endpoint).
 
-#### Parsing OCCI messages
+### Parsing OCCI messages
 
 The OCCI gem includes a Parser to easily parse OCCI messages. With a given media type (e.g. json,
 xml or plain text) the parser analyses the content of the message body and, if supplied,
 the message header. As the text/plain and text/occi media type do not clearly distinguish between a message with a
-category and a message with an entity which has a kind, it has to be specified if the message contains a category (e
-.g. for user defined mixins)
+category and a message with an entity which has a kind, it has to be specified if the message contains a category
+(e.g. for user defined mixins)
 
 OCCI messages can be parsed to an OCCI collection for example like
 
@@ -106,7 +132,7 @@ OCCI messages can be parsed to an OCCI collection for example like
     body = %Q|Category: compute; scheme="http://schemas.ogf.org/occi/infrastructure#"; class="kind"|
     collection=Occi::Parser.parse(media_type, body)
 
-#### Parsing OVF / OVA files
+### Parsing OVF / OVA files
 
 Parsing of OVF/OVA files is partly supported and will be improved in future versions.
 
@@ -137,6 +163,12 @@ The occi-core gem includes all OCCI Core classes necessary to handly arbitrary O
 Changelog
 ---------
 
+### Version 4.2
+* Internal changes and bug fixes
+* Extended test coverage
+* Added custom exceptions and error classes
+* Improved text/plain and text/occi rendering
+
 ### Version 4.1
 * Dropped support for Rubies 1.8.x
 * Updated dependencies

data/lib/occi/collection.rb

@@ -2,6 +2,7 @@ module Occi
   class Collection
 
     include Occi::Helpers::Inspect
+    include Occi::Helpers::Comparators::Collection
 
     attr_accessor :kinds, :mixins, :actions, :resources, :links, :action, :model
 
@@ -24,19 +25,17 @@ module Occi
       @actions.merge collection.actions.to_a.collect { |action| Occi::Core::Action.new(action.scheme, action.term, action.title, action.attributes) }
       @resources.merge collection.resources.to_a.collect { |resource| Occi::Core::Resource.new(resource.kind, resource.mixins, resource.attributes, resource.links) }
       @links.merge collection.links.to_a.collect { |link| Occi::Core::Link.new(link.kind, link.mixins, link.attributes) }
-      @action = Occi::Core::ActionInstance.new(collection.action, collection.attributes) if collection.action
+      @action = Occi::Core::ActionInstance.new(collection.action) if collection.action
     end
 
     def <<(object)
-      object.kind_of? Occi::Core::Kind and self.kinds << object
-      object.kind_of? Occi::Core::Mixin and self.mixins << object
-      object.kind_of? Occi::Core::Action and self.actions << object
-      object.kind_of? Occi::Core::Resource and self.resources << object
-      object.kind_of? Occi::Core::Link and self.links << object
-    end
+      self.kinds << object if object.kind_of? Occi::Core::Kind
+      self.mixins << object if object.kind_of? Occi::Core::Mixin
+      self.actions << object if object.kind_of? Occi::Core::Action
+      self.resources << object if object.kind_of? Occi::Core::Resource
+      self.links << object if object.kind_of? Occi::Core::Link
 
-    def ==(category)
-      not intersect(category).empty?
+      self
     end
 
     # @return [Occi::Core::Categories] categories combined list of all kinds, mixins and actions
@@ -70,19 +69,23 @@ module Occi
     # @param [Occi::Collection] other_collection
     # @return [Occi::Collection]
     def merge!(other_collection)
-      merge other_collection, self
+      self.kinds.merge other_collection.kinds.select { |kind| get_by_id(kind.type_identifier).nil? }
+      self.mixins.merge other_collection.mixins.select { |mixin| get_by_id(mixin.type_identifier).nil? }
+      self.actions.merge other_collection.actions.select { |action| get_by_id(action.type_identifier).nil? }
+      self.resources.merge other_collection.resources.select { |resource| get_by_id(resource.id).nil? }
+      self.links.merge other_collection.links.select { |link| get_by_id(link.id).nil? }
+      self.action = other_collection.action if other_collection.action
     end
 
     # @param [Occi::Collection] other_collection
     # @param [Occi::Collection] collection
     # @return [Occi::Collection]
-    def merge(other_collection, collection=self.clone)
-      collection.kinds.merge other_collection.kinds.select { |kind| get_by_id(kind.type_identifier).nil? }
-      collection.mixins.merge other_collection.mixins.select { |mixin| get_by_id(mixin.type_identifier).nil? }
-      collection.actions.merge other_collection.actions.select { |action| get_by_id(action.type_identifier).nil? }
-      collection.resources.merge other_collection.resources.select { |resource| get_by_id(resource.id).nil? }
-      collection.links.merge other_collection.links.select { |link| get_by_id(link.type_identifier).nil? }
-      collection.action = other_collection.action if other_collection.action
+    def merge(other_collection, first=self)
+      collection = Occi::Collection.new
+
+      collection.merge!(first)
+      collection.merge!(other_collection)
+
       collection
     end
 
@@ -100,7 +103,7 @@ module Occi
       collection.mixins.replace other_collection.mixins.select { |mixin| get_by_id(mixin.type_identifier) }
       collection.actions.replace other_collection.actions.select { |action| get_by_id(action.type_identifier) }
       collection.resources.replace other_collection.resources.select { |resource| get_by_id(resource.id) }
-      collection.links.replace other_collection.links.select { |link| get_by_id(link.type_identifier) }
+      collection.links.replace other_collection.links.select { |link| get_by_id(link.id) }
       if collection.action == other_collection.action
         collection.action = other_collection.action
       else
@@ -182,11 +185,24 @@ module Occi
       header = Hashie::Mash.new
       header['Category'] = self.categories.collect { |category| category.to_string_short }.join(',') if self.categories.any?
       raise "Only one resource allowed for rendering to text/occi" if self.resources.size > 1
-      header = self.resources.first.to_header if self.resources.any?
+      header = self.class.header_merge(header, self.resources.first.to_header) if self.resources.any?
       header['Link'] = self.links.collect { |link| link.to_string }.join(',') if self.links.any?
-      header = self.action.to_header if self.action
+      header = self.class.header_merge(header, self.action.to_header) if self.action
       header
     end
 
+    private
+
+    def self.header_merge(target, other, separator=',')
+      other.each_pair do |key,val|
+        if target.key?(key)
+          target[key] = "#{target[key]}#{separator}#{val}"
+        else
+          target[key] = val
+        end
+      end
+      target
+    end
+
   end
-end
+end

data/lib/occi/core/action.rb

@@ -2,7 +2,7 @@ module Occi
   module Core
     class Action < Occi::Core::Category
 
-      # @param [String ] scheme
+      # @param [String] scheme
       # @param [String] term
       # @param [String] title
       # @param [Hash] attributes
@@ -10,23 +10,23 @@ module Occi
           term='action',
           title=nil,
           attributes=Occi::Core::Attributes.new)
-        super scheme, term, title, attributes
+        super(scheme, term, title, attributes)
       end
 
       # @return [String] text representation
       def to_text
         text = super
-        text << ';attributes=' + @attributes.names.join(' ').inspect if @attributes.any?
+        text << "#{@attributes.to_string_short}"
         text
       end
 
       # @return [Hash] hash containing the HTTP headers of the text/occi rendering
       def to_header
         header = super
-        header["Category"] << ';attributes=' + @attributes.names.join(' ').inspect if @attributes.any?
+        header[:Category] << "#{@attributes.to_string_short}"
         header
       end
 
     end
   end
-end
+end

data/lib/occi/core/action_instance.rb

@@ -3,6 +3,7 @@ module Occi
     class ActionInstance
 
       include Occi::Helpers::Inspect
+      include Occi::Helpers::Comparators::ActionInstance
 
       attr_accessor :action, :attributes, :model
 
@@ -16,12 +17,17 @@ module Occi
                                            attributes=self.attributes
 
       def initialize(action = self.action, attributes=self.attributes)
+        raise ArgumentError, 'action cannot be nil' unless action
+        raise ArgumentError, 'attributes cannot be nil' unless attributes
+        raise ArgumentError, 'attributes must respond to #convert' unless attributes.respond_to? :convert
+
         if action.kind_of? String
           scheme, term = action.split '#'
           action = Occi::Core::Action.new(scheme, term)
         end
+
         @action = action
-        @attributes = attributes.convert
+        @attributes = Occi::Core::Attributes.new(attributes)
       end
 
       # @param [Hash] options
@@ -29,10 +35,46 @@ module Occi
       def as_json(options={})
         action = Hashie::Mash.new
         action.action = @action.to_s if @action
-        action.attributes = @attributes if @attributes.any?
+        action.attributes = @attributes.any? ? @attributes.as_json : Occi::Core::Attributes.new.as_json
         action
       end
 
+      # @return [String] text representation
+      def to_text
+        text = "Category: #{@action.to_string_short}"
+        @attributes.names.each_pair do |name, value|
+          value = value.to_s.inspect unless value && value.is_a?(Numeric)
+          text << "\nX-OCCI-Attribute: #{name}=#{value}"
+        end
+
+        text
+      end
+
+      # @return [String] JSON representation
+      def to_json
+        as_json.to_json
+      end
+
+      # @return [Hash] hash containing the HTTP headers of the text/occi rendering
+      def to_header
+        header = Hashie::Mash.new
+        header['Category'] = @action.to_string_short
+
+        attributes = []
+        @attributes.names.each_pair do |name, value|
+          value = value.to_s.inspect unless value && value.is_a?(Numeric)
+          attributes << "#{name}=#{value}"
+        end
+        header['X-OCCI-Attribute'] = attributes.join(',') if attributes.any?
+
+        header
+      end
+
+      # @return [Bool] Indicating whether this action instance is "empty", i.e. required attributes are blank
+      def empty?
+        action.nil? || action.empty?
+      end
+
     end
   end
-end
+end

data/lib/occi/core/actions.rb

@@ -9,9 +9,10 @@ module Occi
 
         if category.kind_of? String
           scheme, term = category.split '#'
-          scheme       += '#'
+          scheme << '#'
           category = Occi::Core::Action.new(scheme, term)
         end
+
         category
       end