occi 3.0.0.beta.1 → 3.0.0

data/Gemfile

@@ -1,32 +1,9 @@
 source :rubygems
 
-# external ruby libraries
-gem "json"
-gem "antlr3"
-gem "hashie"
-gem "uuidtools", ">=2.1.3"
-gem "nokogiri"
-gem "builder"
-gem "activesupport"
-gem "rake"
-gem "httparty"
-gem "highline"
-gem "i18n"
-gem "amqp"
+gemspec
 
-# development related gems
-group :development do
-  gem "rspec"
-  gem "simplecov"
-  gem "yard"
-  gem "yard-sinatra"
-  gem "yard-rspec"
-  gem "yard-cucumber"
-  gem "rspec-http"
-  gem "vcr"
-  gem "webmock", "=1.8.11"
-end
+gem 'vcr', :git => 'git://github.com/arax/vcr.git', :branch => 'test_framework_patches'
 
 platforms :jruby do
-  gem 'jruby-openssl'
+  gem 'jruby-openssl' if ((defined? JRUBY_VERSION) && (JRUBY_VERSION.split('.')[1].to_i < 7))
 end

data/Gemfile.lock

@@ -1,22 +1,43 @@
+GIT
+  remote: git://github.com/arax/vcr.git
+  revision: e82e843ceddd8822acea59846b015bcabf1906df
+  branch: test_framework_patches
+  specs:
+    vcr (2.4.0)
+
+PATH
+  remote: .
+  specs:
+    occi (3.0.0.beta.1)
+      activesupport
+      amqp
+      antlr3
+      hashie
+      highline
+      httparty
+      i18n
+      json
+      nokogiri
+      uuidtools (>= 2.1.3)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.2.9)
+    activesupport (3.2.11)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     addressable (2.3.2)
-    amq-client (0.9.5)
+    amq-client (0.9.10)
       amq-protocol (>= 0.9.4)
       eventmachine
-    amq-protocol (0.9.5)
+    amq-protocol (1.0.1)
     amqp (0.9.8)
       amq-client (~> 0.9.5)
       amq-protocol (>= 0.9.4)
       eventmachine
     antlr3 (1.8.12)
-    bouncy-castle-java (1.5.0146.1)
     builder (3.1.4)
-    crack (0.3.1)
+    crack (0.3.2)
     cucumber (1.2.1)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
@@ -35,32 +56,29 @@ GEM
       multi_json (~> 1.0)
       multi_xml
     i18n (0.6.1)
-    jruby-openssl (0.7.7)
-      bouncy-castle-java (>= 1.5.0146.1)
-    json (1.7.5)
-    json (1.7.5-java)
-    multi_json (1.3.7)
+    json (1.7.6)
+    json (1.7.6-java)
+    multi_json (1.5.0)
     multi_xml (0.5.1)
-    nokogiri (1.5.5)
-    nokogiri (1.5.5-java)
-    rake (0.9.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
+    nokogiri (1.5.6)
+    nokogiri (1.5.6-java)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
     rspec-http (0.10.0)
       rspec (~> 2.0)
-    rspec-mocks (2.11.3)
+    rspec-mocks (2.12.1)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     uuidtools (2.1.3)
-    vcr (2.3.0)
-    webmock (1.8.11)
+    webmock (1.9.0)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
     yard (0.8.3)
@@ -78,24 +96,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
-  amqp
-  antlr3
   builder
-  hashie
-  highline
-  httparty
-  i18n
-  jruby-openssl
-  json
-  nokogiri
+  occi!
   rake
   rspec
   rspec-http
   simplecov
-  uuidtools (>= 2.1.3)
-  vcr
-  webmock (= 1.8.11)
+  vcr!
+  webmock
   yard
   yard-cucumber
   yard-rspec

data/README.md

@@ -1,7 +1,9 @@
 rOCCI - A Ruby OCCI Framework
 =================================
 
-[![Build Status](https://secure.travis-ci.org/gwdg/rOCCI.png)](http://travis-ci.org/gwdg/rOCCI) [![Dependency Status](https://gemnasium.com/gwdg/rOCCI.png)](https://gemnasium.com/gwdg/rOCCI)
+[![Build Status](https://secure.travis-ci.org/gwdg/rOCCI.png)](http://travis-ci.org/gwdg/rOCCI)
+[![Dependency Status](https://gemnasium.com/gwdg/rOCCI.png)](https://gemnasium.com/gwdg/rOCCI)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/occi.png)](https://badge.fury.io/rb/occi)
 
 Requirements
 ------------
@@ -14,9 +16,20 @@ The following setup is recommended
 
 Installation
 ------------
+To install the most recent stable version
 
     gem install occi
 
+To install the most recent beta version
+
+    gem install occi --pre
+
+To build and install the bleeding edge version from master
+
+    git clone git://github.com/gwdg/rOCCI.git
+    cd rOCCI
+    rake install
+
 Usage
 -----
 ### Client
@@ -30,6 +43,7 @@ To run the client in an interactive mode use
 
     occi --interactive
     occi --interactive --endpoint https://<ENDPOINT>:<PORT>/
+    occi --interactive --endpoint https://<ENDPOINT>:<PORT>/ --auth x509
 
 To list available resources use
 
@@ -93,6 +107,12 @@ For X.509 auth use
     auth.user_cert_password = 'MyPassword'
     auth.ca_path = '/Path/To/root-certificates'
 
+For keystone auth use
+
+    auth = Hashie::Mash.new
+    auth.type = 'keystone'
+    auth.token = '887665443383838'
+
 #### DSL
 In your scripts, you can use the OCCI client DSL.
 
@@ -104,10 +124,12 @@ To connect to an OCCI endpoint/server (e.g. running on http://localhost:3300/ )
 
     connect(:http, 'http://localhost:3300',auth||=nil)
 
-To get the list of available resource types or mixin types use
+To get the list of available resource, mixin, entity or link types use
 
     resource_types
     mixin_types
+    entity_types
+    link_types
 
 To get compute, storage or network descriptions use
 
@@ -174,10 +196,12 @@ All available categories are automatically registered to the OCCI model during c
 
     client.model
 
-To get the list of available resource types or mixin types use
+To get the list of available resource, mixin, entity or link types use
 
     client.get_resource_types
     client.get_mixin_types
+    client.get_entity_types
+    client.get_link_types
 
 To get compute, storage or network descriptions use
 
@@ -303,7 +327,19 @@ The OCCI gem includes all OCCI Core classes necessary to handly arbitrary OCCI o
 Changelog
 ---------
 
-### version 2.5
+### Version 3.0
+
+* many bugfixes
+* rewrote Core classes to use metaprogramming techniques
+* added VCR cassettes for reliable testing against prerecorded server responses
+* several updates to the OCCI Client
+* started work on an OCCI Client using AMQP as transport protocol
+* added support for keystone authentication to be used with the OpenStack OCCI server
+* updated dependencies
+* updated rspec tests
+* started work on cucumber features
+
+### Version 2.5
 
 * improved OCCI Client
 * improved documentation

data/bin/occi

@@ -41,37 +41,38 @@ output = Occi::Bin::ResourceOutputFactory.new options.output_format
 Occi::Log.info "Starting OCCI client ..."
 Occi::Log.debug "Options: #{options}"
 
+# TODO: this part isn't necessary, just annoying
 # to make the interactive mode completely self-sufficient
 # ask for endpoint and auth method (provide defaults)
-if options.interactive
-  Occi::Log.debug "Checking for endpoint and auth changes ..."
-
-  options.endpoint = ask("What endpoint should I use? ") {
-    |q| q.default = options.endpoint
-  }
-
-  # separate menus
-  say "\n"
-
-  choose do |menu|
-    menu.prompt = "Which auth method should I use? "
-
-    Occi::Bin::OcciOpts::AUTH_METHODS.each do |auth_m|
-      menu.choice(auth_m) { options.auth[:type] = auth_m.to_s }
-    end
-  end
-end
+#if options.interactive
+#  Occi::Log.debug "Checking for endpoint and auth changes ..."
+#
+# options.endpoint = ask("What endpoint should I use? ") {
+#     |q| q.default = options.endpoint
+# }
+#
+# # separate menus
+# say "\n"
+#
+# choose do |menu|
+#   menu.prompt = "Which auth method should I use? "
+#
+#   Occi::Bin::OcciOpts::AUTH_METHODS.each do |auth_m|
+#     menu.choice(auth_m) { options.auth[:type] = auth_m.to_s }
+#   end
+# end
+#end
 
 # running with an empty password, we should ask the user for one
 # if auth method is not "none"
-if options.auth[:password].nil? or options.auth[:user_cert_password].nil? or options.auth[:token].nil?
+if options.auth[:password].nil? || options.auth[:user_cert_password].nil? || options.auth[:token].nil?
   Occi::Log.debug "Password or token is not set, asking for it now ..."
 
   say("\n")
 
   options.auth[:user_cert_password] = ask("Enter a password or an auth. token: ") {
-    |q| q.echo = false
-  } unless options.auth[:type] == "none"
+      |q| q.echo = false
+  } unless options.auth[:type] == "none" || (options.auth[:proxy_ca] && options.auth[:type] == "x509")
 
   options.auth[:token] = options.auth[:password] = options.auth[:user_cert_password]
 end
@@ -102,7 +103,7 @@ rescue OpenSSL::PKey::RSAError => key_ex
 rescue Errno::ECONNREFUSED
   # the remote server has refused our connection attempt(s)
   # there is nothing we can do ...
-  Occi::Log.error "Connection refused!"
+  Occi::Log.error "Connection refused by #{options.endpoint}!"
   exit!
 rescue Exception => ex
   # something went wrong during the execution
@@ -121,12 +122,14 @@ if options.dump_model
     exit!
   end
 
+  collection = model.get options.filter
+
   # iterate through available instance variables
-  model.instance_variables.each do |inst_var_sym|
+  collection.instance_variables.each do |inst_var_sym|
     puts "#"*79
     puts "Dumping #{inst_var_sym.to_s}:"
 
-    inst_var = model.instance_variable_get(inst_var_sym)
+    inst_var = collection.instance_variable_get(inst_var_sym)
     next unless inst_var.respond_to? :each
 
     # iterate through collection elements
@@ -195,7 +198,7 @@ begin
       }
 
       # describe action requires a resource type or a resource location
-      menu.choice(:describe) { 
+      menu.choice(:describe) {
         options.action = :describe
 
         # separate menus from each other
@@ -260,7 +263,7 @@ begin
         if options.action == :create
           options.resource_title = ask("What name should I give to the new resource? ")
           number_of_mixins = ask("How many mixins do you wish me to mix into this resource? ",
-                                  Integer) { |q| q.in = 0..2 }
+                                 Integer) { |q| q.in = 0..2 }
 
           options.mixin = {}
           (1..number_of_mixins).each do |mixin_number|
@@ -336,59 +339,59 @@ begin
 
   # call the appropriate helper and then format its output
   case options.action
-  when :list
-    found = helper_list options
+    when :list
+      found = helper_list options
 
-    valid = Occi::Bin::ResourceOutputFactory.allowed_resource_types.include? options.resource.to_sym
-    Occi::Log.error "Not printing, the resource type is not supported!" unless valid
+      valid = Occi::Bin::ResourceOutputFactory.allowed_resource_types.include? options.resource.to_sym
+      Occi::Log.error "Not printing, the resource type is not supported!" unless valid
 
-    puts output.format(found, :locations, options.resource.to_sym) if valid
-  when :describe
-    found = helper_describe options
+      puts output.format(found, :locations, options.resource.to_sym) if valid
+    when :describe
+      found = helper_describe options
 
-    if options.resource.start_with? options.endpoint
-      resource_type = options.resource.split("/")[3].to_sym
-    elsif mixin_types.include? options.resource.split('#').first
-      resource_type = options.resource.split('#').first.to_sym
-    else
-      resource_type = options.resource.to_sym
-    end
+      if options.resource.start_with? options.endpoint
+        resource_type = options.resource.split("/")[3].to_sym
+      elsif mixin_types.include? options.resource.split('#').first
+        resource_type = options.resource.split('#').first.to_sym
+      else
+        resource_type = options.resource.to_sym
+      end
+
+      valid = Occi::Bin::ResourceOutputFactory.allowed_resource_types.include? resource_type
+      Occi::Log.error "Not printing, the resource type is not supported!" unless valid
+
+      puts output.format(found, :resources, resource_type) if valid
+    when :create
+      location = helper_create options
+      puts location
+    when :delete
+      result = helper_delete options
 
-    valid = Occi::Bin::ResourceOutputFactory.allowed_resource_types.include? resource_type
-    Occi::Log.error "Not printing, the resource type is not supported!" unless valid
-
-    puts output.format(found, :resources, resource_type) if valid
-  when :create
-    location = helper_create options
-    puts location
-  when :delete
-    result = helper_delete options
-    
-    if result
-      puts "Resource #{options.resource} successfully removed!"
+      if result
+        puts "Resource #{options.resource} successfully removed!"
+      else
+        puts "Failed to remove resource #{options.resource}!"
+      end
+    when :trigger
+      helper_trigger options
+    when :refresh
+      refresh
+    when :skip
+      Occi::Log.info "Skipping this action, probably not implemented yet!"
     else
-      puts "Failed to remove resource #{options.resource}!"
-    end
-  when :trigger
-    helper_trigger options
-  when :refresh
-    refresh
-  when :skip
-    Occi::Log.info "Skipping this action, probably not implemented yet!"
-  else
-    raise "Unknown action [#{options.action}]!"
+      raise "Unknown action [#{options.action}]!"
   end
 
 rescue Errno::ECONNREFUSED
   # remote server refused our connection attempt(s)
   # even though initial connect was successful
-  Occi::Log.error "Connection refused!"
+  Occi::Log.error "Connection refused by #{options.endpoint}!"
   exit!
 rescue Exception => ex
   # something went wrong during the execution
   # hide the stack trace in non-debug modes
   Occi::Log.error "An error occurred! Message: #{ex.message}"
-  
+
   raise ex if options.debug
   exit!
 end while options.interactive