rbvmomi 1.2.1 → 1.2.2

data/README.html

@@ -0,0 +1,76 @@
+<h1>RbVmomi</h1>
+
+<h2>Introduction</h2>
+
+<p>RbVmomi is a Ruby interface to the vSphere API. Like the Perl and Java SDKs,
+you can use it to manage ESX and VirtualCenter servers. The current release
+supports the vSphere 4.1 API.</p>
+
+<h2>Usage</h2>
+
+<p>A simple example of turning on a VM:</p>
+
+<pre><code>require 'rbvmomi'
+conn = RbVmomi.connect host: 'foo', user: 'bar', password: 'baz'
+dc = conn.serviceInstance.find_datacenter("mydatacenter") or fail "datacenter not found"
+vm = dc.find_vm("myvm") or fail "VM not found"
+vm.PowerOn_Task.wait_for_completion
+</code></pre>
+
+<p>This code uses several RbVmomi extensions to the VI API for concision. The
+expanded snippet below uses only standard API calls and should be familiar to
+users of the Java SDK:</p>
+
+<pre><code>require 'rbvmomi'
+conn = RbVmomi.connect host: 'foo', user: 'bar', password: 'baz'
+rootFolder = conn.serviceInstance.content.rootFolder
+dc = rootFolder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == "mydatacenter" } or fail "datacenter not found"
+vm = dc.vmFolder.childEntity.grep(RbVmomi::VIM::VirtualMachine).find { |x| x.name == "myvm" } or fail "VM not found"
+task = vm.PowerOn_Task
+filter = conn.propertyCollector.CreateFilter(
+  spec: {
+    propSet: [{ type =&gt; 'Task', all: false, pathSet: ['info.state']}],
+    objectSet: [{ obj: task }]
+  },
+  partialUpdates: false
+)
+ver = ''
+while true
+  result = conn.propertyCollector.WaitForUpdates(version: ver)
+  ver = result.version
+  break if ['success', ['error'].member? task.info.state
+end
+filter.DestroyPropertyFilter
+raise task.info.error if task.info.state == 'error'
+</code></pre>
+
+<p>As you can see, the extensions RbVmomi adds can dramatically decrease the code
+needed to perform simple tasks while still letting you use the full power of
+the API when necessary. RbVmomi extensions are often more efficient than a
+naive implementation; for example, the find_vm method on VIM::Datacenter used
+in the first example uses the SearchIndex for fast lookups.</p>
+
+<p>A few important points:</p>
+
+<ul>
+<li>Ruby 1.9 is required.</li>
+<li>Properties are exposed as methods: vm.summary</li>
+<li>All class, method, parameter, and property names match the <a href="http://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/index.html">official documentation</a>.</li>
+<li>Data object types can usually be inferred from context, so you may simply use a hash instead.</li>
+<li>Enumeration values are simply strings.</li>
+<li>Example code is included in the examples/ directory.</li>
+<li>A set of helper methods for Trollop is included to speed up development of
+command line apps. See the included examples for usage.</li>
+<li>This is a side project of a VMware developer and is entirely unsupported by VMware.</li>
+</ul>
+
+<p>Built-in extensions are in lib/rbvmomi/extensions.rb. You are encouraged to
+reopen VIM classes in your applications and add extensions of your own. If you
+write something generally useful please send it to me and I'll add it in. One
+important point about extensions is that since VIM classes are lazily loaded,
+you need to trigger this loading before you can reopen the class. Putting the
+class name on a line by itself before reopening is enough.</p>
+
+<h2>Development</h2>
+
+<p>Send patches to rlane@vmware.com.</p>

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.2.2

data/lib/rbvmomi/basic_types.rb

@@ -138,18 +138,23 @@ class DataObject < ObjectWithProperties
 end
 
 class ManagedObject < ObjectWithMethods
-  def initialize soap, ref
+  def initialize connection, ref
     super()
-    @soap = soap
+    @connection = connection
+    @soap = @connection # XXX deprecated
     @ref = ref
   end
 
+  def _connection
+    @connection
+  end
+
   def _ref
     @ref
   end
 
   def _get_property sym
-    ret = @soap.propertyCollector.RetrieveProperties(:specSet => [{
+    ret = @connection.propertyCollector.RetrieveProperties(:specSet => [{
       :propSet => [{ :type => self.class.wsdl_name, :pathSet => [sym.to_s] }],
       :objectSet => [{ :obj => self }],
     }])[0]
@@ -169,7 +174,7 @@ class ManagedObject < ObjectWithMethods
   def _call method, o={}
     fail "parameters must be passed as a hash" unless o.is_a? Hash
     desc = self.class.full_methods_desc[method.to_s] or fail "unknown method"
-    @soap.call method, desc, self, o
+    @connection.call method, desc, self, o
   end
 
   def to_s

data/lib/rbvmomi/vim/Folder.rb

@@ -71,7 +71,7 @@ class RbVmomi::VIM::Folder
     elsif path.is_a? Enumerable
       es = path
     else
-      fail "unexpected path class"
+      fail "unexpected path class #{path.class}"
     end
     return self if es.empty?
     final = es.pop

data/lib/rbvmomi/vim/OvfManager.rb

@@ -74,8 +74,8 @@ class RbVmomi::VIM::OvfManager
         method = fileItem.create ? "PUT" : "POST"
 
         href = deviceUrl.url.gsub("*", opts[:host].config.network.vnic[0].spec.ip.ipAddress)
-        downloadCmd = "#{CURLBIN} -L '#{filename}'"
-        uploadCmd = "#{CURLBIN} -X #{method} --insecure -T - -H 'Content-Type: application/x-vnd.vmware-streamVmdk' -H 'Content-Length: #{fileItem.size}' '#{href}'"
+        downloadCmd = "#{CURLBIN} -L '#{URI::escape(filename)}'"
+        uploadCmd = "#{CURLBIN} -X #{method} --insecure -T - -H 'Content-Type: application/x-vnd.vmware-streamVmdk' -H 'Content-Length: #{fileItem.size}' '#{URI::escape(href)}'"
         system("#{downloadCmd} | #{uploadCmd}")
         progress += (95.0 / result.fileItem.length)
         nfcLease.HttpNfcLeaseProgress(:percent => progress.to_i)

metadata

@@ -2,7 +2,7 @@
 name: rbvmomi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors: 
 - Rich Lane
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 -07:00
+date: 2011-03-18 00:00:00 -07:00
 default_executable: rbvmomish
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,6 +54,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
+- README.html
 - README.rdoc
 files: 
 - .yardopts
@@ -103,6 +104,7 @@ files:
 - test/test_parse_response.rb
 - test/test_serialization.rb
 - vmodl.db
+- README.html
 has_rdoc: true
 homepage: https://github.com/rlane/rbvmomi
 licenses: []
@@ -127,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ruby interface to the VMware vSphere API