occi 2.5.1 → 2.5.2

data/README.md

@@ -20,50 +20,84 @@ Installation
 Usage
 -----
 
+Use the Interactive Ruby Shell (IRB) to interact with an OCCI server. If you have the occi gem installed, you just have
+to start irb from the command line:
+
+    irb
+
+If you want to test newer versions of rOCCI, you have to tell irb from where it
+should load occi:
+
+    cd rOCCI
+    irb -I lib
+
 First require the gem, for Ruby 1.8.7 you also have to require rubygems
+
     require 'rubygems'
     require 'occi'
 
 ### Client
 
-The OCCI gem includes a Client to simplify the usage of an OCCI endpoint.
+The OCCI gem includes a Client to simplify the usage of an OCCI endpoint. If you want to use authentication then you
+should create a hash with information either on username and password for basic authentication or with a X.509 user
+certificate, the user certificate password and the path to the Root CAs which are used to verify the certificate of the
+OCCI server.
+
+For Basic auth use
+
+    auth = Hashie::Mash.new
+    auth.type = 'basic'
+    auth.username = 'user'
+    auth.password = 'mypass'
 
-To connect to an OCCI endpoint/server (e.g. running at http://localhost:3000/ ) use
+For Digest auth use
 
-    client = OCCI::Client.new('http://occi.cloud.gwdg.de:3300')
+    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'
+
+To connect to an OCCI endpoint/server (e.g. running on http://localhost:3000/ )
+
+    client = OCCI::Client.new('http://occi.cloud.gwdg.de:3300',auth||=nil)
 
 All available categories are automatically registered to the OCCI model during client initialization. You can get them via
 
-    OCCI::Model.get
+    client.model
 
 To get all resources (as a list of OCCI::Resources) currently managed by the endpoint use
 
-    client.get_resources
+    client.get resources
 
 To get only compute, storage or network resources use get_compute_resources, ...
 
 To get the location of all resources use
 
-    client.get_resource_list
+    client.list resources
 
-Analogue for compute, storage, network via get_compute_list, ...
+Analogue for compute, storage, network.
 
 To get a list of all OS / resource templates use
 
     client.get_os_templates
     client.get_resource_templates
 
-To get all attributes with their default values for a given category use
-
-    client.get_attributes(client.compute)
-
 To create a new compute resource use
 
     os = client.get_os_templates.select { |template| template.term.include? 'my_os' }
     size = client.get_resource_templates.select { |template| template.term.include? 'large' }
-    attributes = client.get_attributes([client.compute,os,size])
-    attributes['occi.core.title'] = "My VM"
-    client.post_compute(attributes,os,size)
+    cmpt = OCCI::Core::Resource.new compute
+    cmpt.mixins << os << size
+    cmpt.attributes.occi!.core!.title = "My VM"
+    client.create cmpt
 
 ### Logging
 
@@ -136,6 +170,12 @@ The OCCI gem includes all OCCI Core classes necessary to handly arbitrary OCCI o
 Changelog
 ---------
 
+### 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, ...)

data/examples/x509auth_example.rb

@@ -1,17 +1,27 @@
 require 'rubygems'
 require 'occi'
 require 'pp'
+require 'hashie/mash'
+
+## 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/usercert.pem'
-USER_CERT_PASSPWORD = 'mypassphrase'
+USER_CERT_PASSWORD = 'mypassphrase'
 CA_PATH             = '/etc/grid-security/certificates'
 
+## get an OCCI::Client instance
 client = OCCI::Client.new('https://localhost:3300',
                           { :type               => "x509",
                             :user_cert          => USER_CERT,
                             :user_cert_password => USER_CERT_PASSWORD,
                             :ca_path            => CA_PATH })
 
+## get detailed information about all available resources
+## then query each resource category in turn
 puts "\n\nPrinting all resources"
 pp client.get resources
 
@@ -24,6 +34,8 @@ pp client.get network
 puts "\n\nPrinting compute resources"
 pp client.get compute
 
+## get links of all available resources
+## then get links for each category in turn
 puts "\n\nPrinting locations of all resources"
 pp client.list resources
 
@@ -36,7 +48,73 @@ pp client.list compute
 puts "\n\nPrinting locations of network resources"
 pp client.list network
 
+## get detailed information about available OS templates (== VM templates in ON)
+## and resource templates (== INSTANCE TYPES, e.g. small, medium, large etc.)
+puts "\n\nPrinting OS templates"
+pp client.get_os_templates
+
+puts "\n\nPrinting resource templates"
+pp client.get_resource_templates
+
+## create a compute resource using the chosen method
 puts "\n\nCreate compute resources"
+
 cmpt = OCCI::Core::Resource.new 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 << 'http://my.occi.service//occi/infrastructure/resource_tpl#medium'
+
+  ## list network/storage locations and select the appropriate ones (the first ones in this case) 
+  puts "\nUsing"
+  pp storage_loc = client.list(storage)[0]
+  pp network_loc = client.list(network)[0]
+
+  ## create links and attach them to the compure resource
+  client.storagelink cmpt, storage_loc
+  client.networkinterface cmpt, 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 = client.get_os_templates.select { |template| template.term.include? OS_TEMPLATE }
+  pp size = client.get_resource_templates.select { |template| template.term.include? 'medium' }
+  
+  ## attach chosen resources to the compute resource
+  cmpt.mixins << os << size
+  ## we can change some of the values manually
+  cmpt.attributes.occi!.core!.title = "My rOCCI VM"
+end
+
+## create the compute resource and print its location
 cmpt_loc = client.create cmpt
-pp "Location of new compute resource: #{cmpt_loc}"
+pp "Location of new compute resource: #{cmpt_loc}"
+
+## get links of all available compute resouces again
+puts "\n\nPrinting locations of compute resources (should now contain #{cmpt_loc})"
+pp client.list compute
+
+## get detailed information about the new compute resource
+## using Hashie simplifies access to its attributes
+puts "\n\nPrinting information about compute resource #{cmpt_loc}"
+cmpt_data = client.get cmpt_loc.to_s.split('/')[3] + '/' + cmpt_loc.to_s.split('/')[4]
+cmpt_hashie = Hashie::Mash.new(JSON.parse(cmpt_data.to_json))
+
+## wait until the resource is "active"
+while cmpt_hashie.resources.first.attributes.occi.compute.state == "inactive"
+  puts "\nCompute resource #{cmpt_loc} is inactive, waiting ..."
+  sleep 1
+  cmpt_data = client.get cmpt_loc.to_s.split('/')[3] + '/' + cmpt_loc.to_s.split('/')[4]
+  cmpt_hashie = Hashie::Mash.new(JSON.parse(cmpt_data.to_json))
+end
+
+puts "\nCompute resource #{cmpt_loc} is #{cmpt_hashie.resources.first.attributes.occi.compute.state}"
+
+## delete the resource and exit
+if clean_up_compute
+  puts "\n\nDeleting compute resource #{cmpt_loc}"
+  pp client.delete cmpt_loc.to_s.split('/')[3] + '/' + cmpt_loc.to_s.split('/')[4]
+end

data/lib/occi/client.rb

@@ -142,7 +142,9 @@ module OCCI
     # @param [String] path
     # @return [Array] list of URIs
     def list(path='')
-      self.class.get(path, :headers => { "Accept" => 'text/uri-list' }).split("\n").compact
+      path = path.split('#').last + '/' if path.start_with? 'http://'
+      path     = path.reverse.chomp('/').reverse
+      self.class.get(@endpoint + path, :headers => { "Accept" => 'text/uri-list' }).body.split("\n").compact
     end
 
     # @param [OCCI::Core::Entity] entity
@@ -303,4 +305,4 @@ module OCCI
     end
 
   end
-end
+end

data/lib/occi/core/entity.rb

@@ -40,10 +40,10 @@ module OCCI
         @checked = false
         raise "Kind #{kind} not of type String" unless kind.kind_of? String
         @kind                        = kind
-        @mixins                      = mixins.to_a
+        @mixins                      = mixins.to_a.flatten
         @attributes                  = OCCI::Core::Attributes.new(attributes)
         @attributes.occi!.core![:id] ||= UUIDTools::UUID.random_create.to_s
-        @actions                     = actions.to_a
+        @actions                     = actions.to_a.flatten
       end
 
       # @param [Array] mixins

data/lib/occi/version.rb

@@ -1,3 +1,3 @@
 module OCCI
-  VERSION = "2.5.1" unless defined?(::OCCI::VERSION)
+  VERSION = "2.5.2" unless defined?(::OCCI::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occi
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json