occi-api 4.0.0.alpha.1

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.swp
+.project
+.idea
+.yardoc
+.bundle
+.rvmrc
+lib/occiantlr/output/
+pkg
+tmp
+log
+coverage
+vendor
+collection
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper --color --format documentation

data/.travis.yml

@@ -0,0 +1,43 @@
+language: ruby
+
+before_install:
+  - sudo apt-get install -qq libonig-dev
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - 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: 2.0.0
+      jdk: openjdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: ruby-head
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: oraclejdk7
+
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1 @@
+--title "Documentation of the OCCI gem" --markup markdown --private

data/AUTHORS

@@ -0,0 +1,9 @@
+rOcci was designed and is mainly developed by Florian Feldhaus (GWDG) and Piotr Kasprzak (GWDG) in Germany.
+
+Special thanks to the following extraordinary individuals, whithout whom rOcci would not be possible:
+
+* Hayati Bice - who wrote the initial version of an Occi server rOcci is based on
+* Max Günther - who wrote the EC2 backend
+* Andre Thevapalan - for his input regarding the JSON rendering
+* Boris Parak - especially for his input regarding the Client / Client DSL and CLI
+* the OCCI Working Group - for developing OCCI

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org/"
+
+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'
+end
+
+platforms :jruby do
+  gem 'jruby-openssl' if ((defined? JRUBY_VERSION) && (JRUBY_VERSION.split('.')[1].to_i < 7))
+end
+
+platforms :ruby_18 do
+    gem 'oniguruma'
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012 GWDG
+
+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.

data/README.md

@@ -0,0 +1,344 @@
+rOCCI-api - A Ruby OCCI Framework
+=================================
+
+[![Build Status](https://secure.travis-ci.org/gwdg/rOCCI-api.png)](http://travis-ci.org/gwdg/rOCCI-api)
+[![Dependency Status](https://gemnasium.com/gwdg/rOCCI-api.png)](https://gemnasium.com/gwdg/rOCCI-api)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/occi-api.png)](https://badge.fury.io/rb/occi-api)
+[![Code Climate](https://codeclimate.com/github/gwdg/rOCCI-api.png)](https://codeclimate.com/github/gwdg/rOCCI-api)
+
+Requirements
+------------
+
+Ruby
+* at least version 1.8.7 is required
+
+The following setup is recommended
+
+* usage of the Ruby Version Manager
+* Ruby 1.9.3
+* RubyGems installed
+
+The following libraries / packages may be required to use rOCCI
+
+* libxslt-dev
+* libxml2-dev
+* **only if using Ruby 1.8.7:** libonig-dev (Linux) or oniguruma (Mac)
+
+Installation
+------------
+
+To install the most recent stable version
+
+    gem install occi-api
+
+To install the most recent beta version
+
+    gem install occi-api --pre
+
+### Installation from source
+
+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
+
+#### Ruby
+
+To build and install the bleeding edge version from master
+
+    git clone git://github.com/gwdg/rOCCI-api.git
+    cd rOCCI-api
+    rvm install ruby-1.9.3
+    rvm --create --ruby-version use 1.9.3@rOCCI-api
+    bundle install --deployment
+    rake install
+
+Usage
+-----
+### Auth
+
+For Basic auth use
+
+    auth = Hashie::Mash.new
+    auth.type = 'basic'
+    auth.username = 'user'
+    auth.password = 'mypass'
+ 
+For Digest auth use
+
+    auth = Hashie::Mash.new
+    auth.type = 'digest'
+    auth.username = 'user'
+    auth.password = 'mypass'
+
+For X.509 auth use
+ 
+    auth = Hashie::Mash.new
+    auth.type = 'x509'
+    auth.user_cert = '/Path/To/My/usercert.pem'
+    auth.user_cert_password = 'MyPassword'
+    auth.ca_path = '/Path/To/root-certificates'
+
+### DSL
+In your scripts, you can use the OCCI client DSL.
+
+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/ )
+
+    # 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
+
+    resource_types
+    mixin_types
+    entity_types
+    link_types
+
+To get compute, storage or network descriptions use
+
+    describe "compute"
+    describe "storage"
+    describe "network"
+
+To get the location of compute, storage or network resources use
+
+    list "compute"
+    list "storage"
+    list "network"
+
+To get the identifiers of specific mixins in specific mixin types use
+
+    mixin "my_template", "os_tpl"
+    mixin "small", "resource_tpl"
+
+To get the identifiers of specific mixins with unknown types use
+
+    mixin "medium"
+
+To get mixin descriptions use
+
+    mixin "medium", nil, true
+    mixin "my_template", "os_tpl", true
+
+To get a list of names of all / OS templates / Resource templates mixins use
+
+    mixins
+    mixins "os_tpl"
+    mixins "resource_tpl"
+
+To create a new compute resource use
+
+    os = mixin 'my_os', 'os_tpl'
+    size = mixin 'large', 'resource_tpl'
+    cmpt = resource "compute"
+    cmpt.mixins << os << size
+    cmpt.title = "My VM"
+    create cmpt
+
+To get a description of a specific resource use
+
+    describe "/compute/<OCCI_ID>"
+    describe "/storage/<OCCI_ID>"
+    describe "/network/<OCCI_ID>"
+
+To delete a specific resource use
+
+    delete "/compute/<OCCI_ID>"
+    delete "/storage/<OCCI_ID>"
+    delete "/network/<OCCI_ID>"
+
+### API
+If you need low level access to parts of the OCCI client or need to use more than one instance
+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/ )
+
+    # 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
+
+    client.model
+
+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
+
+    client.describe "compute"
+    client.describe "storage"
+    client.describe "network"
+
+To get the location of compute, storage or network resources use
+
+    client.list "compute"
+    client.list "storage"
+    client.list "network"
+
+To get the identifiers of specific mixins in specific mixin types use
+
+    client.find_mixin "my_template", "os_tpl"
+    client.find_mixin "small", "resource_tpl"
+
+To get the identifiers of specific mixins with unknown types use
+
+    client.find_mixin "medium"
+
+To get mixin descriptions use
+
+    client.find_mixin "medium", nil, true
+    client.find_mixin "my_template", "os_tpl", true
+
+To get a list of names of all / OS templates / Resource templates mixins use
+
+    client.get_mixins
+    client.get_mixins "os_tpl"
+    client.get_mixins "resource_tpl"
+
+To create a new compute resource use
+
+    os = client.find_mixin 'my_os', 'os_tpl'
+    size = client.find_mixin 'large', 'resource_tpl'
+    cmpt = client.get_resource "compute"
+    cmpt.mixins << os << size
+    cmpt.title = "My VM"
+    client.create cmpt
+
+To get a description of a specific resource use
+
+    client.describe "/compute/<OCCI_ID>"
+    client.describe "/storage/<OCCI_ID>"
+    client.describe "/network/<OCCI_ID>"
+
+To delete a specific resource use
+
+    client.delete "/compute/<OCCI_ID>"
+    client.delete "/storage/<OCCI_ID>"
+    client.delete "/network/<OCCI_ID>"
+
+### 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
+STDOUT) and the log level.
+
+    Occi::Log.new(STDOUT,Occi::Log::INFO)
+
+You can create multiple Loggers to receive the log output.
+
+You can always, even if there is no logger defined, log output using the class methods of OCCI::Log e.g.
+
+    Occi::Log.info("Test message")
+
+Changelog
+---------
+
+### Version 3.1
+* added basic OS Keystone support
+* added support for PKCS12 credentials for X.509 authN
+* updated templates for plain output formatting
+* minor client API changes
+* several bugfixes
+
+### 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
+* several bugfixes
+
+### Version 2.4
+
+* Changed OCCI attribute properties from lowercase to first letter uppercase (e.g. type -> Type, default -> Default, ...)
+
+### Version 2.3
+
+* OCCI objects are now initialized with a list of attributes instead of a hash. Thus it is easier to check which
+attributes are expected by a class and helps prevent errors.
+* Parsing of a subset of the OVF specification is supported. Further parts of the specification will be covered in
+future versions of rOCCI.
+
+### Version 2.2
+
+* OCCI Client added. The client simplifies the execution of OCCI commands and provides shortcuts for often used steps.
+
+### Version 2.1
+
+* Several improvements to the gem structure and code documentation. First rSpec test were added. Readme has been extended to include instructions how the gem can be used.
+
+### Version 2.0
+
+* Starting with version 2.0 Florian Feldhaus and Piotr Kasprzak took over the development of the OCCI gem. The codebase was taken from the rOCCI framework and improved to be bundled as a standalone gem.
+
+### Version 1.X
+
+* Version 1.X of the OCCI gem has been developed by retr0h and served as a simple way to access the first OpenNebula OCCI implementation.
+
+Development
+-----------
+
+Checkout latest version from GIT:
+
+    git clone git://github.com/gwdg/rOCCI-api.git
+
+Change to rOCCI-api folder
+
+    cd rOCCI-api
+
+Install dependencies for deployment
+
+    bundle install
+
+### Code Documentation
+
+[Code Documentation for rOCCI-api by YARD](http://rubydoc.info/github/gwdg/rOCCI-api/)
+
+### Continuous integration
+
+[Continuous integration for rOCCI-api by Travis-CI](http://travis-ci.org/gwdg/rOCCI-api/)
+
+### Contribute
+
+1. Fork it.
+2. Create a branch (git checkout -b my_markup)
+3. Commit your changes (git commit -am "My changes")
+4. Push to the branch (git push origin my_markup)
+5. Create an Issue with a link to your branch

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems/tasks'
+
+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 => false})
+
+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"
+  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
+
+require 'yard'
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.files   = ['features/**/*.feature', 'features/**/*.rb']
+  t.options = ['--any', '--extra', '--opts'] # optional
+end

data/examples/dsl_example.rb

@@ -0,0 +1,167 @@
+require 'rubygems'
+require 'pp'
+
+# load and include rOCCI client DSL
+require 'occi-api'
+extend Occi::Api::Dsl
+
+                              ## options
+use_os_temlate = true         # use OS_TEMPLATE or NETWORK + STORAGE + INSTANCE TYPE
+OS_TEMPLATE    = 'monitoring' # name of the VM template in ON
+
+clean_up_compute = true       # issue DELETE <RESOURCE> after we are done
+
+USER_CERT          = ENV['HOME'] + '/.globus/usercred.pem'
+USER_CERT_PASSWORD = 'mypassphrase'
+CA_PATH            = '/etc/grid-security/certificates'
+ENDPOINT           = 'https://localhost:3300'
+
+## establish a connection
+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|
+  puts "\n#{type}"
+end
+
+puts "\n\nListing all available resource type identifiers:"
+resource_type_identifiers.each do |type_id|
+  puts "\n#{type_id}"
+end
+
+puts "\n\nListing all available mixin types:"
+mixin_types.each do |mixin_type|
+  puts "\n#{mixin_type}"
+end
+
+puts "\n\nListing all available mixin type identifiers:"
+mixin_type_identifiers.each do |mixin_typeid|
+  puts "\n#{mixin_typeid}"
+end
+
+puts "\n\nListing all available mixins:"
+mixins.each do |mixin|
+  puts "\n#{mixin}"
+end
+
+samples = [OS_TEMPLATE, "medium", "large", "small"]
+
+puts "\n\nFind mixins using their names:"
+samples.each do |mxn|
+  puts "\n#{mxn}:\n"
+  pp mixin mxn
+end
+
+puts "\n\nFind mixins using their names and a type:"
+samples.each do |mxn|
+  puts "\n#{mxn}:\n"
+  pp mixin(mxn, "os_tpl")
+end
+
+puts "\n\nFind mixins using their names and a type:"
+samples.each do |mxn|
+  puts "\n#{mxn}:\n"
+  pp mixin(mxn, "resource_tpl")
+end
+
+puts "\n\nFind mixins using their names (showing detailed descriptions):"
+samples.each do |mxn|
+  puts "\n#{mxn}:\n"
+  pp mixin(mxn, nil, true)
+end
+
+## get links of all available resources
+puts "\n\nListing storage resources"
+pp list "storage"
+
+puts "\n\nListing network resources"
+pp list "network"
+
+puts "\n\nListing compute resources"
+pp list "compute"
+
+## get detailed information about all available resources
+puts "\n\nDescribing storage resources"
+pp describe "storage"
+
+puts "\n\nDescribing compute resources"
+pp describe "compute"
+
+puts "\n\nDescribing network resources"
+pp describe "network"
+
+## create a compute resource using the chosen method (os_tpl|strg+ntwrk)
+puts "\n\nCreate compute resources"
+cmpt = resource "compute"
+
+unless use_os_temlate
+  ## without OS template, we have to manually select and attach
+  ## network, storage and resource template (instance type)
+
+  ## select instance type medium
+  cmpt.mixins << mixin('medium', "resource_tpl")
+
+  ## list network/storage locations and select the appropriate ones (the first ones in this case)
+  puts "\nUsing:"
+  pp storage_loc = list("storage")[0]
+  pp network_loc = list("network")[0]
+
+  ## create links and attach them to the compure resource
+  puts "\n Connecting to our compute:"
+  cmpt.storagelink storage_loc
+  cmpt.networkinterface network_loc
+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 = mixin(OS_TEMPLATE, "os_tpl")
+  pp size = mixin('medium', "resource_tpl")
+
+  ## attach chosen resources to the compute resource
+  cmpt.mixins << os << size
+  ## we can change some of the values manually
+  cmpt.title = "My rOCCI x509 VM"
+end
+
+## create the compute resource and print its location
+cmpt_loc = create cmpt
+pp "Location of new compute resource: #{cmpt_loc}"
+
+## get links of all available compute resouces again
+puts "\n\nListing locations of compute resources (should now contain #{cmpt_loc})"
+pp list "compute"
+
+## get detailed information about the new compute resource
+puts "\n\nListing information about compute resource #{cmpt_loc}"
+cmpt_data = describe cmpt_loc
+pp cmpt_data
+
+## wait until the resource is "active"
+while cmpt_data[0].resources.first.attributes.occi.compute.state == "inactive"
+  puts "\nCompute resource #{cmpt_loc} is inactive, waiting ..."
+  sleep 1
+  cmpt_data = describe cmpt_loc
+end
+
+puts "\nCompute resource #{cmpt_loc} is #{cmpt_data[0].resources.first.attributes.occi.compute.state}"
+
+## delete the resource and exit
+if clean_up_compute
+  puts "\n\nDeleting compute resource #{cmpt_loc}"
+  pp delete cmpt_loc
+end