vcloud 0.0.1.1

data/spec/rest_api_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+include WebMock::API
+
+describe VCloud::RestApi do
+  describe 'when receiving an HTTP error code' do
+    it 'should handle a HTTP 401 error when logging in with a bad password' do
+      stub_request(:post, "https://someuser%40someorg:badpassword@some.vcloud.com/api/sessions").
+               with(:headers => {'Accept'=>'application/*+xml;version=1.5', 'Accept-Encoding'=>'gzip, deflate', 'User-Agent'=>'Ruby'}).
+               to_return(:status => 401, :body => "", :headers => {})
+               
+      session = VCloud::Client.new('https://some.vcloud.com/api/', '1.5')             
+      expect { session.login('someuser@someorg', 'badpassword') }.to raise_error(VCloud::VCloudError) { |error| 
+        error.major_error_code.should == 401
+      }
+    end
+    
+    it 'should handle a HTTP 403 error when logging out with a bad token' 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"})
+      
+      session = VCloud::Client.new('https://some.vcloud.com/api/', '1.5')
+      session.login('someuser@someorg', 'password')    
+      
+      stub_request(:delete, "https://some.vcloud.com/api/session").
+        with(:headers => {'Accept'=>'application/*+xml;version=1.5', 'X-Vcloud-Authorization'=>'bad token'}).
+        to_return(:status => 403, :body => "", :headers => {})
+      
+      session.token[:x_vcloud_authorization] = "bad token" 
+      expect { session.logout }.to raise_error(VCloud::VCloudError) { |error| 
+        error.major_error_code.should == 403
+      }
+    end
+    
+    it 'should handle a HTTP 404 error when logging in with a bad API endpoint' do
+      stub_request(:post, "https://someuser%40someorg:password@some.vcloud.com/badapiendpoint/sessions").
+               with(:headers => {'Accept'=>'application/*+xml;version=1.5'}).
+               to_return(:status => 404, :body => fixture_file('error_login_404.html'), :headers => {})
+               
+      session = VCloud::Client.new('https://some.vcloud.com/badapiendpoint/', '1.5')             
+      
+      expect { session.login('someuser@someorg', 'password') }.to raise_error(VCloud::VCloudError) { |error| 
+        error.major_error_code.should == 404
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'webmock/rspec'
+
+require_relative '../lib/vcloud'
+
+RSpec.configure do |config|
+  config.before(:each) {
+    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"})
+             
+    @session = VCloud::Client.new('https://some.vcloud.com/api/', '1.5')
+    @session.login('someuser@someorg', 'password')
+    
+    WebMock.reset!
+  }
+end
+
+def fixture_file(filename)
+  File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
+end

data/spec/task_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+include WebMock::API
+
+describe VCloud::Task do
+  describe 'when parsing #from_xml' do
+    before(:each) do
+      @task = VCloud::Task.from_xml(fixture_file('task.xml'))
+    end
+
+    it 'should have correct values' do
+      @task.name.should == 'task'
+      @task.id.should == 'urn:vcloud:task:5acdbbab-0496-4a57-bf81-cec0be0ae8fb'
+      @task.type.should == 'application/vnd.vmware.vcloud.task+xml'
+      @task.href.should == "https://vcloud.com/api/task/5acdbbab-0496-4a57-bf81-cec0be0ae8fb"
+      @task.status.should == 'running'
+      @task.start_time.should == '2012-10-01T15:31:10.175-04:00'
+      @task.operation_name.should == 'vappUndeployPowerOff'
+      @task.operation.should == 'Stopping Virtual Application (6e2ec079-c533-4d99-8f29-2a90ba18da87)'
+      @task.expiry_time.should == '2012-12-30T15:31:10.175-05:00'
+    end
+  end
+ 
+  describe 'when #wait_to_finish' do
+    before(:each) do
+      @task = VCloud::Task.from_xml(fixture_file('task.xml'))
+      @task.session = @session
+    end
+    
+    it 'should timeout' do
+      stub_request(:get, 'https://vcloud.com/api/task/5acdbbab-0496-4a57-bf81-cec0be0ae8fb').
+        with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.task+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+        to_return(:status => 200, :body => fixture_file('task.xml'))
+      
+      lambda {@task.wait_to_finish(5)}.should raise_error(Timeout::Error)
+    end     
+    
+    it "should consider 'success' complete" do
+      stub_request(:get, 'https://vcloud.com/api/task/5acdbbab-0496-4a57-bf81-cec0be0ae8fb').
+        with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.task+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+        to_return(:status => 200, :body => lambda{|request| t=VCloud::Task.new;t.status='success';t.to_xml})
+        
+       lambda {@task.wait_to_finish(54)}.should_not raise_error(Timeout::Error)
+       @task.status.should == 'success'      
+    end
+    
+    it "should consider 'error' complete" do
+      stub_request(:get, 'https://vcloud.com/api/task/5acdbbab-0496-4a57-bf81-cec0be0ae8fb').
+        with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.task+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+        to_return(:status => 200, :body => lambda{|request| t=VCloud::Task.new;t.status='error';t.to_xml})
+        
+       lambda {@task.wait_to_finish(54)}.should_not raise_error(Timeout::Error)
+       @task.status.should == 'error'      
+    end
+
+    it "should consider 'canceled' complete" do
+      stub_request(:get, 'https://vcloud.com/api/task/5acdbbab-0496-4a57-bf81-cec0be0ae8fb').
+        with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.task+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+        to_return(:status => 200, :body => lambda{|request| t=VCloud::Task.new;t.status='canceled';t.to_xml})
+        
+       lambda {@task.wait_to_finish(54)}.should_not raise_error(Timeout::Error)
+       @task.status.should == 'canceled'      
+    end    
+      
+    it "should consider 'aborted' complete" do
+      stub_request(:get, 'https://vcloud.com/api/task/5acdbbab-0496-4a57-bf81-cec0be0ae8fb').
+        with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.task+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+        to_return(:status => 200, :body => lambda{|request| t=VCloud::Task.new;t.status='aborted';t.to_xml})
+        
+       lambda {@task.wait_to_finish(54)}.should_not raise_error(Timeout::Error)
+       @task.status.should == 'aborted'      
+    end
+  end
+end

data/spec/vapp_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+include WebMock::API
+
+describe VCloud::VApp do
+  
+  before(:each) do
+    @vapp = VCloud::VApp.from_xml(fixture_file('vapp.xml'))
+    @vapp.session = @session
+  end
+  
+  describe 'parses xml #from_xml' do 
+    it 'should have correct values' do
+      @vapp.name.should == "Linux FTP server"
+      @vapp.id.should == 'urn:vcloud:vapp:aaa-bbb-ccc-ddd-eee-fff'
+      @vapp.type.should == 'application/vnd.vmware.vcloud.vApp+xml'
+      @vapp.href.should == "https://some.vcloud.com/api/vApp/vapp-aaa-bbb-ccc-ddd-eee-fff"
+    end
+    
+    it 'should parse links' do
+      @vapp.links.should_not be_nil
+      @vapp.links.should have(14).items
+      
+      @vapp.links.first.type.should == 'application/vnd.vmware.vcloud.vAppNetwork+xml'
+      @vapp.links.first.name.should == 'Dev VLAN'
+      @vapp.links.first.href.should == 'https://some.vcloud.com/api/network/aaa-bbb-ccc-ddd-eee-fff'
+    end
+    
+    it 'should parse tasks' do
+      @vapp.tasks.should_not be_nil
+      @vapp.tasks.should have(1).items
+      @vapp.tasks.first.status.should == 'running'
+      @vapp.tasks.first.operation_name.should == 'vdcInstantiateVapp'
+      @vapp.tasks.first.operation.should == 'Creating Virtual Application Linux FTP server(aaa-bbb-ccc-ddd-eee-fff)'
+      @vapp.tasks.first.expiry_time.should == '2012-12-19T10:40:08.286-05:00'
+      @vapp.tasks.first.name.should == 'task'
+      @vapp.tasks.first.id.should == 'urn:vcloud:task:aaa-bbb-ccc-ddd-eee-fff'
+      @vapp.tasks.first.href.should == 'https://some.vcloud.com/api/task/aaa-bbb-ccc-ddd-eee-fff'
+
+      @vapp.tasks.first.links.should have(1).item
+      @vapp.tasks.first.links.first.rel.should == 'task:cancel'
+      @vapp.tasks.first.links.first.href.should == 'https://some.vcloud.com/api/task/aaa-bbb-ccc-ddd-eee-fff/action/cancel'
+    end
+  end
+  
+  it "retrieves a VApp" do
+    stub_request(:get, 'https://some.vcloud.com/api/vApp/vapp-aaa-bbb-ccc-ddd-eee-fff').
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.vApp+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('vapp.xml'))
+
+    vapp = VCloud::VApp.from_reference(stub(:href => 'https://some.vcloud.com/api/vApp/vapp-aaa-bbb-ccc-ddd-eee-fff'), @session)
+    
+    vapp.name.should == "Linux FTP server"
+    vapp.href.should == 'https://some.vcloud.com/api/vApp/vapp-aaa-bbb-ccc-ddd-eee-fff'
+  end
+  
+  it 'should #power_on' do
+    stub_request(:post, 'https://vcloud.diebold.dev/api/vApp/vapp-1/power/action/powerOn').
+      with(:headers => {'Accept'=>'application/*+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('task.xml'))
+      
+    task = @vapp.power_on
+    task.should_not be_nil
+  end
+  
+  it 'should #remove' do
+    stub_request(:delete, 'https://vcloud.diebold.dev/api/vApp/vapp-1').
+      with(:headers => {'Accept'=>'application/*+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('task.xml'))
+      
+    task = @vapp.remove
+    task.should_not be_nil
+  end
+  
+  it 'should #undeploy' do
+    stub_request(:post, 'https://vcloud.diebold.dev/api/vApp/vapp-1/action/undeploy').
+      with(:headers => {'Content-Type'=>'application/vnd.vmware.vcloud.undeployVAppParams+xml','Accept'=>'application/*+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'},
+           :body => lambda{p=VCloud::UndeployVAppParams.new;p.undeploy_power_action='powerOff';p.to_xml}.call).
+      to_return(:status => 200, :body => fixture_file('task.xml'))
+    
+    task = @vapp.undeploy('powerOff')
+    task.should_not be_nil    
+  end
+  
+end

data/spec/vdc_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+include WebMock::API
+
+describe VCloud::Vdc do
+  before(:each) do
+    @vdc = VCloud::Vdc.from_xml(fixture_file('vdc.xml'))    
+  end
+  
+  describe 'when parsing xml #from_xml' do 
+    it 'should have correct values' do
+      @vdc.name.should == 'TestVDC'
+      @vdc.id.should == 'urn:vcloud:vdc:aaa-bbb-ccc-ddd-eee-fff'
+      @vdc.type.should == 'application/vnd.vmware.vcloud.vdc+xml'
+      @vdc.href.should == 'https://some.vcloud.com/api/vdc/aaa-bbb-ccc-ddd-eee-fff'
+    end
+    
+    it 'should parese a network references' do  
+      @vdc.network_references.should_not be_nil
+      @vdc.network_references.should have(1).items
+      @vdc.network_references.first.name.should == "Dev VLAN"
+      @vdc.network_references.first.href.should == "https://some.vcloud.com/api/network/aaa-bbb-ccc-ddd-eee-fff"
+    end
+    
+    it 'should parse links' do
+      @vdc.links.should_not be_nil
+      @vdc.links.should have(10).items
+      @vdc.links.first.type.should == 'application/vnd.vmware.vcloud.org+xml'
+      @vdc.links.first.href.should == 'https://some.vcloud.com/api/org/aaa-bbb-ccc-ddd-eee-fff'
+    end
+    
+    it 'should #get_network_references_by_name' do
+      refs_by_name = @vdc.get_network_references_by_name
+      refs_by_name.should have(1).items
+      
+      refs_by_name['Dev VLAN'].type.should == 'application/vnd.vmware.vcloud.network+xml'
+      refs_by_name['Dev VLAN'].name.should == 'Dev VLAN'
+      refs_by_name['Dev VLAN'].href.should == 'https://some.vcloud.com/api/network/aaa-bbb-ccc-ddd-eee-fff'
+    end
+  end
+  
+  it "should retrieve VDC #from_reference" do
+    stub_request(:get, "https://some.vcloud.com/api/vdc/aaa-bbb-ccc-ddd-eee-fff").
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.vdc+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('vdc.xml'))
+    
+    vdc = VCloud::Vdc.from_reference(stub(:href => 'https://some.vcloud.com/api/vdc/aaa-bbb-ccc-ddd-eee-fff'), @session)
+    
+    WebMock.should have_requested(:get, 'https://some.vcloud.com/api/vdc/aaa-bbb-ccc-ddd-eee-fff').
+      with(:headers => {'Accept'=>'application/vnd.vmware.vcloud.vdc+xml;version=1.5', 'X-Vcloud-Authorization'=>'abc123xyz'})
+        
+    vdc.id.should == "urn:vcloud:vdc:aaa-bbb-ccc-ddd-eee-fff"
+  end
+  
+  it "should #instantiate_vapp_template" do    
+    net_section = VCloud::NetworkConfigSection.new
+    net_config = VCloud::NetworkConfig.new
+    net_config.network_name = "TestVappNetworkConfigNetwork"
+    net_config.parent_network_reference = VCloud::Reference.new({})
+    net_config.fence_mode = 'bridged'
+    net_section.network_configs << net_config
+
+    vapp_params = VCloud::InstantiateVAppTemplateParams.new
+    vapp_params.name = 'SomeVAppTemplateParams'
+    vapp_params.description = 'some descriptive string'
+    vapp_params.source_reference = VCloud::Reference.new({})
+    vapp_params.network_config_section = net_section
+    
+    stub_request(:post, 'https://some.vcloud.com/api/vdc/aaa-bbb-ccc-ddd-eee-fff/action/instantiateVAppTemplate').
+      with(:headers => {'Accept'=>'application/*+xml;version=1.5', 'Content-Type'=>'application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml', 'X-Vcloud-Authorization'=>'abc123xyz'}).
+      to_return(:status => 200, :body => fixture_file('vapp.xml'))
+    
+    vapp = @vdc.instantiate_vapp_template(vapp_params, @session)
+    
+    WebMock.should have_requested(:post, 'https://some.vcloud.com/api/vdc/aaa-bbb-ccc-ddd-eee-fff/action/instantiateVAppTemplate').
+      with(:headers => {'Accept'=>'application/*+xml;version=1.5', 'Accept-Encoding'=>'gzip, deflate', 'Content-Type'=>'application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml', 'X-Vcloud-Authorization'=>'abc123xyz'})
+  
+    vapp.id.should == 'urn:vcloud:vapp:aaa-bbb-ccc-ddd-eee-fff'
+
+    vapp.session.should == @session
+  end
+  
+end

data/vcloud.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brian McClain", "Zach Robinson"]
+  gem.description   = %q{vCloud Director API Ruby Bindings}
+  gem.summary       = gem.summary
+  gem.homepage      = "https://github.com/DieboldInc/vcloud-ruby"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "vcloud"
+  gem.require_paths = ["lib"]
+  gem.version       = VCloud::VERSION
+  
+  gem.add_dependency "rest-client"
+  gem.add_dependency 'nokogiri-happymapper'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: vcloud
+version: !ruby/object:Gem::Version
+  version: 0.0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian McClain
+- Zach Robinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri-happymapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: vCloud Director API Ruby Bindings
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- examples/hello_vcloud.rb
+- lib/vcloud.rb
+- lib/vcloud/base_vcloud_entity.rb
+- lib/vcloud/client.rb
+- lib/vcloud/constants.rb
+- lib/vcloud/errors.rb
+- lib/vcloud/parses_xml.rb
+- lib/vcloud/rest_api.rb
+- lib/vcloud/user.rb
+- lib/vcloud/user/catalog.rb
+- lib/vcloud/user/catalog_item.rb
+- lib/vcloud/user/error.rb
+- lib/vcloud/user/instantiate_vapp_template_params.rb
+- lib/vcloud/user/link.rb
+- lib/vcloud/user/network_config.rb
+- lib/vcloud/user/network_config_section.rb
+- lib/vcloud/user/org.rb
+- lib/vcloud/user/org_list.rb
+- lib/vcloud/user/reference.rb
+- lib/vcloud/user/task.rb
+- lib/vcloud/user/vapp.rb
+- lib/vcloud/user/vdc.rb
+- lib/version.rb
+- spec/catalog_item_spec.rb
+- spec/catalog_spec.rb
+- spec/client_spec.rb
+- spec/fixtures/catalog.xml
+- spec/fixtures/catalog_item.xml
+- spec/fixtures/error_login_404.html
+- spec/fixtures/instantiate_vapp_template_params.xml
+- spec/fixtures/network_config.xml
+- spec/fixtures/network_config_section.xml
+- spec/fixtures/org.xml
+- spec/fixtures/org_list.xml
+- spec/fixtures/session.xml
+- spec/fixtures/task.xml
+- spec/fixtures/vapp.xml
+- spec/fixtures/vapp_template.xml
+- spec/fixtures/vdc.xml
+- spec/instantiate_vapp_template_params_spec.rb
+- spec/network_config_section_spec.rb
+- spec/network_config_spec.rb
+- spec/org_spec.rb
+- spec/rest_api_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb
+- spec/vapp_spec.rb
+- spec/vdc_spec.rb
+- vcloud.gemspec
+- vendor/cache/addressable-2.3.2.gem
+- vendor/cache/crack-0.3.1.gem
+- vendor/cache/diff-lcs-1.1.3.gem
+- vendor/cache/mime-types-1.19.gem
+- vendor/cache/nokogiri-1.5.5.gem
+- vendor/cache/rake-0.9.2.2.gem
+- vendor/cache/rest-client-1.6.7.gem
+- vendor/cache/rspec-2.11.0.gem
+- vendor/cache/rspec-core-2.11.1.gem
+- vendor/cache/rspec-expectations-2.11.3.gem
+- vendor/cache/rspec-mocks-2.11.3.gem
+- vendor/cache/webmock-1.8.10.gem
+homepage: https://github.com/DieboldInc/vcloud-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1663315438711745401
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/catalog_item_spec.rb
+- spec/catalog_spec.rb
+- spec/client_spec.rb
+- spec/fixtures/catalog.xml
+- spec/fixtures/catalog_item.xml
+- spec/fixtures/error_login_404.html
+- spec/fixtures/instantiate_vapp_template_params.xml
+- spec/fixtures/network_config.xml
+- spec/fixtures/network_config_section.xml
+- spec/fixtures/org.xml
+- spec/fixtures/org_list.xml
+- spec/fixtures/session.xml
+- spec/fixtures/task.xml
+- spec/fixtures/vapp.xml
+- spec/fixtures/vapp_template.xml
+- spec/fixtures/vdc.xml
+- spec/instantiate_vapp_template_params_spec.rb
+- spec/network_config_section_spec.rb
+- spec/network_config_spec.rb
+- spec/org_spec.rb
+- spec/rest_api_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb
+- spec/vapp_spec.rb
+- spec/vdc_spec.rb
+has_rdoc: