solusvm 1.1.0.beta2 → 1.2.0

data/lib/solusvm.rb

@@ -25,9 +25,7 @@ module Solusvm
   end
 end
 
-require 'solusvm/exceptions'
 require 'solusvm/hash'
-require 'solusvm/solusvm_errors'
 require 'solusvm/base'
 require 'solusvm/general'
 require 'solusvm/client'

data/lib/solusvm/base.rb

@@ -1,16 +1,15 @@
-Faraday.register_middleware :response, :solusvm_errors => Solusvm::SolusvmErrors
-
 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']
+    VALID_SERVER_TYPES = ["openvz", "xen", "xen hvm"]
+
+    attr_reader :returned_parameters
 
     # 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)
+    #      perform_request(:action => "name", :id => 1)
     #    end
     #  end
     #
@@ -20,14 +19,15 @@ module Solusvm
     #
     # <tt>force_array</tt> - see parse_response
     def perform_request(options = {}, force_array = false)
-      ca_path  = File.join(File.dirname(__FILE__), '..', 'cacert.pem')
+      ca_path  = File.join(File.dirname(__FILE__), "..", "cacert.pem")
       ssl      = {:verify => true, :ca_file => File.expand_path(ca_path)}
+
       response = Faraday.new(:url => api_endpoint, :ssl => ssl) do |c|
         c.params = options.merge(api_login)
-        c.response :solusvm_errors
         c.adapter :net_http
       end.get
-      @returned_parameters = parse_response(response.body, force_array)
+
+      @returned_parameters = parse_response(response.status, response.body, force_array)
       log_messages(options)
       successful?
     end
@@ -36,26 +36,45 @@ module Solusvm
     #
     # <tt>force_array</tt> - 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 = "<solusrequest>#{body}</solusrequest>"
-      XmlSimple.xml_in(body, 'ForceArray' => force_array)
+    def parse_response(status, body, force_array = false)
+      parse_error(status, body) || begin
+        force_array = Array(force_array) if force_array
+        body        = "<solusrequest>#{body}</solusrequest>"
+        XmlSimple.xml_in(body, "ForceArray" => force_array)
+      end
     end
 
     # Parses a returned_parameters value as a list, if present.
     def parse_returned_params_as_list(attribute)
       if returned_parameters[attribute] && !returned_parameters[attribute].empty?
-        returned_parameters[attribute].to_s.split(',')
+        returned_parameters[attribute].to_s.split(",")
+      end
+    end
+
+    # Parses error responses.
+    def parse_error(status, body)
+      if (200..299).include?(status)
+        # Checks for application errors
+        case body.downcase
+        when /invalid ipaddress/i
+          { "status" => "error", "statusmsg" => "This IP is not authorized to use the API" }
+        when /Invalid id or key/i
+          { "status" => "error", "statusmsg" => "Invalid ID or key" }
+        when /Node not found/i
+          { "status" => "error", "statusmsg" => "Node does not exist" }
+        end
+      else
+        { "status" => "error", "statusmsg" => "Bad HTTP Status: #{status}" }
       end
     end
 
     # Returns true when a request has been successful
     #
     #   my_class = MyClass.new
-    #   my_class.create_server('example.com')
+    #   my_class.create_server("example.com")
     #   my_class.successful? # => true
     def successful?
-      returned_parameters['status'] == 'success'
+      returned_parameters["status"] == "success"
     end
 
     # URI parsed API URL
@@ -81,14 +100,22 @@ module Solusvm
 
     # API response message
     def statusmsg
-      returned_parameters['statusmsg']
+      returned_parameters["statusmsg"]
     end
 
-    # Raises an exception unless a valid type is specified
-    def validate_server_type!(type)
+    # Validates the server type.
+    def validate_server_type(type, &block)
       type = type.strip
-      unless VALID_SERVER_TYPES.include?(type)
-        raise SolusvmError, "Invalid Virtual Server type: #{type}"
+
+      if valid = VALID_SERVER_TYPES.include?(type)
+        yield
+      else
+        @returned_parameters = {
+          "status"    => "error",
+          "statusmsg" => "Invalid Virtual Server type: #{type}"
+        }
+
+        false
       end
     end
   end

data/lib/solusvm/general.rb

@@ -1,16 +1,17 @@
 module Solusvm
   # Solusvm::General is the class for retrieving general information.
   class General < Base
-    
+
     # Lists available templates.
     #
     # Parameters:
     #
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def templates(type)
-      validate_server_type!(type)
-      perform_request(:action => 'listtemplates', :type => type)
-      parse_returned_params_as_list('templates')
+      validate_server_type(type) do
+        perform_request(:action => 'listtemplates', :type => type)
+        parse_returned_params_as_list('templates')
+      end
     end
 
     # Lists available plans.
@@ -19,9 +20,10 @@ module Solusvm
     #
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def plans(type)
-      validate_server_type!(type)
-      perform_request(:action => 'listplans', :type => type)
-      parse_returned_params_as_list('plans')
+      validate_server_type(type) do
+        perform_request(:action => 'listplans', :type => type)
+        parse_returned_params_as_list('plans')
+      end
     end
 
     # Lists available isos.
@@ -30,9 +32,10 @@ module Solusvm
     #
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def isos(type)
-      validate_server_type!(type)
-      perform_request(:action => 'listiso', :type => type)
-      parse_returned_params_as_list('iso')
+      validate_server_type(type) do
+        perform_request(:action => 'listiso', :type => type)
+        parse_returned_params_as_list('iso')
+      end
     end
   end
 end

data/lib/solusvm/node.rb

@@ -8,9 +8,10 @@ module Solusvm
     #
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def list(type)
-      validate_server_type!(type)
-      perform_request(:action => 'listnodes', :type => type)
-      parse_returned_params_as_list('nodes')
+      validate_server_type(type) do
+        perform_request(:action => 'listnodes', :type => type)
+        parse_returned_params_as_list('nodes')
+      end
     end
 
     # Lists existing nodes ids of a given type.
@@ -19,9 +20,10 @@ module Solusvm
     #
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def ids(type)
-      validate_server_type!(type)
-      perform_request(:action => 'node-idlist', :type => type)
-      returned_parameters['nodes'].split(',')
+      validate_server_type(type) do
+        perform_request(:action => 'node-idlist', :type => type)
+        returned_parameters['nodes'].split(',')
+      end
     end
 
     # Retrieves statistics from a specific node.

data/lib/solusvm/version.rb

@@ -1,3 +1,3 @@
 module Solusvm
-  VERSION = "1.1.0.beta2"
+  VERSION = "1.2.0"
 end

data/test/solusvm/test_base.rb

@@ -55,49 +55,47 @@ class TestBase < Test::Unit::TestCase
 
   def test_validate_server_type
     Solusvm::Base::VALID_SERVER_TYPES.each do |type|
-      assert_nothing_raised do
-        @base.validate_server_type!(type)
-      end
+      assert @base.validate_server_type(type) { true }
     end
 
-    begin
-      @base.validate_server_type!('bob')
-      flunk "Shouldn't get here"
-    rescue Solusvm::SolusvmError => e
-      assert_equal 'Invalid Virtual Server type: bob', e.message
-    end
+    assert !@base.validate_server_type('bob') { true }
+    assert !@base.successful?
+    assert_equal "Invalid Virtual Server type: bob", @base.statusmsg
   end
 
   def test_unautorized_ip
     VCR.use_cassette "base/unauthorized_ip" do
-      assert_raise RuntimeError do
-        @base.perform_request(:action => 'unauthorized')
-      end
+      @base.perform_request(:action => 'unauthorized')
+
+      assert !@base.successful?
+      assert_equal "This IP is not authorized to use the API", @base.statusmsg
     end
   end
 
   def test_invalid_key_or_id
     VCR.use_cassette "base/invalid_key" do
-      assert_raise RuntimeError do
-        @base.perform_request(:action => 'badkey')
-      end
+      @base.perform_request(:action => 'badkey')
+
+      assert !@base.successful?
+      assert_equal "Invalid ID or key", @base.statusmsg
     end
   end
 
   def test_node_does_not_exist
     VCR.use_cassette "base/nonexistent_node" do
-      assert_raise RuntimeError do
-        @base.perform_request(:action => 'nodeexist')
-      end
+      @base.perform_request(:action => 'nodeexist')
+
+      assert !@base.successful?
+      assert_equal "Node does not exist", @base.statusmsg
     end
   end
 
   def test_invalid_http_status
     VCR.use_cassette "base/invalid_status" do
-      assert_raise Solusvm::SolusvmError do
-        @base.perform_request(:action => 'httperror')
-      end
+      @base.perform_request(:action => 'httperror')
+
+      assert !@base.successful?
+      assert_equal "Bad HTTP Status: 404", @base.statusmsg
     end
-    
   end
 end

data/test/solusvm/test_general.rb

@@ -20,11 +20,7 @@ class TestGeneral < Test::Unit::TestCase
   end
 
   def test_templates_with_invalid_type
-    VCR.use_cassette "general/templates" do
-      assert_raise Solusvm::SolusvmError do
-        @general.templates('badserver')
-      end
-    end
+    assert !@general.templates('badserver')
   end
 
   def test_plans
@@ -40,11 +36,7 @@ class TestGeneral < Test::Unit::TestCase
   end
 
   def test_plans_with_invalid_type
-    VCR.use_cassette "general/plans" do
-      assert_raise Solusvm::SolusvmError do
-        @general.plans('whatever')
-      end
-    end
+    assert !@general.plans('whatever')
   end
 
   def test_isos
@@ -60,10 +52,6 @@ class TestGeneral < Test::Unit::TestCase
   end
 
   def test_isos_with_invalid_type
-    VCR.use_cassette "general/isos" do
-      assert_raise Solusvm::SolusvmError do
-        @general.isos('whatever')
-      end
-    end
+    assert !@general.isos('whatever')
   end
 end

data/test/solusvm/test_node.rb

@@ -13,24 +13,22 @@ class TestNode < Test::Unit::TestCase
   end
 
   def test_list_empty
-    VCR.use_cassette "node/list" do    
+    VCR.use_cassette "node/list" do
       assert !@nodes.list('openvz')
     end
   end
 
   def test_nodes_with_invalid_type
-    assert_raise Solusvm::SolusvmError do
-      @nodes.list('whatever')
-    end
+    assert !@nodes.list('whatever')
   end
 
   def test_statistics
     VCR.use_cassette "node/statistics" do
       @nodes.statistics(1)
     end
-    
+
     node_statistics = @nodes.returned_parameters
-    
+
     assert_equal '1000', node_statistics['freedisk']
     assert_equal '22', node_statistics['sshport']
     assert_equal 'city', node_statistics['city']
@@ -49,7 +47,7 @@ class TestNode < Test::Unit::TestCase
   def test_list_all_ips_available
     Solusvm.config("api_id1", api_login[:key], :url => 'http://www.example.com/api')
     VCR.use_cassette "node/available_ips" do
-      assert_equal %w(123.123.123.123 124.124.124.124 125.125.125.125).sort, @nodes.available_ips(1).sort 
+      assert_equal %w(123.123.123.123 124.124.124.124 125.125.125.125).sort, @nodes.available_ips(1).sort
     end
   end
 
@@ -67,9 +65,7 @@ class TestNode < Test::Unit::TestCase
   end
 
   def test_nodes_ids_error
-    assert_raise Solusvm::SolusvmError do
-      @nodes.ids('whatever')
-    end
+    assert !@nodes.ids('whatever')
   end
 
   def test_virtualservers
@@ -77,9 +73,9 @@ class TestNode < Test::Unit::TestCase
     VCR.use_cassette "node/virtualservers" do
       @nodes.virtualservers(1)
     end
-    
+
     server = @nodes.returned_parameters["virtualservers"]["virtualserver"].first
-    
+
     assert_equal "theid", server["vserverid"]
     assert_equal "thexid", server["ctid-xid"]
     assert_equal "theclientid", server["clientid"]
@@ -111,9 +107,9 @@ class TestNode < Test::Unit::TestCase
     VCR.use_cassette "node/xenresources" do
       @nodes.xenresources(1)
     end
-    
+
     node_resources = @nodes.returned_parameters
-    
+
     assert_equal 'thefreememory', node_resources['freememory']
     assert_equal 'thefreehdd', node_resources['freehdd']
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: solusvm
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta2
-  prerelease: 6
+  version: 1.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Justin Mazzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
@@ -182,13 +182,11 @@ files:
 - lib/solusvm/cli/reseller_cli.rb
 - lib/solusvm/cli/server_cli.rb
 - lib/solusvm/client.rb
-- lib/solusvm/exceptions.rb
 - lib/solusvm/general.rb
 - lib/solusvm/hash.rb
 - lib/solusvm/node.rb
 - lib/solusvm/reseller.rb
 - lib/solusvm/server.rb
-- lib/solusvm/solusvm_errors.rb
 - lib/solusvm/version.rb
 - solusvm.gemspec
 - test/cli/test_base_cli.rb
@@ -278,90 +276,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -963033860729967788
+      hash: -2927450006008360826
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: -2927450006008360826
 requirements: []
 rubyforge_project: solusvm
-rubygems_version: 1.8.21
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Wrapper for the SolusVM Admin::API
-test_files:
-- test/cli/test_base_cli.rb
-- test/cli/test_client_cli.rb
-- test/cli/test_general_cli.rb
-- test/cli/test_node_cli.rb
-- test/cli/test_reseller_cli.rb
-- test/cli/test_server_cli.rb
-- test/solusvm/test_base.rb
-- test/solusvm/test_cli.rb
-- test/solusvm/test_client.rb
-- test/solusvm/test_general.rb
-- test/solusvm/test_hash.rb
-- test/solusvm/test_node.rb
-- test/solusvm/test_reseller.rb
-- test/solusvm/test_server.rb
-- test/test_helper.rb
-- test/test_solusvm.rb
-- test/vcr_cassettes/base/invalid_key.yml
-- test/vcr_cassettes/base/invalid_status.yml
-- test/vcr_cassettes/base/nonexistent_node.yml
-- test/vcr_cassettes/base/parse_response.yml
-- test/vcr_cassettes/base/statusmsg.yml
-- test/vcr_cassettes/base/successful.yml
-- test/vcr_cassettes/base/unauthorized_ip.yml
-- test/vcr_cassettes/client/authenticate.yml
-- test/vcr_cassettes/client/change_password.yml
-- test/vcr_cassettes/client/create.yml
-- test/vcr_cassettes/client/delete.yml
-- test/vcr_cassettes/client/exists.yml
-- test/vcr_cassettes/client/list.yml
-- test/vcr_cassettes/general/isos.yml
-- test/vcr_cassettes/general/plans.yml
-- test/vcr_cassettes/general/templates.yml
-- test/vcr_cassettes/node/available_ips.yml
-- test/vcr_cassettes/node/ids.yml
-- test/vcr_cassettes/node/list.yml
-- test/vcr_cassettes/node/statistics.yml
-- test/vcr_cassettes/node/virtualservers.yml
-- test/vcr_cassettes/node/xenresources.yml
-- test/vcr_cassettes/reseller/change_resources.yml
-- test/vcr_cassettes/reseller/create.yml
-- test/vcr_cassettes/reseller/delete.yml
-- test/vcr_cassettes/reseller/info.yml
-- test/vcr_cassettes/reseller/list.yml
-- test/vcr_cassettes/server/.yml
-- test/vcr_cassettes/server/boot.yml
-- test/vcr_cassettes/server/change_bootorder.yml
-- test/vcr_cassettes/server/change_consolepass.yml
-- test/vcr_cassettes/server/change_hostname.yml
-- test/vcr_cassettes/server/change_owner.yml
-- test/vcr_cassettes/server/change_plan.yml
-- test/vcr_cassettes/server/change_rootpassword.yml
-- test/vcr_cassettes/server/change_vncpass.yml
-- test/vcr_cassettes/server/console.yml
-- test/vcr_cassettes/server/create.yml
-- test/vcr_cassettes/server/exists.yml
-- test/vcr_cassettes/server/info.yml
-- test/vcr_cassettes/server/info_all.yml
-- test/vcr_cassettes/server/mountiso.yml
-- test/vcr_cassettes/server/network_disable.yml
-- test/vcr_cassettes/server/network_enable.yml
-- test/vcr_cassettes/server/pae_disable.yml
-- test/vcr_cassettes/server/pae_enable.yml
-- test/vcr_cassettes/server/reboot.yml
-- test/vcr_cassettes/server/rebuild.yml
-- test/vcr_cassettes/server/resume.yml
-- test/vcr_cassettes/server/shutdown.yml
-- test/vcr_cassettes/server/status.yml
-- test/vcr_cassettes/server/suspend.yml
-- test/vcr_cassettes/server/terminate.yml
-- test/vcr_cassettes/server/tun_disable.yml
-- test/vcr_cassettes/server/tun_enable.yml
-- test/vcr_cassettes/server/unmountiso.yml
-- test/vcr_cassettes/server/vnc.yml
+test_files: []

data/lib/solusvm/exceptions.rb

@@ -1,4 +0,0 @@
-module Solusvm
-  class SolusvmError < StandardError
-  end
-end

data/lib/solusvm/solusvm_errors.rb

@@ -1,22 +0,0 @@
-module Solusvm
-  class SolusvmErrors < Faraday::Response::Middleware
-
-    def on_complete(env)
-      if (200..299).include? env[:status]
-        # Checks for application errors
-        case env[: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
-      else
-        raise SolusvmError, "Bad HTTP Status: #{env[:status]}"
-      end
-
-    end
-
-  end
-end