squall 1.3.0 → 1.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4e877b7b98d79a741107b805282e235e4f18a7b
+  data.tar.gz: 0d74e4d6ab3b2765e7c60f488e353f97b575965c
+SHA512:
+  metadata.gz: 5ae37aad74e9d15a958c9bd1524c8c72a63fd0971bd16bebea5c62ed1fbcef551be04d58153329f6df2eff4de67ca27806816a570adae97b07559a269668fa21
+  data.tar.gz: 29ddbec2e6e0de8af682dc088fad4df8fb07c0b92e946b154b526e4cdbdcd43876b62421d0eb9adc82e003ea8cb25c107063c2bb1d8355517a9e314e8694e398

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 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.md

@@ -3,21 +3,31 @@ Squall [![Squall Build Status][Build Icon]][Build Status]
 
 A Ruby library for working with the [OnApp REST API][].
 
-Squall has been tested on MRI 1.8.7, MRI 1.9.2, MRI 1.9.3 Preview 1,
-Rubinius 2.0.0pre, and JRuby 1.6.2.
+Squall has been tested on MRI versions 1.9.2, 1.9.3, 2.0.0 and 1.9-compatible
+JRuby.
 
-Documentation is available in [RDoc][] format.
+Documentation is available in [TomDoc][] format.
 
 [Build Status]: http://travis-ci.org/site5/squall
 [Build Icon]: https://secure.travis-ci.org/site5/squall.png?branch=master
-[OnApp REST API]: https://help.onapp.com/manual.php?m=2
-[RDoc]: http://rdoc.info/github/site5/squall/master/frames
+[OnApp REST API]: http://onapp.com/cloud/technology/api/
+[TomDoc]: http://site5.github.io/squall/
 
 Install
 -------
 
-    gem install squall
-    bundle install
+To install Squall using [Bundler](http://bundler.io):
+
+```
+echo "gem 'squall'" >> Gemfile
+bundle install
+```
+
+To install Squall globally using RubyGems:
+
+```
+gem install squall
+```
 
 Configuration
 -------------
@@ -26,30 +36,38 @@ You have two main options for configuring Squall.
 
 Directly in a config block:
 
-    require 'squall'
+```ruby
+require 'squall'
 
-    Squall.config do |c|
-      c.base_uri 'https://onappurl.com' # Root level URI for OnApp instance
-      c.username 'username' # OnApp username
-      c.password 'topsecret' # OnApp password
-      c.debug true # Toggle HTTParty debugging (prints to $stderr)
-    end
+Squall.config do |c|
+  c.base_uri 'https://onappurl.com' # Root level URI for OnApp instance
+  c.username 'username'             # OnApp username
+  c.password 'topsecret'            # OnApp password
+  c.debug     true                  # Toggle HTTP/Faraday debugging (prints to $stderr)
+end
+```
 
 Squall can load configuration from a yaml file:
 
-    # .squall.yml
-    base_uri: 'https://onappurl.com'
-    username: 'username'
-    password: 'topsecret'
-    debug: false
+```yaml
+# .squall.yml
+base_uri: 'https://onappurl.com'
+username: 'username'
+password: 'topsecret'
+debug: false
+```
 
 To load it (by default it assumes ~/.squall.yml):
 
-    Squall.config_file(/[path]/[to]/.squall.yml)
+```ruby
+Squall.config_file("/path/to/.squall.yml")
+```
 
 It is also possible to change individual configuration settings on the fly.
 
-    Squall.configuration.debug(true)
+```ruby
+Squall.configuration.debug(true)
+```
 
 Note: you will need to re-instantiate all modules after changing Squall's configuration.
 
@@ -58,25 +76,29 @@ Usage
 
 Show the info for a VM:
 
-    vm = Squall::VirtualMachine.new
-    vm.show 1
+```ruby
+vm = Squall::VirtualMachine.new
+vm.show 1
+```
 
 Create a new VM:
 
-    vm = Squall::VirtualMachine.new
+```ruby
+vm = Squall::VirtualMachine.new
 
-    params = {
-      :label             => 'testmachine',
-      :hypervisor_id     => 5,
-      :hostname          => 'testmachine',
-      :memory            => 512,
-      :cpus              => 1,
-      :cpu_shares        => 10,
-      :primary_disk_size => 10,
-      :template_id       => 1
-    }
+params = {
+  label:             'testmachine',
+  hypervisor_id:     5,
+  hostname:          'testmachine',
+  memory:            512,
+  cpus:              1,
+  cpu_shares:        10,
+  primary_disk_size: 10,
+  template_id:       1
+}
 
-    vm.create params
+vm.create params
+```
 
 Supported Methods
 -----------------
@@ -101,13 +123,13 @@ The following OnApp modules have been added:
 * Transactions
 * Virtual machines
 * Whitelists
+* Disks
 
 The following still need to be added:
 
 * Billing plans
 * Currencies
 * Network interfaces
-* Disks
 * Template groups
 * Software licenses
 * Resolvers
@@ -129,8 +151,10 @@ Tests
 
 Squall uses rspec for tests. To run:
 
-    bundle exec rake # Runs all tests
-    bundle exec rspec spec/squall/[module]_spec.rb # Runs tests for a specific module
+```
+bundle exec rake # Runs all tests
+bundle exec rspec spec/squall/[module]_spec.rb # Runs tests for a specific module
+```
 
 Squall uses [VCR](https://github.com/myronmarston/vcr) to cache server
 responses to test against. To test via live http connections, pass RERECORD=1
@@ -142,8 +166,7 @@ Known issues:
 
 1. VirtualMachine#change_user currently breaks the parser on an invalid
    user_id  because OnApp returns html instead of JSON
-2. VirtualMachine#create is currently broken in certain cases.  See
-   <https://help.onapp.com/kb_article.php?s=0b397f5b851334cea54da9ddd829bf5f&ref=8181-TYFH-8069>
+2. VirtualMachine#create is currently broken in certain cases.
 3. FirewallRule#edit and #create break the parser by returning invalid JSON
 
 Note on Patches/Pull Requests
@@ -161,4 +184,4 @@ Note on Patches/Pull Requests
 Copyright
 ---------
 
-Copyright (c) 2012 Site5.com. See LICENSE for details.
+Copyright (c) 2010-2014 Site5.com. See LICENSE for details.

data/Rakefile

@@ -1,18 +1,12 @@
-require 'bundler'
-require 'uri'
 begin
+  require 'bundler/gem_tasks'
   require 'rspec/core/rake_task'
+  require 'rake-tomdoc' unless RUBY_PLATFORM == 'java'
 rescue LoadError
-  puts "Please install rspec (bundle install)"
-  exit
+  abort "Please run `bundle install` first"
 end
 
 RSpec::Core::RakeTask.new :spec
 Bundler::GemHelper.install_tasks
 
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -r ./lib/squall.rb -I ./lib"
-end
-
 task :default => [:spec]

data/lib/squall/data_store_zone.rb

@@ -1,56 +1,50 @@
 module Squall
   # OnApp DataStoreZone
   class DataStoreZone < Base
-    # Returns a list of data store zones
+    # Public: List data store zones.
+    #
+    # Returns an Array.
     def list
       response = request(:get, "/data_store_zones.json")
       response.collect { |i| i['data_store_group'] }
     end
 
-    # Get the details for a data store zone
+    # Public: Get the details for a data store zone.
     #
-    # ==== Params
+    # id - ID of the data store zone
     #
-    # * +id+ - ID of the data store zone
+    # Returns a Hash.
     def show(id)
       response = request(:get, "/data_store_zones/#{id}.json")
       response['data_store_group']
     end
 
-    # Updates an existing data store zone
-    #
-    # ==== Params
-    #
-    # * +id+ - ID of the data store zone
-    # * +options+ - Params for the data store zone
+    # Public: Updates an existing data store zone.
     #
-    # ==== Options
+    # id      - ID of the data store zone
+    # options - Params for the data store zone:
+    #           :label - Label for the data store zone
     #
-    # * +label*+ - Label for the data store zone
+    # Returns an empty Hash.
     def edit(id, options = {})
-      params.required(:label).validate!(options)
-      response = request(:put, "/data_store_zones/#{id}.json", :query => {:pack => options})
+      request(:put, "/data_store_zones/#{id}.json", query: { pack: options })
     end
 
-    # Creates a new DataStoreZone
-    #
-    # ==== Params
-    #
-    # * +options+ - Params for the data store zone
+    # Public: Creates a new DataStoreZone.
     #
-    # ==== Options
+    # options - Params for the data store zone:
+    #           :label - Label for the data store zone
     #
-    # * +label*+ - Label for the data store zone
+    # Returns a Hash.
     def create(options = {})
-      params.required(:label).validate!(options)
-      response = request(:post, "/data_store_zones.json", :query => {:pack => options})
+      request(:post, "/data_store_zones.json", query: { pack: options })
     end
 
-    # Deletes an existing DataStoreZone
+    # Public: Deletes an existing DataStoreZone.
     #
-    # ==== Params
+    # id - ID of the data store zone
     #
-    # * +id+ - ID of the data store zone
+    # Returns an empty Hash.
     def delete(id)
       request(:delete, "/data_store_zones/#{id}.json")
     end

data/lib/squall/disk.rb

@@ -0,0 +1,174 @@
+module Squall
+  # OnApp Disk
+  class Disk < Base
+    # Public: List all disks.
+    #
+    # Returns an Array.
+    def list
+      response = request(:get, "/settings/disks.json")
+      response.collect { |i| i['disk'] }
+    end
+
+    # Public: List all disks available for a particular VM.
+    #
+    # id - ID of the virtual machine
+    #
+    # Returns an Array.
+    def vm_disk_list(id)
+      response = request(:get, "/virtual_machines/#{id}/disks.json")
+      response.collect { |i| i['disk'] }
+    end
+
+    # Public: Creates a new Disk.
+    #
+    # id      - ID of the virtual machine
+    # options - Params for the disk:
+    #           :add_to_linux_fstab  - Set true to add
+    #           :data_store_id       - The ID of a data store where this disk is
+    #                                  located
+    #           :disk_size           - The disk space in GB
+    #           :is_swap             - Set true if this is a swap disk
+    #           :mount_point         - a physical location in the partition used
+    #                                  as a root filesystem
+    #           :require_format_disk – set true to format disk
+    #
+    # Example
+    #
+    #     create(
+    #       add_to_linux_fstab:  1,
+    #       data_store_id:       1,
+    #       disk_size:           10,
+    #       is_swap:             0,
+    #       mount_point:         '/disk2',
+    #       require_format_disk: 1
+    #     )
+    #
+    # Returns a Hash.
+    def create(id, options = {})
+      request(:post, "/virtual_machines/#{id}/disks.json", default_params(options))
+    end
+
+    # Public: Updates an existing disk.
+    #
+    # id      - ID of the disk
+    # options - Params for the disk
+    #           :disk_size - The disk space in GB
+    #
+    # Returns a Hash.
+    def edit(id, options = {})
+      request(:put, "/settings/disks/#{id}.json", default_params(options))
+    end
+
+    # Public: Migrates a VM disk to another data store.
+    #
+    # vm_id   - ID of the virtual machine
+    # id      - ID of the disk
+    # options - Params for the disk
+    #           :data_store_id - The disk space in GB
+    #
+    # Returns a Hash.
+    def migrate(vm_id, id, options = {})
+      request(:post, "/virtual_machines/#{vm_id}/disks/#{id}/migrate.json", default_params(options))
+    end
+
+    # Public: View Input/Output statistics for a disk.
+    #
+    # id - ID of the disk
+    #
+    # Returns an Array
+    def iops_usage(id)
+      response = request(:get, "/settings/disks/#{id}/usage.json")
+      response.collect { |i| i['disk_hourly_stat'] }
+    end
+
+    # Public: Builds a disk.
+    #
+    # id - ID of the disk
+    #
+    # Returns a Hash.
+    def build(id)
+      response = request(:post, "/settings/disks/#{id}/build.json")
+      response['disk']
+    end
+
+    # Public: Unlock a disk.
+    #
+    # id - ID of the disk
+    #
+    # Returns a Hash.
+    def unlock(id)
+      response = request(:post, "/settings/disks/#{id}/unlock.json")
+      response['disk']
+    end
+
+    # Public: Enable autobackups for a disk.
+    #
+    # id - ID of the disk
+    #
+    # Returns a Hash.
+    def auto_backup_on(id)
+      response = request(:post, "/settings/disks/#{id}/autobackup_enable.json")
+      response['disk']
+    end
+
+    # Public: Disable autobackups for a disk
+    #
+    # id - ID of the disk
+    #
+    # Returns a Hash.
+    def auto_backup_off(id)
+      response = request(:post, "/settings/disks/#{id}/autobackup_disable.json")
+      response['disk']
+    end
+
+    # Public: Get the list of schedules for a disk.
+    #
+    # id - ID of the disk
+    #
+    # Returns an Array.
+    def schedules(id)
+      response = request(:get, "/settings/disks/#{id}/schedules.json")
+      response.collect { |i| i['schedule'] }
+    end
+
+    # Public: Add autobackup schedule to a disk
+    #
+    # id      - ID of the disk
+    # options - Params for the disk
+    #           :action   - set Autobackup to add a backup schedule
+    #           :duration - specify duration
+    #           :period   - set the period (days|weeks|months|years)
+    #
+    # Example
+    #
+    #     params = {
+    #       action:   'autobackup',
+    #       duration: 10,
+    #       period:   days
+    #     }
+    #
+    # Returns an Array.
+    def add_schedule(id, options = {})
+      request(:post, "/settings/disks/#{id}/schedules.json", default_params(options))
+    end
+
+    # Public: List backups available for a disk.
+    #
+    # id - ID of the disk
+    #
+    # Returns an Array.
+    def backups(id)
+      response = request(:get, "/settings/disks/#{id}/backups.json")
+      response.collect { |i| i['backup'] }
+    end
+
+    # Public: Delete a disk.
+    #
+    # id - ID of the disk
+    #
+    # Returns a Hash.
+    def delete(id)
+      request(:delete, "/settings/disks/#{id}.json")
+    end
+  end
+end

data/lib/squall/firewall_rule.rb

@@ -1,66 +1,59 @@
 module Squall
   # OnApp FirewallRule
   class FirewallRule < Base
-
-    # Return a list of all firewall rules for a virtual machine
+    # Public: Lists all firewall rules for a virtual machine.
     #
-    # ==== Params
+    # vm_id - ID of the virtual machine
     #
-    # * +vm_id*+ - ID of the virtual machine
+    # Returns an Array.
     def list(vm_id)
       response = request(:get, "/virtual_machines/#{vm_id}/firewall_rules.json")
       response.collect { |firewall_rule| user['firewall_rule'] }
     end
 
-    # Create a firewall rule for a virtual machine
-    #
-    # ==== Params
-    #
-    # * +vm_id*+ - ID of the virtual machine
-    #
-    # ==== Options
-    #
-    # * +command*+ - DROP or ACCEPT
-    # * +protocol*+ - TCP or UDP
-    # * +network_interface_id*+ - ID of the network interface
-    # * +address+ - IP address or range scope for rule.  Leave blank to apply to all.
-    # * +port+ - Port address for rule
-    #
-    # ==== Example
-    #
-    #   create :command              => "DROP",
-    #          :protocol             => "TCP",
-    #          :network_interface_id => 1
-    def create(vm_id, options={})
-      params.required(:command, :protocol, :network_interface_id).accepts(:address, :port).validate!(options)
+    # Public: Create a firewall rule for a virtual machine.
+    #
+    # vm_id   - ID of the virtual machine
+    # options - A Hash of options for the firewall rule:
+    #           :address              - IP address or range scope for rule.
+    #                                   Leave blank to apply to all.
+    #           :command              - DROP or ACCEPT
+    #           :network_interface_id - ID of the network interface
+    #           :port                 - Port address for rule
+    #           :protocol             - TCP or UDP
+    #
+    # Example
+    #
+    #     create(
+    #       command:              "DROP",
+    #       protocol              "TCP",
+    #       network_interface_id: 1
+    #     )
+    #
+    # Returns a Hash.
+    def create(vm_id, options = {})
       request(:post, "/virtual_machines/#{vm_id}/firewall_rules.json", default_params(options))
     end
 
-    # Edit a firewall rule
-    #
-    # ==== Params
+    # Public: Edit a firewall rule.
     #
-    # * +vm_id+ - ID of the virtual machine
-    # * +id+ - ID of the firewall rule
-    # * +options+ - Options for the firewall rule.
+    # vm_id   - ID of the virtual machine
+    # id      - ID of the firewall rule
+    # options - A Hash of options for the firewall rule, see `#create`.
     #
-    # ==== Options
-    #
-    # See #create
-    def edit(vm_id, id, options={})
-      params.accepts(:command, :protocol, :network_interface_id, :address, :port).validate!(options)
+    # Returns a Hash.
+    def edit(vm_id, id, options = {})
       request(:put, "/virtual_machines/#{vm_id}/firewall_rules/#{id}.json", default_params(options))
     end
 
-    # Delete a firewall rule
+    # Public: Delete a firewall rule.
     #
-    # ==== Params
+    # vm_id - ID of the virtual machine
+    # id    - ID of the firewall rule
     #
-    # * +vm_id*+ - ID of the virtual machine
-    # * +id+ - ID of the firewall rule
+    # Returns a Hash.
     def delete(vm_id, id)
       request(:delete, "/virtual_machines/#{vm_id}/firewall_rules/#{id}.json")
     end
-
   end
 end