solusvm 0.5.1 → 0.6.0

data/README.markdown

@@ -0,0 +1,108 @@
+Solusvm
+=======
+
+Solusvm allows for easy interaction with the SolusVM Admin::API.
+This library was first created for internal use at {Site5 LLC}[http://www.site5.com].
+
+Basic Examples
+==============
+
+    Solusvm.config('api_id', 'api_password', :url => 'http://www.example.com/api')
+    server = Solusvm::Server.new
+
+    # 200 is the id of the virtual server
+    server.shutdown(200) # => true
+    server.boot(200) # => true
+    server.reboot(200) # => true
+    server.suspend(200) # => true
+    server.resume(200) # => true
+
+Server creation
+===============
+
+    options = {:type => 'xen', :username => 'bob', :node => 'node1', :plan => 'plan1', :template => 'mytpl', :ips => 1}
+    result = sever.create('server.hostname.com', 'password', options}
+    p server.successful?
+    => true
+
+    p result
+    => {"mainipaddress"=>"127.0.0.1", "consoleuser"=>"console-user", "vserverid"=>"10", 
+    "statusmsg"=>"Virtual server created", "virtid"=>"vm10", "consolepassword"=>"myPassisL33t", 
+    "extraipaddress"=>{}, "hostname"=>"server.hostname", "rootpassword"=>"password", "status"=>"success"}
+
+
+Command Line Usage
+==================
+
+    USAGE: solusvm <command> [options]
+        -I, --api-login [id]             API ID
+        -K, --api-key [key]              API KEY
+        -N, --node [node]                Node to provision on
+        -U, --api-url [URL]              URL to the API
+        -u, --username [username]        The client to put the VPS under
+        -k, --kind [kind]                Type of VPS (openvz,xen,xen hvm)
+        -t, --template [template]        VPS template to boot from
+        -p, --plan [plan]                Plan to use
+        -i, --ips [number]               Number of ips to add to the VPS
+        -h, --help                       Show help documentation
+    Commands:
+      server-check-exists <vserverid>
+      server-shutdown <vserverid>
+      server-changeplan <vserverid> <newplan>
+      server-resume <vserverid>
+      server-reboot <vserverid>
+      server-status <vserverid>
+      server-boot <vserverid>
+      server-create <hostname> <password> -t myimag -k xen -p myplan -i 1
+      server-suspend <vserverid>
+      server-addip <vserverid>
+
+Default Config for Command Line
+================================
+
+The command line utility, solusvm, will look for a .solusvm.yml file in ~/. You can specify some defaults. 
+
+    ~/.solusvm.yml
+    id: api_id
+    key: api_key
+    # URL to the API endpoint
+    url: https://portal.yoursite.com/api/admin/command.php
+    # Default client to put servers under
+    username: bob
+
+REQUIREMENTS
+============
+
+* xml-simple
+
+DOCUMENTATION
+=============
+
+* http://solusvm.rubyforge.org/solusvm/
+
+INSTALL:
+========
+
+    gem install solusvm
+
+Contributors
+============
+
+* [Justin Mazzi](http://github.com/jmazzi)
+* [Maran H.](http://github.com/maran)
+
+Note on Patches/Pull Requests
+=============================
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+=========
+
+Copyright (c) 2010 Site5. See LICENSE for details.

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 1
-:build: 
 :major: 0
-:minor: 5
+:build: 
+:minor: 6
+:patch: 0

data/bin/solusvm

@@ -8,20 +8,28 @@ $:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
 require "solusvm"
 
 opts = {}
-shell_methods = {}
-shell_methods['server-create'] = "<hostname> <password> -t myimage -k xen -p myplan -i 1"
-shell_methods['server-boot'] = "<vserverid>"
-shell_methods['server-reboot'] = "<vserverid>"
-shell_methods['server-shutdown'] = "<vserverid>"
-shell_methods['server-suspend'] = "<vserverid>"
-shell_methods['server-resume'] = "<vserverid>"
-shell_methods['server-status'] = "<vserverid>"
-shell_methods['server-addip'] = "<vserverid>"
-shell_methods['server-changeplan'] = "<vserverid> <newplan>"
-shell_methods['server-check-exists'] = "<vserverid>"
-shell_methods['server-terminate'] = "<vserverid>"
-
-OptionParser.new do |o|
+$shell_methods = {}
+$shell_methods['server-create'] = "<hostname> <password> -t myimage -k xen -p myplan -i 1"
+$shell_methods['server-boot'] = "<vserverid>"
+$shell_methods['server-reboot'] = "<vserverid>"
+$shell_methods['server-shutdown'] = "<vserverid>"
+$shell_methods['server-suspend'] = "<vserverid>"
+$shell_methods['server-resume'] = "<vserverid>"
+$shell_methods['server-status'] = "<vserverid>"
+$shell_methods['server-addip'] = "<vserverid>"
+$shell_methods['server-changeplan'] = "<vserverid> <newplan>"
+$shell_methods['server-check-exists'] = "<vserverid>"
+$shell_methods['server-terminate'] = "<vserverid>"
+
+$shell_methods['node-available-ips'] = "<nodeid>"
+
+def list_commands
+  puts "Commands:"
+  puts $shell_methods.collect { |k,v| "  #{k} #{v}"}.join("\n")
+  exit
+end
+
+op = OptionParser.new do |o|
   o.banner = "USAGE: #{File.basename($0)} <command> [options]"
   o.on("-I", "--api-login [id]", "API ID") do |opt|
     opts[:api_id] = opt
@@ -61,17 +69,21 @@ OptionParser.new do |o|
 
   o.on("-h", "--help", "Show help documentation") do |h|
     puts o
-    puts "Commands:"
-    puts shell_methods.collect { |k,v| "  #{k} #{v}"}.join("\n")
-    
-    exit
+    list_commands
   end
-end.parse!
+end
+
+optparse = op
+op.parse!
 
 config_file = File.join(File.expand_path(ENV['HOME']), '.solusvm.yml')
 server = Solusvm::Server.new
+general = Solusvm::General.new
+
 if ARGV.empty?
-  STDERR.puts "USAGE: #{File.basename($0)} [function] [options]"
+  # STDERR.puts "USAGE: #{File.basename($0)} [function] [options]"
+  puts optparse.help
+  list_commands
 else
   if File.exists?(config_file)
     config = YAML::load(File.open(config_file))
@@ -84,37 +96,44 @@ else
     exit
   end
   meth = ARGV[0].chomp
-  if shell_methods.include?(meth)
+  if $shell_methods.include?(meth)
     ARGV.shift
     if ARGV.empty?
-      p shell_methods[meth]
+      p $shell_methods[meth]
       exit
     else
-      case meth
-      when 'server-create'
-        unless ARGV.size == 2
-          p shell_methods[meth]
-          exit
+      begin
+        case meth
+        when 'server-create'
+          unless ARGV.size == 2
+            list_commands
+          end
+          p server.create(ARGV[0], ARGV[1], :plan => opts[:plan], :ips => opts[:ips], :type => opts[:kind], 
+                          :username => opts[:username], :template => opts[:template], :node => opts[:node])
+        when 'server-status'
+          p server.status(ARGV[0])
+        when 'server-boot'
+          p server.boot(ARGV[0])
+        when 'server-reboot'
+          p server.reboot(ARGV[0])
+        when 'server-suspend'
+          p server.suspend(ARGV[0])
+        when 'server-resume'
+          p server.resume(ARGV[0])
+        when 'server-check-exists'
+          p server.exists?(ARGV[0])
+        when 'server-terminate'
+          p server.terminate(ARGV[0])
+        when 'node-available-ips'
+          p general.node_available_ips(ARGV[0])
         end
-        p server.create(ARGV[0], ARGV[1], :plan => opts[:plan], :ips => opts[:ips], :type => opts[:kind], 
-                        :username => opts[:username], :template => opts[:template], :node => opts[:node])
-      when 'server-status'
-        p server.status(ARGV[0])
-      when 'server-boot'
-        p server.boot(ARGV[0])
-      when 'server-reboot'
-        p server.reboot(ARGV[0])
-      when 'server-suspend'
-        p server.suspend(ARGV[0])
-      when 'server-resume'
-        p server.resume(ARGV[0])
-      when 'server-check-exists'
-        p server.exists?(ARGV[0])
-      when 'server-terminate'
-        p server.terminate(ARGV[0])
+      rescue Exception => e
+        puts "Error:  #{e}\n\n"
+        puts "Backtrace: \n\n"
+        puts e.backtrace.join("\n")
       end
     end
   else
     puts "#{meth} is not a valid function"
   end
-end
+end

data/lib/solusvm/base.rb

@@ -26,6 +26,7 @@ module Solusvm
         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)
         log_messages(options)
       end
@@ -38,6 +39,18 @@ module Solusvm
       XmlSimple.xml_in(body, 'ForceArray' => false)
     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
@@ -80,4 +93,4 @@ module Solusvm
       end
     end
   end
-end
+end

data/lib/solusvm/general.rb

@@ -16,5 +16,16 @@ module Solusvm
       perform_request(:action => 'node-statistics', :nodeid => nodeid)
       returned_parameters
     end
+
+    # List a nodes available IPs
+    def node_available_ips(nodeid)
+      perform_request(:action => 'node-iplist', :nodeid => nodeid)
+      puts statusmsg
+      if statusmsg.match /no available ip/i
+        []
+      else
+        returned_parameters['ips'].split(',')
+      end
+    end
   end
-end
+end

data/solusvm.gemspec

@@ -5,18 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{solusvm}
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Mazzi"]
-  s.date = %q{2010-07-24}
+  s.date = %q{2010-08-04}
   s.default_executable = %q{solusvm}
   s.description = %q{Solusvm allows for easy interaction with the SolusVM Admin::API.}
   s.email = %q{jmazzi@gmail.com}
   s.executables = ["solusvm"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
      "Gemfile",
      "Gemfile.lock",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION.yml",
      "bin/solusvm",
@@ -36,6 +36,9 @@ Gem::Specification.new do |s|
      "lib/solusvm/hash.rb",
      "lib/solusvm/server.rb",
      "solusvm.gemspec",
+     "test/fixtures/base_bad_key.txt",
+     "test/fixtures/base_node_does_not_exist.txt",
+     "test/fixtures/base_unauthorized_ip.txt",
      "test/fixtures/client_authenticate_error.txt",
      "test/fixtures/client_authenticate_success.txt",
      "test/fixtures/client_change_password_error.txt",
@@ -44,6 +47,8 @@ Gem::Specification.new do |s|
      "test/fixtures/client_create_success.txt",
      "test/fixtures/client_exists_success.txt",
      "test/fixtures/error.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_nodes_success.txt",
      "test/fixtures/general_templates_success.txt",

data/test/fixtures/base_bad_key.txt

@@ -0,0 +1 @@
+Invalid id or key

data/test/fixtures/base_node_does_not_exist.txt

@@ -0,0 +1 @@
+Node not found

data/test/fixtures/base_unauthorized_ip.txt

@@ -0,0 +1 @@
+Invalid ipaddress

data/test/fixtures/general_node_list_all_ips_available.txt

@@ -0,0 +1,4 @@
+<status>success</status>
+<statusmsg>Available ip addresses</statusmsg>
+<ipcount>3</ipcount>
+<ips>123.123.123.123,124.124.124.124,125.125.125.125</ips>

data/test/fixtures/general_node_list_all_ips_not_available.txt

@@ -0,0 +1,4 @@
+<status>success</status>
+<statusmsg>No available ip addresses</statusmsg>
+<ipcount>3</ipcount>
+<ips></ips>

data/test/test_base.rb

@@ -68,4 +68,37 @@ class TestBase < Test::Unit::TestCase
       assert_equal 'Invalid Virtual Server type: bob', e.message
     end
   end
+
+  def test_unautorized_ip
+    FakeWeb.register_uri(:get, "#{base_uri}&action=unauthorized", :body => load_response('base_unauthorized_ip'))
+    message = ""
+    begin
+      @base.perform_request(:action => 'unauthorized')
+    rescue Exception => e
+      message = e  
+    end
+    assert_equal "This IP is not authorized to use the API", message.to_s
+  end
+
+  def test_invalid_key_or_id
+    FakeWeb.register_uri(:get, "#{base_uri}&action=badkey", :body => load_response('base_bad_key'))
+    message = ""
+    begin
+      @base.perform_request(:action => 'badkey')
+    rescue Exception => e
+      message = e  
+    end
+    assert_equal "Invalid ID or key", message.to_s
+  end
+
+  def test_node_does_not_exist
+    FakeWeb.register_uri(:get, "#{base_uri}&action=nodeexist", :body => load_response('base_node_does_not_exist'))
+    message = ""
+    begin
+      @base.perform_request(:action => 'nodeexist')
+    rescue Exception => e
+      message = e  
+    end
+    assert_equal "Node does not exist", message.to_s
+  end
 end

data/test/test_general.rb

@@ -60,4 +60,20 @@ class TestGeneral < Test::Unit::TestCase
     assert_equal 'hostname.com', node_statistics['hostname']
     assert_equal 'success', node_statistics['status']
   end
-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'))
+    avaialble_ips = @general.node_available_ips(1)
+
+    expected_ips = %w(123.123.123.123 124.124.124.124 125.125.125.125).sort
+    assert !avaialble_ips.empty?
+    assert_equal expected_ips, avaialble_ips.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'))
+    avaialble_ips = @general.node_available_ips(1)
+
+    assert avaialble_ips.empty?
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: solusvm
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 1
-  version: 0.5.1
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Justin Mazzi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-24 00:00:00 -04:00
+date: 2010-08-04 00:00:00 -04:00
 default_executable: solusvm
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,14 +40,14 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION.yml
 - bin/solusvm
@@ -59,6 +59,9 @@ files:
 - lib/solusvm/hash.rb
 - lib/solusvm/server.rb
 - solusvm.gemspec
+- test/fixtures/base_bad_key.txt
+- test/fixtures/base_node_does_not_exist.txt
+- test/fixtures/base_unauthorized_ip.txt
 - test/fixtures/client_authenticate_error.txt
 - test/fixtures/client_authenticate_success.txt
 - test/fixtures/client_change_password_error.txt
@@ -67,6 +70,8 @@ files:
 - test/fixtures/client_create_success.txt
 - test/fixtures/client_exists_success.txt
 - test/fixtures/error.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_nodes_success.txt
 - test/fixtures/general_templates_success.txt

data/README.rdoc

@@ -1,85 +0,0 @@
-= Solusvm
-
-Solusvm allows for easy interaction with the SolusVM Admin::API.
-
-This library was first created for internal use at {Site5 LLC}[http://www.site5.com].
-
-== Basic Examples
-  Solusvm.config('api_id', 'api_password', :url => 'http://www.example.com/api')
-  server = Solusvm::Server.new
-
-  # 200 is the id of the virtual server
-  server.shutdown(200) # => true
-  server.boot(200) # => true
-  server.reboot(200) # => true
-  server.suspend(200) # => true
-  server.resume(200) # => true
-
-== Server creation
-  options = {:type => 'xen', :username => 'bob', :node => 'node1', :plan => 'plan1', :template => 'mytpl', :ips => 1}
-  result = sever.create('server.hostname.com', 'password', options}
-  p server.successful?
-  => true
-
-  p result
-  => {"mainipaddress"=>"127.0.0.1", "consoleuser"=>"console-user", "vserverid"=>"10", 
-  "statusmsg"=>"Virtual server created", "virtid"=>"vm10", "consolepassword"=>"myPassisL33t", 
-  "extraipaddress"=>{}, "hostname"=>"server.hostname", "rootpassword"=>"password", "status"=>"success"}
-
-
-== Command Line Usage
-  USAGE: solusvm <command> [options]
-      -I, --api-login [id]             API ID
-      -K, --api-key [key]              API KEY
-      -N, --node [node]                Node to provision on
-      -U, --api-url [URL]              URL to the API
-      -u, --username [username]        The client to put the VPS under
-      -k, --kind [kind]                Type of VPS (openvz,xen,xen hvm)
-      -t, --template [template]        VPS template to boot from
-      -p, --plan [plan]                Plan to use
-      -i, --ips [number]               Number of ips to add to the VPS
-      -h, --help                       Show help documentation
-  Commands:
-    server-check-exists <vserverid>
-    server-shutdown <vserverid>
-    server-changeplan <vserverid> <newplan>
-    server-resume <vserverid>
-    server-reboot <vserverid>
-    server-status <vserverid>
-    server-boot <vserverid>
-    server-create <hostname> <password> -t myimag -k xen -p myplan -i 1
-    server-suspend <vserverid>
-    server-addip <vserverid>
-
-== Default Config for Command Line
-The command line utility, solusvm, will look for a .solusvm.yml file in ~/. You can specify some defaults. 
-  ~/.solusvm.yml
-  id: api_id
-  key: api_key
-  # URL to the API endpoint
-  url: https://portal.yoursite.com/api/admin/command.php
-  # Default client to put servers under
-  username: bob
-
-== REQUIREMENTS:
-* xml-simple
-
-== DOCUMENTATION
-* http://solusvm.rubyforge.org/solusvm/
-
-== INSTALL:
-* gem install solusvm
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Site5. See LICENSE for details.