vcloud 0.0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+ignore_test
+vendor
+doc
+.yardoc

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'rest-client', '1.6.7'
+gem 'nokogiri-happymapper', '0.5.5'
+
+gem 'rake', '0.9.2.2', :group => [:development, :test]
+
+group :test do
+  gem 'rspec', '2.11.0'
+  gem 'rspec-mocks', '2.11.3'
+  gem 'webmock', '1.8.10'
+  gem 'yard', '0.8.2.1'
+  gem 'redcarpet', '2.1.1'
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    mime-types (1.19)
+    nokogiri (1.5.5)
+    nokogiri-happymapper (0.5.5)
+      nokogiri (~> 1.4)
+    rake (0.9.2.2)
+    redcarpet (2.1.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    webmock (1.8.10)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nokogiri-happymapper (= 0.5.5)
+  rake (= 0.9.2.2)
+  redcarpet (= 2.1.1)
+  rest-client (= 1.6.7)
+  rspec (= 2.11.0)
+  rspec-mocks (= 2.11.3)
+  webmock (= 1.8.10)
+  yard (= 0.8.2.1)

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2012 Diebold, Inc. (http://www.diebold.com/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+vcloud-ruby
+===========
+
+DESCRIPTION
+-----------
+
+Ruby bindings to the VMware vCloud Director REST API
+
+This is a work in progress, but it currently supports enough functionality to perform the entire Hello vCloud example in the [vCloud API Guide](http://www.vmware.com/pdf/vcd_15_api_guide.pdf).
+
+
+INSTALL
+-------
+
+<pre>gem install vcloud-ruby</pre>
+
+
+USAGE
+-----
+
+The examples/hello_vcloud.rb file demonstrates basic usage of the gem, for example...
+
+```
+require 'vcloud'
+@session = VCloud::Client.new("https://my.vcloud.local/api/"), '1.5')
+@session.login('someuser@someorg', 'secretp@ssw0rd)
+@org = @session.get_org_from_name('myorg')
+@catalog = @org.get_catalog_from_name('TestCatalog')
+@vdc     = @org.get_vdc_from_name('TestVDC')
+@catalog_item = @catalog.get_catalog_item_from_name('TestLinuxTemplate')
+```
+
+...and so on
+
+CONTRIBUTE
+----------
+* Fork the project
+* Make your feature addition or bug fix.
+* Add tests
+* Commit, do not modify with rakefile or version, we'll handle this
+* Send a pull request
+
+LICENSE
+-------
+(The MIT License)
+
+Copyright © 2012 Diebold, Inc. [http://www.diebold.com](http://www.diebold.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = ['--backtrace', '--format documentation']
+end

data/examples/hello_vcloud.rb

@@ -0,0 +1,183 @@
+$:.unshift File.join( File.dirname( __FILE__ ), '..', 'lib')
+require 'vcloud'
+
+# Check for command line arguments
+if ARGV.length != 7
+  puts "hello_vcloud.rb vCloudURL user@vcloud-organization password orgName vdcName ovfFileLocation catalogName"
+  exit
+else
+  @url = ARGV[0]
+  @username = ARGV[1]
+  @password = ARGV[2]
+  @org_name = ARGV[3]
+  @vdc_name = ARGV[4]
+  @catalog_item_name = ARGV[5]
+  @catalog_name = ARGV[6]
+end
+
+begin
+puts "###############################################"
+puts "1. Log in and retrieve Org"
+puts "###############################################"
+puts
+
+@session = VCloud::Client.new(@url, '1.5', :verify_ssl => false)
+@session.login(@username, @password)
+
+puts 'Available orgs'
+puts '--------------'
+@session.get_org_references.each do |org_ref|
+  puts org_ref.name
+end
+
+@org = @session.get_org_from_name(@org_name)
+## ---
+## or get the org from a reference
+## ---
+# org_ref_hash = @session.get_org_references_by_name
+# org_ref      = org_ref_hash[@org_name]
+# @org         = VCloud::Org.from_reference(org_ref, @session) 
+
+puts
+puts "Selected org: #{@org.name}"
+
+puts
+puts "###############################################"
+puts "2. Find a Catalog and a vDC"
+puts "###############################################"
+puts
+
+@catalog = @org.get_catalog_from_name(@catalog_name)
+@vdc     = @org.get_vdc_from_name(@vdc_name)      
+## ---
+## or get the catalog and vdc from a link
+## ---                                        
+# catalog_link_hash = @org.get_catalog_links_by_name
+# catalog_link      = catalog_link_hash[@catalog_name]
+# @catalog          = VCloud::Catalog.from_reference(catalog_link, @session)  
+# 
+# vdc_link_hash = @org.get_vdc_links_by_name
+# vdc_link      = vdc_link_hash[@vdc_name]
+# @vdc          = VCloud::Vdc.from_reference(vdc_link, @session)   
+
+puts "Selected catalog: #{@catalog.name}"
+puts "Selected vdc:     #{@vdc.name}"
+
+puts
+puts "###############################################"
+puts "4. Retrieve a Catalog Item"
+puts "###############################################"
+puts
+
+@catalog_item = @catalog.get_catalog_item_from_name(@catalog_item_name)
+## ---
+## or get the catalog_item from a reference
+## ---                                        
+# catalog_item_ref_hash = @catalog.get_catalog_item_references_by_name
+# catalog_item_ref      = catalog_item_ref_hash[@catalog_item_name]
+# @catalog_item         = VCloud::CatalogItem.from_reference(catalog_item_ref, @session)    
+
+@vapp_ref = @catalog_item.entity_reference
+
+puts "Selected catalog item: #{@catalog_item.name}"
+
+puts
+puts "###############################################"
+puts "5. Retrieve Deployment Information From the vDC"
+puts "###############################################"
+puts
+
+@network_ref = @vdc.network_references.first
+
+puts "Selected network: #{@network_ref.name}"
+
+puts
+puts "###############################################"
+puts "6. Deploy the vApp"
+puts "###############################################"
+puts
+
+net_config                          = VCloud::NetworkConfig.new
+net_config.network_name             = @network_ref.name
+net_config.parent_network_reference = @network_ref
+net_config.fence_mode               = VCloud::NetworkConfig::FenceMode::BRIDGED       
+
+@vapp_template = VCloud::InstantiateVAppTemplateParams.new
+@vapp_template.name        = "HelloVCloud-VappTemplate"
+@vapp_template.description = "HelloVCloud-VappTemplate description"
+@vapp_template.power_on    = false
+@vapp_template.deploy      = false
+@vapp_template.network_config_section = VCloud::NetworkConfigSection.new
+@vapp_template.network_config_section.network_configs << net_config
+@vapp_template.source_reference = @vapp_ref
+
+@vapp = @vdc.instantiate_vapp_template(@vapp_template)
+
+print "Deploying vapp #{@vapp.name}...."
+if @vapp.tasks.count > 0 
+  @vapp.tasks.first.wait_to_finish { @vapp.refresh } 
+end                                     
+puts "Deployed."
+
+puts
+puts "###############################################"
+puts "7. Operate the vApp"
+puts "###############################################"
+puts
+
+print "Powering on vapp #{@vapp.name}..."
+@vapp.power_on.wait_to_finish { @vapp.refresh }
+puts 'Powered on.'
+
+print "Suspending vapp #{@vapp.name}..."
+@vapp.undeploy(VCloud::VApp::UndeployPowerAction::SUSPEND).wait_to_finish { @vapp.refresh }
+puts "Suspended." 
+
+print "Powering on vapp #{@vapp.name}..."
+@vapp.power_on.wait_to_finish { @vapp.refresh }
+puts 'Powered on.'
+
+puts
+puts "###############################################"
+puts "8. Displaying the Virtual Machine Console"
+puts "###############################################"
+puts
+
+puts
+puts "###############################################"
+puts "9. Delete the vApp"
+puts "###############################################"
+puts 
+
+print "Powering off vapp #{@vapp.name}..."
+@vapp.undeploy(VCloud::VApp::UndeployPowerAction::POWER_OFF).wait_to_finish { @vapp.refresh }
+puts 'Undeployed.'      
+
+print "Removing vapp #{@vapp.name}..."
+@vapp.remove.wait_to_finish
+puts 'Removed.'                              
+
+puts
+puts "###############################################"
+puts "10. Log Out"
+puts "###############################################" 
+
+@session.logout
+
+rescue Timeout::Error => err
+  puts
+  puts "#{err.class} occurred."
+  puts err.message
+rescue VCloud::VCloudError => err
+  puts
+  puts "#{err.class} occurred."
+  puts err.message
+rescue SocketError => err
+  puts
+  puts "#{err.class} occurred."
+  puts err.message
+rescue Exception => err
+  puts
+  puts "#{err.class} occurred."
+  puts err.message
+end

data/lib/vcloud.rb

@@ -0,0 +1,16 @@
+# Require files in lib/vcloud
+
+module VCloud
+  require 'restclient'
+  require 'happymapper'
+  require 'set'
+
+  require 'vcloud/errors'
+  require 'vcloud/constants'
+  require 'vcloud/parses_xml'
+  require 'vcloud/rest_api'
+  require 'vcloud/base_vcloud_entity'
+  
+  require 'vcloud/user'  
+  require 'vcloud/client'
+end

data/lib/vcloud/base_vcloud_entity.rb

@@ -0,0 +1,59 @@
+module VCloud
+  # Base class for all vCloud entities (Org, CatalogItem, vApp, etc.)
+  class BaseVCloudEntity  
+    include RestApi
+
+    def self.inherited(base)
+      base.class_variable_set(:@@initialize_args, Set.new)
+      base.send(:include, ParsesXml)
+      base.class_eval { attr_accessor :session }
+    end
+            
+    def initialize(params = {})
+      initialize_args.each do |arg|
+        self.instance_variable_set("@#{arg}".to_sym, params[arg])
+      end
+      @type = self.type
+    end
+    
+    def self.type
+      self.class_variable_get(:@@content_type)
+    end
+
+    # Retrieve an entity from a VCloud::Reference
+    #
+    # @param [VCloud::Reference] ref Reference to retrieve the entity with
+    # @param [VCloud::Client] session Session to authenticate with when retrieving the entity
+    # @param [VCloud::BaseVCloudEntity] Entity from vCloud Director
+    def self.from_reference(ref, session)
+      obj = new(:href => ref.href, :session => session)
+      obj.refresh 
+      obj
+    end
+    
+    def self.attr_reader *args
+      super *args
+      args.each { |arg| self.class_variable_get(:@@initialize_args) << arg }
+    end
+    
+    def self.attr_writer *args
+      super *args
+      args.each { |arg| self.class_variable_get(:@@initialize_args) << arg }
+    end
+    
+    def self.attr_accessor *args
+      super *args
+      args.each { |arg| self.class_variable_get(:@@initialize_args) << arg }
+    end 
+    
+    private
+    
+    def self.has_type(type)
+      self.class_variable_set(:@@content_type, type)
+    end
+    
+    def initialize_args
+      self.class.class_variable_get(:@@initialize_args)
+    end
+  end
+end

data/lib/vcloud/client.rb

@@ -0,0 +1,117 @@
+module VCloud
+
+  # Handles creating and managing a session in vCloud Director.
+  class Client < BaseVCloudEntity    
+    
+    tag 'Session'
+    has_links
+    attribute :type, String
+    attribute :href, String
+    attribute :user, String
+    attribute :org, String
+    
+    LOGIN = 'login'
+    SESSION = 'sessions'
+    LOGOUT_SESSION = 'session'
+    LOGOUT_HTTP_RESPONSE = 204
+    TOKEN = 'x_vcloud_authorization'.to_sym
+
+    attr_reader :api_version, :url, :token
+    attr_accessor :verify_ssl
+
+    # Create a new client
+    #
+    # @param [String] url API endpoint URL
+    # @param [VCloud::Constants::Version] api_version API version
+    def initialize(url, api_version, opts={}) 
+      @links=[]
+      @url = url.strip
+      @api_version = api_version
+      @token = {}
+      @logged_in = false
+      
+      @verify_ssl = opts[:verify_ssl].nil? ? true : opts[:verify_ssl]
+    end
+
+    # Create a new session and retrieves the session token
+    #
+    # @param [String] username Username to log in with
+    # @param [String] password Password to log in with
+    # @return [Boolean] True if a session token has been generated
+    def login(username, password)
+      return true if @logged_in
+
+      url = @api_version > VCloud::Constants::Version::V0_9 ? @url + SESSION : @url + LOGIN
+
+      response = post(url, nil, nil, self, :user => username, :password => password)
+      parse_xml(response)
+
+      @token = { TOKEN => response.headers[TOKEN] }      
+      @logged_in = true
+            
+      return true
+    end
+  
+    # Returns a hash of of all Org refs keyed by the Org name
+    #
+    # @return [Hash{String => VCloud::Reference}] Reference to all Orgs the user has access to, keyed by Org name
+    def get_org_references_by_name()
+      Hash[get_org_references.collect{ |i| [i.name, i] }]
+    end
+  
+    # Returns an OrgList that contains all of the Orgs the user has access to
+    #
+    # @return [VCloud::OrgList] OrgList that contains all of the Orgs the user has access to
+    def get_org_references()
+      OrgList.from_reference(get_orglist_link, self).org_references
+    end
+    
+    # Retrieves an Org, assuming the user has access to it
+    #
+    # @param [String] name Org name
+    # @return [VCloud::Org] Org object
+    def get_org_from_name(name)
+      orgs = get_org_references_by_name
+      ref = orgs[name] or return nil
+      org = Org.from_reference(ref, self)
+      return org
+    end
+    
+    # Returns the Link object to retrieve an OrgList
+    #
+    # @return [VCloud::Link] Link for the OrgList
+    def get_orglist_link
+      @orglist ||= @links.select {|l| l.type == VCloud::Constants::ContentType::ORG_LIST}.first
+    end
+    
+    # Determins if the user is logged in
+    #
+    # @return [Boolean] True if the user is logged in, otherwise false
+    def logged_in?
+      @logged_in
+    end
+    
+    # Destroy the current session
+    #
+    # @return [Boolean] True if the session was destroyed, false if it could not be destroyed or a session does not exist
+    def logout
+      return false if not logged_in?
+      
+      url = @api_version > VCloud::Constants::Version::V0_9 ? @url + LOGOUT_SESSION : @url + LOGIN
+
+      begin
+        delete(url, nil, nil, self)
+      rescue => error
+        if error.instance_of? VCloud::VCloudError
+          raise error
+        else
+          return false
+        end
+      end
+      
+      @token = nil   
+      @logged_in = false
+      return true
+    end
+  end
+end