occi-api 4.1.1 → 4.2.0.beta.2

data/Gemfile

@@ -5,4 +5,13 @@ gemspec
 group :development do
   gem 'vcr', :git => 'git://github.com/arax/vcr.git', :branch => 'test_framework_patches', :ref => 'e82e843ceddd8822acea59846b015bcabf1906df'
   gem 'rubygems-tasks', :git => 'git://github.com/postmodern/rubygems-tasks.git'
+  gem "rspec"
+  gem "rake"
+  gem "builder"
+  gem "simplecov"
+  gem "yard"
+  gem "yard-sinatra"
+  gem "yard-rspec"
+  gem "rspec-http"
+  gem "webmock", "~> 1.9.3"
 end

data/README.md

@@ -14,20 +14,32 @@ 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-api#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-api#RVM](#rvm) and install RVM with a newer Ruby version.**
+
+To use rOCCI-cli with Java, you need JRE 6 or 7. To build rOCCI-cli for Java, you need JDK 6 or 7.
 
 Installation
 ------------
@@ -47,12 +59,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-api 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
 
@@ -60,9 +68,27 @@ To build and install the bleeding edge version from master
     cd rOCCI-api
     gem install bundler
     bundle install
-    bundle exec rake install
+    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
 -----
 ### Auth

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems/tasks'
 
 task :default => 'test'
 
-desc "Run all tests; includes rspec, cucumber and coverage reports"
+desc "Run all tests; includes rspec and coverage reports"
 task :test => 'rcov:all'
 
 Gem::Tasks.new(:build => {:tar => true, :zip => true}, :sign => {:checksum => true, :pgp => false})
@@ -10,22 +10,15 @@ Gem::Tasks.new(:build => {:tar => true, :zip => true}, :sign => {:checksum => tr
 namespace :rcov do
 
   require 'rspec/core/rake_task'
-  require 'cucumber/rake/task'
-
-  Cucumber::Rake::Task.new(:cucumber) do |t|
-    t.cucumber_opts = "--format pretty"
-    ENV['COVERAGE'] = "true"
-  end
 
   RSpec::Core::RakeTask.new(:rspec) do |t|
     ENV['COVERAGE'] = "true"
   end
 
-  desc "Run cucumber & rspec to generate aggregated coverage"
+  desc "Run rspec to generate aggregated coverage"
   task :all do |t|
     rm "coverage/coverage.data" if File.exist?("coverage/coverage.data")
     Rake::Task['rcov:rspec'].invoke
-    Rake::Task["rcov:cucumber"].invoke
   end
 
 end

data/examples/dsl_example.rb

@@ -55,7 +55,7 @@ mixin_type_identifiers.each do |mixin_typeid|
 end
 
 puts "\n\nListing all available mixins:"
-mixins.each do |mixin|
+mixin_list.each do |mixin|
   puts "\n#{mixin}"
 end
 
@@ -158,7 +158,7 @@ while cmpt_data[0].resources.first.attributes.occi.compute.state == "inactive"
   cmpt_data = describe cmpt_loc
 end
 
-puts "\nCompute resource #{cmpt_loc} is #{cmpt_data[0].resources.first.attributes.occi.compute.state}"
+puts "\nCompute resource #{cmpt_loc} is #{cmpt_data.first.state}"
 
 ## delete the resource and exit
 if clean_up_compute

data/examples/x509auth_example.rb

@@ -49,7 +49,7 @@ client.get_mixin_type_identifiers.each do |mixin_typeid|
 end
 
 puts "\n\nListing all available mixins:"
-client.get_mixins.each do |mixin|
+client.list_mixins.each do |mixin|
   puts "\n#{mixin}"
 end
 
@@ -58,25 +58,25 @@ samples = [OS_TEMPLATE, "medium", "large", "small"]
 puts "\n\nFind mixins using their names:"
 samples.each do |mixin|
   puts "\n#{mixin}:\n"
-  pp client.find_mixin mixin
+  pp client.get_mixin mixin
 end
 
 puts "\n\nFind mixins using their names and a type:"
 samples.each do |mixin|
   puts "\n#{mixin}:\n"
-  pp client.find_mixin(mixin, "os_tpl")
+  pp client.get_mixin(mixin, "os_tpl")
 end
 
 puts "\n\nFind mixins using their names and a type:"
 samples.each do |mixin|
   puts "\n#{mixin}:\n"
-  pp client.find_mixin(mixin, "resource_tpl")
+  pp client.get_mixin(mixin, "resource_tpl")
 end
 
 puts "\n\nFind mixins using their names (showing detailed descriptions):"
 samples.each do |mixin|
   puts "\n#{mixin}:\n"
-  pp client.find_mixin(mixin, nil, true)
+  pp client.get_mixin(mixin, nil, true)
 end
 
 ## get links of all available resources
@@ -108,7 +108,7 @@ unless use_os_temlate
   ## network, storage and resource template (instance type)
 
   ## select instance type medium
-  cmpt.mixins << client.find_mixin('medium', "resource_tpl")
+  cmpt.mixins << client.get_mixin('medium', "resource_tpl")
 
   ## list network/storage locations and select the appropriate ones (the first ones in this case)
   puts "\nUsing:"
@@ -123,8 +123,8 @@ else
   ## with OS template, we have to find the template by name
   ## optionally we can change its "size" by choosing an instance type
   puts "\nUsing:"
-  pp os = client.find_mixin(OS_TEMPLATE, "os_tpl")
-  pp size = client.find_mixin('medium', "resource_tpl")
+  pp os = client.get_mixin(OS_TEMPLATE, "os_tpl")
+  pp size = client.get_mixin('medium', "resource_tpl")
 
   ## attach chosen resources to the compute resource
   cmpt.mixins << os << size
@@ -152,7 +152,7 @@ while cmpt_data[0].resources.first.attributes.occi.compute.state == "inactive"
   cmpt_data = client.describe cmpt_loc
 end
 
-puts "\nCompute resource #{cmpt_loc} is #{cmpt_data[0].resources.first.attributes.occi.compute.state}"
+puts "\nCompute resource #{cmpt_loc} is #{cmpt_data.first.state}"
 
 ## delete the resource and exit
 if clean_up_compute

data/lib/occi-api.rb

@@ -9,5 +9,4 @@ require 'occi/api/version'
 require 'occi/api/client/client_base'
 require 'occi/api/client/errors'
 require 'occi/api/client/client_http'
-require 'occi/api/client/client_amqp'
 require 'occi/api/dsl'

data/lib/occi/api/client/client_base.rb

@@ -91,16 +91,16 @@ module Occi
         #
         # @example
         #    client.describe
-        #     # => [#<Occi::Collection>, #<Occi::Collection>, #<Occi::Collection>]
+        #     # => #<Occi::Core::Resources>
         #    client.describe "compute"
-        #     # => [#<Occi::Collection>, #<Occi::Collection>, #<Occi::Collection>]
+        #     # => #<Occi::Core::Resources>
         #    client.describe "http://schemas.ogf.org/occi/infrastructure#compute"
-        #     # => [#<Occi::Collection>, #<Occi::Collection>, #<Occi::Collection>]
+        #     # => #<Occi::Core::Resources>
         #    client.describe "http://localhost:3300/compute/j5hk1234jk2524-2j3j2k34jjh234-adfaf1234"
-        #     # => [#<Occi::Collection>]
+        #     # => #<Occi::Core::Resources>
         #
         # @param [String] resource type identifier, type name or resource location
-        # @return [Array<Occi::Collection>] list of resource descriptions
+        # @return [Occi::Core::Resources] list of resource descriptions
         def describe(resource_type_identifier=nil); end
 
         # Creates a new resource on the server. Resource must be provided
@@ -111,8 +111,8 @@ module Occi
         #    res = client.get_resource "compute"
         #
         #    res.title = "MyComputeResource1"
-        #    res.mixins << client.find_mixin('small', "resource_tpl")
-        #    res.mixins << client.find_mixin('debian6', "os_tpl")
+        #    res.mixins << client.get_mixin('small', "resource_tpl")
+        #    res.mixins << client.get_mixin('debian6', "os_tpl")
         #
         #    client.create res # => "http://localhost:3300/compute/df7698...f987fa"
         #
@@ -203,11 +203,11 @@ module Occi
             resource_type
           else
             # we got a resource type name
-            type_ids = @model.kinds.select { |kind| kind.term == resource_type }
+            type_ids = @model.kinds.to_a.select { |kind| kind.term == resource_type }
             type_ids.first.type_identifier if type_ids.any?
           end
 
-          raise "Unknown resource type! [#{resource_type}]" unless type_id
+          raise "Unknown resource type! #{resource_type.inspect}" unless type_id
 
           Occi::Core::Resource.new type_id
         end
@@ -236,7 +236,7 @@ module Occi
         # @return [Array<String>] list of available entity types in a human-readable format
         def get_entity_types
           Occi::Log.debug("Getting entity types ...")
-          @model.kinds.collect { |kind| kind.term }
+          @model.kinds.to_a.collect { |kind| kind.term }
         end
 
         # Retrieves all available entity type identifiers.
@@ -305,21 +305,21 @@ module Occi
         # Will return mixin's full location (a link) or a description.
         #
         # @example
-        #    client.find_mixin "debian6"
+        #    client.get_mixin "debian6"
         #     # => "http://my.occi.service/occi/infrastructure/os_tpl#debian6"
-        #    client.find_mixin "debian6", "os_tpl", true
-        #     # => #<Occi::Collection>
-        #    client.find_mixin "large", "resource_tpl"
+        #    client.get_mixin "debian6", "os_tpl", true
+        #     # => #<Occi::Core::Mixin>
+        #    client.get_mixin "large", "resource_tpl"
         #     # => "http://my.occi.service/occi/infrastructure/resource_tpl#large"
-        #    client.find_mixin "debian6", "resource_tpl" # => nil
+        #    client.get_mixin "debian6", "resource_tpl" # => nil
         #
         # @param [String] name of the mixin
         # @param [String] type of the mixin
         # @param [Boolean] should we describe the mixin or return its link?
-        # @return [String, Occi::Collection, nil] link, mixin description or nothing found
-        def find_mixin(name, type = nil, describe = false)
+        # @return [String, Occi::Core::Mixin, nil] link, mixin description or nothing found
+        def get_mixin(name, type = nil, describe = false)
+          # TODO: mixin fix
           Occi::Log.debug("Looking for mixin #{name} + #{type} + #{describe}")
-          raise "Unknown mixin type! [#{type}]" if type && !@mixins.has_key?(type.to_sym)
 
           # TODO: extend this code to support multiple matches and regex filters
           # should we look for links or descriptions?
@@ -331,19 +331,21 @@ module Occi
         #
         # @example
         #    client.describe_mixin "debian6"
-        #     # => #<Occi::Collection>
+        #     # => #<Occi::Core::Mixin>
         #    client.describe_mixin "debian6", "os_tpl"
-        #     # => #<Occi::Collection>
+        #     # => #<Occi::Core::Mixin>
         #    client.describe_mixin "large", "resource_tpl"
-        #     # => #<Occi::Collection>
+        #     # => #<Occi::Core::Mixin>
         #    client.describe_mixin "debian6", "resource_tpl" # => nil
         #
         # @param [String] name of the mixin
         # @param [String] type of the mixin
-        # @return [Occi::Collection, nil] mixin description or nothing found
+        # @return [Occi::Core::Mixin, nil] mixin description or nothing found
         def describe_mixin(name, type = nil)
-          found_ary = type ? describe_mixin_w_type(name, type) : describe_mixin_wo_type(name)
-          found_ary.any? ? found_ary.first : nil
+          mixins = get_mixins(type)
+
+          mixins = mixins.to_a.select { |m| m.term == name }
+          mixins.any? ? mixins.first : nil
         end
 
         # Looks up a mixin with a specific type, will return
@@ -351,10 +353,9 @@ module Occi
         #
         # @param [String] name of the mixin
         # @param [String] type of the mixin
-        # @return [Occi::Collection] mixin description
+        # @return [Occi::Core::Mixin] mixin description
         def describe_mixin_w_type(name, type)
-          return unless %w( os_tpl resource_tpl ).include? type.to_s
-          send("get_#{type.to_s}s".to_sym).select { |mixin| mixin.term == name }
+          describe_mixin(name, type)
         end
 
         # Looks up a mixin in all available mixin types, will
@@ -362,14 +363,9 @@ module Occi
         # first match found, search will start in os_tpl.
         #
         # @param [String] name of the mixin
-        # @return [Occi::Collection] mixin description
+        # @return [Occi::Core::Mixin] mixin description
         def describe_mixin_wo_type(name)
-          %w( os_tpl resource_tpl ).each do |type|
-            found = send("get_#{type}s".to_sym).select { |mixin| mixin.term == name }
-            return found if found.any?
-          end
-
-          []
+          describe_mixin(name, nil)
         end
 
         # Looks up a mixin using its name and, optionally, a type as well.
@@ -388,37 +384,68 @@ module Occi
         # @param [String] type of the mixin
         # @return [String, nil] link or nothing found
         def list_mixin(name, type = nil)
-          mxns = type ? @mixins[type.to_sym] : @mixins.flatten(2)
-          mxns = mxns.select { |mixin| mixin.to_s.reverse.start_with? "##{name}".reverse }
-          mxns.any? ? mxns.first : nil
+          mixin = describe_mixin(name, type)
+          mixin ? mixin.type_identifier : nil
         end
 
         # Retrieves available mixins of a specified type or all available
         # mixins if the type wasn't specified. Mixins are returned in the
-        # form of mixin identifiers.
+        # form of mixin instances.
         #
         # @example
         #    client.get_mixins
-        #     # => ["http://my.occi.service/occi/infrastructure/os_tpl#debian6",
-        #     #     "http://my.occi.service/occi/infrastructure/resource_tpl#small"]
+        #     # => #<Occi::Core::Mixins>
         #    client.get_mixins "os_tpl"
-        #     # => ["http://my.occi.service/occi/infrastructure/os_tpl#debian6"]
+        #     # => #<Occi::Core::Mixins>
         #    client.get_mixins "resource_tpl"
-        #     # => ["http://my.occi.service/occi/infrastructure/resource_tpl#small"]
+        #     # => #<Occi::Core::Mixins>
         #
         # @param [String] type of mixins
-        # @return [Array<String>] list of available mixins
+        # @return [Occi::Core::Mixins] collection of available mixins
         def get_mixins(type = nil)
-          if type
-            # is type valid?
-            raise "Unknown mixin type! #{type}" unless @mixins.has_key? type.to_sym
-            @mixins[type.to_sym]
+          unless type.blank?
+            unless get_mixin_types.include?(type) || get_mixin_type_identifiers.include?(type)
+              raise ArgumentError,
+                    "There is no such mixin type registered in the model! #{type.inspect}"
+            end
+
+            type = get_mixin_type_identifier(type) if get_mixin_types.include?(type)
+            mixins = @model.mixins.to_a.select { |m| m.related_to?(type) }
+
+            # drop the type mixin itself
+            mixins.delete_if { |m| m.type_identifier == type }
           else
             # we did not get a type, return all mixins
-            mixins = []
-            get_mixin_types.each { |ltype| mixins.concat @mixins[ltype.to_sym] }
-            mixins
+            mixins = Occi::Core::Mixins.new(@model.mixins)
+          end
+
+          unless mixins.kind_of? Occi::Core::Mixins
+            col = Occi::Core::Mixins.new
+            mixins.each { |m| col << m }
+          else
+            col = mixins
           end
+
+          col
+        end
+
+        # Retrieves available mixins of a specified type or all available
+        # mixins if the type wasn't specified. Mixins are returned in the
+        # form of mixin identifiers.
+        #
+        # @example
+        #    client.list_mixins
+        #     # => #<Array<String>>
+        #    client.list_mixins "os_tpl"
+        #     # => #<Array<String>>
+        #    client.list_mixins "resource_tpl"
+        #     # => #<Array<String>>
+        #
+        # @param [String] type of mixins
+        # @return [Array<String>] collection of available mixin identifiers
+        def list_mixins(type = nil)
+          mixins = get_mixins(type)
+          mixins.to_a.collect { |m| m.type_identifier }
         end
 
         # Retrieves available mixin types. Mixin types are presented
@@ -429,7 +456,7 @@ module Occi
         #
         # @return [Array<String>] list of available mixin types
         def get_mixin_types
-          @mixins.keys.map { |k| k.to_s }
+          get_mixins.to_a.collect { |m| m.term }
         end
 
         # Retrieves available mixin type identifiers.
@@ -441,34 +468,40 @@ module Occi
         #
         # @return [Array<String>] list of available mixin type identifiers
         def get_mixin_type_identifiers
-          identifiers = []
-
-          get_mixin_types.each do |mixin_type|
-            identifiers << "http://schemas.ogf.org/occi/infrastructure##{mixin_type}"
-          end
+          list_mixins(nil)
+        end
 
-          identifiers
+        # Retrieves available mixin type identifier for the given mixin type.
+        #
+        # @example
+        #    client.get_mixin_type_identifier("os_tpl")
+        #     # => 'http://schemas.ogf.org/occi/infrastructure#os_tpl'
+        #
+        # @return [String, nil] mixin type identifier for the given mixin type
+        def get_mixin_type_identifier(type)
+          mixins = get_mixins.to_a.select { |m| m.term == type }
+          mixins.collect { |m| m.type_identifier }.first
         end
 
         # Retrieves available os_tpls from the model.
         #
         # @example
-        #    get_os_templates # => #<Occi::Collection>
+        #    get_os_templates # => #<Occi::Core::Mixins>
         #
-        # @return [Occi::Collection] collection containing all registered OS templates
+        # @return [Occi::Core::Mixins] collection containing all registered OS templates
         def get_os_templates
-          @model.get.mixins.select { |mixin| mixin.related.select { |rel| rel.type_identifier.end_with? 'os_tpl' }.any? }
+          get_mixins "http://schemas.ogf.org/occi/infrastructure#os_tpl"
         end
         alias_method :get_os_tpls, :get_os_templates
 
         # Retrieves available resource_tpls from the model.
         #
         # @example
-        #    get_resource_templates # => #<Occi::Collection>
+        #    get_resource_templates # => #<Occi::Core::Mixins>
         #
-        # @return [Occi::Collection] collection containing all registered resource templates
+        # @return [Occi::Core::Mixins] collection containing all registered resource templates
         def get_resource_templates
-          @model.get.mixins.select { |mixin| mixin.related.select { |rel| rel.type_identifier.end_with? 'resource_tpl' }.any? }
+          get_mixins "http://schemas.ogf.org/occi/infrastructure#resource_tpl"
         end
         alias_method :get_resource_tpls, :get_resource_templates
 
@@ -493,7 +526,7 @@ module Occi
             #we got an resource link
             path = sanitize_resource_link(resource_type_identifier)
           else
-            raise "Unknown resource identifier! #{resource_type_identifier}"
+            raise "Unknown resource identifier! #{resource_type_identifier.inspect}"
           end
         end
 
@@ -512,7 +545,7 @@ module Occi
           # everything starting with '/' is considered to be a resource path
           return resource_link if resource_link.start_with? '/'
 
-          raise "Resource link #{resource_link} is not valid!" unless resource_link.start_with? @endpoint
+          raise "Resource link #{resource_link.inspect} is not valid!" unless resource_link.start_with? @endpoint
 
           resource_link.gsub @endpoint, '/'
         end
@@ -593,13 +626,6 @@ module Occi
         def set_model(model)
           # build model
           @model = Occi::Model.new(model)
-
-          @mixins = {
-            :os_tpl => get_os_tpl_mixins_ary,
-            :resource_tpl => get_resource_tpl_mixins_ary
-          }
-
-          @model
         end
 
         # Returns mixin type identifiers for os_tpl mixins
@@ -607,7 +633,8 @@ module Occi
         #
         # @return [Array] array of os_tpl mixin identifiers
         def get_os_tpl_mixins_ary
-          get_mixins_ary(:os_tpl)
+          mixins = get_os_tpls
+          mixins.to_a.collect { |m| m.type_identifier }
         end
 
         # Returns mixin type identifiers for resource_tpl mixins
@@ -615,25 +642,8 @@ module Occi
         #
         # @return [Array] array of resource_tpl mixin identifiers
         def get_resource_tpl_mixins_ary
-          get_mixins_ary(:resource_tpl)
-        end
-
-        # Returns mixin type identifiers for given mixin type
-        # in an array.
-        #
-        # @param [Symbol] mixin type
-        # @return [Array] array of mixin identifiers
-        def get_mixins_ary(mixin_type)
-          mixins = []
-
-          send("get_#{mixin_type.to_s}s".to_sym).each do |mixin|
-            next if mixin.nil? || mixin.type_identifier.nil?
-
-            tid = mixin.type_identifier.strip
-            mixins << tid unless tid.empty?
-          end
-
-          mixins
+          mixins = get_resource_tpls
+          mixins.to_a.collect { |m| m.type_identifier }
         end
 
       end