occi 3.0.0 → 3.1.0.beta.1

data/.gitignore

@@ -11,5 +11,4 @@ tmp
 log
 coverage
 vendor
-doc
 collection

data/.travis.yml

@@ -1,11 +1,35 @@
 language: ruby
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - ruby-head
   - jruby-18mode
   - jruby-19mode
+  - jruby-head
+
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  exclude:
+    - rvm: 1.8.7
+      jdk: openjdk7
+    - rvm: 1.8.7
+      jdk: oraclejdk7
+    - rvm: 1.9.3
+      jdk: openjdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: ruby-head
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: oraclejdk7
 
 branches:
   only:
-    - master
+    - master

data/Gemfile

@@ -1,8 +1,11 @@
-source :rubygems
+source "https://rubygems.org/"
 
 gemspec
 
-gem 'vcr', :git => 'git://github.com/arax/vcr.git', :branch => 'test_framework_patches'
+group :development do
+  gem 'vcr', :git => 'git://github.com/arax/vcr.git', :branch => 'test_framework_patches'
+  gem 'warbler', :git => 'git://github.com/jruby/warbler.git'
+end
 
 platforms :jruby do
   gem 'jruby-openssl' if ((defined? JRUBY_VERSION) && (JRUBY_VERSION.split('.')[1].to_i < 7))

data/Gemfile.lock

@@ -5,10 +5,20 @@ GIT
   specs:
     vcr (2.4.0)
 
+GIT
+  remote: git://github.com/jruby/warbler.git
+  revision: ce3ce4df137504822e4cbb9399dee7e7dd767c44
+  specs:
+    warbler (1.3.7.dev)
+      jruby-jars (>= 1.5.6)
+      jruby-rack (>= 1.0.0)
+      rake (>= 0.9.6)
+      rubyzip (>= 0.9.8)
+
 PATH
   remote: .
   specs:
-    occi (3.0.0.beta.1)
+    occi (3.1.0.beta.1)
       activesupport
       amqp
       antlr3
@@ -21,19 +31,19 @@ PATH
       uuidtools (>= 2.1.3)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (3.2.11)
+    activesupport (3.2.12)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    addressable (2.3.2)
-    amq-client (0.9.10)
-      amq-protocol (>= 0.9.4)
+    addressable (2.3.3)
+    amq-client (0.9.12)
+      amq-protocol (>= 1.2.0)
       eventmachine
-    amq-protocol (1.0.1)
-    amqp (0.9.8)
-      amq-client (~> 0.9.5)
-      amq-protocol (>= 0.9.4)
+    amq-protocol (1.2.0)
+    amqp (0.9.9)
+      amq-client (~> 0.9.12)
+      amq-protocol (~> 1.2.0)
       eventmachine
     antlr3 (1.8.12)
     builder (3.1.4)
@@ -46,20 +56,22 @@ GEM
     diff-lcs (1.1.3)
     eventmachine (1.0.0)
     eventmachine (1.0.0-java)
-    gherkin (2.11.5)
-      json (>= 1.4.6)
-    gherkin (2.11.5-java)
-      json (>= 1.4.6)
-    hashie (1.2.0)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
+    gherkin (2.11.6-java)
+      json (>= 1.7.6)
+    hashie (2.0.2)
     highline (1.6.15)
-    httparty (0.9.0)
+    httparty (0.10.2)
       multi_json (~> 1.0)
-      multi_xml
+      multi_xml (>= 0.5.2)
     i18n (0.6.1)
-    json (1.7.6)
-    json (1.7.6-java)
-    multi_json (1.5.0)
-    multi_xml (0.5.1)
+    jruby-jars (1.7.3)
+    jruby-rack (1.1.13.1)
+    json (1.7.7)
+    json (1.7.7-java)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
     nokogiri (1.5.6)
     nokogiri (1.5.6-java)
     rake (10.0.3)
@@ -72,17 +84,19 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-http (0.10.0)
       rspec (~> 2.0)
-    rspec-mocks (2.12.1)
+    rspec-mocks (2.12.2)
+    rubygems-tasks (0.2.3)
+    rubyzip (0.9.9)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     uuidtools (2.1.3)
-    webmock (1.9.0)
+    webmock (1.9.3)
       addressable (>= 2.2.7)
-      crack (>= 0.1.7)
-    yard (0.8.3)
-    yard-cucumber (2.2.2)
+      crack (>= 0.3.2)
+    yard (0.8.4.1)
+    yard-cucumber (2.2.3)
       cucumber (>= 0.7.5)
       gherkin (>= 2.2.9)
       yard (>= 0.8.1)
@@ -101,8 +115,10 @@ DEPENDENCIES
   rake
   rspec
   rspec-http
+  rubygems-tasks
   simplecov
   vcr!
+  warbler!
   webmock
   yard
   yard-cucumber

data/README.md

@@ -14,8 +14,19 @@ The following setup is recommended
 * Ruby 1.9.3
 * RubyGems installed
 
+The following libraries / packages may be required to use rOCCI
+
+* libxslt-dev
+* libxml2-dev
+
+To use rOCCI with Java, you need JRE 6 or 7. To build rOCCI for Java, you need JDK 6 or 7.
+
 Installation
 ------------
+
+**[Mac OS X has some special requirements for the installation. Detailed information can be found in
+doc/macosx.md.](doc/macosx.md)**
+
 To install the most recent stable version
 
     gem install occi
@@ -24,12 +35,39 @@ To install the most recent beta version
 
     gem install occi --pre
 
+### Installation from source
+
+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
+
+#### Ruby
+
 To build and install the bleeding edge version from master
 
     git clone git://github.com/gwdg/rOCCI.git
     cd rOCCI
+    rvm install ruby-1.9.3
+    rvm --create --ruby-version use 1.9.3@rOCCI
+    bundle install --deployment
     rake install
 
+#### Java
+
+To build a Java jar file from master use
+
+    git clone git://github.com/gwdg/rOCCI.git
+    cd rOCCI
+    rvm install jruby-1.7.1
+    rvm --create --ruby-version use jruby-1.7.1@rOCCI
+    gem install bundler
+    bundle install
+    warble
+
+For Linux / Mac OS X you can create a OCCI Java executable from the jar file using
+
+    sudo echo '#!/usr/bin/java -jar' | cat - occi.jar > occi ; sudo chmod +x occi
+
 Usage
 -----
 ### Client
@@ -116,13 +154,26 @@ For keystone auth use
 #### DSL
 In your scripts, you can use the OCCI client DSL.
 
-To include the DSL definitions in your script use
+To include the DSL definitions in a script use
 
     extend Occi::Api::Dsl
 
+To include the DSL definitions in a class use
+
+    include Occi::Api:Dsl
+
 To connect to an OCCI endpoint/server (e.g. running on http://localhost:3300/ )
 
-    connect(:http, 'http://localhost:3300',auth||=nil)
+    # defaults
+    options = {
+      :endpoint => "http://localhost:3300/",
+      :auth => {:type => "none"},
+      :log => {:out => STDERR, :level => Occi::Log::WARN, :logger => nil},
+      :auto_connect => "value", auto_connect => true,
+      :media_type => nil
+    }
+
+    connect(:http, options ||= {})
 
 To get the list of available resource, mixin, entity or link types use
 
@@ -190,7 +241,16 @@ at a time, you should use the OCCI client API directly.
 
 To connect to an OCCI endpoint/server (e.g. running on http://localhost:3300/ )
 
-    client = Occi::Api::Client::ClientHttp.new('http://localhost:3300',auth||=nil)
+    # defaults
+    options = {
+      :endpoint => "http://localhost:3300/",
+      :auth => {:type => "none"},
+      :log => {:out => STDERR, :level => Occi::Log::WARN, :logger => nil},
+      :auto_connect => "value", auto_connect => true,
+      :media_type => nil
+    }
+
+    client = Occi::Api::Client::ClientHttp.new(options ||= {})
 
 All available categories are automatically registered to the OCCI model during client initialization. You can get them via
 
@@ -385,7 +445,7 @@ Change to rOCCI folder
 
 Install dependencies for deployment
 
-    bundle install --deployment
+    bundle install
 
 ### Code Documentation
 

data/Rakefile

@@ -1,7 +1,11 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'rubygems/tasks'
 
-task :default => 'rcov:all'
+task :default => 'test'
+
+desc "Run all tests; includes rspec, cucumber and coverage reports"
+task :test => 'rcov:all'
+
+Gem::Tasks.new(:build => {:tar => true, :zip => true}, :sign => {:checksum => true, :pgp => true})
 
 namespace :rcov do
 

data/bin/occi

@@ -41,28 +41,6 @@ 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
-
 # running with an empty password, we should ask the user for one
 # if auth method is not "none"
 if options.auth[:password].nil? || options.auth[:user_cert_password].nil? || options.auth[:token].nil?
@@ -82,7 +60,9 @@ end
 # no effect on the non-interactive one
 begin
   Occi::Log.info "Establishing a connection to #{options.endpoint} ..."
-  connect :http, options.endpoint, options.auth, options.log, true, options.media_type
+
+  options.auto_connect = true
+  connect :http, options
 rescue OpenSSL::SSL::SSLError => ssl_ex
   # generic SSL error raised whilst establishing a connection
   # possibly an untrusted server cert or invalid user credentials 
@@ -118,7 +98,7 @@ end
 if options.dump_model
 
   if !model.respond_to? :instance_variables
-    puts "Your Ruby doesn't support 'instance_variables' calls!"
+    Occi::Log.error "Your Ruby doesn't support 'instance_variables' calls!"
     exit!
   end
 
@@ -261,17 +241,19 @@ begin
         # if the user didn't choose "Back", ask for details
         # TODO: currently only COMPUTE is supported
         if options.action == :create
-          options.resource_title = ask("What name should I give to the new resource? ")
+          options.attributes = {} if options.attributes.nil?
+
+          options.attributes[: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 }
 
-          options.mixin = {}
+          options.mixins = {}
           (1..number_of_mixins).each do |mixin_number|
             mixin = ask("What mixin should I mix in? ") { |q| q.validate = /\A\w+#\w+\Z/ }
             parts = mixin.split("#")
 
-            options.mixin[parts[0]] = [] if options.mixin[parts[0]].nil?
-            options.mixin[parts[0]] << parts[1]
+            options.mixins[parts[0]] = [] if options.mixins[parts[0]].nil?
+            options.mixins[parts[0]] << parts[1]
           end
         end
       }
@@ -340,40 +322,15 @@ begin
   # call the appropriate helper and then format its output
   case options.action
     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
-
-      puts output.format(found, :locations, options.resource.to_sym) if valid
+      helper_list options, output
     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
-
-      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
+      helper_describe options, output
     when :create
-      location = helper_create options
-      puts location
+      helper_create options, output
     when :delete
-      result = helper_delete options
-
-      if result
-        puts "Resource #{options.resource} successfully removed!"
-      else
-        puts "Failed to remove resource #{options.resource}!"
-      end
+      helper_delete options, output
     when :trigger
-      helper_trigger options
+      helper_trigger options, output
     when :refresh
       refresh
     when :skip

data/config/warble.rb

@@ -0,0 +1,151 @@
+# Disable Rake-environment-task framework detection by uncommenting/setting to false
+# Warbler.framework_detection = false
+
+# Warbler web application assembly configuration file
+Warbler::Config.new do |config|
+  # Features: additional options controlling how the jar is built.
+  # Currently the following features are supported:
+  # - gemjar: package the gem repository in a jar file in WEB-INF/lib
+  # - executable: embed a web server and make the war executable
+  # - compiled: compile .rb files to .class files
+  config.features = %w(compiled)
+
+  # Application directories to be included in the webapp.
+  config.dirs = %w(config lib)
+
+  # Additional files/directories to include, above those in config.dirs
+  # config.includes = FileList["db"]
+
+  # Additional files/directories to exclude
+  # config.excludes = FileList["lib/tasks/*"]
+
+  # Additional Java .jar files to include.  Note that if .jar files are placed
+  # in lib (and not otherwise excluded) then they need not be mentioned here.
+  # JRuby and JRuby-Rack are pre-loaded in this list.  Be sure to include your
+  # own versions if you directly set the value
+  # config.java_libs += FileList["lib/java/*.jar"]
+
+  # Loose Java classes and miscellaneous files to be included.
+  # config.java_classes = FileList["target/classes/**.*"]
+
+  # One or more pathmaps defining how the java classes should be copied into
+  # the archive. The example pathmap below accompanies the java_classes
+  # configuration above. See http://rake.rubyforge.org/classes/String.html#M000017
+  # for details of how to specify a pathmap.
+  # config.pathmaps.java_classes << "%{target/classes/,}p"
+
+  # Bundler support is built-in. If Warbler finds a Gemfile in the
+  # project directory, it will be used to collect the gems to bundle
+  # in your application. If you wish to explicitly disable this
+  # functionality, uncomment here.
+  # config.bundler = false
+
+  # An array of Bundler groups to avoid including in the war file.
+  # Defaults to ["development", "test", "assets"].
+  # config.bundle_without = []
+
+  # Other gems to be included. If you don't use Bundler or a gemspec
+  # file, you need to tell Warbler which gems your application needs
+  # so that they can be packaged in the archive.
+  # For Rails applications, the Rails gems are included by default
+  # unless the vendor/rails directory is present.
+  # config.gems += ["activerecord-jdbcmysql-adapter", "jruby-openssl"]
+  # config.gems << "tzinfo"
+
+  # Uncomment this if you don't want to package rails gem.
+  # config.gems -= ["rails"]
+
+  # The most recent versions of gems are used.
+  # You can specify versions of gems by using a hash assignment:
+  # config.gems["rails"] = "2.3.10"
+
+  # You can also use regexps or Gem::Dependency objects for flexibility or
+  # finer-grained control.
+  # config.gems << /^merb-/
+  # config.gems << Gem::Dependency.new("merb-core", "= 0.9.3")
+
+  # Include gem dependencies not mentioned specifically. Default is
+  # true, uncomment to turn off.
+  # config.gem_dependencies = false
+
+  # Array of regular expressions matching relative paths in gems to be
+  # excluded from the war. Defaults to empty, but you can set it like
+  # below, which excludes test files.
+  # config.gem_excludes = [/^(test|spec)\//]
+
+  # Pathmaps for controlling how application files are copied into the archive
+  # config.pathmaps.application = ["WEB-INF/%p"]
+
+  # Name of the archive (without the extension). Defaults to the basename
+  # of the project directory.
+  config.jar_name = "occi"
+
+  # Name of the MANIFEST.MF template for the war file. Defaults to a simple
+  # MANIFEST.MF that contains the version of Warbler used to create the war file.
+  # config.manifest_file = "config/MANIFEST.MF"
+
+  # When using the 'compiled' feature and specified, only these Ruby
+  # files will be compiled. Default is to compile all \.rb files in
+  # the application.
+  # config.compiled_ruby_files = FileList['app/**/*.rb']
+
+  # === War files only below here ===
+
+  # Path to the pre-bundled gem directory inside the war file. Default
+  # is 'WEB-INF/gems'. Specify path if gems are already bundled
+  # before running Warbler. This also sets 'gem.path' inside web.xml.
+  # config.gem_path = "WEB-INF/vendor/bundler_gems"
+
+  # Files for WEB-INF directory (next to web.xml). This contains
+  # web.xml by default. If there is an .erb-File it will be processed
+  # with webxml-config. You may want to exclude this file via
+  # config.excludes.
+  # config.webinf_files += FileList["jboss-web.xml"]
+
+  # Files to be included in the root of the webapp.  Note that files in public
+  # will have the leading 'public/' part of the path stripped during staging.
+  # config.public_html = FileList["public/**/*", "doc/**/*"]
+
+  # Pathmaps for controlling how public HTML files are copied into the .war
+  # config.pathmaps.public_html = ["%{public/,}p"]
+
+  # Embedded webserver to use with the 'executable' feature. Currently supported
+  # webservers are:
+  # * <tt>winstone</tt> (default) - Winstone 0.9.10 from sourceforge
+  # * <tt>jenkins-ci.winstone</tt> - Improved Winstone from Jenkins CI
+  # * <tt>jetty</tt> - Embedded Jetty from Eclipse
+  # config.webserver = 'jetty'
+
+  # Value of RAILS_ENV for the webapp -- default as shown below
+  # config.webxml.rails.env = ENV['RAILS_ENV'] || 'production'
+
+  # Application booter to use, one of :rack, :rails, or :merb (autodetected by default)
+  # config.webxml.booter = :rails
+
+  # Set JRuby to run in 1.9 mode.
+  # config.webxml.jruby.compat.version = "1.9"
+
+  # When using the :rack booter, "Rackup" script to use.
+  # - For 'rackup.path', the value points to the location of the rackup
+  # script in the web archive file. You need to make sure this file
+  # gets included in the war, possibly by adding it to config.includes
+  # or config.webinf_files above.
+  # - For 'rackup', the rackup script you provide as an inline string
+  #   is simply embedded in web.xml.
+  # The script is evaluated in a Rack::Builder to load the application.
+  # Examples:
+  # config.webxml.rackup.path = 'WEB-INF/hello.ru'
+  # config.webxml.rackup = %{require './lib/demo'; run Rack::Adapter::Camping.new(Demo)}
+  # config.webxml.rackup = require 'cgi' && CGI::escapeHTML(File.read("config.ru"))
+
+  # Control the pool of Rails runtimes. Leaving unspecified means
+  # the pool will grow as needed to service requests. It is recommended
+  # that you fix these values when running a production server!
+  # If you're using threadsafe! mode, you probably don't want to set these values,
+  # since 1 runtime(default for threadsafe mode) will be enough.
+  # config.webxml.jruby.min.runtimes = 2
+  # config.webxml.jruby.max.runtimes = 4
+
+  # JNDI data source name
+  # config.webxml.jndi = 'jdbc/rails'
+end

data/doc/macosx.md

@@ -0,0 +1,27 @@
+# rOCCI on Mac OS X
+
+## Installation
+
+To use a recent version of Ruby on Mac OS X, a few preparations are needed. Installing Ruby on Apple Mac OS X is not as 
+straightforward as it is on other platforms, hence following detailed instructions.
+
+1. Install the latest version of Xcode either
+[from the Mac OS X App Store](itms://itunes.apple.com/de/app/xcode/id497799835?mt=12#) or by downloading it from
+[[http://developer.apple.com]] and then installing the package.
+2. Open Xcode, then download and install the Xcode command line tools (Menu->Xcode->Preferences->Downloads)
+3. In the Terminal, install RVM with `curl -L https://get.rvm.io | bash -s stable`
+4. Read the plattform requirements for your specific setup by running `rvm requirements` in the Terminal. Execute any
+tasks mentioned there for installing Ruby 1.9.3 (you can ignore hints for Ruby 1.8.7). If you need to install additional
+packages it is recommended to use Homebew for it (unless you already use MacPorts). To install Homebrew paste the
+following in your Terminal `ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"`
+5. Install Ruby 1.9.3 with `rvm install ruby-1.9.3`
+
+Now that you have Ruby 1.9.3 installed, you can intall rOCCI.
+
+To install the most recent stable version
+
+    gem install occi
+
+To install the most recent beta version
+
+    gem install occi --pre

data/examples/dsl_example.rb

@@ -17,13 +17,22 @@ CA_PATH            = '/etc/grid-security/certificates'
 ENDPOINT           = 'https://localhost:3300'
 
 ## establish a connection
-connect(:http, ENDPOINT,
-        { :type               => "x509",
-          :user_cert          => USER_CERT,
-          :user_cert_password => USER_CERT_PASSWORD,
-          :ca_path            => CA_PATH },
-        { :out   => STDERR,
-          :level => Occi::Log::DEBUG })
+connect(
+  :http,
+  {
+    :endpoint => ENDPOINT,
+    :auth     => {
+      :type               => "x509",
+      :user_cert          => USER_CERT,
+      :user_cert_password => USER_CERT_PASSWORD,
+      :ca_path            => CA_PATH
+    },
+    :log => {
+      :out   => STDERR,
+      :level => Occi::Log::DEBUG
+    }
+  }
+)
 
 puts "\n\nListing all available resource types:"
 resource_types.each do |type|

data/examples/x509auth_example.rb

@@ -14,13 +14,19 @@ CA_PATH            = '/etc/grid-security/certificates'
 ENDPOINT           = 'https://localhost:3300'
 
 ## get an OCCI::Api::Client::ClientHttp instance
-client = Occi::Api::Client::ClientHttp.new(ENDPOINT,
-        { :type               => "x509",
-          :user_cert          => USER_CERT,
-          :user_cert_password => USER_CERT_PASSWORD,
-          :ca_path            => CA_PATH },
-        { :out   => STDERR,
-          :level => Occi::Log::DEBUG })
+client = Occi::Api::Client::ClientHttp.new({
+  :endpoint => ENDPOINT,
+  :auth => {
+    :type               => "x509",
+    :user_cert          => USER_CERT,
+    :user_cert_password => USER_CERT_PASSWORD,
+    :ca_path            => CA_PATH
+  },
+  :log => {
+    :out   => STDERR,
+    :level => Occi::Log::DEBUG
+  }
+})
 
 puts "\n\nListing all available resource types:"
 client.get_resource_types.each do |type|