virtualbox-ws 0.0.3 → 0.0.5

data/lib/virtualbox/webservice.rb

@@ -0,0 +1,105 @@
+require 'savon'
+
+
+module VBox
+  module WebService
+    class << self
+      def connect
+        # Initialize configuration here in case if it was not initialized in client
+        self.configuration ||= Configuration.new
+
+        host = configuration.vboxweb_host
+        port = configuration.vboxweb_port
+        log_level = configuration.log_level
+        @logger = configuration.logger
+
+        # Savon XML logging
+        savon_debug = log_level == 'DEBUG'
+
+        endpoint = "http://#{host}:#{port}"
+        wsdl = endpoint + '/?wsdl'
+        @logger.info("VirtualBox SOAP web service endpoint: #{endpoint}")
+        @logger.info("VirtualBox SOAP web service WSDL: #{wsdl}")
+
+        # Create web service connection
+        @conn = Savon.client(:wsdl => wsdl, :endpoint => endpoint, :log => savon_debug, :pretty_print_xml => savon_debug)
+
+        # Check if we really connected to a VirtualBox SOAP web service
+        unless operations.include?(:i_websession_manager_logon)
+          @logger.fatal("Could not connect to VirtualBox SOAP Web Service at #{endpoint}. No VirtualBox SOAP service found")
+          raise NoWebServiceError.new(endpoint)
+        end
+      end
+
+      def operations
+        @conn.operations
+      end
+
+      def send_request(soap_method, soap_message)
+        @logger.info("Request operation: #{soap_method}")
+
+        # Filter out the password string
+        log_soap_message = soap_message.clone
+        if soap_method == :i_websession_manager_logon
+          log_soap_message[:password] = '<filtered>' if log_soap_message.has_key?(:password)
+        end
+
+        @logger.info("Request message: #{log_soap_message}")
+
+        begin
+          response = @conn.call(soap_method, :message => soap_message)
+        rescue Savon::SOAPFault => e
+          @logger.debug(e.message)
+          parse_soap_fault(e.message)
+        rescue Savon::HTTPError => e
+          @logger.error(e.message)
+          raise
+        end
+        parse_response(response)
+      end
+
+      def parse_soap_fault(message)
+        error_code = message.match(/0x[[:xdigit:]]+/)
+        if error_code.nil?
+          if message.match(/Validation constraint violation: data type mismatch  in element <\S+>/).nil?
+            raise UnknownError, message
+          else
+            argument = message.match(/<\S+>/).to_s[1..-2].to_underscore
+            raise ArgumentError, "Argument #{argument} is of invalid data type"
+          end
+        else
+          error_message = message.split("(SOAP-ENV:Client) VirtualBox error: rc=#{error_code} ")[1].split(" (#{error_code})")[0]
+          raise UnknownError, message if error_message.nil?
+          argument = error_message.match(/\sa[A-Z]\S+\s/)
+          if argument.nil?
+            if error_message.match(/Method \S+ is not implemented/).nil?
+              raise Error, error_message
+            else
+              raise NotImplementedError, error_message
+            end
+          else
+            error_message.gsub!(argument.to_s.strip, argument.to_s.strip[1..-1].to_underscore).
+                          gsub!(/\s\(must be .*\)/, '')
+            raise ArgumentError, error_message
+          end
+        end
+      end
+
+      def parse_response(response)
+        @logger.info("Response: #{response.body}")
+        response_struct = response.body[response.body.keys[0]]
+        if response_struct.nil?
+          nil
+        else
+          if response_struct.keys.length > 1
+            returnval = response_struct[:returnval].nil? || response_struct[:returnval]
+            response_struct.delete(:returnval)
+            [returnval, response_struct]
+          else
+            response_struct[:returnval]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox-ws.rb

@@ -1,3 +1,7 @@
 require 'require_all'
 require_rel 'core_ext'
-require_rel 'virtualbox'
+require_rel 'virtualbox/configuration'
+require_rel 'virtualbox/exceptions'
+require_rel 'virtualbox/webservice'
+require_rel 'virtualbox/base'
+require_rel 'virtualbox/classes/websession_manager'

data/virtualbox-ws.gemspec

@@ -1,6 +1,9 @@
+require './lib/virtualbox/version'
+
+
 Gem::Specification.new do |s|
   s.name = "virtualbox-ws"
-  s.version = '0.0.3'
+  s.version = VBox::VERSION
   s.platform = Gem::Platform::RUBY
   s.authors = ['Andriy Yurchuk']
   s.email = ['ayurchuk@minuteware.net']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virtualbox-ws
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Andriy Yurchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -55,7 +55,6 @@ files:
 - lib/core_ext/string.rb
 - lib/virtualbox-ws.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
@@ -65,6 +64,7 @@ files:
 - lib/virtualbox/classes/dhcp_server.rb
 - lib/virtualbox/classes/directory.rb
 - lib/virtualbox/classes/display.rb
+- lib/virtualbox/classes/emulated_usb.rb
 - lib/virtualbox/classes/event.rb
 - lib/virtualbox/classes/event_listener.rb
 - lib/virtualbox/classes/event_source.rb
@@ -78,10 +78,29 @@ files:
 - 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_file_event.rb
+- lib/virtualbox/classes/events/guest_file_io_event.rb
+- lib/virtualbox/classes/events/guest_file_offset_changed_event.rb
+- lib/virtualbox/classes/events/guest_file_read_event.rb
+- lib/virtualbox/classes/events/guest_file_registered_event.rb
+- lib/virtualbox/classes/events/guest_file_state_changed_event.rb
+- lib/virtualbox/classes/events/guest_file_write_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_multi_touch_event.rb
+- lib/virtualbox/classes/events/guest_process_event.rb
+- lib/virtualbox/classes/events/guest_process_input_notify_event.rb
+- lib/virtualbox/classes/events/guest_process_io_event.rb
+- lib/virtualbox/classes/events/guest_process_output_event.rb
+- lib/virtualbox/classes/events/guest_process_registered_event.rb
+- lib/virtualbox/classes/events/guest_process_state_changed_event.rb
 - lib/virtualbox/classes/events/guest_property_changed_event.rb
+- lib/virtualbox/classes/events/guest_session_event.rb
+- lib/virtualbox/classes/events/guest_session_registered_event.rb
+- lib/virtualbox/classes/events/guest_session_state_changed_event.rb
+- lib/virtualbox/classes/events/guest_user_state_changed_event.rb
+- lib/virtualbox/classes/events/host_name_resolution_configuration_change_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
@@ -92,6 +111,12 @@ files:
 - 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_network_alter_event.rb
+- lib/virtualbox/classes/events/nat_network_changed_event.rb
+- lib/virtualbox/classes/events/nat_network_creation_deletion_event.rb
+- lib/virtualbox/classes/events/nat_network_port_forward_event.rb
+- lib/virtualbox/classes/events/nat_network_setting_event.rb
+- lib/virtualbox/classes/events/nat_network_start_stop_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
@@ -112,9 +137,12 @@ files:
 - 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/video_capture_changed_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/framebuffer.rb
+- lib/virtualbox/classes/framebuffer_overlay.rb
 - lib/virtualbox/classes/fs_obj_info.rb
 - lib/virtualbox/classes/guest.rb
 - lib/virtualbox/classes/guest_directory.rb
@@ -126,15 +154,19 @@ files:
 - 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/host_video_input_device.rb
 - lib/virtualbox/classes/keyboard.rb
 - lib/virtualbox/classes/machine.rb
+- lib/virtualbox/classes/machine_debugger.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/nat_network.rb
 - lib/virtualbox/classes/network_adapter.rb
 - lib/virtualbox/classes/parallel_port.rb
+- lib/virtualbox/classes/pci_address.rb
 - lib/virtualbox/classes/performance_collector.rb
 - lib/virtualbox/classes/performance_metric.rb
 - lib/virtualbox/classes/process.rb
@@ -145,9 +177,11 @@ files:
 - lib/virtualbox/classes/snapshot.rb
 - lib/virtualbox/classes/storage_controller.rb
 - lib/virtualbox/classes/system_properties.rb
+- lib/virtualbox/classes/token.rb
 - lib/virtualbox/classes/usb_controller.rb
 - lib/virtualbox/classes/usb_device.rb
 - lib/virtualbox/classes/usb_device_filter.rb
+- lib/virtualbox/classes/usb_device_filters.rb
 - lib/virtualbox/classes/vfs_explorer.rb
 - lib/virtualbox/classes/virtual_box.rb
 - lib/virtualbox/classes/virtual_box_error_info.rb
@@ -155,7 +189,10 @@ files:
 - 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/configuration.rb
+- lib/virtualbox/exceptions.rb
+- lib/virtualbox/version.rb
+- lib/virtualbox/webservice.rb
 - virtualbox-ws.gemspec
 homepage: https://github.com/Ch00k/virtualbox-ws
 licenses:
@@ -177,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Object-oriented VirtualBox SOAP API wrapper

data/lib/virtualbox/classes/additions_facility.rb

@@ -1,26 +0,0 @@
-module VBox
-  class AdditionsFacility < Base
-
-    # Attributes
-
-    def class_type
-      VBox::WebService.send_request(:i_additions_facility_get_class_type, _this)
-    end
-
-    def last_updated
-      VBox::WebService.send_request(:i_additions_facility_get_last_updated, _this)
-    end
-
-    def name
-      VBox::WebService.send_request(:i_additions_facility_get_name, _this)
-    end
-
-    def status
-      VBox::WebService.send_request(:i_additions_facility_get_status, _this)
-    end
-
-    def type
-      VBox::WebService.send_request(:i_additions_facility_get_type, _this)
-    end
-  end
-end

data/lib/virtualbox/connection.rb

@@ -1,68 +0,0 @@
-require 'savon'
-
-
-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
-
-      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 debug
-        @debug
-      end
-
-      def debug=(debug)
-        @debug = debug
-      end
-
-      def savon_debug
-        @debug
-      end
-
-      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 "DEBUG --- 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