solusvm 1.0.0.beta2 → 1.0.0.beta3

data/lib/solusvm/base.rb

@@ -28,7 +28,7 @@ module Solusvm
         request = Net::HTTP::Get.new("#{api_endpoint.path}?#{options.to_query}")
         response = http.request(request)
 
-        handle_errors(response.body)
+        handle_errors(response)
         @returned_parameters = parse_response(response.body, force_array)
         log_messages(options)
       end
@@ -45,20 +45,32 @@ module Solusvm
       XmlSimple.xml_in(body, 'ForceArray' => force_array)
     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(',')
+      end
+    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"
+    def handle_errors(response)
+      if (200..299).include? response.code.to_i
+        # Checks for application errors
+        case response.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: #{response.code}"
       end
     end
 
     # Returns true when a request has been successful
-    # 
+    #
     #   my_class = MyClass.new
     #   my_class.create_server('example.com')
     #   my_class.successful? # => true
@@ -77,7 +89,7 @@ module Solusvm
 
     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|
@@ -94,7 +106,7 @@ module Solusvm
 
     # Raises an exception unless a valid type is specified
     def validate_server_type!(type)
-      type.strip!
+      type = type.strip
       unless VALID_SERVER_TYPES.include?(type)
         raise SolusvmError, "Invalid Virtual Server type: #{type}"
       end

data/lib/solusvm/cli/base_cli.rb

@@ -6,38 +6,44 @@ require 'solusvm/version'
 module Solusvm
   class BaseCli < Thor
     include Thor::Actions
+    
+    class << self
+      # Overrides the default banner implementation to output the whole command
+      def banner(task, namespace = true, subcommand = false)
+        "#{self.namespace.split(":").join(" ")} #{task.formatted_usage(self, false, false)}"
+      end
 
-    # Retrieves default options coming from a configuration file, if any.
-    def self.default_option(key)
-      @@yaml ||= begin
-        file = File.join(File.expand_path(ENV['HOME']), '.solusvm.yml')
-        if File.exists?(file)
-          YAML::load(File.open(file))
+      # Convenience method to get the namespace from the class name. It's the
+      # same as Thor default except that the "_cli" at the end of the class
+      # is removed.
+      def namespace(name=nil)
+        if name
+          super
         else
-          {}
+          @namespace ||= super.sub(/_cli$/, '')
         end
       end
 
-      @@yaml[key.to_s]
-    end
+      # Retrieves default options coming from a configuration file, if any.
+      def default_option(key)
+        @@yaml ||= begin
+          file = File.join(File.expand_path(ENV['HOME']), '.solusvm.yml')
+          if File.exists?(file)
+            YAML::load(File.open(file))
+          else
+            {}
+          end
+        end
 
-    # Convenience method to get the namespace from the class name. It's the
-    # same as Thor default except that the "_cli" at the end of the class
-    # is removed.
-    def self.namespace(name=nil)
-      return super if name
-      @namespace ||= super.sub(/_cli$/, '')
+        @@yaml[key.to_s]
+      end
     end
-    
+
+    # Default required options
     class_option :api_login, :type => :string, :desc => "API ID; Required.",  :aliases => ["-I", "--api-login"], :default => default_option(:id)
     class_option :api_key,   :type => :string, :desc => "API KEY; Required.", :aliases => ["-K", "--api-key"], :default => default_option(:key)
     class_option :api_url,   :type => :string, :desc => "API URL; Required.", :aliases => ["-U", "--api-url"], :default => default_option(:url)
 
-    # Overrides the default banner implementation to output the whole command
-    def self.banner(task, namespace = true, subcommand = false)
-      "#{self.namespace.split(":").join(" ")} #{task.formatted_usage(self, false, false)}"
-    end
-
     protected
 
     def configure

data/lib/solusvm/general.rb

@@ -10,7 +10,7 @@ module Solusvm
     def templates(type)
       validate_server_type!(type)
       perform_request(:action => 'listtemplates', :type => type)
-      returned_parameters['templates'].split(',')
+      parse_returned_params_as_list('templates')
     end
 
     # Lists available plans.
@@ -21,7 +21,7 @@ module Solusvm
     def plans(type)
       validate_server_type!(type)
       perform_request(:action => 'listplans', :type => type)
-      returned_parameters['plans'].split(',')
+      parse_returned_params_as_list('plans')
     end
 
     # Lists available isos.
@@ -32,7 +32,7 @@ module Solusvm
     def isos(type)
       validate_server_type!(type)
       perform_request(:action => 'listiso', :type => type)
-      returned_parameters['iso'].split(',')
+      parse_returned_params_as_list('iso')
     end
   end
 end

data/lib/solusvm/node.rb

@@ -10,7 +10,7 @@ module Solusvm
     def list(type)
       validate_server_type!(type)
       perform_request(:action => 'listnodes', :type => type)
-      returned_parameters['nodes'].split(',')
+      parse_returned_params_as_list('nodes')
     end
 
     # Lists existing nodes ids of a given type.

data/lib/solusvm/reseller.rb

@@ -65,7 +65,7 @@ module Solusvm
     # Lists existing resellers.
     def list
       perform_request(:action => 'reseller-list')
-      returned_parameters['usernames'].split(',')
+      parse_returned_params_as_list('usernames')
     end
 
   end

data/lib/solusvm/version.rb

@@ -1,3 +1,3 @@
 module Solusvm
-  VERSION = "1.0.0.beta2"
+  VERSION = "1.0.0.beta3"
 end

data/test/test_base.rb

@@ -75,7 +75,7 @@ class TestBase < Test::Unit::TestCase
     begin
       @base.perform_request(:action => 'unauthorized')
     rescue Exception => e
-      message = e  
+      message = e
     end
     assert_equal "This IP is not authorized to use the API", message.to_s
   end
@@ -86,7 +86,7 @@ class TestBase < Test::Unit::TestCase
     begin
       @base.perform_request(:action => 'badkey')
     rescue Exception => e
-      message = e  
+      message = e
     end
     assert_equal "Invalid ID or key", message.to_s
   end
@@ -97,8 +97,19 @@ class TestBase < Test::Unit::TestCase
     begin
       @base.perform_request(:action => 'nodeexist')
     rescue Exception => e
-      message = e  
+      message = e
     end
     assert_equal "Node does not exist", message.to_s
   end
+
+  def test_invalid_http_status
+    FakeWeb.register_uri(:get, "#{base_uri}&action=httperror", :body => "", :status => ["404", "Not Found"])
+    message = ""
+    begin
+      @base.perform_request(:action => 'httperror')
+    rescue Solusvm::SolusvmError => e
+      message = e
+    end
+    assert_equal "Bad HTTP Status: 404", message.to_s
+  end
 end

data/test/test_general.rb

@@ -13,7 +13,12 @@ class TestGeneral < Test::Unit::TestCase
     assert_equal %w(template1 template2 template3), @general.templates('xen')
   end
 
-  def test_templates_error
+  def test_templates_empty
+    FakeWeb.register_uri(:get, "#{base_uri}&action=listtemplates&type=xen", :body => load_response('error'))
+    assert !@general.templates('xen')
+  end
+
+  def test_templates_with_invalid_type
     FakeWeb.register_uri(:get, "#{base_uri}&action=listtemplates&type=whatever", :body => load_response('error'))
     begin
       @general.templates('whatever')
@@ -28,7 +33,12 @@ class TestGeneral < Test::Unit::TestCase
     assert_equal %w(plan1 plan2 plan3 plan4), @general.plans('xen')
   end
 
-  def test_plans_error
+  def test_plans_empty
+    FakeWeb.register_uri(:get, "#{base_uri}&action=listplans&type=xen", :body => load_response('error'))
+    assert !@general.plans('xen')
+  end
+
+  def test_plans_with_invalid_type
     FakeWeb.register_uri(:get, "#{base_uri}&action=listplans&type=whatever", :body => load_response('error'))
     begin
       @general.plans('whatever')
@@ -43,7 +53,12 @@ class TestGeneral < Test::Unit::TestCase
     assert_equal %w(iso1 iso2 iso3), @general.isos('xen')
   end
 
-  def test_isos_error
+  def test_isos_empty
+    FakeWeb.register_uri(:get, "#{base_uri}&action=listiso&type=xen", :body => load_response('error'))
+    assert !@general.isos('xen')
+  end
+
+  def test_isos_with_invalid_type
     FakeWeb.register_uri(:get, "#{base_uri}&action=listiso&type=whatever", :body => load_response('error'))
     begin
       @general.isos('whatever')

data/test/test_node.rb

@@ -9,11 +9,16 @@ class TestNode < Test::Unit::TestCase
   end
 
   def test_list
-    FakeWeb.register_uri(:get, "#{base_uri}&action=listnodes&type=xen", :body => load_response('general_nodes_success'))
+    FakeWeb.register_uri(:get, "#{base_uri}&action=listnodes&type=xen", :body => load_response('nodes_list_success'))
     assert_equal %w(node1 node2 node3 node4), @nodes.list('xen')
   end
 
-  def test_nodes_error
+  def test_list_empty
+    FakeWeb.register_uri(:get, "#{base_uri}&action=listnodes&type=xen", :body => load_response('error'))
+    assert !@nodes.list('xen')
+  end
+
+  def test_nodes_with_invalid_type
     FakeWeb.register_uri(:get, "#{base_uri}&action=listnodes&type=whatever", :body => load_response('error'))
     begin
       @nodes.list('whatever')
@@ -24,7 +29,7 @@ class TestNode < Test::Unit::TestCase
   end
 
   def test_statistics
-    FakeWeb.register_uri(:get, "#{base_uri}&action=node-statistics&nodeid=1", :body => load_response('general_node_statistics_success'))
+    FakeWeb.register_uri(:get, "#{base_uri}&action=node-statistics&nodeid=1", :body => load_response('node_statistics_success'))
     node_statistics = @nodes.statistics(1)
     
     assert_equal '1000', node_statistics['freedisk']
@@ -43,17 +48,17 @@ class TestNode < Test::Unit::TestCase
   end
 
   def test_list_all_ips_available
-    FakeWeb.register_uri(:get, "#{base_uri}&action=node-iplist&nodeid=1", :body => load_response('general_node_list_all_ips_available'))
+    FakeWeb.register_uri(:get, "#{base_uri}&action=node-iplist&nodeid=1", :body => load_response('node_list_all_ips_available'))
     assert_equal %w(123.123.123.123 124.124.124.124 125.125.125.125).sort, @nodes.available_ips(1).sort 
   end
 
   def test_list_all_ips_not_available
-    FakeWeb.register_uri(:get, "#{base_uri}&action=node-iplist&nodeid=1", :body => load_response('general_node_list_all_ips_not_available'))
+    FakeWeb.register_uri(:get, "#{base_uri}&action=node-iplist&nodeid=1", :body => load_response('node_list_all_ips_not_available'))
     assert @nodes.available_ips(1).empty?
   end
 
   def test_ids
-    FakeWeb.register_uri(:get, "#{base_uri}&action=node-idlist&type=xen", :body => load_response('general_nodes_ids_success'))
+    FakeWeb.register_uri(:get, "#{base_uri}&action=node-idlist&type=xen", :body => load_response('nodes_ids_success'))
     assert_equal %w(nodeid1 nodeid2 nodeid3 nodeid4), @nodes.ids('xen')
   end
 
@@ -68,7 +73,7 @@ class TestNode < Test::Unit::TestCase
   end
 
   def test_virtualservers
-    FakeWeb.register_uri(:get, "#{base_uri}&action=node-virtualservers&nodeid=1", :body => load_response('general_node_virtualservers_success'))
+    FakeWeb.register_uri(:get, "#{base_uri}&action=node-virtualservers&nodeid=1", :body => load_response('node_virtualservers_success'))
 
     servers = @nodes.virtualservers(1)
     assert_equal 1, servers.size
@@ -88,7 +93,7 @@ class TestNode < Test::Unit::TestCase
   end
 
   def test_virtualservers_empty
-    FakeWeb.register_uri(:get, "#{base_uri}&action=node-virtualservers&nodeid=1", :body => load_response('general_node_virtualservers_success_empty'))
+    FakeWeb.register_uri(:get, "#{base_uri}&action=node-virtualservers&nodeid=1", :body => load_response('node_virtualservers_success_empty'))
     assert @nodes.virtualservers(1).empty?
   end
 
@@ -98,7 +103,7 @@ class TestNode < Test::Unit::TestCase
   end
 
   def test_xenresources
-    FakeWeb.register_uri(:get, "#{base_uri}&action=node-xenresources&nodeid=1", :body => load_response('general_node_xenresources_success'))
+    FakeWeb.register_uri(:get, "#{base_uri}&action=node-xenresources&nodeid=1", :body => load_response('node_xenresources_success'))
     node_resources = @nodes.xenresources(1)
     
     assert_equal 'thefreememory', node_resources['freememory']

data/test/test_reseller.rb

@@ -67,6 +67,11 @@ class TestReseller < Test::Unit::TestCase
     assert_equal %w(username1 username2 username3), @reseller.list
   end
 
+  def test_list_empty
+    FakeWeb.register_uri(:get, "#{base_uri}&action=reseller-list", :body => load_response('error'))
+    assert !@reseller.list
+  end
+
   def test_delete
     FakeWeb.register_uri(:get, "#{base_uri}&action=reseller-delete&username=vps123", :body => load_response('reseller_delete_success'))    
     assert @reseller.delete("vps123")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solusvm
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
   prerelease: 6
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
-  requirement: &15026220 !ruby/object:Gem::Requirement
+  requirement: &10478600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *15026220
+  version_requirements: *10478600
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &15025220 !ruby/object:Gem::Requirement
+  requirement: &10477860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *15025220
+  version_requirements: *10477860
 - !ruby/object:Gem::Dependency
   name: redgreen
-  requirement: &15024020 !ruby/object:Gem::Requirement
+  requirement: &10476700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.2.2
   type: :development
   prerelease: false
-  version_requirements: *15024020
+  version_requirements: *10476700
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &15023240 !ruby/object:Gem::Requirement
+  requirement: &10474880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *15023240
+  version_requirements: *10474880
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &15022480 !ruby/object:Gem::Requirement
+  requirement: &10473260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 0.10.3
   type: :development
   prerelease: false
-  version_requirements: *15022480
+  version_requirements: *10473260
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &15021900 !ruby/object:Gem::Requirement
+  requirement: &10472140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *15021900
+  version_requirements: *10472140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15021240 !ruby/object:Gem::Requirement
+  requirement: &10471240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,7 +88,7 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *15021240
+  version_requirements: *10471240
 description: Solusvm allows for easy interaction with the SolusVM Admin::API.
 email:
 - jmazzi@gmail.com
@@ -145,16 +145,16 @@ files:
 - test/fixtures/client_list_success_empty.txt
 - test/fixtures/error.txt
 - test/fixtures/general_isos_success.txt
-- test/fixtures/general_node_list_all_ips_available.txt
-- test/fixtures/general_node_list_all_ips_not_available.txt
-- test/fixtures/general_node_statistics_success.txt
-- test/fixtures/general_node_virtualservers_success.txt
-- test/fixtures/general_node_virtualservers_success_empty.txt
-- test/fixtures/general_node_xenresources_success.txt
-- test/fixtures/general_nodes_ids_success.txt
-- test/fixtures/general_nodes_success.txt
 - test/fixtures/general_plans_success.txt
 - test/fixtures/general_templates_success.txt
+- test/fixtures/node_list_all_ips_available.txt
+- test/fixtures/node_list_all_ips_not_available.txt
+- test/fixtures/node_statistics_success.txt
+- test/fixtures/node_virtualservers_success.txt
+- test/fixtures/node_virtualservers_success_empty.txt
+- test/fixtures/node_xenresources_success.txt
+- test/fixtures/nodes_ids_success.txt
+- test/fixtures/nodes_list_success.txt
 - test/fixtures/reseller_change_resources_success.txt
 - test/fixtures/reseller_create_success.txt
 - test/fixtures/reseller_delete_success.txt
@@ -213,7 +213,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4337387384446240597
+      hash: 429201309612601316
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -247,16 +247,16 @@ test_files:
 - test/fixtures/client_list_success_empty.txt
 - test/fixtures/error.txt
 - test/fixtures/general_isos_success.txt
-- test/fixtures/general_node_list_all_ips_available.txt
-- test/fixtures/general_node_list_all_ips_not_available.txt
-- test/fixtures/general_node_statistics_success.txt
-- test/fixtures/general_node_virtualservers_success.txt
-- test/fixtures/general_node_virtualservers_success_empty.txt
-- test/fixtures/general_node_xenresources_success.txt
-- test/fixtures/general_nodes_ids_success.txt
-- test/fixtures/general_nodes_success.txt
 - test/fixtures/general_plans_success.txt
 - test/fixtures/general_templates_success.txt
+- test/fixtures/node_list_all_ips_available.txt
+- test/fixtures/node_list_all_ips_not_available.txt
+- test/fixtures/node_statistics_success.txt
+- test/fixtures/node_virtualservers_success.txt
+- test/fixtures/node_virtualservers_success_empty.txt
+- test/fixtures/node_xenresources_success.txt
+- test/fixtures/nodes_ids_success.txt
+- test/fixtures/nodes_list_success.txt
 - test/fixtures/reseller_change_resources_success.txt
 - test/fixtures/reseller_create_success.txt
 - test/fixtures/reseller_delete_success.txt