module Solusvm # Solusvm::Base is the main class for mapping API resources as subclasses. class Base attr_reader :returned_parameters, :statusmsg VALID_SERVER_TYPES = ['openvz', 'xen', 'xen hvm'] # Prepares and sends the API request to the URL specificed in Solusvm.config # # class MyClass < Base # def create_server(name) # perform_request(:action => 'name', :id => 1) # end # end # # Options: # * :action - Specifies which API method to execute # All other options passed in are converted to http query arguments and are passed along to the API # # force_array - see parse_response def perform_request(options = {}, force_array = false) options.merge!(api_login) http = Net::HTTP.new(api_endpoint.host, api_endpoint.port) if api_endpoint.port == 443 http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE end http.start do |http| request = Net::HTTP::Get.new("#{api_endpoint.path}?#{options.to_query}") response = http.request(request) handle_errors(response.body) @returned_parameters = parse_response(response.body, force_array) log_messages(options) end successful? end # Converts the XML response to a Hash # # force_array - Parses the xml element as an array; can be a string with the element name # or an array with element names def parse_response(body, force_array = false) force_array = Array(force_array) if force_array body = "#{body}" XmlSimple.xml_in(body, 'ForceArray' => force_array) end # Look for known error messages def handle_errors(body) case body.downcase when /invalid ipaddress/i raise "This IP is not authorized to use the API" when /Invalid id or key/i raise "Invalid ID or key" when /Node not found/i raise "Node does not exist" end end # Returns true when a request has been successful # # my_class = MyClass.new # my_class.create_server('example.com') # my_class.successful? # => true def successful? returned_parameters['status'] == 'success' end # URI parsed API URL def api_endpoint Solusvm.api_endpoint end def api_login {:id => Solusvm.api_id, :key => Solusvm.api_key} end def log_messages(options) logger, logger_method = Solusvm.api_options[:logger], Solusvm.api_options[:logger_method] if logger && logger.respond_to?(logger_method) logger.send(logger_method, "[Start] => #{options[:action]}") returned_parameters.each do |k,v| logger.send(logger_method, " #{k} => #{v}") end logger.send(logger_method, "[End] => #{options[:action]}") end end # API response message def statusmsg returned_parameters['statusmsg'] end # Raises an exception unless a valid type is specified def validate_server_type!(type) type.strip! unless VALID_SERVER_TYPES.include?(type) raise SolusvmError, "Invalid Virtual Server type: #{type}" end end end end