occi 1.0.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p0@occi

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+#gem "hugs", "~> 2.1.0"
+gem "hugs", :path => "~/git/hugs"
+gem "multipart-post", "~> 1.0.1"
+gem "nokogiri", "~> 1.4.4"
+
+group :development do
+  gem "rake"
+  gem "jeweler", "~> 1.5.1"
+  gem "webmock", "~> 1.6.1"
+  gem "vcr", "~> 1.4.0"
+  gem "minitest", "~> 2.0.0"
+end

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: ~/git/hugs
+  specs:
+    hugs (2.0.0)
+      net-http-persistent (~> 1.4.1)
+      nokogiri (~> 1.4.4)
+      yajl-ruby (~> 0.7.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.2)
+    crack (0.1.8)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.0.0)
+    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.1)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hugs!
+  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)

data/LICENSE

@@ -0,0 +1,4 @@
+"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.

data/README.md

@@ -0,0 +1,28 @@
+# OCCI
+
+[Ruby](http://www.ruby-lang.org/) bindings to [OpenNebula's](http://opennebula.org) [Open Cloud Computing Interface (OCCI)](http://www.opennebula.org/documentation:rel2.0:occidd).
+
+## Usage
+
+### Bundler
+
+    gem "occi"
+
+### Examples
+
+See the examples section in the [wiki](http://github.com/retr0h/occi/wiki).
+
+## Testing
+
+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.
+
+    $ export ONE_USER=$user
+    $ export ONE_PASSWORD=$password
+
+    $ bundle exec rake
+
+## TODO
+
+* Should we raise when we do not have expected HTTP code or body?

data/Rakefile

@@ -0,0 +1,25 @@
+require "rubygems"
+require "rake"
+
+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"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs   << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/occi.rb

@@ -0,0 +1 @@
+require "occi/client"

data/lib/occi/client.rb

@@ -0,0 +1,35 @@
+require "hugs"
+require "digest/sha1"
+
+module Occi
+  class Client
+    ##
+    # Include endpoints.
+
+    %w(pool entity).each do |mixin|
+      require "occi/#{mixin}"
+      include eval "Occi::#{mixin.capitalize}"
+    end
+
+    ##
+    # Required:
+    # +user+: A String containing the username for use in HTTP Basic auth.
+    # +password+: A String containing the password for use in HTTP Basic auth.
+    # +host+: A String with the host to connect.
+
+    def initialize options
+      @connection = Hugs.new(
+        :user     => options[:user],
+        :password => Digest::SHA1.hexdigest(options[:password]),
+        :host     => options[:host],
+        :scheme   => options[:scheme] || "http",
+        :port     => options[:port] || 4567,
+        :type     => options[:type] || :xml,
+      )
+    end
+
+    def request
+      @connection
+    end
+  end
+end

data/lib/occi/entity.rb

@@ -0,0 +1,63 @@
+module Occi
+  module Entity
+    Gets = %w(
+      compute
+      network
+      storage
+    ).map { |v| "#{v}_get" }.freeze
+
+    Deletes = %w(
+      compute
+      network
+      storage
+    ).map { |v| "#{v}_delete" }.freeze
+
+    Puts = %w(
+      compute
+    ).map { |v| "#{v}_put" }.freeze
+
+    ##
+    # The _get methods:
+    #   Returns the representation of the Compute resource identified by +compute_id+.
+    #   200 OK: An XML representation of the pool in the http body.
+    #
+    # The _delete methods:
+    #   Deletes the Compute resource identified by +compute_id+.
+    #   204 No Content : The Compute has been successfully deleted.
+    #
+    # The _put methods:
+    #   Update request for a Compute identified by +compute_id+.
+    #   202 Accepted : The update request is being process, polling required to confirm update.
+
+    (Gets + Deletes + Puts).each do |method|
+      define_method method do |*args|
+        id         = args[0]
+        params     = args[1] || {}
+        path, verb = method.split("_")
+
+        request.send verb, "/#{path}/#{id}", params
+      end
+    end
+
+    ##
+    # :method: compute_get
+
+    ##
+    # :method: compute_delete
+
+    ##
+    # :method: compute_put
+
+    ##
+    # :method: network_get
+
+    ##
+    # :method: network_delete
+
+    ##
+    # :method: storage_get
+
+    ##
+    # :method: storage_delete
+  end
+end

data/lib/occi/pool.rb

@@ -0,0 +1,52 @@
+module Occi
+  module Pool
+    Gets = %w(
+      computes
+      networks
+      storages
+    ).map { |v| "#{v}_get" }.freeze
+
+    Posts = %w(
+      computes
+      networks
+      storages
+    ).map { |v| "#{v}_post" }.freeze
+
+    ##
+    # The _get methods:
+    #   Returns the contents of the pool.
+    #   200 OK: An XML representation of the pool in the http body.
+    #
+    # The _post methods:
+    #   Request for the creation of an ER. An XML representation of a
+    #   VM without the ID element should be passed in the http body.
+    #   201 Created: An XML representation of a ER of type COMPUTE with the ID.
+
+    (Gets + Posts).each do |method|
+      define_method method do |*args|
+        params     = args[0] || {}
+        path, verb = method.split("_")
+
+        request.send verb, "/#{path.sub(%r{s$}, '')}", params
+      end
+    end
+
+    ##
+    # :method: computes_get
+
+    ##
+    # :method: computes_post
+
+    ##
+    # :method: networks_get
+
+    ##
+    # :method: networks_post
+
+    ##
+    # :method: storages_get
+
+    ##
+    # :method: storages_post
+  end
+end

data/test/fixtures/cassettes/compute_delete.yml

@@ -0,0 +1,22 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :delete
+    uri: http://oneadmin:a9464e3228ae563be6207bbf50437a219550f48b@one.example.com:4567/compute/135
+    body: 
+    headers: 
+      accept: 
+      - application/xml
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 204
+      message: No Content
+    headers: 
+      server: 
+      - thin 1.2.7 codename No Hup
+    body: 
+    http_version: "1.1"

data/test/fixtures/cassettes/compute_get.yml

@@ -0,0 +1,109 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://oneadmin:a9464e3228ae563be6207bbf50437a219550f48b@one.example.com:4567/compute/130
+    body: 
+    headers: 
+      accept: 
+      - application/xml
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/html;charset=utf-8
+      content-length: 
+      - "714"
+      connection: 
+      - keep-alive
+      server: 
+      - thin 1.2.7 codename No Hup
+    body: <COMPUTE href="http://cm-01.cloud.int.ev1.atti.com:4567/compute/130"><ID>130</ID><NAME>Test Framework</NAME><INSTANCE_TYPE>small</INSTANCE_TYPE><STATE>ACTIVE</STATE><DISK><STORAGE href="http://cm-01.cloud.int.ev1.atti.com:4567/storage/11" name="Centos 5.4 x86_64"/><TYPE>DISK</TYPE><TARGET>hda</TARGET></DISK><NIC><NETWORK href="http://cm-01.cloud.int.ev1.atti.com:4567/network/14" name="10.3.172.0"/><IP>10.3.172.23</IP><MAC>02:00:0a:03:ac:17</MAC></NIC><CONTEXT><FILES>/opt/tpkg/opennebula-2.0/../var/opennebula-2.0/templates/context/init.sh</FILES><GATEWAY>10.3.172.1</GATEWAY><HOSTNAME>02:00:0a:03:ac:17</HOSTNAME><IP_PUBLIC>10.3.172.23</IP_PUBLIC><NETMASK>/23</NETMASK><TARGET>hdc</TARGET></CONTEXT></COMPUTE>
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://oneadmin:a9464e3228ae563be6207bbf50437a219550f48b@one.example.com:4567/compute/131
+    body: 
+    headers: 
+      accept: 
+      - application/xml
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/html;charset=utf-8
+      content-length: 
+      - "715"
+      connection: 
+      - keep-alive
+      server: 
+      - thin 1.2.7 codename No Hup
+    body: <COMPUTE href="http://cm-01.cloud.int.ev1.atti.com:4567/compute/131"><ID>131</ID><NAME>Test Framework</NAME><INSTANCE_TYPE>small</INSTANCE_TYPE><STATE>PENDING</STATE><DISK><STORAGE href="http://cm-01.cloud.int.ev1.atti.com:4567/storage/11" name="Centos 5.4 x86_64"/><TYPE>DISK</TYPE><TARGET>hda</TARGET></DISK><NIC><NETWORK href="http://cm-01.cloud.int.ev1.atti.com:4567/network/14" name="10.3.172.0"/><IP>10.3.172.24</IP><MAC>02:00:0a:03:ac:18</MAC></NIC><CONTEXT><FILES>/opt/tpkg/opennebula-2.0/../var/opennebula-2.0/templates/context/init.sh</FILES><GATEWAY>10.3.172.1</GATEWAY><HOSTNAME>02:00:0a:03:ac:18</HOSTNAME><IP_PUBLIC>10.3.172.24</IP_PUBLIC><NETMASK>/23</NETMASK><TARGET>hdc</TARGET></CONTEXT></COMPUTE>
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://oneadmin:a9464e3228ae563be6207bbf50437a219550f48b@one.example.com:4567/compute/1
+    body: 
+    headers: 
+      accept: 
+      - application/xml
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/html;charset=utf-8
+      content-length: 
+      - "136"
+      connection: 
+      - keep-alive
+      server: 
+      - thin 1.2.7 codename No Hup
+    body: <COMPUTE href="http://cm-01.cloud.int.ev1.atti.com:4567/compute/1"><ID>1</ID><NAME>Centos 5.4 x86_64</NAME><STATE>DONE</STATE></COMPUTE>
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://oneadmin:a9464e3228ae563be6207bbf50437a219550f48b@one.example.com:4567/compute/135
+    body: 
+    headers: 
+      accept: 
+      - application/xml
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/html;charset=utf-8
+      content-length: 
+      - "714"
+      connection: 
+      - keep-alive
+      server: 
+      - thin 1.2.7 codename No Hup
+    body: <COMPUTE href="http://cm-01.cloud.int.ev1.atti.com:4567/compute/135"><ID>135</ID><NAME>Test Framework</NAME><INSTANCE_TYPE>small</INSTANCE_TYPE><STATE>ACTIVE</STATE><DISK><STORAGE href="http://cm-01.cloud.int.ev1.atti.com:4567/storage/11" name="Centos 5.4 x86_64"/><TYPE>DISK</TYPE><TARGET>hda</TARGET></DISK><NIC><NETWORK href="http://cm-01.cloud.int.ev1.atti.com:4567/network/14" name="10.3.172.0"/><IP>10.3.172.25</IP><MAC>02:00:0a:03:ac:19</MAC></NIC><CONTEXT><FILES>/opt/tpkg/opennebula-2.0/../var/opennebula-2.0/templates/context/init.sh</FILES><GATEWAY>10.3.172.1</GATEWAY><HOSTNAME>02:00:0a:03:ac:19</HOSTNAME><IP_PUBLIC>10.3.172.25</IP_PUBLIC><NETMASK>/23</NETMASK><TARGET>hdc</TARGET></CONTEXT></COMPUTE>
+    http_version: "1.1"

data/test/fixtures/cassettes/compute_put.yml

@@ -0,0 +1,35 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :put
+    uri: http://oneadmin:a9464e3228ae563be6207bbf50437a219550f48b@one.example.com:4567/compute/134
+    body: |
+      <?xml version="1.0"?>
+      <COMPUTE>
+        <STATE>shutdown</STATE>
+      </COMPUTE>
+
+    headers: 
+      accept: 
+      - application/xml
+      content-type: 
+      - application/xml
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 202
+      message: Accepted
+    headers: 
+      content-type: 
+      - text/html;charset=utf-8
+      content-length: 
+      - "809"
+      connection: 
+      - keep-alive
+      server: 
+      - thin 1.2.7 codename No Hup
+    body: <COMPUTE href="http://cm-01.cloud.int.ev1.atti.com:4567/compute/134"><ID>134</ID><NAME>Centos-5-4_x86_64-Kevin</NAME><STATE>ACTIVE</STATE><DISK><STORAGE href="http://cm-01.cloud.int.ev1.atti.com:4567/storage/22" name="Centos 5.4 x86_64 Kevin"/><TYPE>DISK</TYPE><TARGET>hda</TARGET></DISK><DISK><STORAGE href="http://cm-01.cloud.int.ev1.atti.com:4567/storage/" name=""/><TYPE>swap</TYPE><TARGET>hdd</TARGET></DISK><NIC><NETWORK href="http://cm-01.cloud.int.ev1.atti.com:4567/network/15" name="10.3.174.0"/><IP>10.3.174.10</IP><MAC>02:00:0a:03:ae:0a</MAC></NIC><CONTEXT><FILES>/opt/tpkg/var/opennebula-2.0/templates/context/init.sh</FILES><GATEWAY>10.3.174.1</GATEWAY><HOSTNAME>02:00:0a:03:ae:0a</HOSTNAME><IP_PUBLIC>10.3.174.10</IP_PUBLIC><NETMASK>/23</NETMASK><NS></NS><TARGET>hdc</TARGET></CONTEXT></COMPUTE>
+    http_version: "1.1"