virtualbox-ws 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c19d181323956fc9c6a21c66e82471f872f5f09c
+  data.tar.gz: 14ef98271b843289e6d4fcbdc893971ba941a8f9
+SHA512:
+  metadata.gz: 2244297783f0448236657edd24e391d0c70fb68b1d8437a37dfbc14374d7f5c0c235cfd118440532cb4a323edfd2c6c6b8ed0841968c6ad2afb6bd640ee95145
+  data.tar.gz: db8aa2318dbefec7af12b7e18b1d1b98675d471976f5c3d502373f2ffb729fb0e49ec21390f5d2cdaf8d6d9fea712a0f390e192b9d1ac996071521577cd311c5

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'savon'

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akami (1.2.0)
+      gyoku (>= 0.4.0)
+      nokogiri (>= 1.4.0)
+    builder (3.2.2)
+    gyoku (1.1.0)
+      builder (>= 2.1.2)
+    httpi (2.1.0)
+      rack
+      rubyntlm (~> 0.3.2)
+    nokogiri (1.5.10)
+    nori (2.3.0)
+    rack (1.5.2)
+    rubyntlm (0.3.4)
+    savon (2.3.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.1.0)
+      httpi (~> 2.1.0)
+      nokogiri (>= 1.4.0, < 1.6)
+      nori (~> 2.3.0)
+      wasabi (~> 3.2.0)
+    wasabi (3.2.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.0, < 1.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  savon

data/README.md

@@ -0,0 +1,39 @@
+Usage
+-----
+
+First connect to vboxwebsrv service
+```
+irb> VirtualBoxWS.connect
+ => true
+```
+By default it connects to `http://127.0.0.1:18083` but host and port parameters can be passed to the connect method
+explicitly
+
+To operate on the VirtualBox Web Service you need to logon to it.
+```
+irb> web_session = VirtualBoxWS::IWebsessionManager.new
+ => #<VirtualBoxWS::IWebsessionManager:0x0000000383b9b0 @_this={}>
+irb> key = web_session.logon(:username => 'john', :password => 'doe')
+ => "deb9086e1f72ddbf-0000000000000002"
+```
+Having a key we can now create an instance of IVirtualBox class, which is basically the entry point for the whole
+VirtualBox operations scope.
+```
+irb> i_virtualbox = VirtualBoxWS::IVirtualBox.new(key)
+ => #<VirtualBoxWS::IVirtualBox:0x0000000352a028 @_this={:_this=>"deb9086e1f72ddbf-0000000000000002"}>
+```
+Now having an IVirtualBox we are ready to do something useful. The following will create a very basic virtual machine
+```
+irb> machine = i_virtualbox.create_machine(:name => 'JohnDoe')
+ => "deb9086e1f72ddbf-0000000000000003"
+irb> i_virtualbox.register_machine(:machine => machine)
+ => nil
+```
+To start the machine we've just created we first need to create an instance of IMachine passing it our machine's
+object reference. After that we are able to execute launch_vm_process on this instance
+```
+irb> i_machine = VirtualBoxWS::IMachine.new(machine)
+ => #<VirtualBoxWS::IMachine:0x000000047fdee8 @_this={:_this=>"deb9086e1f72ddbf-0000000000000003"}>
+irb> i_machine.launch_vm_process(:session => web_session.get_session_object, :type => 'gui')
+ => "deb9086e1f72ddbf-0000000000000004"
+```

data/lib/virtualbox/classes/i_bios_settings.rb

@@ -0,0 +1,7 @@
+module VirtualBoxWS
+  class IBIOSSettings < IBase
+
+    vb_attr_accessor :logo_fade_in, :logo_fade_out, :logo_display_time, :logo_image_path, :boot_menu_mode,
+                     :acpi_enabled, :ioapic_enabled, :time_offset, :pxe_debug_enabled
+  end
+end

data/lib/virtualbox/classes/i_console.rb

@@ -0,0 +1,16 @@
+module VirtualBoxWS
+  class IConsole < IBase
+
+    vb_attr_reader :machine, :state, :guest, :keyboard, :mouse, :display, :debugger, :usb_devices, :remote_usb_devices,
+                   :shared_folders, :vrde_server_info, :event_source, :attached_pci_devices
+
+    vb_attr_accessor :use_host_clipboard
+
+    vb_method :adopt_saved_state, :attach_usb_device, :create_shared_folder, :delete_snapshot,
+              :delete_snapshot_and_all_children, :delete_snapshot_range, :detach_usb_device, :discard_saved_state,
+              :find_usb_device_by_address, :find_usb_device_by_id, :get_device_activity, :get_guest_entered_acpi_mode,
+              :get_power_button_handled, :pause, :power_button, :power_down, :power_up, :power_up_paused,
+              :remove_shared_folder, :reset, :restore_snapshot, :resume, :save_state, :sleep_button, :take_snapshot,
+              :teleport
+  end
+end

data/lib/virtualbox/classes/i_host.rb

@@ -0,0 +1,15 @@
+module VirtualBoxWS
+  class IHost < IBase
+
+    vb_attr_reader :dvd_drives, :floppy_drives, :usb_devices, :usb_devices_filters, :network_interfaces,
+                   :processor_count, :processor_online_count, :processor_core_count, :memory_size, :memory_available,
+                   :operating_system, :os_version, :utc_time, :accleration_3d_available
+
+    vb_method :create_host_only_network_interface, :create_usb_device_filter, :find_host_dvd_drive,
+              :find_host_floppy_drive, :find_host_network_interface_by_id, :find_host_network_interface_by_name,
+              :find_host_network_interfaces_of_type, :find_usb_device_by_address, :find_usb_device_by_id,
+              :generate_mac_address, :get_processof_cpuid_leaf, :get_processor_description, :get_processor_feature,
+              :get_processor_speed, :insert_usb_device_filter, :remove_host_only_network_interface,
+              :remove_usb_device_filter
+  end
+end

data/lib/virtualbox/classes/i_host_network_interface.rb

@@ -0,0 +1,9 @@
+module VirtualBoxWS
+  class IHostNetworkInterface < IBase
+
+    vb_attr_reader :name, :id, :network_name, :dhcp_enabled, :ip_address, :network_mask, :ipv6_supported, :ipv6_address,
+                   :ipv6_network_mask_prefix_length, :hardware_address, :medium_type, :status, :interface_type
+
+    vb_method :dycp_rediscover, :enable_dynamic_ip_config, :enable_static_ip_config, :enable_static_ip_config_v6
+  end
+end

data/lib/virtualbox/classes/i_machine.rb

@@ -0,0 +1,40 @@
+module VirtualBoxWS
+  class IMachine < IBase
+
+    vb_attr_reader :parent, :accessible, :access_error, :id, :bios_settings, :vrde_server, :medium_attachments,
+                   :usb_controller, :audio_adapter, :storage_controllers, :settings_file_path, :settings_modified,
+                   :session_state, :session_type, :sessio_pid, :state, :last_state_change, :state_file_path,
+                   :log_folder, :current_snapshot, :snaphot_count, :current_state_modified, :shared_folders,
+                   :pci_devices_assignments, :bandwidth_control
+
+    vb_attr_accessor :name, :description, :groups, :os_type_id, :hardware_version, :hardware_uuid, :cpu_count,
+                     :cpu_hot_plug_enabled, :cpu_execution_cap, :memory_size, :memory_balloon_size,
+                     :page_fusion_enabled, :vram_size, :accelerate_3d_enabled, :accelerate_2d_video_enabled,
+                     :monitor_count, :video_capture_enabled, :video_capture_file, :video_capture_width,
+                     :video_capture_height, :firmware_type, :pointing_hid_type, :keyboard_hid_type, :hpet_enabled,
+                     :chipset_type, :snapshot_folder, :emulated_usb_webcamera_enabled,
+                     :emulated_usb_card_reader_enabled, :clipboard_mode, :drag_and_drop_mode,
+                     :guest_proprty_notificaton_patterns, :teleporter_enabled, :teleporter_port, :teleporter_address,
+                     :teleporter_password, :fault_tolerance_state, :fault_tolerance_port, :fault_tolerance_address,
+                     :fault_tolerance_password, :fault_tolerance_sync_interval, :rtc_use_utc, :io_cache_enabled,
+                     :io_cache_size, :io_cache_size, :tracing_enabled, :tracing_config, :allow_tracing_to_access_vm,
+                     :autostart_enabled, :autostart_delay, :autostop_type
+
+    vb_method :add_storage_controller, :attach_device, :attach_device_without_medium, :attach_host_pci_device,
+              :can_show_console_window, :clone_to, :create_shared_folder, :delete, :delete_guest_property,
+              :detach_device, :detach_host_pci_device, :discard_settings, :enumerate_guest_properties, :export,
+              :find_snapshot, :get_boot_order, :get_cpuid_leaf, :get_cpu_property, :get_cpu_status, :get_extra_data,
+              :get_extra_data_keys, :get_guest_property, :get_guest_property_timestamp, :get_guest_property_value,
+              :get_hw_virt_ex_property, :get_medium, :get_medium_attachment, :get_medium_attachments_of_controller,
+              :get_network_adapter, :get_parallel_port, :get_serial_port, :get_storage_controller_by_instance,
+              :get_storage_controller_by_name, :hot_plug_cpu, :hot_unplug_cpu, :launch_vm_process, :lock_machine,
+              :mount_medium, :non_rotational_device, :passthrough_device, :query_log_filename,
+              :query_saved_guest_screen_info, :query_saved_screnshot_png_size, :query_saved_thumbnail_size, :read_log,
+              :read_saved_screenshot_png_to_array, :read_saved_thumbnail_png_to_array, :read_saved_thumbnail_to_array,
+              :reamove_all_cpuid_leaves, :remove_cpuid_leaf, :remove_shared_folder, :remove_storage_controller,
+              :save_settings, :set_auto_discard_for_device, :set_bandwidth_group_for_device, :set_boot_order,
+              :set_cpuid_leaf, :set_cpu_property, :set_extra_data, :set_guest_property, :set_guest_property_value,
+              :set_hw_virt_ex_property, :set_no_bandwidth_group_for_device, :set_storage_controller_bootable,
+              :show_console_window, :temporary_eject_device, :unmount_medium, :unregister
+  end
+end

data/lib/virtualbox/classes/i_managed_object_ref.rb

@@ -0,0 +1,6 @@
+module VirtualBoxWS
+  class IManagedObjectRef < IBase
+
+    vb_method :get_interface_name, :release
+  end
+end

data/lib/virtualbox/classes/i_medium.rb

@@ -0,0 +1,13 @@
+module VirtualBoxWS
+  class IMedium < IBase
+
+    vb_attr_reader :id, :state, :name, :device_type, :host_drive, :size, :format, :medium_format, :allowed_types,
+                   :parent, :children, :base, :read_only, :logical_size, :last_access_error, :machine_ids
+
+    vb_attr_accessor :description, :location, :type, :auto_reset
+
+    vb_method :clone_to, :clone_to_base, :close, :cpmpact, :create_base_storage, :create_diff_storage, :delete_storage,
+              :get_properties, :get_property, :get_snapshot_ids, :lock_read, :lock_write, :merge_to, :refresh_state,
+              :reset, :resize, :set_ids, :set_properties, :set_property, :unlock_read, :unlock_write
+  end
+end

data/lib/virtualbox/classes/i_medium_format.rb

@@ -0,0 +1,6 @@
+module VirtualBoxWS
+  class IMediumFormat < IBase
+    vb_attr_reader :id, :name, :capabilities
+    vb_method :describe_file_extensions, :describe_properties
+  end
+end

data/lib/virtualbox/classes/i_network_adapter.rb

@@ -0,0 +1,12 @@
+module VirtualBoxWS
+  class INetworkAdapter < IBase
+
+    vb_attr_reader :slot, :nat_engine
+
+    vb_attr_accessor :adapter_type, :enabled, :mac_address, :attachment_type, :bridged_interface, :host_only_interface,
+                     :internal_network, :nat_network, :generic_driver, :cable_connected, :line_speed,
+                     :promisc_mode_policy, :trace_enabled, :trace_file, :boot_proirity, :bandwidth_group
+
+    vb_method :get_properties, :get_property, :set_property
+  end
+end

data/lib/virtualbox/classes/i_session.rb

@@ -0,0 +1,6 @@
+module VirtualBoxWS
+  class ISession < IBase
+    vb_attr_reader :state, :type, :machine, :console
+    vb_method :unlock_machine
+  end
+end

data/lib/virtualbox/classes/i_system_properties.rb

@@ -0,0 +1,18 @@
+module VirtualBoxWS
+  class ISystemProperties < IBase
+
+    vb_attr_reader :min_guest_ram, :max_guest_ram, :min_guest_vram, :max_guest_vram, :min_guest_cpu_count,
+                   :max_guest_cpu_count, :max_guest_monitors, :info_vd_size, :serial_port_count, :parallel_port_count,
+                   :max_boot_position, :meduim_formats, :default_audio_driver
+
+    vb_attr_accessor :default_machine_folder, :default_hard_disk_format, :free_disk_space_warning,
+                     :free_disk_space_percent_warning, :free_disk_space_error, :free_disk_space_percent_error,
+                     :vrde_auth_library, :web_service_auth_library, :default_vrde_ext_pack, :log_history_count,
+                     :autostart_database_path, :default_additional_iso
+
+    vb_method :get_default_io_cache_setting_for_storage_controller, :get_device_types_for_storage_bus,
+              :get_max_devices_per_port_for_storage_bus, :get_max_instances_of_storage_bus, :get_max_network_adapters,
+              :get_max_network_adapters_of_type, :get_max_port_count_for_storage_bus,
+              :get_min_port_count_for_storage_bus
+  end
+end

data/lib/virtualbox/classes/i_virtualbox.rb

@@ -0,0 +1,17 @@
+module VirtualBoxWS
+  class IVirtualBox < IBase
+
+    vb_attr_reader :version, :version_normalized, :revision, :package_type, :api_version, :home_folder,
+                   :settings_file_path, :host, :system_properties, :machines, :machine_groups, :hard_disks, :dvd_images,
+                   :floppy_images, :progress_operations, :guest_os_types, :shared_folders, :performance_collector,
+                   :dhcp_servers, :event_source, :internal_networks, :generic_network_drivers
+
+    vb_method :check_firmware_present, :compose_machine_filename, :create_appliance, :create_dhcp_server,
+              :create_hard_disk, :create_machine, :create_shared_folder, :find_dhcp_server_by_network_name,
+              :find_machine, :get_extra_data, :get_extra_data_keys, :get_guest_os_types, :get_machine_states,
+              :get_machines_by_groups, :open_machine, :open_medium, :register_machine, :remove_dhcp_server,
+              :remove_shared_folder, :set_extra_data, :set_settings_secret
+  end
+end
+
+

data/lib/virtualbox/classes/i_web_session_manager.rb

@@ -0,0 +1,21 @@
+module VirtualBoxWS
+  class IWebsessionManager < IBase
+
+    vb_method :get_session_object
+
+    def initialize(obj_ref=nil)
+      super
+    end
+
+    def logon(args={})
+      key = VirtualBoxWS.send_request(:i_websession_manager_logon, args)
+      @_this[:ref_i_virtual_box] = key
+    end
+
+    def logoff
+      VirtualBoxWS.send_request(:i_websession_manager_logoff, @_this)
+      @_this = {}
+      nil
+    end
+  end
+end

data/lib/virtualbox/connection.rb

@@ -0,0 +1,43 @@
+require 'savon'
+
+
+module VirtualBoxWS
+  class << self
+    def parse_response(response)
+      if response.body[response.body.keys[0]].nil?
+        nil
+      else
+        response.body[response.body.keys[0]][:returnval]
+      end
+    end
+
+    def send_request(soap_method, soap_message)
+      response = @conn.call(soap_method, :message => soap_message)
+      parse_response(response)
+    end
+
+    def connect(host='127.0.0.1', port='18083', debug=false)
+      endpoint = "http://#{host}:#{port}"
+      wsdl = endpoint + '/?wsdl'
+      @conn = Savon.client(:wsdl => wsdl, :endpoint => endpoint, :log => debug, :pretty_print_xml => debug)
+      if @conn.operations.include?(:i_websession_manager_logon)
+        @debug = debug
+        true
+      else
+        raise "Could not connect to VirtualBox SOAP Web Service at #{endpoint} (No VirtualBox SOAP service found)"
+      end
+    rescue Errno::ECONNREFUSED
+      raise "Could not connect to VirtualBox SOAP Web Service at #{endpoint} (Connection refused)"
+    end
+
+    def debug
+      @debug
+    end
+
+    def debug=(debug)
+      @debug = debug
+      @conn.globals[:log] = debug
+      @conn.globals[:pretty_print_xml] = debug
+    end
+  end
+end

data/lib/virtualbox/core_ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  def to_underscore
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+  end
+end

data/lib/virtualbox/enumerations.rb

@@ -0,0 +1,6 @@
+module VirtualBoxWS
+  DEVICE_TYPE = %w(Null Floppy DVD HardDisk Network USB SharedFolder)
+  NETWORK_ADAPTER_TYPE = %w(Null Am79C970A Am79C973 I82540EM I82543GC I82545EM Virtio)
+  NETWORK_ATTACHMENT_TYPE = %w(Null NAT Bridged Internal HostOnly Generic)
+  STORAGE_BUS = %w(Null IDE SATA SCSI Floppy SAS)
+end

data/lib/virtualbox/i_base.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/core_ext/string')
+
+
+module VirtualBoxWS
+  class IBase
+    def initialize(obj_ref)
+      @_this = {}
+      @_this[:_this] = obj_ref unless obj_ref.nil?
+    end
+
+    def self.vb_attr_accessor(*vb_attrs)
+      vb_attrs.each do |vb_attr|
+        define_method(vb_attr) do
+          soap_method = "#{self.class.name.split('::').last.to_underscore}_get_#{vb_attr}".to_sym
+          VirtualBoxWS.send_request(soap_method, @_this)
+        end
+
+        define_method("#{vb_attr}=") do |value|
+          soap_method = "#{self.class.name.split('::').last.to_underscore}_set_#{vb_attr}".to_sym
+          # A hack for tags that start with an uppercase character
+          if vb_attr == :ioapic_enabled
+            soap_message = {'IOAPICEnabled' => value}
+          elsif vb_attr == :cpu_count
+            soap_message = {'CPUCount' => value}
+          else
+            soap_message = {vb_attr => value}
+          end
+          VirtualBoxWS.send_request(soap_method, @_this.merge(soap_message))
+        end
+      end
+    end
+
+    def self.vb_attr_reader(*vb_attrs)
+      vb_attrs.each do |vb_attr|
+        define_method(vb_attr) do
+          soap_method = "#{self.class.name.split('::').last.to_underscore}_get_#{vb_attr}".to_sym
+          VirtualBoxWS.send_request(soap_method, @_this)
+        end
+      end
+    end
+
+    def self.vb_method(*vb_meths)
+      vb_meths.each do |vb_meth|
+        define_method(vb_meth) do |message={}|
+          soap_method = "#{self.class.name.split('::').last.to_underscore}_#{vb_meth}".to_sym
+          VirtualBoxWS.send_request(soap_method, @_this.merge(message))
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox-ws.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/virtualbox/connection')
+require File.expand_path(File.dirname(__FILE__) + '/virtualbox/i_base')
+require File.expand_path(File.dirname(__FILE__) + '/virtualbox/enumerations')
+
+classes_dir = File.expand_path(File.dirname(__FILE__)) + '/virtualbox/classes/*.rb'
+Dir[classes_dir].each { |file| require file }

data/virtualbox-ws.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = "virtualbox-ws"
+  s.version = '0.0.1'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Andriy Yurchuk']
+  s.email = ['ayurchuk@minuteware.net']
+  s.homepage = 'https://github.com/Ch00k/virtualbox-ws'
+  s.summary = 'VirtualBox SOAP API wrapper'
+  s.description = 'API wrapper that makes using VirtualBox SOAP API (relatively) easier'
+  s.license = 'MIT'
+
+  s.add_dependency 'savon'
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: virtualbox-ws
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andriy Yurchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API wrapper that makes using VirtualBox SOAP API (relatively) easier
+email:
+- ayurchuk@minuteware.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/virtualbox-ws.rb
+- lib/virtualbox/classes/i_bios_settings.rb
+- lib/virtualbox/classes/i_console.rb
+- lib/virtualbox/classes/i_host.rb
+- lib/virtualbox/classes/i_host_network_interface.rb
+- lib/virtualbox/classes/i_machine.rb
+- lib/virtualbox/classes/i_managed_object_ref.rb
+- lib/virtualbox/classes/i_medium.rb
+- lib/virtualbox/classes/i_medium_format.rb
+- lib/virtualbox/classes/i_network_adapter.rb
+- lib/virtualbox/classes/i_session.rb
+- lib/virtualbox/classes/i_system_properties.rb
+- lib/virtualbox/classes/i_virtualbox.rb
+- lib/virtualbox/classes/i_web_session_manager.rb
+- lib/virtualbox/connection.rb
+- lib/virtualbox/core_ext/string.rb
+- lib/virtualbox/enumerations.rb
+- lib/virtualbox/i_base.rb
+- virtualbox-ws.gemspec
+homepage: https://github.com/Ch00k/virtualbox-ws
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.4
+signing_key: 
+specification_version: 4
+summary: VirtualBox SOAP API wrapper
+test_files: []