squall 1.3.0 → 1.3.1

data/lib/squall/hypervisor.rb

@@ -1,110 +1,112 @@
 module Squall
   # OnApp Hypervisor
   class Hypervisor < Base
-
-    # Returns a list of all hypervisors
+    # Public: Lists all hypervisors.
+    #
+    # Returns an Array.
     def list
       req = request(:get, '/settings/hypervisors.json')
       req.collect { |hv| hv['hypervisor'] }
     end
 
-    # Returns the hypervisor info as a hash
+    # Public: Retrieves hypervisor info.
     #
-    # ==== Params
+    # id - The id of the hypervisor
     #
-    # * +id+ - The id of the hypervisor
+    # Returns a Hash.
     def show(id)
       req = request(:get, "/settings/hypervisors/#{id}.json")
       req.first[1]
     end
 
-    # Create a new Hypervisor
-    #
-    # ==== Params
+    # Public: Create a new Hypervisor.
     #
-    # * +options+ - Options for creating the hypervisor
+    # options - Options for creating the hypervisor:
+    #           :label           - Label for the hypervisor
+    #           :ip_address      - IP for the hypervisor
+    #           :hypervisor_type - Type of the hypervisor
     #
-    # ==== Options
+    # Example
     #
-    # * +label*+ - Label for the hypervisor
-    # * +ip_address*+ - IP for the hypervisor
-    # * +hypervisor_type*+ - Type of the hypervisor
+    #     create(
+    #       label:           'myhv',
+    #       ip_address:      '127.0.0.1',
+    #       hypervisor_type: 'xen'
+    #     )
     #
-    # ==== Example
-    #
-    #   create :label => 'myhv', :ip_address => '127.0.0.1', :hypervisor_type => 'xen'
+    # Returns a Hash.
     def create(options = {})
-      params.required(:label, :ip_address, :hypervisor_type).accepts(:memory_overhead, :enabled, :hypervisor_group_id, :disable_failover).validate!(options)
       req = request(:post, '/settings/hypervisors.json', default_params(options))
       req.first[1]
     end
 
-    # Edit a Hypervisor
-    #
-    # ==== Params
-    #
-    # * +id*+ - ID of the hypervisor
-    # * +options+ - Params for editing the Hypervisor
+    # Public: Edit a Hypervisor.
     #
-    # ==== Options
+    # id      - ID of the hypervisor
+    # options - Params for editing the Hypervisor, see `#create`.
     #
-    # See #create
+    # Example
     #
-    # ==== Example
+    #     edit 1, label: 'myhv', ip_address: '127.0.0.1'
     #
-    #   edit 1, :label => 'myhv', :ip_address => '127.0.0.1'
-    def edit(id, options ={})
-      params.accepts(:label, :ip_address, :hypervisor_type, :memory_overhead, :enabled, :hypervisor_group_id, :disable_failover).validate!(options)
+    # Returns a Hash.
+    def edit(id, options = {})
       request(:put, "/settings/hypervisors/#{id}.json", default_params(options))
     end
 
-    # Reboot a hypervisor
+    # Public: Reboot a hypervisor.
     #
-    # ==== Params
+    # id - ID of the hypervisor
     #
-    # * +id*+ - ID of the hypervisor
+    # Returns a Hash.
     def reboot(id)
       response = request(:get, "/settings/hypervisors/#{id}/rebooting.json")
       response['hypervisor']
     end
 
-    # Delete a hypervisor
+    # Public: Delete a hypervisor
     #
-    # ==== Params
+    # id - ID of the hypervisor
     #
-    # * +id*+ - ID of the hypervisor
+    # Returns a Hash.
     def delete(id)
       req = request(:delete, "/settings/hypervisors/#{id}.json")
     end
 
+    # TODO: Add documentation
     def virtual_machines(id)
       response = request(:get, "/settings/hypervisors/#{id}/virtual_machines.json")
       response.collect { |vm| vm['virtual_machine'] }
     end
 
+    # TODO: Add documentation
     def data_store_joins(id)
       response = request(:get, "/settings/hypervisors/#{id}/data_store_joins.json")
       response.collect { |dsj| dsj['data_store_join'] }
     end
 
+    # TODO: Add documentation
     def add_data_store_join(id, data_store_id)
-      request(:post, "/settings/hypervisors/#{id}/data_store_joins.json", :query => {:data_store_id => data_store_id})
+      request(:post, "/settings/hypervisors/#{id}/data_store_joins.json", query: { data_store_id:  data_store_id })
     end
 
+    # TODO: Add documentation
     def remove_data_store_join(id, data_store_join_id)
       request(:delete, "/settings/hypervisors/#{id}/data_store_joins/#{data_store_join_id}.json")
     end
 
+    # TODO: Add documentation
     def network_joins(id)
       response = request(:get, "/settings/hypervisors/#{id}/network_joins.json")
       response.collect { |nj| nj['network_join'] }
     end
 
+    # TODO: Add documentation
     def add_network_join(id, options)
-      params.required(:network_id, :interface).validate!(options)
-      request(:post, "/settings/hypervisors/#{id}/network_joins.json", :query => {:network_join => options})
+      request(:post, "/settings/hypervisors/#{id}/network_joins.json", query: { network_join: options })
     end
 
+    # TODO: Add documentation
     def remove_network_join(id, network_join_id)
       request(:delete, "/settings/hypervisors/#{id}/network_joins/#{network_join_id}.json")
     end

data/lib/squall/hypervisor_zone.rb

@@ -1,135 +1,123 @@
 module Squall
   # OnApp HypervisorZone
   class HypervisorZone < Base
-    # Returns a list of hypervisor zones
+    # Public: Lists all hypervisor zones.
+    #
+    # Returns an Array.
     def list
       response = request(:get, "/settings/hypervisor_zones.json")
       response.collect { |i| i['hypervisor_group'] }
     end
 
-    # Get the details for a hypervisor zone
+    # Public: Get the details for a hypervisor zone.
     #
-    # ==== Params
+    # id - ID of the hypervisor zone
     #
-    # * +id*+ - ID of the hypervisor zone
+    # Returns a Hash.
     def show(id)
       response = request(:get, "/settings/hypervisor_zones/#{id}.json")
       response['hypervisor_group']
     end
 
-    # Updates an existing hypervisor zone
-    #
-    # ==== Params
-    #
-    # * +id*+ - ID of the hypervisor zone
-    # * +options+ - Params for updating the hypervisor zone
+    # Public: Creates a new hypervisor zone.
     #
-    # ==== Options
+    # options - Params for updating the hypervisor zone:
+    #           :label - Label for the hypervisor zone
     #
-    # See #create
-    def edit(id, options = {})
-      params.required(:label).validate!(options)
-      response = request(:put, "/settings/hypervisor_zones/#{id}.json", :query => {:pack => options})
+    # Returns a Hash
+    def create(options = {})
+      request(:post, "/settings/hypervisor_zones.json", query: { pack: options })
     end
 
-    # Creates a new hypervisor zone
-    #
-    # ==== Params
+    # Public: Updates an existing hypervisor zone.
     #
-    # * +options+ - Params for updating the hypervisor zone
+    # id      - ID of the hypervisor zone
+    # options - Params for updating the hypervisor zone, see `#create`
     #
-    # ==== Options
-    #
-    # * +label*+ - Label for the hypervisor zone
-    def create(options = {})
-      params.required(:label).validate!(options)
-      response = request(:post, "/settings/hypervisor_zones.json", :query => {:pack => options})
+    # Returns a Hash.
+    def edit(id, options = {})
+      request(:put, "/settings/hypervisor_zones/#{id}.json", query:  { pack: options })
     end
 
-    # Deletes an existing hypervisor zone
+    # Public: Deletes an existing hypervisor zone.
     #
-    # ==== Params
+    # id - ID of the hypervisor zone
     #
-    # * +id*+ - ID of the hypervisor zone
+    # Returns a Hash.
     def delete(id)
       request(:delete, "/settings/hypervisor_zones/#{id}.json")
     end
 
-    # Get the list of hypervisors attached to a zone
+    # Public: List hypervisors attached to a zone.
     #
-    # ==== Params
+    # id - ID of the hypervisor zone
     #
-    # * +id*+ - ID of the hypervisor zone
+    # Returns an Array.
     def hypervisors(id)
       response = request(:get, "/settings/hypervisor_zones/#{id}/hypervisors.json")
       response.collect { |hv| hv['hypervisor'] }
     end
 
-    # Get the list of data store joins attached to a hypervisor zone
+    # Public: List data store joins attached to a hypervisor zone.
     #
-    # ==== Params
+    # id - ID of the hypervisor zone
     #
-    # * +id*+ - ID of the hypervisor zone
+    # Returns an Array.
     def data_store_joins(id)
       response = request(:get, "/settings/hypervisor_zones/#{id}/data_store_joins.json")
       response.collect { |i| i['data_store_join'] }
     end
 
-    # Add a data store to a hypervisor zone
+    # Public: Add a data store to a hypervisor zone.
     #
-    # ==== Params
+    # id            - ID of the hypervisor zone
+    # data_store_id - ID of the data store
     #
-    # * +id*+ - ID of the hypervisor zone
-    # * +data_store_id*+ - ID of the data store
+    # Returns a Hash.
     def add_data_store_join(id, data_store_id)
-      request(:post, "/settings/hypervisor_zones/#{id}/data_store_joins.json", :query => {:data_store_id => data_store_id})
+      request(:post, "/settings/hypervisor_zones/#{id}/data_store_joins.json", query: { data_store_id: data_store_id })
     end
 
-    # Remove a data store from a hypervisor zone
+    # Public: Remove a data store from a hypervisor zone.
     #
-    # ==== Params
+    # id                 - ID of the hypervisor zone
+    # data_store_join_id - ID of the join record
     #
-    # * +id*+ - ID of the hypervisor zone
-    # * +data_store_join_id*+ - ID of the join record
+    # Returns a Hash.
     def remove_data_store_join(id, data_store_join_id)
       request(:delete, "/settings/hypervisor_zones/#{id}/data_store_joins/#{data_store_join_id}.json")
     end
 
-    # Get the list of networks attached to a hypervisor zone
+    # Public: List networks attached to a hypervisor zone.
     #
-    # ==== Params
+    # id - ID of the hypervisor zone
     #
-    # * +id*+ - ID of the hypervisor zone
+    # Returns an Array.
     def network_joins(id)
       response = request(:get, "/settings/hypervisor_zones/#{id}/network_joins.json")
       response.collect { |i| i['network_join'] }
     end
 
-    # Add a network to a hypervisor zone
+    # Public: Add a network to a hypervisor zone
     #
-    # ==== Params
+    # id      - ID of the hypervisor zone
+    # options - Params for updating the hypervisor zone
+    #           :network_id - ID of the network to add to the hypervisor zone
+    #           :interface  - Name of the appropriate network interface
     #
-    # * +id*+ - ID of the hypervisor zone
-    # * +options+ - Params for updating the hypervisor zone
-    #
-    # ==== Options
-    #
-    # * +network_id*+ - The ID of the network to add to the hypervisor zone
-    # * +interface*+ - The name of the appropriate network interface
-    def add_network_join(id, options={})
-      params.required(:network_id, :interface).validate!(options)
-      request(:post, "/settings/hypervisor_zones/#{id}/network_joins.json", :query => {:network_join => options})
+    # Returns a Hash.
+    def add_network_join(id, options = {})
+      request(:post, "/settings/hypervisor_zones/#{id}/network_joins.json", query: { network_join:  options })
     end
 
-    # Remove a network from a hypervisor zone
+    # Public: Remove a network from a hypervisor zone.
     #
-    # ==== Params
+    # id              - ID of the hypervisor zone
+    # network_join_id - ID of the join record
     #
-    # * +id*+ - ID of the hypervisor zone
-    # * +network_join_id*+ - ID of the join record
+    # Returns a Hash.
     def remove_network_join(id, network_join_id)
       request(:delete, "/settings/hypervisor_zones/#{id}/network_joins/#{network_join_id}.json")
     end
-
   end
 end

data/lib/squall/ip_address.rb

@@ -1,58 +1,53 @@
 module Squall
   # OnApp IpAddress
   class IpAddress < Base
-    # Returns a list of ip addresses for a network
+    # Public: Lists IP addresses for a network.
     #
-    # ==== Params
+    # network_id - ID of the network
     #
-    # * +network_id+ - ID of the network
+    # Returns an Array.
     def list(network_id)
       response = request(:get, "/settings/networks/#{network_id}/ip_addresses.json")
       response.collect { |ip| ip['ip_address'] }
     end
 
-    # Updates an existing ip address
-    #
-    # ==== Params
-    #
-    # * +network_id+ - ID of the network
-    # * +id+ - ID of the ip address
-    # * +options+ - Params for updating the ip address
-    #
-    # ==== Options
-    #
-    # See #create
-    def edit(network_id, id, options = {})
-      params.accepts(:address, :netmask, :broadcast, :network_address, :gateway, :disallowed_primary).validate!(options)
-      response = request(:put, "/settings/networks/#{network_id}/ip_addresses/#{id}.json", default_params(options))
+    # Public: Creates a new IpAddress
+    #
+    # network_id - ID of the network
+    # options    - Params for the new ip address
+    #              :address            - IP address
+    #              :broadcast          - A logical address at which all devices
+    #                                    connected to a multiple-access
+    #                                    communications network are enabled to
+    #                                    receive datagrams
+    #              :disallowed_primary - Set to '1' to prevent this address
+    #                                    being used as primary
+    #              :gateway            - Gateway address
+    #              :netmask            - Network mask
+    #              :network_address    - IP address of network
+    #
+    # Returns a Hash.
+    def create(network_id, options = {})
+      request(:post, "/settings/networks/#{network_id}/ip_addresses.json", default_params(options))
     end
 
-    # Creates a new IpAddress
-    #
-    # ==== Params
-    #
-    # * +network_id+ - ID of the network
-    # * +options+ - Params for the new ip address
+    # Public: Updates an existing ip address.
     #
-    # ==== Options
+    # network_id - ID of the network
+    # id         - ID of the ip address
+    # options     - Params for updating the ip address, see `#create`
     #
-    # * +address*+ - IP address
-    # * +netmask*+ - Network mask
-    # * +broadcast*+ - A logical address at which all devices connected to a multiple-access communications network are enabled to receive datagrams
-    # * +network_address*+ - IP address of network
-    # * +gateway*+ - Gateway address
-    # * +disallowed_primary+ - Set to '1' to prevent this address being used as primary
-    def create(network_id, options = {})
-      params.required(:address, :netmask, :broadcast, :network_address, :gateway).accepts(:disallowed_primary).validate!(options)
-      response = request(:post, "/settings/networks/#{network_id}/ip_addresses.json", default_params(options))
+    # Returns a Hash.
+    def edit(network_id, id, options = {})
+      request(:put, "/settings/networks/#{network_id}/ip_addresses/#{id}.json", default_params(options))
     end
 
-    # Deletes an existing ip address
+    # Public: Deletes an existing ip address.
     #
-    # ==== Params
+    # network_id - ID of the network
+    # id         - ID of the ip address
     #
-    # * +network_id+ - ID of the network
-    # * +id+ - ID of the ip address
+    # Returns a Hash.
     def delete(network_id, id)
       request(:delete, "/settings/networks/#{network_id}/ip_addresses/#{id}.json")
     end

data/lib/squall/ip_address_join.rb

@@ -1,44 +1,35 @@
 module Squall
   # Handles IP assignments for virtual machines
   class IpAddressJoin < Base
-
-    # Get the list of IP address assignments for a particular virtual machine
+    # Public: List IP address assignments for a virtual machine.
     #
-    # ==== Params
+    # virtual_machine_id - Virtual machine ID to lookup
     #
-    # * +virtual_machine_id*+ - Virtual machine ID to lookup
+    # Returns an Array.
     def list(virtual_machine_id)
       response = request(:get, "/virtual_machines/#{virtual_machine_id}/ip_addresses.json")
       response.collect { |ip| ip['ip_address_join'] }
     end
 
-    # Assigns an IP address to a VM
-    #
-    # ==== Params
-    #
-    # * +virtual_machine_id*+ - Virtual machine ID to assign IP to
-    # * +options+ - Params for IP assignment
+    # Public: Assigns an IP address to a VM.
     #
-    # ==== Options
+    # virtual_machine_id - Virtual machine ID to assign IP to
+    # options            - Params for IP assignment:
+    #                      :ip_address_id        - ID of the IP address
+    #                      :network_interface_id - ID of the network interface
     #
-    # * +ip_address_id*+ - ID of the IP address
-    # * +network_interface_id*+ - ID of the network interface id
+    # Returns a Hash.
     def assign(virtual_machine_id, options = {})
-      params.required(:ip_address_id, :network_interface_id).validate!(options)
       response = request(:post, "/virtual_machines/#{virtual_machine_id}/ip_addresses.json", default_params(options))
       response['ip_address_join']
     end
 
-    # Deletes an IP address assignment from a VM
-    #
-    # ==== Params
-    #
-    # * +virtual_machine_id+ - Virtual machine ID to remove IP join from
-    # * +ip_address_id+ - IP Address ID to remove
+    # Public: Deletes an IP address assignment from a VM
     #
-    # ==== Options
+    # virtual_machine_id - Virtual machine ID to remove IP join from
+    # ip_address_id      - IP Address ID to remove, see `#assign`.
     #
-    # See #assign
+    # Returns a Hash.
     def delete(virtual_machine_id, ip_address_id)
       request(:delete, "/virtual_machines/#{virtual_machine_id}/ip_addresses/#{ip_address_id}.json")
     end

data/lib/squall/network.rb

@@ -1,59 +1,62 @@
 module Squall
   # OnApp Network
   class Network < Base
-    # Returns a list of Networks
+    # Public: Lists all networks.
+    #
+    # Returns an Array.
     def list
       response = request(:get, '/settings/networks.json')
       response.collect { |network| network['network'] }
     end
 
-    # Edit a Network
+    # Public: Create a Network.
     #
-    # ==== Params
+    # options - Params for creating the Network:
+    #           :label
+    #           :vlan
+    #           :identifier
     #
-    # * +id*+ - ID of the network
-    # * +options+ - Params for editing the Network
+    # Example
     #
-    # ==== Options
+    #   create(
+    #     label:            'mynetwork',
+    #     network_group_id: 1,
+    #     vlan:             2,
+    #     identifier:       'something'
+    #   )
     #
-    # See #create
+    # Returns a Hash.
+    def create(options = {})
+      response = request(:post, '/settings/networks.json', default_params(options))
+      response.first[1]
+    end
+
+    # Public: Edit a Network
     #
-    # ==== Example
+    # id      - ID of the network
+    # options - Params for editing the Network, see `#create`
     #
-    #   edit 1, :label => 'mynetwork', :network_group_id => 1, :vlan => 2, :identifier => 'something'
+    # Returns a Hash.
     def edit(id, options = {})
-      params.accepts(:label, :network_group_id, :vlan, :identifier).validate!(options)
-      response = request(:put, "/settings/networks/#{id}.json", default_params(options))
+      request(:put, "/settings/networks/#{id}.json", default_params(options))
     end
 
-    # Create a Network
-    #
-    # ==== Params
-    #
-    # * +options+ - Params for creating the Network
-    #
-    # ==== Options
+    # Public: Delete a network.
     #
-    # * +label*+
-    # * +vlan+
-    # * +identifier+
+    # id - ID of the network
     #
-    # ==== Example
-    #
-    #   create :label => 'mynetwork', :network_group_id => 1, :vlan => 2, :identifier => 'something'
-    def create(options = {})
-      params.accepts(:vlan, :identifier).required(:label).validate!(options)
-      response = request(:post, '/settings/networks.json', default_params(options))
-      response.first[1]
+    # Returns a Hash.
+    def delete(id)
+      request(:delete, "/settings/networks/#{id}.json")
     end
 
-    # Delete a network
+    # Public: Rebuild VM network.
     #
-    # ==== Params
+    # id - ID of the virtual machine
     #
-    # * +id*+ - ID of the network
-    def delete(id)
-      request(:delete, "/settings/networks/#{id}.json")
+    # Returns a Hash.
+    def rebuild(id)
+      request(:post, "/virtual_machines/#{id}/rebuild_network.json")
     end
   end
 end