virtualbox-ws 0.0.3 → 0.0.5

data/lib/virtualbox/classes/virtual_box.rb

@@ -1,240 +1,54 @@
 module VBox
   class VirtualBox < Base
 
-    # Attributes
+    vb_attr :version
+    vb_attr :version_normalized
+    vb_attr :revision
+    vb_attr :package_type
+    vb_attr :api_version
+    vb_attr :home_folder
+    vb_attr :settings_file_path
+    vb_attr :host
+    vb_attr :system_properties
+    vb_attr :machines, :force_array => true
+    vb_attr :machine_groups, :force_array => true
+    vb_attr :hard_disks, :force_array => true
+    vb_attr :dvd_images, :force_array => true
+    vb_attr :floppy_images, :force_array => true
+    vb_attr :progress_operations, :force_array => true
+    vb_attr :guest_os_types
+    vb_attr :shared_folders, :force_array => true
+    vb_attr :performance_collector
+    vb_attr :dhcp_servers, :force_array => true
+    vb_attr :nat_networks, :force_array => true
+    vb_attr :event_source
+    vb_attr :internal_networks, :force_array => true
+    vb_attr :generic_network_drivers, :force_array => true
+
+    vb_method :check_firmware_present
+    vb_method :compose_machine_filename
+    vb_method :create_appliance
+    vb_method :create_dhcp_server
+    vb_method :create_hard_disk
+    vb_method :create_machine
+    vb_method :create_nat_network
+    vb_method :create_shared_folder
+    vb_method :find_dhcp_server_by_network_name
+    vb_method :find_machine
+    vb_method :find_nat_network_by_name
+    vb_method :get_extra_data
+    vb_method :get_extra_data_keys, :force_array => true
+    vb_method :get_guest_os_type
+    vb_method :get_machine_states, :force_array => true
+    vb_method :get_machines_by_groups, :force_array => true
+    vb_method :open_machine
+    vb_method :open_medium
+    vb_method :register_machine
+    vb_method :remove_dhcp_server
+    vb_method :remove_nat_network
+    vb_method :remove_shared_folder
+    vb_method :set_extra_data
+    vb_method :remove_settings_secret
 
-    def version
-      VBox::WebService.send_request(:i_virtual_box_get_version, _this)
-    end
-
-    def version_normalized
-      VBox::WebService.send_request(:i_virtual_box_get_version_normalized, _this)
-    end
-
-    def revision
-      VBox::WebService.send_request(:i_virtual_box_get_revision, _this)
-    end
-
-    def package_type
-      VBox::WebService.send_request(:i_virtual_box_get_package_type, _this)
-    end
-
-    def api_version
-      VBox::WebService.send_request(:i_virtual_box_get_api_version, _this)
-    end
-
-    def home_folder
-      VBox::WebService.send_request(:i_virtual_box_get_home_folder, _this)
-    end
-
-    def settings_file_path
-      VBox::WebService.send_request(:i_virtual_box_get_settings_file_path, _this)
-    end
-
-    def host
-      host = VBox::WebService.send_request(:i_virtual_box_get_host, _this)
-      VBox::Host.new(host)
-    end
-
-    def system_properties
-      system_properties = VBox::WebService.send_request(:i_virtual_box_get_system_properties, _this)
-      VBox::SystemProperties.new(system_properties)
-    end
-
-    def machines
-      machines = VBox::WebService.send_request(:i_virtual_box_get_machines, _this)
-      machines.to_a.map do |machine|
-        VBox::Machine.new(machine)
-      end
-    end
-
-    def machine_groups
-      VBox::WebService.send_request(:i_virtual_box_get_machine_groups, _this)
-    end
-
-    def hard_disks
-      hard_disks = VBox::WebService.send_request(:i_virtual_box_get_hard_disks, _this)
-      hard_disks.to_a.map do |hard_disk|
-        VBox::Medium.new(hard_disk)
-      end
-    end
-
-    def dvd_images
-      dvd_images = VBox::WebService.send_request(:i_virtual_box_get_dvd_images, _this)
-      dvd_images.to_a.map do |dvd_image|
-        VBox::Medium.new(dvd_image)
-      end
-    end
-
-    def floppy_images
-      floppy_images = VBox::WebService.send_request(:i_virtual_box_get_floppy_images, _this)
-      floppy_images.to_a.map do |floppy_image|
-        VBox::Medium.new(floppy_image)
-      end
-    end
-
-    def progress_operations
-      progress_operations = VBox::WebService.send_request(:i_virtual_box_get_progress_operations, _this)
-      progress_operations.to_a.map do |progress_operation|
-        VBox::Progress.new(progress_operation)
-      end
-    end
-
-    def guest_os_types
-      VBox::WebService.send_request(:i_virtual_box_get_guest_os_types, _this)
-    end
-
-    def shared_folders
-      shared_folders = VBox::WebService.send_request(:i_virtual_box_get_shared_folders, _this)
-      shared_folders.to_a.map do |shared_folder|
-        VBox::SharedFolder.new(shared_folder)
-      end
-    end
-
-    def performance_collector
-      performance_collector = VBox::WebService.send_request(:i_virtual_box_get_performance_collector, _this)
-      VBox::PerformanceCollector.new(performance_collector)
-    end
-
-    def dhcp_servers
-      dhcp_servers = VBox::WebService.send_request(:i_virtual_box_get_dhcp_server, _this)
-      dhcp_servers.to_a.map do |dhcp_server|
-        VBox::DHCPServer.new(dhcp_server)
-      end
-    end
-
-    def event_source
-      event_source = VBox::WebService.send_request(:i_virtual_box_get_event_source, _this)
-      VBox::EventSource.new(event_source)
-    end
-
-    def internal_networks
-      VBox::WebService.send_request(:i_virtual_box_get_internal_networks, _this)
-    end
-
-    def generic_network_drivers
-      VBox::WebService.send_request(:i_virtual_box_get_generic_network_drivers, _this)
-    end
-
-    # Methods
-
-    def check_firmware_present(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_check_firmware_present, _this.merge(args))
-    end
-
-    def compose_machine_filename(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_compose_machine_filename, _this.merge(args))
-    end
-
-    def create_appliance
-      appliance = VBox::WebService.send_request(:i_virtual_box_create_appliance, _this)
-      VBox::Appliance.new(appliance)
-    end
-
-    def create_dhcp_server(args={})
-      ensure_hash args
-      dhcp_server = VBox::WebService.send_request(:i_virtual_box_create_dhcp_server, _this.merge(args))
-      VBox::DHCPServer.new(dhcp_server)
-    end
-
-    def create_hard_disk(args={})
-      ensure_hash args
-      hard_disk = VBox::WebService.send_request(:i_virtual_box_create_hard_disk, _this.merge(args))
-      VBox::Medium.new(hard_disk)
-    end
-
-    def create_machine(args={})
-      ensure_hash args
-      machine = VBox::WebService.send_request(:i_virtual_box_create_machine, _this.merge(args))
-      VBox::Machine.new(machine)
-    end
-
-    def create_shared_folder(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_create_shared_folder, _this.merge(args))
-    end
-
-    def find_dhcp_server_by_network_name(args={})
-      ensure_hash args
-      dhcp_server = VBox::WebService.send_request(:i_virtual_box_find_dhcp_server_by_network_name, _this.merge(args))
-      VBox::DHCPServer.new(dhcp_server)
-    end
-
-    def find_machine(args={})
-      ensure_hash args
-      machine = VBox::WebService.send_request(:i_virtual_box_find_machine, _this.merge(args))
-      VBox::Machine.new(machine)
-    end
-
-    def get_extra_data(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_get_extra_data, _this.merge(args))
-    end
-
-    def get_extra_data_keys
-      VBox::WebService.send_request(:i_virtual_box_get_extra_data_keys, _this)
-    end
-
-    def get_guest_os_type(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_get_guest_os_type, _this.merge(args))
-    end
-
-    def get_machine_states(args={})
-      ensure_hash args
-      if args.has_key?(:machines)
-        args[:machines].map! do |machine|
-          machine.ref
-        end
-      end
-      VBox::WebService.send_request(:i_virtual_box_get_machine_states, _this.merge(args))
-    end
-
-    def get_machines_by_groups(args={})
-      ensure_hash args
-      machines = VBox::WebService.send_request(:i_virtual_box_get_machines_by_groups, _this.merge(args))
-      machines.to_a.map do |machine|
-        VBox::Machine.new(machine)
-      end
-    end
-
-    def open_machine(args={})
-      ensure_hash args
-      machine = VBox::WebService.send_request(:i_virtual_box_open_machine, _this.merge(args))
-      VBox::Machine.new(machine)
-    end
-
-    def open_medium
-      medium = VBox::WebService.send_request(:i_virtual_box_open_medium, _this.merge(args))
-      VBox::Medium.new(medium)
-    end
-
-    def register_machine(args={})
-      ensure_hash args
-      args[:machine] = args[:machine].ref
-      VBox::WebService.send_request(:i_virtual_box_register_machine, _this.merge(args))
-    end
-
-    def remove_dhcp_server(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_remove_dhcp_server, _this.merge(args))
-    end
-
-    def remove_shared_folder(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_remove_shared_folder, _this.merge(args))
-    end
-
-    def set_extra_data(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_set_extra_data, _this.merge(args))
-    end
-
-    def set_settings_secret(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_box_set_settings_secret, _this.merge(args))
-    end
   end
 end

data/lib/virtualbox/classes/virtual_box_error_info.rb

@@ -1,27 +1,12 @@
 module VBox
   class VirtualBoxErrorInfo < Base
 
-    # Attributes
+    vb_attr :result_code
+    vb_attr :result_detail
+    vb_attr :interface_id
+    vb_attr :component
+    vb_attr :text
+    vb_attr :next
 
-    def result_code
-      VBox::WebService.send_request(:i_virtual_box_error_info_get_result_code, _this)
-    end
-
-    def interface_id
-      VBox::WebService.send_request(:i_virtual_box_error_info_get_interface_id, _this)
-    end
-
-    def component
-      VBox::WebService.send_request(:i_virtual_box_error_info_get_component, _this)
-    end
-
-    def text
-      VBox::WebService.send_request(:i_virtual_box_error_info_get_text, _this)
-    end
-
-    def next
-      virtual_box_error_info = VBox::WebService.send_request(:i_virtual_box_error_info_get_next, _this)
-      VBox::VirtualBoxErrorInfo.new(virtual_box_error_info)
-    end
   end
 end

data/lib/virtualbox/classes/virtual_system_description.rb

@@ -1,36 +1,12 @@
 module VBox
   class VirtualSystemDescription < Base
 
-    # Attributes
+    vb_attr :count
+    vb_method :add_description
+    vb_method :get_description
+    vb_method :get_description_by_type
+    vb_method :get_values_by_type
+    vb_method :set_final_values
 
-    def count
-      VBox::WebService.send_request(:i_virtual_system_description_get_count, _this)
-    end
-
-    # Methods
-
-    def add_description(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_system_description_add_description, _this)
-    end
-
-    def get_description
-      VBox::WebService.send_request(:i_virtual_system_description_get_description, _this)
-    end
-
-    def get_description_by_type(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_system_description_get_description_by_type, _this)
-    end
-
-    def get_values_by_type(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_system_description_get_values_by_type, _this)
-    end
-
-    def set_final_values(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:i_virtual_system_description_set_final_values, _this)
-    end
   end
 end

data/lib/virtualbox/classes/vrde_server.rb

@@ -1,78 +1,17 @@
 module VBox
   class VRDEServer < Base
 
-    # Attributes
+    vb_attr :enabled
+    vb_attr :auth_type
+    vb_attr :auth_timeout
+    vb_attr :allow_multi_connection
+    vb_attr :reuse_single_connection
+    vb_attr :vrde_ext_pack, :force_tag => 'VRDEExtPack'
+    vb_attr :auth_library
+    vb_attr :vrde_properties
+
+    vb_method :get_vrde_property
+    vb_method :set_vrde_property
 
-    def enabled
-      VBox::WebService.send_request(:ivrde_server_get_enabled, _this)
-    end
-
-    def enabled=(enabled)
-      VBox::WebService.send_request(:ivrde_server_set_enabled, _this.merge(:enabled => enabled))
-    end
-
-    def auth_type
-      VBox::WebService.send_request(:ivrde_server_get_auth_type, _this)
-    end
-
-    def auth_type=(auth_type)
-      VBox::WebService.send_request(:ivrde_server_set_auth_type, _this.merge(:auth_type => auth_type))
-    end
-
-    def auth_timeout
-      VBox::WebService.send_request(:ivrde_server_get_auth_timeout, _this)
-    end
-
-    def auth_timeout=(auth_timeout)
-      VBox::WebService.send_request(:ivrde_server_set_auth_timeout, _this.merge(:auth_timeout => auth_timeout))
-    end
-
-    def allow_multi_connection
-      VBox::WebService.send_request(:ivrde_server_get_allow_multi_connection, _this)
-    end
-
-    def allow_multi_connection=(allow_multi_connection)
-      VBox::WebService.send_request(:ivrde_server_set_allow_multi_connection, _this.merge(:allow_multi_connection => allow_multi_connection))
-    end
-
-    def reuse_single_connection
-      VBox::WebService.send_request(:ivrde_server_get_reuse_single_connection, _this)
-    end
-
-    def reuse_single_connection=(reuse_single_connection)
-      VBox::WebService.send_request(:ivrde_server_set_reuse_single_connection, _this.merge(:reuse_single_connection => reuse_single_connection))
-    end
-
-    def vrde_ext_pack
-      VBox::WebService.send_request(:ivrde_server_get_vrde_ext_pack, _this)
-    end
-
-    def vrde_ext_pack=(vrde_ext_pack)
-      VBox::WebService.send_request(:ivrde_server_set_vrde_ext_pack, _this.merge(:vrde_ext_pack => vrde_ext_pack))
-    end
-
-    def auth_library
-      VBox::WebService.send_request(:ivrde_server_get_auth_library, _this)
-    end
-
-    def auth_library=(auth_library)
-      VBox::WebService.send_request(:ivrde_server_set_auth_library, _this.merge(:auth_library => auth_library))
-    end
-
-    def vrde_properties
-      VBox::WebService.send_request(:ivrde_server_get_vrde_properties, _this)
-    end
-
-    # Methods
-
-    def get_vrde_property(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:ivrde_server_get_vrde_property, _this.merge(args))
-    end
-
-    def set_vrde_property(args={})
-      ensure_hash args
-      VBox::WebService.send_request(:ivrde_server_set_vrde_property, _this.merge(args))
-    end
   end
 end

data/lib/virtualbox/classes/vrde_server_info.rb

@@ -1,66 +1,21 @@
 module VBox
   class VRDEServerInfo < Base
 
-    # Attributes
+    vb_attr :active
+    vb_attr :port
+    vb_attr :number_of_clients
+    vb_attr :begin_time
+    vb_attr :end_time
+    vb_attr :bytes_sent
+    vb_attr :bytes_sent_total
+    vb_attr :bytes_received
+    vb_attr :bytes_received_total
+    vb_attr :user
+    vb_attr :domain
+    vb_attr :client_name
+    vb_attr :client_ip
+    vb_attr :client_version
+    vb_attr :encryption_style
 
-    def active
-      VBox::WebService.send_request(:ivrde_server_info_get_active, _this)
-    end
-
-    def port
-      VBox::WebService.send_request(:ivrde_server_info_get_port, _this)
-    end
-
-    def number_of_clients
-      VBox::WebService.send_request(:ivrde_server_info_get_number_of_clients, _this)
-    end
-
-    def begin_time
-      VBox::WebService.send_request(:ivrde_server_info_get_begin_time, _this)
-    end
-
-    def end_time
-      VBox::WebService.send_request(:ivrde_server_info_get_end_time, _this)
-    end
-
-    def bytes_sent
-      VBox::WebService.send_request(:ivrde_server_info_get_active, _this)
-    end
-
-    def bytes_sent_total
-      VBox::WebService.send_request(:ivrde_server_info_get_bytes_sent_total, _this)
-    end
-
-    def bytes_received
-      VBox::WebService.send_request(:ivrde_server_info_get_bytes_received, _this)
-    end
-
-    def bytes_received_total
-      VBox::WebService.send_request(:ivrde_server_info_get_bytes_receied_total, _this)
-    end
-
-    def user
-      VBox::WebService.send_request(:ivrde_server_info_get_user, _this)
-    end
-
-    def domain
-      VBox::WebService.send_request(:ivrde_server_info_get_domain, _this)
-    end
-
-    def client_name
-      VBox::WebService.send_request(:ivrde_server_info_get_client_name, _this)
-    end
-
-    def client_ip
-      VBox::WebService.send_request(:ivrde_server_info_get_client_ip, _this)
-    end
-
-    def client_version
-      VBox::WebService.send_request(:ivrde_server_info_get_client_version, _this)
-    end
-
-    def encryption_style
-      VBox::WebService.send_request(:ivrde_server_info_get_encryption_style, _this)
-    end
   end
 end

data/lib/virtualbox/classes/websession_manager.rb

@@ -1,8 +1,10 @@
 module VBox
   class WebsessionManager < Base
 
-    def initialize(obj_ref=nil)
-      super
+    def initialize
+      WebService.connect
+      @ref = nil
+      require_rel '/../classes'
     end
 
     def _this
@@ -13,21 +15,19 @@ module VBox
 
     # Methods
 
-    def logon(args={})
-      ensure_hash args
-      key = VBox::WebService.send_request(:i_websession_manager_logon, args)
+    def logon
+      args = Hash[:username => WebService.configuration.vboxweb_user,
+                  :password => WebService.configuration.vboxweb_pass]
+      key = WebService.send_request(:i_websession_manager_logon, args)
       @ref = key
-      VBox::VirtualBox.new(key)
+      VirtualBox.new(key)
     end
 
     def logoff
-      VBox::WebService.send_request(:i_websession_manager_logoff, _this)
+      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
+    vb_method :get_session_object
   end
 end

data/lib/virtualbox/configuration.rb

@@ -0,0 +1,35 @@
+require 'logger'
+
+
+module VBox
+  module WebService
+    class Configuration
+
+      attr_accessor :vboxweb_host, :vboxweb_port, :vboxweb_user, :vboxweb_pass, :log_level, :logger
+
+      def initialize
+        @vboxweb_host = ENV['VBOXWEB_HOST'] || '127.0.0.1'
+        @vboxweb_port = ENV['VBOXWEB_PORT'] || '18083'
+        @vboxweb_user = ENV['VBOXWEB_USER']
+        @vboxweb_pass = ENV['VBOXWEB_PASS']
+        @log_level = ENV['VBOXWEB_LOGGING'] || 'ERROR'
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger.const_get(@log_level)
+      end
+
+      def log_level=(log_level)
+        @log_level = ['ERROR', 'INFO', 'DEBUG'].include?(log_level) ? log_level : 'ERROR'
+        @logger.level = Logger.const_get(@log_level)
+      end
+    end
+
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+  end
+end

data/lib/virtualbox/exceptions.rb

@@ -0,0 +1,28 @@
+module VBox
+  module WebService
+    class Error < StandardError; end
+
+    class ConnectionError < Error
+      def initialize(endpoint, message)
+        @endpoint = endpoint
+        @message = message
+      end
+
+      def to_s
+        "Could not connect to VirtualBox SOAP Web Service at #{@endpoint}. #{@message}"
+      end
+    end
+
+    class NoWebServiceError < ConnectionError
+      def initialize(endpoint, message = 'No VirtualBox SOAP service found')
+        super
+      end
+    end
+
+    class UnknownError < Error; end
+
+    class ArgumentError < Error; end
+
+    class NotImplementedError < Error; end
+  end
+end

data/lib/virtualbox/version.rb

@@ -0,0 +1,3 @@
+module VBox
+  VERSION = '0.0.5'
+end