vcloud 0.0.1.1

data/lib/vcloud/user/reference.rb

@@ -0,0 +1,27 @@
+module VCloud
+  # A reference to a resource. Contains an href attribute and optional name and type attributes.
+  class Reference
+    include HappyMapper 
+    
+    tag '*'
+    attribute :id, 'String'
+    attribute :type, 'String'
+    attribute :name, 'String'
+    attribute :href, 'String'
+
+    def initialize(args = {})
+      @rel = args[:id]
+      @type = args[:type]
+      @name = args[:name]
+      @href = args[:href]
+    end
+
+    # Parse a VCloud::Reference from XML
+    #
+    # @param [String] xml XML to parse
+    # @return [VCloud::Reference] Reference that is parsed from the XML
+    def self.from_xml(xml)
+      parse(xml)
+    end
+  end
+end

data/lib/vcloud/user/task.rb

@@ -0,0 +1,54 @@
+module VCloud
+  # Represents an asynchronous operation in vCloud Director
+  class Task < BaseVCloudEntity
+    require 'timeout'
+    
+    include ParsesXml
+
+    has_type VCloud::Constants::ContentType::TASK
+    tag 'Task'
+    has_links
+    has_default_attributes
+    attribute :status,          String
+    attribute :start_time,      String, :tag => 'startTime' 
+    attribute :operation_name,  String, :tag => 'operationName'
+    attribute :operation,       String
+    attribute :expiry_time,     String, :tag => 'expiryTime'
+
+    # Wait until the status of the task is set to indicate that the task has completed
+    #
+    # @param [Integer] timeout Timeout in seconds
+    # @yield Block to run upon completion or the timeout is reached, whichever comes first
+    def wait_to_finish(timeout = 60 * 10) 
+      first_run = true
+      Timeout::timeout(timeout) do        
+        until @@completed_statuses.include?(self.status)
+          sleep 3 if not first_run
+          refresh    
+          first_run = false
+        end
+      end
+      yield(self) if block_given?
+    end
+
+    # Task status as it's being processed
+    module Status
+      # The task has been queued for execution
+      QUEUED      = 'queued'
+      # The task is awaiting preprocessing or administrative action
+      PRE_RUNNING = 'preRunning'
+      # The task is running
+      RUNNING     = 'running'
+      # The task completed with a status of success
+      SUCCESS     = 'success'
+      # The task encountered an error while running
+      ERROR       = 'error'
+      # The task was canceled by the owner or an administrator
+      CANCELED    = 'canceled'
+      # The task was aborted by an administrative action
+      ABORTED     = 'aborted'    
+    end
+    @@completed_statuses = [Status::SUCCESS, Status::ERROR, Status::CANCELED, Status::ABORTED]
+
+  end
+end

data/lib/vcloud/user/vapp.rb

@@ -0,0 +1,103 @@
+module VCloud
+  # A vApp is a collection of VMs, network config, etc.
+  class VApp < BaseVCloudEntity
+    include ParsesXml
+
+    has_type VCloud::Constants::ContentType::VAPP
+    tag 'VApp'
+    has_links
+    has_default_attributes
+    has_many :tasks, 'VCloud::Task'
+
+    # Power on all VMs iin the vApp. This operation is available only for a vApp that is powered off.
+    #
+    # @return [VCloud::Task] Task used to monitor the power on event
+    def power_on
+      link = links.select{ |l| l.rel == "power:powerOn" }.first
+      post_task(link) 
+    end
+
+    # def power_off
+    #   link = links.select{ |l| l.rel == "power:powerOff" }.first
+    #   post_task(link)       
+    # end
+    # 
+    # def suspend
+    #   link = links.select{ |l| l.rel == "power:suspend" }.first
+    #   post_task(link)  
+    # end 
+    
+    # Delete the vApp
+    #
+    # @return [VCloud::Task] Task used to monitor the delete vApp event
+    def remove
+      link = links.select{ |l| l.rel == "remove" }.first
+      result = delete(link.href, nil, VCloud::Constants::ACCEPT_HEADER)
+      task = VCloud::Task.from_xml(result)
+      task.session = session
+      task
+    end
+
+    # def deploy
+    #   link = links.select{ |l| l.rel == "deploy" }.first
+    #   post_task(link)
+    # end   
+    
+    # Undeployment deallocates all resources used by the vApp and the VMs it contains
+    #
+    # @param [VCloud::VApp::UndeployPowerAction] power_action
+    # @return [VCloud::Task] Task used to monitor the undeploy vApp event
+    def undeploy(power_action)             
+      undeploy_params = UndeployVAppParams.new
+      undeploy_params.undeploy_power_action = power_action
+
+      link = links.select{ |l| l.rel == "undeploy" }.first
+
+      result = post(link.href, undeploy_params.to_xml, VCloud::Constants::ContentType::UNDEPLOY_VAPP_PARAMS) 
+  
+      task = VCloud::Task.from_xml(result)
+      task.session = self.session
+      task
+    end  
+    
+    def parse_xml(xml)
+      super xml
+      if self.session
+        self.tasks.each do |task|
+          task.session = self.session
+        end
+      end
+    end
+ 
+    def post_task(link)
+      result = post(link.href, nil, VCloud::Constants::ACCEPT_HEADER)
+      task = VCloud::Task.from_xml(result)
+      task.session = self.session       
+      task  
+    end
+    
+    # The specified action is applied to all VMs in the vApp. 
+    # All values other than 'default' ignore actions, order, and delay specified in the StartupSection.
+    module UndeployPowerAction
+      # Power off the VMs. This is the default action if this attribute is missing or empty)     
+      POWER_OFF = 'powerOff'
+      # Suspend the VMs
+      SUSPEND   = 'suspend' 
+      # Shut down the VMs  
+      SHUTDOWN  = 'shutdown'
+      # Attempt to power off the VMs. Failures in undeploying the VM or associated networks are ignored. All references to the vApp and its VMs are removed from the database
+      FORCE     = 'force'
+      # Use the actions, order, and delay specified in the StartupSection
+      DEFAULT   = 'default'
+    end
+
+  end
+  
+  # Paramater passed when undeploying a VApp
+  class UndeployVAppParams
+    include HappyMapper
+    register_namespace 'xmlns', VCloud::Constants::NameSpace::V1_5
+    tag 'UndeployVAppParams'
+    element :undeploy_power_action, String, :tag => 'UndeployPowerAction'    
+  end
+end

data/lib/vcloud/user/vdc.rb

@@ -0,0 +1,32 @@
+module VCloud
+  # Represents the user view of an organization vDC
+  class Vdc < BaseVCloudEntity
+    include ParsesXml
+    
+    has_type VCloud::Constants::ContentType::VDC
+    tag 'Vdc'
+    has_default_attributes
+    has_links
+    has_many :network_references, 'VCloud::Reference', :tag => 'Network'
+    
+    # Returns a hash of of all Network references, keyed by the name
+    #
+    # @return [Hash{String => VCloud::Reference}] Reference to all Networks in the vDC, keyed by name
+    def get_network_references_by_name      
+      Hash[@network_references.collect{ |i| [i.name, i] }]
+    end
+    
+    # Create a vApp from a vApp template
+    #
+    # @param [VCloud::InstantiateVAppTemplateParams] instantiate_vapp_template_params vApp template params
+    # @param [VCloud::Client] session Session to create the vApp Template under
+    # @return [VCloud::VApp] vApp that was created
+    def instantiate_vapp_template(instantiate_vapp_template_params, session = self.session)
+      url = @links.select{ |l| l.type == VCloud::Constants::ContentType::INSTANTIATE_VAPP_TEMPLATE_PARAMS }.first.href
+      response = post(url, instantiate_vapp_template_params.to_xml, VCloud::Constants::ContentType::INSTANTIATE_VAPP_TEMPLATE_PARAMS, session)
+      vapp = VCloud::VApp.new :session => session      
+      vapp.parse_xml(response)
+      vapp
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module VCloud
+  VERSION = "0.0.1.1"
+end

data/spec/catalog_item_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+include WebMock::API
+
+describe VCloud::CatalogItem do
+  describe "when parsing #from_xml" do
+    before(:each) do
+      @item = VCloud::CatalogItem.from_xml(fixture_file('catalog_item.xml'))
+    end    
+        
+    it 'should have correct values' do
+      @item.name.should == 'Ubuntu 10.04.4 LTS'
+      @item.id.should == 'urn:vcloud:catalogitem:aaa-bbb-ccc-ddd-eee-fff'
+      @item.type.should == 'application/vnd.vmware.vcloud.catalogItem+xml'
+      @item.href.should == 'https://some.vcloud.com/api/catalogItem/aaa-bbb-ccc-ddd-eee-fff'
+      @item.links.should have(2).items
+      @item.entity_reference.name.should == 'Ubuntu 10.04.4 LTS'
+      @item.entity_reference.href.should == 'https://some.vcloud.com/api/vAppTemplate/vappTemplate-aaa-bbb-ccc-ddd-eee-fff'
+      @item.entity_reference.type.should == 'application/vnd.vmware.vcloud.vAppTemplate+xml'
+    end
+  end
+  
+  it 'should retrieve CatalogItem #from_reference' do
+    stub_request(:get, "https://vcloud.diebold.dev/api/catalogItem/aaa-bbb-ccc-ddd-eee-fff").
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.catalogItem+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('catalog_item.xml'))
+   
+      item = VCloud::CatalogItem.from_reference(stub(:href => 'https://vcloud.diebold.dev/api/catalogItem/aaa-bbb-ccc-ddd-eee-fff'), @session)
+
+      WebMock.should have_requested(:get, 'https://vcloud.diebold.dev/api/catalogItem/aaa-bbb-ccc-ddd-eee-fff').
+        with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.catalogItem+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'})
+
+      item.id.should == 'urn:vcloud:catalogitem:aaa-bbb-ccc-ddd-eee-fff'
+  end  
+end

data/spec/catalog_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+include WebMock::API
+
+describe VCloud::Catalog do
+  before(:each) do
+    @catalog = VCloud::Catalog.from_xml(fixture_file('catalog.xml'))
+  end
+  
+  describe 'parses xml' do
+    it '#from_xml should have correct values' do
+      @catalog.name.should == 'SuperCool Catalog'
+      @catalog.id.should == 'urn:vcloud:catalog:aaa-bbb-ccc-ddd-eee-fff'
+      @catalog.type.should == 'application/vnd.vmware.vcloud.catalog+xml'
+      @catalog.href.should == 'https://some.vcloud.com/api/catalog/aaa-bbb-ccc-ddd-eee-fff'
+      @catalog.links.should have(1).items
+      @catalog.catalog_item_references.should have(1).items
+      @catalog.is_published.should == true
+    end
+    
+    it 'should #get_catalog_item_references_by_name' do
+      hash = @catalog.get_catalog_item_references_by_name
+      
+      hash.should have(1).items
+      hash['Ubuntu 10.04.4 LTS'].href.should == 'https://some.vcloud.com/api/catalogItem/aaa-bbb-ccc-ddd-eee-fff'      
+    end
+  end  
+  
+  it 'should #get_catalog_item_from_name if name exists' do
+    ref = @catalog.get_catalog_item_references_by_name()['Ubuntu 10.04.4 LTS']
+    VCloud::CatalogItem.should_receive(:from_reference).with(ref, @session).and_return('not nil')
+
+    item = @catalog.get_catalog_item_from_name('Ubuntu 10.04.4 LTS', @session)
+    
+    item.should_not be_nil
+  end
+  
+  it 'should return nil #get_catalog_item_from_name if name does not exist' do
+    item = @catalog.get_catalog_item_from_name('not exist')
+    
+    item.should be_nil
+  end
+
+  it "should retrieve catalog #from_reference" do
+    stub_request(:get, "https://vcloud.diebold.dev/api/catalog/aaa-bbb-ccc-ddd-eee-fff").
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.catalog+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('catalog.xml'))     
+
+    catalog = VCloud::Catalog.from_reference(stub(:href => 'https://vcloud.diebold.dev/api/catalog/aaa-bbb-ccc-ddd-eee-fff'), @session)
+
+    WebMock.should have_requested(:get, 'https://vcloud.diebold.dev/api/catalog/aaa-bbb-ccc-ddd-eee-fff').
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.catalog+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'})
+
+    @catalog.name.should == 'SuperCool Catalog'
+    @catalog.id.should == 'urn:vcloud:catalog:aaa-bbb-ccc-ddd-eee-fff'
+    @catalog.type.should == 'application/vnd.vmware.vcloud.catalog+xml'
+    @catalog.href.should == 'https://some.vcloud.com/api/catalog/aaa-bbb-ccc-ddd-eee-fff'
+    @catalog.links.should have(1).items
+    @catalog.catalog_item_references.should have(1).items
+    @catalog.is_published.should == true  
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+include WebMock::API
+
+describe VCloud::Client do
+  
+  it "should login" do
+    stub_request(:post, "https://someuser%40someorg:password@some.vcloud.com/api/sessions").
+             with(:headers => {'Accept'=>'application/*+xml;version=1.5'}).
+             to_return(:status => 200, :body => fixture_file('session.xml'), :headers => {:x_vcloud_authorization => "abc123xyz"})
+        
+    test_session = VCloud::Client.new('https://some.vcloud.com/api/', '1.5')             
+    test_session.login('someuser@someorg', 'password')
+                               
+    test_session.url.should == 'https://some.vcloud.com/api/'
+    test_session.api_version.should == '1.5'
+    test_session.user.should == 'someuser'
+    test_session.org.should == 'someorg'
+    test_session.type.should == 'application/vnd.vmware.vcloud.session+xml'
+    test_session.href.should == 'https://some.vcloud.com/api/session/'
+    test_session.token.should_not be_nil
+    test_session.token[:x_vcloud_authorization].should == "abc123xyz"
+    test_session.links.should have(4).items
+    test_session.logged_in?.should == true
+  end
+
+  it "should #get_org_references" do
+    stub_request(:get, "https://some.vcloud.com/api/org/").
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.orgList+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('org_list.xml'))
+
+    org_refs = @session.get_org_references
+   
+    WebMock.should have_requested(:get, "https://some.vcloud.com/api/org/").
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.orgList+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'})
+   
+    org_refs.should have(1).items
+    org_refs.first.name.should == "someorg"
+    org_refs.first.href.should == "https://some.vcloud.com/api/org/aaa-bbb-ccc-ddd-eee-fff"    
+  end
+  
+  it "should #get_org_references_by_name" do 
+    stub_request(:get, "https://some.vcloud.com/api/org/").
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.orgList+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('org_list.xml'))
+    
+    hash = @session.get_org_references_by_name
+    
+    hash.should have(1).items
+    hash['someorg'].should_not be_nil   
+  end
+  
+  it "should #get_org_from_name if name exists" do 
+    stub_request(:get, "https://some.vcloud.com/api/org/").
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.orgList+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('org_list.xml'))
+                                                                                          
+    VCloud::Org.should_receive(:from_reference).and_return("not nil")
+
+    org = @session.get_org_from_name('someorg')    
+
+    org.should_not be_nil
+  end                         
+  
+  it "should return nil #get_org_from_name if name does not exist" do
+    stub_request(:get, "https://some.vcloud.com/api/org/").
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.orgList+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('org_list.xml'))
+      
+    VCloud::Org.should_not_receive(:from_reference)
+
+    org = @session.get_org_from_name('no_such_org')    
+
+    org.should be_nil   
+  end
+  
+  it "should #logout and destroy the session" do
+    stub_request(:delete, "https://some.vcloud.com/api/session").
+             with(:headers => {'Accept'=>'application/*+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+             to_return(:status => 204, :body => "", :headers => {})
+    
+    @session.logout
+    
+    @session.logged_in?.should == false
+    @session.token.should == nil
+  end
+end

data/spec/fixtures/catalog.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Catalog xmlns="http://www.vmware.com/vcloud/v1.5" name="SuperCool Catalog" id="urn:vcloud:catalog:aaa-bbb-ccc-ddd-eee-fff" type="application/vnd.vmware.vcloud.catalog+xml" href="https://some.vcloud.com/api/catalog/aaa-bbb-ccc-ddd-eee-fff" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://127.0.0.1/api/v1.5/schema/master.xsd">
+    <Link rel="down" type="application/vnd.vmware.vcloud.metadata+xml" href="https://some.vcloud.com/api/catalog/aaa-bbb-ccc-ddd-eee-fff/metadata"/>
+    <CatalogItems>
+        <CatalogItem type="application/vnd.vmware.vcloud.catalogItem+xml" name="Ubuntu 10.04.4 LTS" href="https://some.vcloud.com/api/catalogItem/aaa-bbb-ccc-ddd-eee-fff"/>
+    </CatalogItems>
+    <IsPublished>true</IsPublished>
+</Catalog>

data/spec/fixtures/catalog_item.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CatalogItem xmlns="http://www.vmware.com/vcloud/v1.5" name="Ubuntu 10.04.4 LTS" id="urn:vcloud:catalogitem:aaa-bbb-ccc-ddd-eee-fff" type="application/vnd.vmware.vcloud.catalogItem+xml" href="https://some.vcloud.com/api/catalogItem/aaa-bbb-ccc-ddd-eee-fff" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://127.0.0.1/api/v1.5/schema/master.xsd">
+    <Link rel="up" type="application/vnd.vmware.vcloud.catalog+xml" href="https://some.vcloud.com/api/catalog/aaa-bbb-ccc-ddd-eee-fff"/>
+    <Link rel="down" type="application/vnd.vmware.vcloud.metadata+xml" href="https://some.vcloud.com/api/catalogItem/aaa-bbb-ccc-ddd-eee-fff/metadata"/>
+    <Entity type="application/vnd.vmware.vcloud.vAppTemplate+xml" name="Ubuntu 10.04.4 LTS" href="https://some.vcloud.com/api/vAppTemplate/vappTemplate-aaa-bbb-ccc-ddd-eee-fff"/>
+</CatalogItem>

data/spec/fixtures/error_login_404.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="mul">
+	
+	<head>
+	    <title>VMware vCloud Director</title>
+	    <link rel="shortcut icon" href="/favicon.ico" />
+	</head>
+    <body style="background-color: #555; padding: 0; margin: 0;">
+        <div id="container">
+		    <div style="float: right; padding-right: "><img width="104" height="104" src="/i/cornerMosaic.png" /></div>
+		    <div style="padding: 15px 0px 3px 15px;"><img width="61" height="10" src="/i/vmware.png" /></div>
+		    <img width="48" height="48" style="display: inline; padding: 2px 15px 3px 15px;" src="/i/logoLarge.png" />
+            <span style="color: #fff; font-size: 16pt; font-weight: bold; font-family: sans-serif;">Page not found.</span>
+            <div>
+                <span style="color: #fff; font-size: 16pt; font-weight: bold; font-family: sans-serif;">
+                    
+                </span>
+            </div>
+        </div>
+	</body>
+</html>