solusvm 1.4.0 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c51edb4b2a1565f254f3764f713865e60c9f0b7
-  data.tar.gz: d0940f9709bd079e7e68d7d95675e7a3c629a4c2
+  metadata.gz: db4b3b950573ce517e0c15de049ba58816bdab54
+  data.tar.gz: 31c21622c214c66e4f4f60c6af9560fa5e530f17
 SHA512:
-  metadata.gz: 9ea7f18ed0eea58289cd486fe03d81b754d5a474bd75250d2fc8e8363ccd0b4d83909c41e5d497a9c2a5f93d550ef38512340b68e720bd4ad466a2df92a1c8e4
-  data.tar.gz: dbb3c21df6def9db1cabee02f789978c3fa245b7d9f25782c84cacd79f085e407c494484fca18e66372f5225a5a71d1b6de620d7d7eb9122e8d40ba6e6aae7c8
+  metadata.gz: 6c1adec97375ad830ca77c3849c8840ccf1f293e353bd77678f500cf3eca001a9a33ee8c79b8c631a10b33fd66bc3478a204f77d9d18e119a9b4ed6063c6a345
+  data.tar.gz: 3e5701afdfa513977a781723997622070b5f44a6a02e69c3a8bcf19115297ad868480cad7360deb5f3553e8bcae029fff6c919721ae0deb3a648ee7ebfb750c6

data/Gemfile

@@ -1,4 +1,3 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in lol.gemspec
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012 Site5.com <http://www.site5.com/>
+Copyright (c) 2010-2014 Site5.com <http://www.site5.com/>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -4,167 +4,210 @@ SolusVM [![SolusVM Build Status][Build Icon]][Build Status]
 SolusVM allows for easy interaction with the [SolusVM Admin::API][].
 This library was first created for internal use at [Site5 LLC][].
 
-SolusVM has been tested on MRI 1.9.2, MRI 1.9.3 and 1.9-compatible JRuby.
+SolusVM has been tested on MRI versions 1.9.2, 1.9.3, 2.0.0 and 1.9-compatible
+JRuby.
+
+Documentation is available in [TomDoc][] format.
 
 [Site5 LLC]: http://www.site5.com
-[SolusVM Admin::API]: http://wiki.solusvm.com/index.php/API:Admin
+[SolusVM Admin::API]: http://docs.solusvm.com/v2/Default.htm#Developer/Admin-Api/Admin-Api.htm
 [Build Status]: http://travis-ci.org/site5/solusvm
 [Build Icon]: https://secure.travis-ci.org/site5/solusvm.png?branch=master
+[TomDoc]: http://site5.github.io/solusvm/
 
 Basic Examples
 --------------
 
-    server = Solusvm::Server.new(api_key: 'key', api_id: 'id', url: 'url')
+```ruby
+server = SolusVM::Server.new(api_key: 'key', api_id: 'id', url: 'url')
 
-    # 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
+# 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
+```ruby
+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"}
+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
 ------------------
 
-    Tasks:
-        solusvm client <command>    # Client commands
-        solusvm general <command>   # General commands
-        solusvm help [TASK]         # Describe available tasks or one specific task
-        solusvm node <command>      # Node commands
-        solusvm reseller <command>  # Reseller commands
-        solusvm server <command>    # Server commands
-        solusvm version             # Outputs the current program version
-
-        solusvm client authenticate USERNAME NEWPASSWORD     # Verify a clients login. Returns true when the specified login is correct
-        solusvm client change-password USERNAME NEWPASSWORD  # Changes the password of an existing client
-        solusvm client check-exists USERNAME                 # Checks if a client exists
-        solusvm client create                                # Creates a new client
-        solusvm client delete USERNAME                       # Deletes an existing client
-        solusvm client help [COMMAND]                        # Describe subcommands or one specific subcommand
-        solusvm client list                                  # Lists existing clients
-
-        solusvm general help [COMMAND]  # Describe subcommands or one specific subcommand
-        solusvm general isos TYPE       # Lists existing isos for a given type [openvz|xen|xen hvm|kvm]
-        solusvm general plans TYPE      # Lists existing plans for a given type [openvz|xen|xen hvm|kvm]
-        solusvm general templates TYPE  # Lists existing templates for a given type [openvz|xen|xen hvm|kvm]
-
-        solusvm node available-ips VSERVERID   # Lists the available ips for a given node
-        solusvm node help [COMMAND]            # Describe subcommands or one specific subcommand
-        solusvm node list TYPE                 # Lists existing nodes for a given type [openvz|xen|xen hvm|kvm]
-        solusvm node list-ids TYPE             # Lists existing nodes ids for a given type [openvz|xen|xen hvm|kvm]
-        solusvm node stats VSERVERID           # Lists statistics for a given node
-        solusvm node virtualservers VSERVERID  # Lists the virtual servers for a given node
-        solusvm node xenresources VSERVERID    # Lists xen resources for a given node
-
-        solusvm reseller change           # Changes the available resources of a reseller
-        solusvm reseller create           # Creates a new reseller
-        solusvm reseller delete USERNAME  # Deletes an existing reseller
-        solusvm reseller help [COMMAND]   # Describe subcommands or one specific subcommand
-        solusvm reseller info USERNAME    # Retrieves information from an existing reseller
-        solusvm reseller list             # Lists existing resellers
-
-        solusvm server addip VSERVERID                            # Adds an ip to the server
-        solusvm server boot VSERVERID                             # Boots up a server
-        solusvm server change-bootorder VSERVERID BOOTORDER       # Changes the boot order of a server [cd(Hard Disk CDROM)|dc(CDROM Hard Disk)|c(Hard Di...
-        solusvm server change-consolepass VSERVERID NEWPASSWORD   # Changes the console password of a server
-        solusvm server change-hostname VSERVERID HOSTNAME         # Changes the hostname of a server
-        solusvm server change-owner VSERVERID CLIENTID            # Changes the owner of a server
-        solusvm server change-plan VSERVERID NEWPLAN              # Changes the plan of a server
-        solusvm server change-rootpass VSERVERID NEWPASSWORD      # Changes the root password of a server
-        solusvm server change-vncpass VSERVERID NEWPASSWORD       # Changes the vnc password of a server
-        solusvm server check-exists VSERVERID                     # Checks if a server exists
-        solusvm server console VSERVERID                          # Retrieves console information from a server
-        solusvm server create HOSTNAME PASSWORD                   # Creates a new server
-        solusvm server help [COMMAND]                             # Describe subcommands or one specific subcommand
-        solusvm server info VSERVERID                             # Retrieves information from a server
-        solusvm server info-all VSERVERID                         # Retrieves all availavle information from a server
-        solusvm server mountiso VSERVERID ISO                     # Mounts an iso
-        solusvm server network-switcher VSERVERID SWITCH(on|off)  # Enable/Disable Network mode
-        solusvm server pae-switcher VSERVERID SWITCH(on|off)      # Enable/Disable PAE
-        solusvm server reboot VSERVERID                           # Reboots a server
-        solusvm server rebuild VSERVERID                          # Rebuilds a server
-        solusvm server resume VSERVERID                           # Resumes a server
-        solusvm server shutdown VSERVERID                         # Shuts down a server
-        solusvm server status VSERVERID                           # Checks the status of a server
-        solusvm server suspend VSERVERID                          # Suspends a server
-        solusvm server terminate VSERVERID                        # Terminates a server
-        solusvm server tun-switcher VSERVERID SWITCH(on|off)      # Enable/Disable TUN/TAP
-        solusvm server unmountiso VSERVERID                       # Unmounts an iso
-        solusvm server vnc VSERVERID                              # Retrieves vnc information from a server
-
-    Options:
-        -I, --api-login, [--api-login=API_LOGIN]  # API ID. Required.
-        -K, --api-key, [--api-key=API_KEY]        # API KEY. Required.
-        -U, --api-url, [--api-url=API_URL]        # API URL. Required.
-
-
-    To check the available options for a given action, you can execute the following command:
-
-        solusvm server help create
+```
+Tasks:
+    solusvm client <command>    # Client commands
+    solusvm general <command>   # General commands
+    solusvm help [TASK]         # Describe available tasks or one specific task
+    solusvm node <command>      # Node commands
+    solusvm reseller <command>  # Reseller commands
+    solusvm server <command>    # Server commands
+    solusvm version             # Outputs the current program version
+
+    solusvm client authenticate USERNAME NEWPASSWORD     # Verify a clients login. Returns true when the specified login is correct
+    solusvm client change-password USERNAME NEWPASSWORD  # Changes the password of an existing client
+    solusvm client check-exists USERNAME                 # Checks if a client exists
+    solusvm client create                                # Creates a new client
+    solusvm client delete USERNAME                       # Deletes an existing client
+    solusvm client help [COMMAND]                        # Describe subcommands or one specific subcommand
+    solusvm client list                                  # Lists existing clients
+
+    solusvm general help [COMMAND]  # Describe subcommands or one specific subcommand
+    solusvm general isos TYPE       # Lists existing isos for a given type [openvz|xen|xen hvm|kvm]
+    solusvm general plans TYPE      # Lists existing plans for a given type [openvz|xen|xen hvm|kvm]
+    solusvm general templates TYPE  # Lists existing templates for a given type [openvz|xen|xen hvm|kvm]
+
+    solusvm node available-ips VSERVERID   # Lists the available ips for a given node
+    solusvm node help [COMMAND]            # Describe subcommands or one specific subcommand
+    solusvm node list TYPE                 # Lists existing nodes for a given type [openvz|xen|xen hvm|kvm]
+    solusvm node list-ids TYPE             # Lists existing nodes ids for a given type [openvz|xen|xen hvm|kvm]
+    solusvm node stats VSERVERID           # Lists statistics for a given node
+    solusvm node virtualservers VSERVERID  # Lists the virtual servers for a given node
+    solusvm node xenresources VSERVERID    # Lists xen resources for a given node
+
+    solusvm reseller change           # Changes the available resources of a reseller
+    solusvm reseller create           # Creates a new reseller
+    solusvm reseller delete USERNAME  # Deletes an existing reseller
+    solusvm reseller help [COMMAND]   # Describe subcommands or one specific subcommand
+    solusvm reseller info USERNAME    # Retrieves information from an existing reseller
+    solusvm reseller list             # Lists existing resellers
+
+    solusvm server addip VSERVERID                            # Adds an ip to the server
+    solusvm server boot VSERVERID                             # Boots up a server
+    solusvm server change-bootorder VSERVERID BOOTORDER       # Changes the boot order of a server [cd(Hard Disk CDROM)|dc(CDROM Hard Disk)|c(Hard Di...
+    solusvm server change-consolepass VSERVERID NEWPASSWORD   # Changes the console password of a server
+    solusvm server change-hostname VSERVERID HOSTNAME         # Changes the hostname of a server
+    solusvm server change-owner VSERVERID CLIENTID            # Changes the owner of a server
+    solusvm server change-plan VSERVERID NEWPLAN              # Changes the plan of a server
+    solusvm server change-rootpass VSERVERID NEWPASSWORD      # Changes the root password of a server
+    solusvm server change-vncpass VSERVERID NEWPASSWORD       # Changes the vnc password of a server
+    solusvm server check-exists VSERVERID                     # Checks if a server exists
+    solusvm server console VSERVERID                          # Retrieves console information from a server
+    solusvm server create HOSTNAME PASSWORD                   # Creates a new server
+    solusvm server help [COMMAND]                             # Describe subcommands or one specific subcommand
+    solusvm server info VSERVERID                             # Retrieves information from a server
+    solusvm server info-all VSERVERID                         # Retrieves all availavle information from a server
+    solusvm server mountiso VSERVERID ISO                     # Mounts an iso
+    solusvm server network-switcher VSERVERID SWITCH(on|off)  # Enable/Disable Network mode
+    solusvm server pae-switcher VSERVERID SWITCH(on|off)      # Enable/Disable PAE
+    solusvm server reboot VSERVERID                           # Reboots a server
+    solusvm server rebuild VSERVERID                          # Rebuilds a server
+    solusvm server resume VSERVERID                           # Resumes a server
+    solusvm server shutdown VSERVERID                         # Shuts down a server
+    solusvm server status VSERVERID                           # Checks the status of a server
+    solusvm server suspend VSERVERID                          # Suspends a server
+    solusvm server terminate VSERVERID                        # Terminates a server
+    solusvm server tun-switcher VSERVERID SWITCH(on|off)      # Enable/Disable TUN/TAP
+    solusvm server unmountiso VSERVERID                       # Unmounts an iso
+    solusvm server vnc VSERVERID                              # Retrieves vnc information from a server
+
+Options:
+    -I, --api-login, [--api-login=API_LOGIN]  # API ID. Required.
+    -K, --api-key, [--api-key=API_KEY]        # API KEY. Required.
+    -U, --api-url, [--api-url=API_URL]        # API URL. Required.
+
+
+To check the available options for a given action, you can execute the following command:
+
+    solusvm server help create
+```
 
 Default Config for Command Line
 --------------------------------
 
-The command line utility, solusvm, will look for a .solusvm.yml file in ~/. You can specify some defaults. 
+The command line utility, `solusvm`, will look for a config file in
+`~/.solusvm.yml`. 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
+```
+~/.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
+Installation
 ------------
 
-* xml-simple
+To install SolusVM using [Bundler](http://gembundler.com):
 
-Documentation
--------------
+```
+echo "gem 'solusvm'" >> Gemfile
+bundle install
+```
 
-* http://solusvm.rubyforge.org/solusvm/
+To install SolusVM globally using RubyGems:
 
-Installation
-------------
+```
+gem install solusvm
+```
 
-    gem install solusvm
+Upgrading to SolusVM 2
+----------------------
+
+Version 2 of the SolusVM gem uses the JSON API that was introduced in the
+SolusVM Admin API in version v1.14. If you are using SolusVM software older
+than v1.14, you will need to stick to an older version of this gem (i.e.
+[v1.4.0](https://github.com/site5/solusvm/tree/v1.4.0)).
+
+Version 2 also changes the name of the gem's top-level module -- it is now
+`SolusVM` instead of the old `Solusvm`. Upgrading will require changing this
+in your code.
 
 Contributors
 ------------
 
-* [Justin Mazzi](http://github.com/jmazzi)
-* [Maran H.](http://github.com/maran)
-* [Joshua Priddle](http://github.com/itspriddle)
-* [Vince Stratful](http://github.com/Vincepbell)
-* [Rubem Nakamura](http://github.com/rubemz)
+SolusVM was originally written by [jmazzi](https://github.com/site5/jmazzi)
+for internal use at Site5.com. Additional contributors are [listed on
+GitHub](https://github.com/site5/solusvm/graphs/contributors).
+
+Tests
+-----
+
+SolusVM uses test-unit for tests. To run:
+
+```
+bundle exec rake # Runs all tests
+bundle exec ruby -I"lib:test" test/path/test_file.rb
+```
 
 Note on Patches/Pull Requests
 -----------------------------
- 
+
 * Fork the project.
 * Add yourself to the Contributors list
 * 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)
+  (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-2013 Site5.com. See LICENSE for details.
+Copyright (c) 2010-2014 Site5.com. See LICENSE for details.

data/Rakefile

@@ -1,8 +1,7 @@
-require 'rubygems'
 require 'rake'
 require 'bundler/gem_tasks'
-
 require 'rake/testtask'
+require 'rake-tomdoc'
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -10,34 +9,5 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-begin
-  require 'rdoc/task'
-  Rake::RDocTask.new do |rdoc|
-    version = Solusvm::VERSION
-
-    rdoc.rdoc_dir = 'rdoc'
-    rdoc.title = "solusvm #{version}"
-    rdoc.rdoc_files.include('README*')
-    rdoc.rdoc_files.include('lib/**/*.rb')
-  end
-rescue LoadError
-  task :rdoc do
-    abort "rdoc is not available. In order to run rdoc, you must: sudo gem install rdoc"
-  end
-end
-
-task :default => :test
-task :spec => :test
+task default: :test
+task spec: :test

data/bin/solusvm

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 
-$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
-
-require "thor"
+# Setup bundler if this script is called directly
+require "bundler/setup" if $0 == __FILE__
 require "solusvm/cli"
 
-Solusvm::Cli.start
+SolusVM::CLI.start

data/lib/solusvm.rb

@@ -1,9 +1,7 @@
-require 'cgi'
-require 'rubygems'
-require 'xmlsimple'
 require 'faraday'
 
 require 'solusvm/hash'
+require 'solusvm/errors'
 require 'solusvm/base'
 require 'solusvm/general'
 require 'solusvm/client'

data/lib/solusvm/base.rb

@@ -1,5 +1,5 @@
-module Solusvm
-  # Solusvm::Base is the main class for mapping API resources as subclasses.
+module SolusVM
+  # SolusVM::Base is the main class for mapping API resources as subclasses.
   class Base
     VALID_SERVER_TYPES = ["openvz", "xen", "xen hvm"]
 
@@ -9,63 +9,94 @@ module Solusvm
       @config = config
     end
 
-    # Prepares and sends the API request to the URL specificed in Solusvm.config
+    # Public: Prepares and sends the API request to the URL specified in
+    # `@config`.
     #
-    #  class MyClass < Base
-    #    def create_server(name)
-    #      perform_request(:action => "name", :id => 1)
-    #    end
-    #  end
+    # options - A Hash of options. Any options not listed below are converted
+    #           to HTTP query arguments and are passed along to the API.
+    #           :action - Specifies which API method to execute
     #
-    # Options:
-    # * <tt>:action</tt> - Specifies which API method to execute
-    # All other options passed in are converted to http query arguments and are passed along to the API
+    # Example
     #
-    # <tt>force_array</tt> - see parse_response
-    def perform_request(options = {}, force_array = false)
-      ca_path  = File.join(File.dirname(__FILE__), "..", "cacert.pem")
-      ssl      = {verify: true, ca_file: File.expand_path(ca_path)}
+    #     class MyClass < Base
+    #       def create_server(name)
+    #         perform_request(:action => "name", :id => 1)
+    #       end
+    #     end
+    #
+    # Returns true if the request was successful.
+    def perform_request(options = {})
+      options.reject! { |_, v| v.nil? }
 
-      options.reject! {|_,v| v.nil? }
+      # Force JSON responses
+      options[:rdtype] = "json"
 
-      response = Faraday.new(url: api_endpoint, ssl: ssl) do |c|
-        c.params = options.merge(api_login)
-        c.adapter :net_http
-      end.get
+      response = conn.get api_endpoint, options.merge(api_login)
 
-      @returned_parameters = parse_response(response.status, response.body, force_array)
+      @returned_parameters = parse_response(response.status, response.body)
       log_messages(options)
       successful?
     end
 
-    # Converts the XML response to a Hash
+    # Public: Creates a Faraday connection.
     #
-    # <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(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)
+    # Returns a Faraday::Connection.
+    def conn
+      @conn ||= Faraday.new(ssl: ssl_option) do |c|
+        c.request :retry if @config.fetch(:retry_request, false)
+        c.adapter :net_http
       end
     end
 
-    # Parses a returned_parameters value as a list, if present.
+    # Public: SSL options used when creating a Faraday connection.
+    #
+    # Returns a Hash.
+    def ssl_option
+      {
+        verify: true,
+        ca_file: File.expand_path("../../cacert.pem", __FILE__)
+      }
+    end
+
+    # Public: Converts the XML response to a Hash.
+    #
+    # status - Faraday::Response#status
+    # body   - Faraday::Response#body
+    #
+    # Returns a Hash.
+    def parse_response(status, body)
+      parse_error(status, body) || JSON.parse(body)
+    end
+
+    # Public: Parses a returned_parameters value as a list, if present.
+    #
+    # attribute - The attribute to check
+    #
+    # Returns an Array or nil.
     def parse_returned_params_as_list(attribute)
       if returned_parameters[attribute] && !returned_parameters[attribute].empty?
         returned_parameters[attribute].to_s.split(",")
       end
     end
 
-    # Parses error responses.
+    # Public: Parses error responses.
+    #
+    # status - HTTP status code
+    # body   - Raw body
+    #
+    # Raises SolusVM::AuthenticationError if there is an error authenticating
+    # with the API. This can happen if the request IP is not authorized, or if
+    # an invalid API key/id was provided.
+    #
+    # Returns a Hash or nil.
     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" }
+          raise AuthenticationError, "This IP is not authorized to use the API"
         when /Invalid id or key/i
-          { "status" => "error", "statusmsg" => "Invalid ID or key" }
+          raise AuthenticationError, "Invalid ID or key"
         when /Node not found/i
           { "status" => "error", "statusmsg" => "Node does not exist" }
         end
@@ -74,24 +105,26 @@ module Solusvm
       end
     end
 
-    # Returns true when a request has been successful
+    # Public: Check if the request was successful.
+    #
+    #     my_class = MyClass.new
+    #     my_class.create_server("example.com")
+    #     my_class.successful? # => true
     #
-    #   my_class = MyClass.new
-    #   my_class.create_server("example.com")
-    #   my_class.successful? # => true
+    # Returns true if the request was successful.
     def successful?
       returned_parameters["status"].nil? || returned_parameters["status"] == "success"
     end
 
-    # Returns the API endpoint set in the instance configuration. Otherwise,
-    # it returns the default configuration.
+    # Public: Returns the API endpoint set in the instance configuration.
+    # Otherwise, it returns the default configuration.
     #
     # Returns a String
     def api_endpoint
       @config.fetch(:url)
     end
 
-    # Returns the API id set in the instance configuration. Otherwise,
+    # Public: Returns the API id set in the instance configuration. Otherwise,
     # it returns the default configuration.
     #
     # Returns a String
@@ -99,24 +132,38 @@ module Solusvm
       @config.fetch(:api_id)
     end
 
-    # Returns the API key set in the instance configuration. Otherwise,
-    # it returns the default configuration.
+    # Public: Returns the API key set in the instance configuration.
+    # Otherwise, it returns the default configuration.
     #
-    # Returns a String
+    # Returns a String.
     def api_key
       @config.fetch(:api_key)
     end
 
+    # Public: API options
+    #
+    # option - Key to fetch
+    #
+    # Returns the given option.
     def api_options(option)
       if options = @config[:options]
         options[option.to_sym]
       end
     end
 
+    # Public: API login information.
+    #
+    # Returns a Hash.
     def api_login
-      {id: api_id, key: api_key}
+      { id: api_id, key: api_key }
     end
 
+    # Public: Logs API actions to the configured logger.
+    #
+    # options - A Hash of options
+    #           :action - the API action
+    #
+    # Returns nothing.
     def log_messages(options)
       logger, logger_method = api_options(:logger), api_options(:logger_method)
 
@@ -129,12 +176,20 @@ module Solusvm
       end
     end
 
-    # API response message
+    # Public: API response message
+    #
+    # Returns a String.
     def statusmsg
       returned_parameters["statusmsg"]
     end
 
-    # Validates the server type.
+    # Public: Validates the server type.
+    #
+    # type - The server type to check
+    #
+    # Yields a required block if given server type is valid.
+    #
+    # Returns the result of the block, or false if the server type is invalid.
     def validate_server_type(type, &block)
       type = type.strip