virtualbox-ws 0.0.1 → 0.0.2

data/lib/virtualbox/classes/websession_manager.rb

@@ -0,0 +1,33 @@
+module VBox
+  class WebsessionManager < Base
+
+    attr_reader :ref
+
+    def initialize(obj_ref=nil)
+      super
+    end
+
+    def _this
+      _this = {}
+      _this[:ref_i_virtual_box] = @ref
+      _this
+    end
+
+    def logon(args={})
+      ensure_hash(args)
+      key = VBox::WebService.send_request(:i_websession_manager_logon, args)
+      @ref = key
+      VBox::VirtualBox.new(key)
+    end
+
+    def logoff
+      VBox::WebService.send_request(:i_websession_manager_logoff, _this)
+      @ref = nil
+    end
+
+    def get_session_object
+      session = VBox::WebService.send_request(:i_websession_manager_get_session_object, _this)
+      VBox::Session.new(session)
+    end
+  end
+end

data/lib/virtualbox/connection.rb

@@ -1,43 +1,68 @@
 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]
+module VBox
+  module WebService
+    class << self
+      def connect(args={})
+        host = args[:host] || '127.0.0.1'
+        port = args[:port] || '18083'
+        debug = args[:debug] || false
+        savon_debug = args[:savon_debug] || false
+        endpoint = "http://#{host}:#{port}"
+        wsdl = endpoint + '/?wsdl'
+        @conn = Savon.client(:wsdl => wsdl, :endpoint => endpoint, :log => savon_debug, :pretty_print_xml => savon_debug)
+        if @conn.operations.include?(:i_websession_manager_logon)
+          @debug = debug
+          @savon_debug = savon_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
-    end
 
-    def send_request(soap_method, soap_message)
-      response = @conn.call(soap_method, :message => soap_message)
-      parse_response(response)
-    end
+      def send_request(soap_method, soap_message)
+        puts "DEBUG --- REQUEST:  #{soap_method}, #{soap_message}" if @debug
+        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)
+      def debug
+        @debug
+      end
+
+      def debug=(debug)
         @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 savon_debug
+        @debug
+      end
 
-    def debug=(debug)
-      @debug = debug
-      @conn.globals[:log] = debug
-      @conn.globals[:pretty_print_xml] = debug
+      def savon_debug=(savon_debug)
+        @savon_debug = savon_debug
+        @conn.globals[:log] = savon_debug
+        @conn.globals[:pretty_print_xml] = savon_debug
+      end
+
+      private
+      def parse_response(response)
+        puts "DUBUG --- RESPONSE: #{response.body}" if @debug
+        response_struct = response.body[response.body.keys[0]]
+        if response_struct.nil?
+          nil
+        else
+          if response_struct.keys.length > 1
+            returnval = response_struct[:returnval]
+            response_struct.delete(:returnval)
+            [returnval, response_struct]
+          else
+            response_struct[:returnval]
+          end
+        end
+      end
     end
   end
-end
+end

data/virtualbox-ws.gemspec

@@ -1,16 +1,17 @@
 Gem::Specification.new do |s|
   s.name = "virtualbox-ws"
-  s.version = '0.0.1'
+  s.version = '0.0.2'
   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.summary = 'Object-oriented VirtualBox SOAP API wrapper'
+  s.description = 'Object-oriented wrapper that makes using VirtualBox SOAP API (relatively) easier'
   s.license = 'MIT'
 
+  s.add_dependency 'require_all'
   s.add_dependency 'savon'
 
   s.files = `git ls-files`.split("\n")
   s.require_path = 'lib'
-end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: virtualbox-ws
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andriy Yurchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  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'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -24,7 +38,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: API wrapper that makes using VirtualBox SOAP API (relatively) easier
+description: Object-oriented wrapper that makes using VirtualBox SOAP API (relatively)
+  easier
 email:
 - ayurchuk@minuteware.net
 executables: []
@@ -34,25 +49,112 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
+- lib/core_ext/string.rb
 - 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/base.rb
+- lib/virtualbox/classes/additions_facility.rb
+- lib/virtualbox/classes/appliance.rb
+- lib/virtualbox/classes/audio_adapter.rb
+- lib/virtualbox/classes/bandwidth_control.rb
+- lib/virtualbox/classes/bandwidth_group.rb
+- lib/virtualbox/classes/bios_settings.rb
+- lib/virtualbox/classes/console.rb
+- lib/virtualbox/classes/dhcp_server.rb
+- lib/virtualbox/classes/directory.rb
+- lib/virtualbox/classes/display.rb
+- lib/virtualbox/classes/event.rb
+- lib/virtualbox/classes/event_listener.rb
+- lib/virtualbox/classes/event_source.rb
+- lib/virtualbox/classes/events/additions_state_changed_event.rb
+- lib/virtualbox/classes/events/bandwidth_group_changed_event.rb
+- lib/virtualbox/classes/events/can_show_window_event.rb
+- lib/virtualbox/classes/events/clipboard_mode_changed_event.rb
+- lib/virtualbox/classes/events/cpu_changed_event.rb
+- lib/virtualbox/classes/events/cpu_execution_cap_changed_event.rb
+- lib/virtualbox/classes/events/drag_and_drop_mode_changed_event.rb
+- lib/virtualbox/classes/events/event_source_changed_event.rb
+- lib/virtualbox/classes/events/extra_data_can_change_event.rb
+- lib/virtualbox/classes/events/extra_data_changed_event.rb
+- lib/virtualbox/classes/events/guest_keyboard_event.rb
+- lib/virtualbox/classes/events/guest_monitor_changed_event.rb
+- lib/virtualbox/classes/events/guest_mouse_event.rb
+- lib/virtualbox/classes/events/guest_property_changed_event.rb
+- lib/virtualbox/classes/events/host_pci_device_plug_event.rb
+- lib/virtualbox/classes/events/keyboard_leds_changed_event.rb
+- lib/virtualbox/classes/events/machine_data_changed_event.rb
+- lib/virtualbox/classes/events/machine_event.rb
+- lib/virtualbox/classes/events/machine_registered_event.rb
+- lib/virtualbox/classes/events/machine_state_changed_event.rb
+- lib/virtualbox/classes/events/medium_changed_event.rb
+- lib/virtualbox/classes/events/medium_registered_event.rb
+- lib/virtualbox/classes/events/mouse_capability_changed_event.rb
+- lib/virtualbox/classes/events/mouse_pointer_shape_changed_event.rb
+- lib/virtualbox/classes/events/nat_redirect_event.rb
+- lib/virtualbox/classes/events/network_adapter_changed_event.rb
+- lib/virtualbox/classes/events/parallel_port_changed_event.rb
+- lib/virtualbox/classes/events/reusable_event.rb
+- lib/virtualbox/classes/events/runtime_error_event.rb
+- lib/virtualbox/classes/events/serial_port_changed_event.rb
+- lib/virtualbox/classes/events/session_state_changed_event.rb
+- lib/virtualbox/classes/events/shared_folder_changed_event.rb
+- lib/virtualbox/classes/events/show_window_event.rb
+- lib/virtualbox/classes/events/snapshot_changed_event.rb
+- lib/virtualbox/classes/events/snapshot_deleted_event.rb
+- lib/virtualbox/classes/events/snapshot_event.rb
+- lib/virtualbox/classes/events/snapshot_taken_event.rb
+- lib/virtualbox/classes/events/state_changed_event.rb
+- lib/virtualbox/classes/events/storage_controller_changed_event.rb
+- lib/virtualbox/classes/events/storage_device_changed_event.rb
+- lib/virtualbox/classes/events/usb_controller_changed_event.rb
+- lib/virtualbox/classes/events/usb_device_state_changed_event.rb
+- lib/virtualbox/classes/events/v_box_svc_availability_chaged_event.rb
+- lib/virtualbox/classes/events/veto_event.rb
+- lib/virtualbox/classes/events/vrde_server_changed_event.rb
+- lib/virtualbox/classes/events/vrde_server_info_changed_event.rb
+- lib/virtualbox/classes/file.rb
+- lib/virtualbox/classes/fs_obj_info.rb
+- lib/virtualbox/classes/guest.rb
+- lib/virtualbox/classes/guest_directory.rb
+- lib/virtualbox/classes/guest_file.rb
+- lib/virtualbox/classes/guest_fs_obj_info.rb
+- lib/virtualbox/classes/guest_process.rb
+- lib/virtualbox/classes/guest_session.rb
+- lib/virtualbox/classes/host.rb
+- lib/virtualbox/classes/host_network_interface.rb
+- lib/virtualbox/classes/host_usb_device.rb
+- lib/virtualbox/classes/host_usb_device_filter.rb
+- lib/virtualbox/classes/keyboard.rb
+- lib/virtualbox/classes/machine.rb
+- lib/virtualbox/classes/managed_object_ref.rb
+- lib/virtualbox/classes/medium.rb
+- lib/virtualbox/classes/medium_format.rb
+- lib/virtualbox/classes/mouse.rb
+- lib/virtualbox/classes/nat_engine.rb
+- lib/virtualbox/classes/network_adapter.rb
+- lib/virtualbox/classes/parallel_port.rb
+- lib/virtualbox/classes/performance_collector.rb
+- lib/virtualbox/classes/performance_metric.rb
+- lib/virtualbox/classes/process.rb
+- lib/virtualbox/classes/progress.rb
+- lib/virtualbox/classes/serial_port.rb
+- lib/virtualbox/classes/session.rb
+- lib/virtualbox/classes/shared_folder.rb
+- lib/virtualbox/classes/snapshot.rb
+- lib/virtualbox/classes/storage_controller.rb
+- lib/virtualbox/classes/system_properties.rb
+- lib/virtualbox/classes/usb_controller.rb
+- lib/virtualbox/classes/usb_device.rb
+- lib/virtualbox/classes/usb_device_filter.rb
+- lib/virtualbox/classes/vfs_explorer.rb
+- lib/virtualbox/classes/virtual_box.rb
+- lib/virtualbox/classes/virtual_box_error_info.rb
+- lib/virtualbox/classes/virtual_system_description.rb
+- lib/virtualbox/classes/vrde_server.rb
+- lib/virtualbox/classes/vrde_server_info.rb
+- lib/virtualbox/classes/websession_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:
@@ -77,5 +179,5 @@ rubyforge_project:
 rubygems_version: 2.1.4
 signing_key: 
 specification_version: 4
-summary: VirtualBox SOAP API wrapper
+summary: Object-oriented VirtualBox SOAP API wrapper
 test_files: []

data/lib/virtualbox/classes/i_bios_settings.rb

@@ -1,7 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,40 +0,0 @@
-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

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

data/lib/virtualbox/classes/i_medium.rb

@@ -1,13 +0,0 @@
-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