occi 1.2.1 → 2.0.0

data/.gitignore

@@ -0,0 +1,9 @@
+.idea
+.yardoc
+.bundle
+tmp
+log
+coverage
+vendor
+doc
+collection

data/.project

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>OCCI</name>
+	<comment></comment>
+	<projects>
+		<project>one</project>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.python.pydev.PyDevBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.wst.common.project.facet.core.builder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.dltk.ruby.core.nature</nature>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+		<nature>org.rubypeople.rdt.core.rubynature</nature>
+		<nature>org.eclipse.wst.common.project.facet.core.nature</nature>
+		<nature>org.python.pydev.pythonNature</nature>
+	</natures>
+</projectDescription>

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1 @@
+--plugin yard-sinatra --markup markdown

data/AUTHORS

@@ -0,0 +1,8 @@
+rOCCI was designed and is mainly developed by Florian Feldhaus (GWDG) and Piotr Kasprzak (GWDG) in Germany.
+
+Special thanks to the following extraordinary individuals, who-out which 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
+* the OCCI Working Group - for developing OCCI

data/Gemfile

@@ -1,15 +1,36 @@
-source "http://rubygems.org"
-
-gem "hugs", "~> 2.3.0"
-#gem "hugs", :path => "~/git/hugs"
-gem "multipart-post", "~> 1.0.1"
-gem "nokogiri", "~> 1.4.4"
-
-group :development, :test do
-  gem "rake"
-  gem "jeweler", "~> 1.5.1"
-  gem "webmock", "~> 1.6.2"
-  gem "vcr", "~> 1.4.0"
-  gem "minitest", "~> 2.0.0"
-  gem "ZenTest", "~> 4.4.2"
+source :rubygems
+
+# external ruby libraries
+gem "uuidtools"
+gem "json"
+gem "antlr3"
+#gem "hashie", :git => 'git://github.com/ffeldhaus/hashie.git', :branch => "hash_deep_merge_with_array_concatenation"
+gem "hashie"
+gem "nokogiri", "<=1.5.0"
+gem "builder"
+gem "haml"
+gem "erubis"
+
+# sinatra and related
+gem "sinatra"
+gem "sinatra-contrib"
+gem "sinatra-cross_origin"
+
+# active gems
+gem "activesupport"
+
+# passenger
+gem "passenger"
+
+group :ec2 do
+  gem "aws-sdk"
+  gem "xml-simple"
 end
+
+group :development do
+  gem "rspec"
+  gem "simplecov"
+  gem "yard"
+  gem "yard-sinatra"
+  gem "rspec-http"
+end

data/Gemfile.lock

@@ -1,40 +1,97 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.4.2)
-    addressable (2.2.2)
-    crack (0.1.8)
-    git (1.2.5)
-    hugs (2.3.0)
-      multipart-post (~> 1.0.1)
-      net-http-persistent (~> 1.4.1)
-      nokogiri (~> 1.4.4)
-      yajl-ruby (~> 0.7.8)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    minitest (2.0.2)
-    multipart-post (1.0.1)
-    net-http-persistent (1.4.1)
-    nokogiri (1.4.4)
-    rake (0.8.7)
-    vcr (1.4.0)
-    webmock (1.6.2)
-      addressable (>= 2.2.2)
-      crack (>= 0.1.7)
-    yajl-ruby (0.7.9)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    antlr3 (1.8.12)
+    aws-sdk (1.3.8)
+      httparty (~> 0.7)
+      json (~> 1.4)
+      nokogiri (<= 1.5.0)
+      uuidtools (~> 2.1)
+    backports (2.5.0)
+    builder (3.0.0)
+    daemon_controller (1.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    eventmachine (0.12.10)
+    fastthread (1.0.7)
+    haml (3.1.6)
+    hashie (1.2.0)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    i18n (0.6.0)
+    json (1.6.6)
+    multi_json (1.2.0)
+    multi_xml (0.4.2)
+    nokogiri (1.5.0)
+    passenger (3.0.11)
+      daemon_controller (>= 0.2.5)
+      fastthread (>= 1.0.1)
+      rack
+      rake (>= 0.8.1)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-http (0.10.0)
+      rspec (~> 2.0)
+    rspec-mocks (2.9.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sinatra-contrib (1.3.1)
+      backports (>= 2.0)
+      eventmachine
+      rack-protection
+      rack-test
+      sinatra (~> 1.3.0)
+      tilt (~> 1.3)
+    sinatra-cross_origin (0.1.0)
+    tilt (1.3.3)
+    uuidtools (2.1.2)
+    xml-simple (1.1.1)
+    yard (0.7.5)
+    yard-sinatra (1.0.0)
+      yard (~> 0.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  ZenTest (~> 4.4.2)
-  hugs (~> 2.3.0)
-  jeweler (~> 1.5.1)
-  minitest (~> 2.0.0)
-  multipart-post (~> 1.0.1)
-  nokogiri (~> 1.4.4)
-  rake
-  vcr (~> 1.4.0)
-  webmock (~> 1.6.1)
+  activesupport
+  antlr3
+  aws-sdk
+  builder
+  erubis
+  haml
+  hashie
+  json
+  nokogiri (<= 1.5.0)
+  passenger
+  rspec
+  rspec-http
+  simplecov
+  sinatra
+  sinatra-contrib
+  sinatra-cross_origin
+  uuidtools
+  xml-simple
+  yard
+  yard-sinatra

data/LICENSE

@@ -1,4 +1,13 @@
-"THE BEER-WARE LICENSE" (Revision 42):
-<john@dewey.ws> wrote this file. As long as you retain this notice you
-can do whatever you want with this stuff. If we meet some day, and you think
-this stuff is worth it, you can buy me a beer in return John-B Dewey Jr.
+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

@@ -1,36 +1,85 @@
-# OCCI
+rOCCI - A Ruby OCCI Framework
+=============================
 
-[Ruby](http://www.ruby-lang.org/) bindings to [Open Cloud Computing Interface (OCCI)](http://www.opennebula.org/documentation:rel2.0:occidd).
+[![Build Status](https://secure.travis-ci.org/gwdg/rOCCI.png)](http://travis-ci.org/gwdg/rOCCI)
 
-Integrated against [OpenNebula](http://opennebula.org) 2.0.1.
+Requirements
+------------
 
-## Usage
+The following setup is recommended
 
-### Bundler
+* usage of the Ruby Version Manger
+* Ruby 1.9.3
+* Bundler gem installed (use ```gem install bundler```)
 
-    gem "occi"
+Installation
+------------
 
-### Examples
+### Stable version
 
-See the examples section in the [wiki](http://github.com/retr0h/occi/wiki).
+Download the latest version from http://dev.opennebula.org/projects/ogf-occi/files
 
-## Compatability
+Extract file
 
-ruby 1.9.2p0
+    tar xzf rOCCI-*.tar.bz
+    unzip rOCCI-*.zip
 
-OCCI API|OCCI Rubygem|OpenNebula
---------|------------|----------
-5       |1.0.1       |2.0.1
+Install dependencies
 
-## Testing
+    bundle install --deployment
 
-MiniTest will run the tests in a random order.  When rebuilding the fixtures, the entity
-tests depend on the pool tests having already been run.  Since the fixtures change infrequently,
-this should be acceptable.
+### Latest version
 
-Tests can run offline thanks to [VCR](https://github.com/myronmarston/vcr).
+Checkout latest version from GIT:
 
-    $ export ONE_USER=$user
-    $ export ONE_PASSWORD=$password
+    git clone git://github.com/gwdg/rOCCI.git
 
-    $ rake
+Change to rOCCI folder
+
+    cd rOCCI
+
+Install dependencies for deployment
+
+    bundle install --deployment
+
+Configure
+---------
+
+Edit etc/occi-server.conf and adapt to your setting.
+
+The default templates for the OpenNebula template are located at etc/one_templates .
+
+The default templates for EC2 are located at etc/ec2_templates .
+
+Usage
+-----
+
+Run Passenger
+
+    passenger start
+
+Testing
+-------
+
+Use curl to request all categories
+
+    curl -X GET http://localhost:3000/-/
+
+Development
+-----------
+
+### Code Documentation
+
+[Code Documentation for rOCCI by YARD](http://rubydoc.info/github/gwdg/rOCCI/)
+
+### Continuous integration
+
+[Continuous integration for rOCCI by Travis-CI](http://travis-ci.org/gwdg/rOCCI/)
+
+### 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

@@ -1,25 +1,29 @@
-require "rubygems"
-require "rake"
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |gem|
-    gem.name = "occi"
-    gem.summary = %Q{Ruby bindings to Open Cloud Computing Interface (OCCI).}
-    gem.email = "john@dewey.ws"
-    gem.homepage = "http://github.com/retr0h/occi"
-    gem.authors = ["retr0h"]
+task :default => 'rcov:all'
+
+require 'rspec/core/rake_task'
+#require 'cucumber/rake/task'
+
+namespace :rcov do
+
+=begin
+  Cucumber::Rake::Task.new(:cucumber) do |t|
+    t.cucumber_opts = "--format pretty"
+
+    ENV['COVERAGE'] = "true"
   end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+=end
 
-require "rake/testtask"
-Rake::TestTask.new(:test) do |test|
-  test.libs   << "lib" << "test"
-  test.pattern = "test/**/*_test.rb"
-  test.verbose = true
-end
+  RSpec::Core::RakeTask.new(:rspec) do |t|
+    ENV['COVERAGE'] = "true"
+  end
 
-task :default => :test
+  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

data/lib/OpenNebula/Acl.rb

@@ -0,0 +1,256 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+
+
+module OpenNebula
+
+    # Abstract rules of the type USER RESOURCE RIGHTS
+    # which are:
+    #     USER      -> #<num>
+    #                  @<num>
+    #                  ALL
+    #     RESOURCE  -> + separated list and "/{#,@}<num>|ALL"
+    #                  VM,
+    #                  HOST
+    #                  NET
+    #                  IMAGE
+    #                  USER
+    #                  TEMPLATE
+    #                  GROUP
+    #                  ACL
+    #     RIGHTS    -> + separated list
+    #                  USE
+    #                  MANAGE
+    #                  ADMIN
+    #                  CREATE
+    class Acl < PoolElement
+
+        USERS = {
+            "UID"           => 0x100000000,
+            "GID"           => 0x200000000,
+            "ALL"           => 0x400000000
+        }
+
+        RESOURCES =
+        {
+            "VM"            => 0x1000000000,
+            "HOST"          => 0x2000000000,
+            "NET"           => 0x4000000000,
+            "IMAGE"         => 0x8000000000,
+            "USER"          => 0x10000000000,
+            "TEMPLATE"      => 0x20000000000,
+            "GROUP"         => 0x40000000000
+        }
+
+        RIGHTS =
+        {
+            "USE"           => 0x1,  # Auth. to use an object
+            "MANAGE"        => 0x2,  # Auth. to perform management actions
+            "ADMIN"         => 0x4,  # Auth. to perform administrative actions
+            "CREATE"        => 0x8   # Auth. to create an object
+        }
+
+        # Constructor
+        #
+        # @param xml [String] must be an xml built with {#build_xml}
+        # @param client [Client] represents an XML-RPC connection
+        def initialize(xml, client)
+            super(xml,client)
+        end
+
+        # Creates an empty XML representation. It contains the id, if it is
+        # specified.
+        #
+        # @param pe_id [Integer] rule ID
+        # @param client [Client] represents an XML-RPC connection
+        #
+        # @return [String] an empty XML representation
+        def self.build_xml(pe_id=nil)
+            if pe_id
+                acl_xml = "<ACL><ID>#{pe_id}</ID></ACL>"
+            else
+                acl_xml = "<ACL></ACL>"
+            end
+
+            XMLElement.build_xml(acl_xml,'ACL')
+        end
+
+        # Creates a new ACL rule.
+        #
+        # @param user [String]
+        #   A string containing a hex number, e.g. 0x100000001
+        # @param resource [String]
+        #   A string containing a hex number, e.g. 0x2100000001
+        # @param rights [String]
+        #   A string containing a hex number, e.g. 0x10
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def allocate(user, resource, rights)
+            return super( AclPool::ACL_POOL_METHODS[:addrule],
+                          user,
+                          resource,
+                          rights )
+        end
+
+        # Deletes the Acl rule
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def delete()
+            super(AclPool::ACL_POOL_METHODS[:delrule])
+        end
+
+        # Does nothing, individual ACL rules info can't be retrieved from
+        # OpenNebula
+        #
+        # @return [nil] nil
+        def info()
+            return nil
+        end
+
+        # Parses a rule string, e.g. "#5 HOST+VM/@12 INFO+CREATE+DELETE"
+        #
+        # @param rule_str [String] an ACL rule in string format
+        #
+        # @return [Array] an Array containing 3 strings (hex 64b numbers),
+        # or OpenNebula::Error objects
+        def self.parse_rule(rule_str)
+            ret = Array.new
+
+            rule_str = rule_str.split(" ")
+
+            if rule_str.length != 3
+                return OpenNebula::Error.new(
+                    "String needs three components: User, Resource, Rights")
+            end
+
+            ret << parse_users(rule_str[0])
+            ret << parse_resources(rule_str[1])
+            ret << parse_rights(rule_str[2])
+
+            errors=ret.map do |arg|
+                if OpenNebula.is_error?(arg)
+                    arg.message
+                else
+                    nil
+                end
+            end
+
+            errors.compact!
+
+            if errors.length>0
+                return OpenNebula::Error.new(errors.join(', '))
+            end
+
+            return ret
+        end
+
+private
+
+        # Converts a string in the form [#<id>, @<id>, *] to a hex. number
+        #
+        # @param users [String] Users component string
+        #
+        # @return [String] A string containing a hex number
+        def self.parse_users(users)
+           begin
+               return calculate_ids(users).to_i.to_s(16)
+           rescue Exception  => e
+               return OpenNebula::Error.new(e.message)
+           end
+        end
+
+        # Converts a resources string to a hex. number
+        #
+        # @param resources [String] Resources component string
+        #
+        # @return [String] A string containing a hex number
+        def self.parse_resources(resources)
+            begin
+                ret = 0
+                resources = resources.split("/")
+
+                if resources.size != 2
+                    raise "Resource '#{resources}' malformed"
+                end
+
+                resources[0].split("+").each{ |resource|
+                    if !RESOURCES[resource.upcase]
+                        raise "Resource '#{resource}' does not exist"
+                    end
+                    ret += RESOURCES[resource.upcase]
+                }
+
+                ret += calculate_ids(resources[1])
+
+                return ret.to_i.to_s(16)
+            rescue Exception  => e
+                return OpenNebula::Error.new(e.message)
+            end
+        end
+
+        # Converts a rights string to a hex. number
+        #
+        # @param rights [String] Rights component string
+        #
+        # @return [String] A string containing a hex number
+        def self.parse_rights(rights)
+            begin
+                ret = 0
+                rights = rights.split("+")
+
+                rights.each{ |right|
+                    raise "Right '#{right}' does not exist" if !RIGHTS[right.upcase]
+
+                    ret += RIGHTS[right.upcase]
+                }
+
+                return ret.to_i.to_s(16)
+            rescue Exception  => e
+                return OpenNebula::Error.new(e.message)
+            end
+        end
+
+        # Calculates the numeric value for a String containing an individual
+        # (#<id>), group (@<id>) or all (*) ID component
+        #
+        # @param id_str [String] Rule Id string
+        #
+        # @return [Integer] the numeric value for the given id_str
+        def self.calculate_ids(id_str)
+            raise "ID string '#{id_str}' malformed" if
+                !id_str.match(/^([\#@]\d+|\*)$/)
+
+            value = 0
+
+            case id_str[0..0]
+                when "#"
+                    value = USERS["UID"]
+                    users_value = id_str[1..-1].to_i + value
+
+                when "@"
+                    value = USERS["GID"]
+                    users_value = id_str[1..-1].to_i + value
+
+                when "*"
+                    users_value = USERS["ALL"]
+            end
+
+            return users_value
+        end
+    end
+end