squall 1.3.0 → 1.3.1

data/lib/squall.rb

@@ -1,13 +1,12 @@
+require 'yaml'
 require 'faraday'
 require 'faraday_middleware'
 
 require 'squall/support/version'
 require 'squall/support/exception'
-require 'squall/support/yaml'
 
 module Squall
   # Support
-  autoload :Params,         'squall/support/params'
   autoload :Config,         'squall/support/config'
   autoload :Base,           'squall/support/base'
   # Api
@@ -28,6 +27,7 @@ module Squall
   autoload :DataStoreZone,  'squall/data_store_zone'
   autoload :NetworkZone,    'squall/network_zone'
   autoload :HypervisorZone, 'squall/hypervisor_zone'
+  autoload :Disk,           'squall/disk'
 
   extend self
 
@@ -39,53 +39,55 @@ module Squall
 
   self.configuration ||= Squall::Config.new
 
-  # Specificy the config via block
+  # Public: Configures Squall.
   #
-  # ==== Attributes
+  # Yields Squall.configuration if a block is given.
   #
-  # * +base_uri+ - URL of your OnApp instance
-  # * +username+ - API username
-  # * +password+ - API Password
-  # * +debug+ - Toggle debug mode to log HTTParty
+  # Example
   #
-  # ==== Example
+  #     Squall.config do |c|
+  #       c.base_uri 'http://onapp.myserver.com'
+  #       c.username 'myuser'
+  #       c.password 'mypass'
+  #       c.debug    true
+  #     end
   #
-  #   Squall.config do |c|
-  #     c.base_uri 'http://onapp.myserver.com'
-  #     c.username 'myuser'
-  #     c.password 'mypass'
-  #   end
+  # Returns a Hash.
   def config
     yield self.configuration if block_given?
     self.configuration.config
   end
 
-  # Load the config from a YAML file
+  # Public: Load the config from a YAML file.
   #
-  # ==== Options
+  # file - Path to the YAML file, defaults to `~/.squall.yml`
   #
-  # * +file+ - Path to the YAML file (default is ~/.squall.yml)
+  # Raises ArgumentError if the config file does not exist.
   #
-  # ==== Example
+  # Example
   #
-  #   Squall.config_file # (loads ~/.squall.yml)
+  #     # Load default config file at `~/.squall.yml`:
+  #     Squall.config_file
   #
-  #   Squall.config_file '/path/to/squall.yml'
+  #     # Load custom config file:
+  #     Squall.config_file '/path/to/squall.yml'
   #
-  def config_file(file = nil)
-    file = File.expand_path(File.expand_path(File.join(ENV['HOME'], '.squall.yml'))) if file.nil?
+  # Returns nothing.
+  def config_file(file = File.expand_path("~/.squall.yml"))
     if File.exists?(file)
       self.configuration_file = file
     else
       raise ArgumentError, "Config file doesn't exist '#{file}'"
     end
-    settings = YAML::load_file(file)
+
     config do |c|
-      settings.each { |k, v| c.send(k, v) }
+      YAML::load_file(file).each { |k, v| c.send(k, v) }
     end
   end
 
-  # Reset the config (aka, clear it)
+  # Public: Reset the config (aka, clear it)
+  #
+  # Returns an instance of Squall::Config.
   def reset_config
     self.configuration = Squall::Config.new
   end

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-require 'yaml'
 require 'rspec'
 require 'vcr'
 require 'squall'
@@ -7,9 +6,9 @@ VCR.config do |c|
   c.cassette_library_dir = 'spec/vcr_cassettes'
   c.stub_with :fakeweb
   if ENV['RERECORD']
-    c.default_cassette_options = {:record => :all}
+    c.default_cassette_options = {record: :all}
   else
-    c.default_cassette_options = {:record => :none}
+    c.default_cassette_options = {record: :none}
   end
   c.filter_sensitive_data("Basic <REDACTED>") { |i| [i.request.headers['authorization']].flatten.first }
   c.filter_sensitive_data("<REDACTED>") { |i| [i.response.headers['set-cookie']].flatten.first }
@@ -30,7 +29,7 @@ end
 
 def configure_for_tests
   if ENV['RERECORD']
-    Squall.config_file 	
+    Squall.config_file
   else
     Squall.config do |c|
       c.username "test"
@@ -40,13 +39,9 @@ def configure_for_tests
   end
 end
 
-def requires_attr(attr, &block)
-  expect { block.call }.to raise_error(ArgumentError, /Missing required params: #{attr}/i)
-end
-
 def mock_request(meth, path, options = {})
   config = Squall.config
-  uri    = URI.parse(Squall.config[:base_uri])
+  uri    = URI.parse(config[:base_uri])
   url    = "#{uri.scheme}://#{config[:username]}:#{config[:password]}@#{uri.host}:#{uri.port}#{path}"
-  FakeWeb.register_uri(meth, url, {:content_type => 'application/json'}.merge(options))
-end
+  FakeWeb.register_uri(meth, url, {content_type: 'application/json'}.merge(options))
+end

data/spec/squall/data_store_zone_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Squall::DataStoreZone do
   before(:each) do
     @data_store_zone = Squall::DataStoreZone.new
-    @valid = {:label => "My zone"}
+    @valid = {label: "My zone"}
   end
 
   describe "#list" do
@@ -22,9 +22,6 @@ describe Squall::DataStoreZone do
 
   describe "#show" do
     use_vcr_cassette "data_store_zone/show"
-    it "requires an id" do
-      expect { @data_store_zone.show }.to raise_error(ArgumentError)
-    end
 
     it "returns a data store zone" do
       data_store_zone = @data_store_zone.show(1)
@@ -34,14 +31,6 @@ describe Squall::DataStoreZone do
 
   describe "#create" do
     use_vcr_cassette "data_store_zone/create"
-    it "requires label" do
-      invalid = @valid.reject{|k,v| k == :label }
-      requires_attr(:label) { @data_store_zone.create(invalid) }
-    end
-
-    it "raises error on unknown params" do
-      expect { @data_store_zone.create(@valid.merge(:what => 'what')) }.to raise_error(ArgumentError, 'Unknown params: what')
-    end
 
     it "creates a data store zone" do
       @data_store_zone.create(@valid)
@@ -60,21 +49,14 @@ describe Squall::DataStoreZone do
       end
     end
 
-    it "raises error on unknown params" do
-      expect { @data_store_zone.edit(1, @valid.merge(:what => 'what')) }.to raise_error(ArgumentError, 'Unknown params: what')
-    end
-
     it "edits a data store zone" do
-      @data_store_zone.edit(1, :label => "Updated zone")
+      @data_store_zone.edit(1, label: "Updated zone")
       @data_store_zone.success.should be_true
     end
   end
 
   describe "#delete" do
     use_vcr_cassette "data_store_zone/delete"
-    it "requires an id" do
-      expect { @data_store_zone.delete }.to raise_error(ArgumentError)
-    end
 
     it "deletes a data store zone" do
       @data_store_zone.delete(1)

data/spec/squall/disk_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+describe Squall::Disk do
+  before(:each) do
+    @disk = Squall::Disk.new
+    @valid = { data_store_id: 1, disk_size: 2, is_swap: 0,
+               mount_point: '/disk2', add_to_linux_fstab: 0,
+               require_format_disk: 1 }
+  end
+
+  describe "#list" do
+    use_vcr_cassette "disk/list"
+
+    it "returns all disk" do
+      disks = @disk.list
+      disks.should be_an(Array)
+    end
+
+    it "contains the disk data" do
+      disks = @disk.list
+      disks.all? { |w| w.is_a?(Hash) }.should be_true
+    end
+
+    it "contains correct disk data" do
+      disks = @disk.list
+      disks.all? { |w| !w['disk_vm_number'].nil? }.should be_true
+    end
+  end
+
+  describe "#vm_disk_list" do
+    use_vcr_cassette "disk/vm_disk_list"
+
+    it "returns all VM disk" do
+      disks = @disk.vm_disk_list(58)
+      disks.should be_an(Array)
+    end
+
+    it "contains the disk data" do
+      disks = @disk.vm_disk_list(58)
+      disks.all? { |w| w.is_a?(Hash) }.should be_true
+    end
+
+    it "contains correct disk data" do
+      disks = @disk.vm_disk_list(58)
+      disks.all? { |w| !w['disk_vm_number'].nil? }.should be_true
+    end
+  end
+
+  describe "#create" do
+    use_vcr_cassette "disk/create"
+
+    it "creates a disk" do
+      @disk.create(58, @valid)
+      @disk.success.should be_true
+    end
+  end
+
+  describe "#edit" do
+    use_vcr_cassette "disk/edit"
+
+    it "accepts valid params" do
+      @disk.edit(78, disk_size: 3)
+      @disk.success.should be_true
+    end
+  end
+
+
+  describe "#migrate" do
+    use_vcr_cassette "disk/migrate"
+
+    it "should return association error" do
+      migrate = @disk.migrate(58, 78, data_store_id: 2)
+      @disk.success.should be_false
+      migrate['errors'].should include("Data store cannot be associated with this virtual machine.")
+    end
+  end
+
+  describe "#iops_usage" do
+    use_vcr_cassette "disk/iops_usage"
+
+    it "returns a disk IOPS usage" do
+      usage = @disk.iops_usage(77)
+      usage.should be_a(Array)
+      usage.all? { |w| w.is_a?(Hash) }.should be_true
+      usage.all? { |w| !w['stat_time'].nil? }.should be_true
+    end
+  end
+
+  describe "#build" do
+    use_vcr_cassette "disk/build"
+
+    it "builds a disk" do
+      @disk.build(78)
+      @disk.success.should be_true
+    end
+
+    it "returns disk info" do
+      build = @disk.build(78)
+      build.should be_a(Hash)
+      build['id'].should eq 78
+    end
+  end
+
+  describe "#unlock" do
+    use_vcr_cassette "disk/unlock"
+
+    it "unlocks a disk" do
+      @disk.unlock(78)
+      @disk.success.should be_true
+    end
+
+    it "returns disk info" do
+      unlock = @disk.unlock(78)
+      unlock.should be_a(Hash)
+      unlock['id'].should eq 78
+    end
+  end
+
+  describe "#auto_backup_on" do
+    use_vcr_cassette "disk/auto_backup_on"
+
+    it "enable auto_backup for disk" do
+      @disk.auto_backup_on(78)
+      @disk.success.should be_true
+    end
+
+    it "returns disk info" do
+      backup = @disk.auto_backup_on(78)
+      backup.should be_a(Hash)
+      backup['id'].should eq 78
+    end
+  end
+
+  describe "#auto_backup_off" do
+    use_vcr_cassette "disk/auto_backup_off"
+
+    it "disable auto_backup for disk" do
+      @disk.auto_backup_off(78)
+      @disk.success.should be_true
+    end
+
+    it "returns disk info" do
+      backup = @disk.auto_backup_off(78)
+      backup.should be_a(Hash)
+      backup['id'].should eq 78
+    end
+  end
+
+  describe "#schedules" do
+    use_vcr_cassette "disk/schedules"
+
+    it "returns schedules for a disk" do
+      schedules = @disk.schedules(78)
+      schedules.should be_a(Array)
+      schedules.all? { |w| !w['target_id'].nil? }.should be_true
+    end
+  end
+
+  describe "#add_schedule" do
+    use_vcr_cassette "disk/add_schedule"
+
+    it "adds schedule for a disk" do
+      disk = @disk.add_schedule(78, action: 'autobackup', duration: 1, period: 'days')
+      @disk.success.should be_true
+      disk.should be_a(Array)
+    end
+  end
+
+  describe "#backups" do
+    use_vcr_cassette "disk/backups"
+
+    it "lists backups for a disk" do
+      backups = @disk.backups(78)
+      @disk.success.should be_true
+      backups.should be_a(Array)
+      backups.all? { |w| !w['disk_id'].nil? }.should be_true
+    end
+  end
+
+  describe "#delete" do
+    use_vcr_cassette "disk/delete"
+
+    it "deletes a disk" do
+      @disk.delete(78)
+      @disk.success.should be_true
+    end
+  end
+
+end

data/spec/squall/firewall_rule_spec.rb

@@ -3,16 +3,12 @@ require 'spec_helper'
 describe Squall::FirewallRule do
   before(:each) do
     @firewall_rule = Squall::FirewallRule.new
-    @valid = {:command => "DROP", :protocol => "TCP", :network_interface_id => 1}
+    @valid = {command: "DROP", protocol: "TCP", network_interface_id: 1}
   end
 
   describe "#list" do
     use_vcr_cassette "firewall_rule/list"
 
-    it "requires vm id" do
-      expect { @firewall_rule.list }.to raise_error(ArgumentError)
-    end
-
     it "returns a list of firewall rules for a vm" do
       firewall_rules = @firewall_rule.list(1)
       firewall_rules.should be_an(Array)
@@ -26,20 +22,6 @@ describe Squall::FirewallRule do
 
   describe "#create" do
     use_vcr_cassette "firewall_rule/create"
-    it "requires command" do
-      invalid = @valid.reject{|k,v| k == :command }
-      requires_attr(:command) { @firewall_rule.create(1, invalid) }
-    end
-
-    it "requires protocol" do
-      invalid = @valid.reject{|k,v| k == :protocol }
-      requires_attr(:protocol) { @firewall_rule.create(1, invalid) }
-    end
-
-    it "requires network_interface_id" do
-      invalid = @valid.reject{|k,v| k == :network_interface_id }
-      requires_attr(:network_interface_id) { @firewall_rule.create(1, invalid) }
-    end
 
     it "allows all optional params" do
       optional = [:network_interface_id, :address, :port]
@@ -49,10 +31,6 @@ describe Squall::FirewallRule do
       end
     end
 
-    it "raises error on unknown params" do
-      expect { @firewall_rule.create(1, @valid.merge(:what => 'what')) }.to raise_error(ArgumentError, 'Unknown params: what')
-    end
-
     it "creates a firewall rule for a virtual machine" do
       @firewall_rule.create(1, @valid)
       @firewall_rule.success.should be_true
@@ -70,12 +48,8 @@ describe Squall::FirewallRule do
       end
     end
 
-    it "raises error on unknown params" do
-      expect { @firewall_rule.edit(1, 1, :what => 'what') }.to raise_error(ArgumentError, 'Unknown params: what')
-    end
-
     it "edits a firewall rule" do
-      @firewall_rule.edit(1, 1, :port => 1000)
+      @firewall_rule.edit(1, 1, port: 1000)
       @firewall_rule.success.should be_true
     end
   end
@@ -83,10 +57,6 @@ describe Squall::FirewallRule do
   describe "#delete" do
     use_vcr_cassette "firewall_rule/delete"
 
-    it "requires an id" do
-      expect { @firewall_rule.delete }.to raise_error(ArgumentError)
-    end
-
     it "deletes a firewall rule" do
       @firewall_rule.delete(1, 1)
       @firewall_rule.success.should be_true

data/spec/squall/hypervisor_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Squall::Hypervisor do
   before(:each) do
     @hv = Squall::Hypervisor.new
-    @valid = {:label => 'A new hypervisor', :ip_address => '127.126.126.126', :hypervisor_type => 'xen'}
+    @valid = {label: 'A new hypervisor', ip_address: '127.126.126.126', hypervisor_type: 'xen'}
   end
 
   describe "#list" do
@@ -23,9 +23,6 @@ describe Squall::Hypervisor do
 
   describe "#show" do
     use_vcr_cassette "hypervisor/show"
-    it "requires an id" do
-      expect { @hv.show }.to raise_error(ArgumentError)
-    end
 
     it "returns a hv" do
       @hv.show(1)
@@ -35,23 +32,6 @@ describe Squall::Hypervisor do
 
   describe "#create" do
     use_vcr_cassette "hypervisor/create"
-    it "requires label" do
-      invalid = @valid.reject{|k,v| k == :label }
-      requires_attr(:label) { @hv.create(invalid) }
-      @hv.success.should be_false
-    end
-
-    it "requires ip_address" do
-      invalid = @valid.reject{|k,v| k == :ip_address }
-      requires_attr(:ip_address) { @hv.create(invalid) }
-      @hv.success.should be_false
-    end
-
-    it "requires hypervisor_type" do
-      invalid = @valid.reject{|k,v| k == :hypervisor_type }
-      requires_attr(:hypervisor_type) { @hv.create(invalid) }
-      @hv.success.should be_false
-    end
 
     it "creates a hypervisor" do
       @hv.create(@valid)
@@ -61,28 +41,15 @@ describe Squall::Hypervisor do
 
   describe "#edit" do
     use_vcr_cassette 'hypervisor/edit'
-    it "requires an id" do
-      expect { @hv.edit }.to raise_error(ArgumentError)
-      @hv.success.should be_false
-    end
-
-    it "raises an error with unknown param " do
-      expect { @hv.edit(1, :blah => 1)}.to raise_error(ArgumentError)
-      @hv.success.should be_false
-    end
 
     it "edits the hypervisor" do
-      edit = @hv.edit(1, :label => 'A new label')
+      edit = @hv.edit(1, label: 'A new label')
       @hv.success.should be_true
     end
   end
 
   describe "#reboot" do
     use_vcr_cassette 'hypervisor/reboot'
-    it "requires an id" do
-      expect { @hv.reboot }.to raise_error(ArgumentError)
-      @hv.success.should be_false
-    end
 
     it "reboots the hypervisor" do
       reboot = @hv.reboot(1)
@@ -92,9 +59,6 @@ describe Squall::Hypervisor do
 
   describe "#delete" do
     use_vcr_cassette "hypervisor/delete"
-    it "requires an id" do
-      expect { @hv.delete }.to raise_error(ArgumentError)
-    end
 
     it "returns a hv" do
       @hv.delete(1)
@@ -155,16 +119,8 @@ describe Squall::Hypervisor do
   describe "#add_network_join" do
     use_vcr_cassette "hypervisor/add_network_join"
 
-    it "requires network id" do
-      requires_attr(:network_id) { @hv.add_network_join(1, :interface => "interface") }
-    end
-
-    it "requires interface" do
-      requires_attr(:interface) { @hv.add_network_join(1, :network_id => 1) }
-    end
-
     it "adds the network to the hypervisor zone" do
-      @hv.add_network_join(1, :network_id => 1, :interface => "interface")
+      @hv.add_network_join(1, network_id: 1, interface: "interface")
       @hv.success.should be_true
     end
 

data/spec/squall/hypervisor_zone_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Squall::HypervisorZone do
   before(:each) do
     @hypervisor_zone = Squall::HypervisorZone.new
-    @valid = {:label => "My zone"}
+    @valid = {label: "My zone"}
   end
 
   describe "#list" do
@@ -22,9 +22,6 @@ describe Squall::HypervisorZone do
 
   describe "#show" do
     use_vcr_cassette "hypervisor_zones/show"
-    it "requires an id" do
-      expect { @hypervisor_zone.show }.to raise_error(ArgumentError)
-    end
 
     it "returns a hypervisor zone" do
       hypervisor_zones = @hypervisor_zone.show(1)
@@ -34,14 +31,6 @@ describe Squall::HypervisorZone do
 
   describe "#create" do
     use_vcr_cassette "hypervisor_zones/create"
-    it "requires label" do
-      invalid = @valid.reject{|k,v| k == :label }
-      requires_attr(:label) { @hypervisor_zone.create(invalid) }
-    end
-
-    it "raises error on unknown params" do
-      expect { @hypervisor_zone.create(@valid.merge(:what => 'what')) }.to raise_error(ArgumentError, 'Unknown params: what')
-    end
 
     it "creates a hypervisor zone" do
       @hypervisor_zone.create(@valid)
@@ -60,12 +49,8 @@ describe Squall::HypervisorZone do
       end
     end
 
-    it "raises error on unknown params" do
-      expect { @hypervisor_zone.edit(1, @valid.merge(:what => 'what')) }.to raise_error(ArgumentError, 'Unknown params: what')
-    end
-
     it "edits a hypervisor zone" do
-      @hypervisor_zone.edit(1, :label => "Updated zone")
+      @hypervisor_zone.edit(1, label: "Updated zone")
       @hypervisor_zone.success.should be_true
     end
   end
@@ -150,16 +135,8 @@ describe Squall::HypervisorZone do
   describe "#add_network_join" do
     use_vcr_cassette "hypervisor_zones/add_network_join"
 
-    it "requires network id" do
-      requires_attr(:network_id) { @hypervisor_zone.add_network_join(1, :interface => "interface") }
-    end
-
-    it "requires interface" do
-      requires_attr(:interface) { @hypervisor_zone.add_network_join(1, :network_id => 1) }
-    end
-
     it "adds the network to the hypervisor zone" do
-      @hypervisor_zone.add_network_join(1, :network_id => 1, :interface => "interface")
+      @hypervisor_zone.add_network_join(1, network_id: 1, interface: "interface")
       @hypervisor_zone.success.should be_true
     end
 
@@ -172,7 +149,5 @@ describe Squall::HypervisorZone do
       @hypervisor_zone.remove_network_join(1, 1)
       @hypervisor_zone.success.should be_true
     end
-
   end
-
 end

data/spec/squall/ip_address_join_spec.rb

@@ -8,10 +8,6 @@ describe Squall::IpAddressJoin do
   describe "#list" do
     use_vcr_cassette 'ipaddress_join/list'
 
-    it "requires virtual machine ID" do
-      expect { @join.list }.to raise_error(ArgumentError)
-    end
-
     it "returns list of ip_addresses" do
       ips = @join.list(1)
       ips.should be_an(Array)
@@ -26,13 +22,8 @@ describe Squall::IpAddressJoin do
   describe "#assign" do
     use_vcr_cassette "ipaddress_join/assign"
 
-    it "raises ArgumentError without required arguments" do
-      expect { @join.assign    }.to raise_error(ArgumentError)
-      expect { @join.assign(1) }.to raise_error(ArgumentError)
-    end
-
     it "assigns the IP join" do
-      join = @join.assign(1, {:ip_address_id => 1, :network_interface_id => 1})
+      join = @join.assign(1, {ip_address_id: 1, network_interface_id: 1})
       @join.success.should be_true
     end
   end
@@ -40,11 +31,6 @@ describe Squall::IpAddressJoin do
   describe "#delete" do
     use_vcr_cassette "ipaddress_join/delete"
 
-    it "raises ArgumentError without required arguments" do
-      expect { @join.delete    }.to raise_error(ArgumentError)
-      expect { @join.delete(1) }.to raise_error(ArgumentError)
-    end
-
     it "deletes the IP join" do
       @join.delete(1, 1)
       @join.success.should be_true