squall 1.0.2 → 1.1.0

data/lib/squall/hypervisor_zone.rb

@@ -0,0 +1,135 @@
+module Squall
+  # OnApp HypervisorZone
+  class HypervisorZone < Base
+    # Returns a list of hypervisor zones
+    def list
+      response = request(:get, "/settings/hypervisor_zones.json")
+      response.collect { |i| i['hypervisor_group'] }
+    end
+
+    # Get the details for a hypervisor zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the hypervisor zone
+    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
+    #
+    # ==== Options
+    #
+    # See #create
+    def edit(id, options = {})
+      params.required(:label).validate!(options)
+      response = request(:put, "/settings/hypervisor_zones/#{id}.json", :query => {:pack => options})
+    end
+
+    # Creates a new hypervisor zone
+    #
+    # ==== Params
+    #
+    # * +options+ - Params for updating the hypervisor zone
+    #
+    # ==== 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})
+    end
+
+    # Deletes an existing hypervisor zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the hypervisor zone
+    def delete(id)
+      request(:delete, "/settings/hypervisor_zones/#{id}.json")
+    end
+
+    # Get the list of hypervisors attached to a zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the hypervisor zone
+    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
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the hypervisor zone
+    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
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the hypervisor zone
+    # * +data_store_id*+ - ID of the data store
+    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})
+    end
+
+    # Remove a data store from a hypervisor zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the hypervisor zone
+    # * +data_store_join_id*+ - ID of the join record
+    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
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the hypervisor zone
+    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
+    #
+    # ==== Params
+    #
+    # * +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})
+    end
+
+    # Remove a network from a hypervisor zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the hypervisor zone
+    # * +network_join_id*+ - ID of the join record
+    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,13 +1,60 @@
 module Squall
   # OnApp IpAddress
   class IpAddress < Base
-    # Returns a list of IpAddresses
+    # Returns a list of ip addresses for a network
     #
-    # ==== Options
-    # * +network_id+ - required
+    # ==== Params
+    #
+    # * +network_id+ - ID of the network
     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))
+    end
+
+    # Creates a new IpAddress
+    #
+    # ==== Params
+    #
+    # * +network_id+ - ID of the network
+    # * +options+ - Params for the new ip address
+    #
+    # ==== Options
+    #
+    # * +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))
+    end
+
+    # Deletes an existing ip address
+    #
+    # ==== Params
+    #
+    # * +network_id+ - ID of the network
+    # * +id+ - ID of the ip address
+    def delete(network_id, id)
+      request(:delete, "/settings/networks/#{network_id}/ip_addresses/#{id}.json")
+    end
   end
 end

data/lib/squall/ip_address_join.rb

@@ -0,0 +1,46 @@
+module Squall
+  # Handles IP assignments for virtual machines
+  class IpAddressJoin < Base
+
+    # Get the list of IP address assignments for a particular virtual machine
+    #
+    # ==== Params
+    #
+    # * +virtual_machine_id*+ - Virtual machine ID to lookup
+    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
+    #
+    # ==== Options
+    #
+    # * +ip_address_id*+ - ID of the IP address
+    # * +network_interface_id*+ - ID of the network interface id
+    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
+    #
+    # ==== Options
+    #
+    # See #assign
+    def delete(virtual_machine_id, ip_address_id)
+      request(:delete, "/virtual_machines/#{virtual_machine_id}/ip_addresses/#{ip_address_id}.json")
+    end
+  end
+end

data/lib/squall/network.rb

@@ -9,12 +9,18 @@ module Squall
 
     # Edit a Network
     #
-    # ==== Options
+    # ==== Params
     #
+    # * +id*+ - ID of the network
     # * +options+ - Params for editing the Network
+    #
+    # ==== Options
+    #
+    # See #create
+    #
     # ==== Example
     #
-    #   edit :label => 'mynetwork', :network_group_id => 1, :vlan => 2, :identifier => 'something'
+    #   edit 1, :label => 'mynetwork', :network_group_id => 1, :vlan => 2, :identifier => 'something'
     def edit(id, options = {})
       params.accepts(:label, :network_group_id, :vlan, :identifier).validate!(options)
       response = request(:put, "/settings/networks/#{id}.json", default_params(options))
@@ -22,19 +28,30 @@ module Squall
 
     # Create a Network
     #
-    # ==== Options
+    # ==== Params
     #
     # * +options+ - Params for creating the Network
+    #
+    # ==== Options
+    #
+    # * +label*+
+    # * +vlan+
+    # * +identifier+
+    #
     # ==== Example
     #
     #   create :label => 'mynetwork', :network_group_id => 1, :vlan => 2, :identifier => 'something'
     def create(options = {})
-      params.accepts(:label, :vlan, :identifier).required(:label).validate!(options)
+      params.accepts(:vlan, :identifier).required(:label).validate!(options)
       response = request(:post, '/settings/networks.json', default_params(options))
       response.first[1]
     end
 
     # Delete a network
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the network
     def delete(id)
       request(:delete, "/settings/networks/#{id}.json")
     end

data/lib/squall/network_zone.rb

@@ -0,0 +1,73 @@
+module Squall
+  # OnApp NetworkZone
+  class NetworkZone < Base
+    # Returns a list of network zones
+    def list
+      response = request(:get, "/network_zones.json")
+      response.collect { |i| i['network_group'] }
+    end
+
+    # Get the details for a network zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the network zone
+    def show(id)
+      response = request(:get, "/network_zones/#{id}.json")
+      response['network_group']
+    end
+
+    # Updates an existing network zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the network zone
+    #
+    # ==== Options
+    #
+    # See #create
+    def edit(id, options = {})
+      params.required(:label).validate!(options)
+      response = request(:put, "/network_zones/#{id}.json", :query => {:pack => options})
+    end
+
+    # Creates a new network zone
+    #
+    # ==== Options
+    #
+    # * +label*+ - Label for the network zone
+    def create(options = {})
+      params.required(:label).validate!(options)
+      response = request(:post, "/network_zones.json", :query => {:pack => options})
+    end
+
+    # Deletes an existing network zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the network zone
+    def delete(id)
+      request(:delete, "/network_zones/#{id}.json")
+    end
+
+    # Attach a network to a network zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the network zone
+    # * +network_id+ - ID of the network
+    def attach(id, network_id)
+      request(:post, "/network_zones/#{id}/networks/#{network_id}/attach.json")
+    end
+
+    # Detach a network from a network zone
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the network zone
+    # * +network_id+ - ID of the network
+    def detach(id, network_id)
+      request(:post, "/network_zones/#{id}/networks/#{network_id}/detach.json")
+    end
+  end
+end

data/lib/squall/payment.rb

@@ -0,0 +1,59 @@
+module Squall
+  # OnApp Payment
+  class Payment < Base
+
+    # Return a list of all payments
+    def list(user_id)
+      response = request(:get, "/users/#{user_id}/payments.json")
+      response.collect { |user| user['payment'] }
+    end
+
+    # Create a payment for a user
+    #
+    # ==== Params
+    #
+    # * +user_id*+ - ID of the user
+    # * +options+ - Params for creating the User
+    #
+    # ==== Options
+    #
+    # * +amount*+ - Amount of the payment
+    # * +invoice_number+ - Number of the invoice
+    #
+    # ==== Example
+    #
+    #   create :amount                 => 500,
+    #          :invoice_number         => "01234",
+    def create(user_id, options={})
+      params.required(:amount).accepts(:invoice_number).validate!(options)
+      request(:post, "/users/#{user_id}/payments.json", default_params(options))
+    end
+
+    # Edit a payment
+    #
+    # ==== Params
+    #
+    # * +user_id*+ - ID of the user
+    # * +id*+ - ID of the payment
+    # * +options+ - Params for editing the payment
+    #
+    # ==== Options
+    #
+    # See #create
+    def edit(user_id, id, options={})
+      params.accepts(:amount, :invoice_number).validate!(options)
+      request(:put, "/users/#{user_id}/payments/#{id}.json", default_params(options))
+    end
+
+    # Delete a payment
+    #
+    # ==== Params
+    #
+    # * +user_id*+ - ID of the user
+    # * +id*+ - ID of the payment
+    def delete(user_id, id)
+      request(:delete, "/users/#{user_id}/payments/#{id}.json")
+    end
+
+  end
+end

data/lib/squall/role.rb

@@ -1,33 +1,46 @@
 module Squall
   # OnApp Role
   class Role < Base
-    # Return a list of Roles
+    # Return a list of roles
     def list
       response = request(:get, '/roles.json')
       response.collect { |role| role['role']}
     end
 
-    # Returns a Hash of the given Role
+    # Returns a Hash of the given roles
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the role
     def show(id)
       response = request(:get, "/roles/#{id}.json")
-      response.first[1]
+      response["role"]
     end
 
     # Edit a Role
     #
+    # ==== Params
+    #
+    # * +id*+ - ID of the role
+    # * +options+ - Params for editing the roles
+    #
     # ==== Options
     #
-    # * +options+ - Params for editing the Role
+    # See #create
+    #
     # ==== Example
     #
-    #   edit :label => 'myrole', :permission => [1,3]
-    #   edit :label => 'myrole', :permission => 1
+    #   edit 1, :label => 'myrole', :permission_ids => [1,3]
     def edit(id, options = {})
-      params.accepts(:label, :permission).validate!(options)
+      params.accepts(:label, :permission_ids).validate!(options)
       response = request(:put, "/roles/#{id}.json", default_params(options))
     end
 
     # Delete a Role
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of the role
     def delete(id)
       request(:delete, "/roles/#{id}.json")
     end
@@ -40,17 +53,21 @@ module Squall
 
     # Create a new Role
     #
+    # ==== Params
+    #
+    # * +options+ - Params for creating the roles
+    #
     # ==== Options
     #
-    # * +options+ - Params for creating the Role
+    # * +label*+ - Label for the role
+    # * +permission_ids+ - An array of permission ids granted to the role.
     #
     # ==== Example
     #
-    #   create :label => 'mypriv', :identifier => 'magic'
+    #   create :label => 'Admin'
     def create(options = {})
-      params.required(:label, :identifier).validate!(options)
+      params.required(:label).accepts(:permission_ids).validate!(options)
       response = request(:post, '/roles.json', default_params(options))
-      response.first[1]
     end
   end
 end

data/lib/squall/statistic.rb

@@ -1,10 +1,10 @@
 module Squall
   # OnApp Statistic
   class Statistic < Base
-    # Returns statitics for a given VirtualMachine
-    def daily_stats(id)
+    # Returns statitics for virtual machines
+    def daily_stats
       response = request(:get, "/usage_statistics.json")
-      response.first['vm_hourly_stat']
+      response.collect {|s| s["vm_stat"]}
     end
   end
 end

data/lib/squall/{base.rb → support/base.rb}

@@ -1,5 +1,5 @@
 module Squall
-  # All OnApp API classes subclass Base to get access to 
+  # All OnApp API classes subclass Base to get access to
   # HTTParty methods and other convenience methods
   class Base
     # Params instance
@@ -19,7 +19,11 @@ module Squall
       self.class.basic_auth Squall::config[:username], Squall::config[:password]
       self.class.format :json
       self.class.headers 'Content-Type' => 'application/json'
-      # self.class.debug_output
+      if Squall::config[:debug]
+        self.class.debug_output
+      else
+        self.class.debug_output(nil)
+      end
     end
 
     # Returns a Params.new
@@ -83,8 +87,8 @@ module Squall
       raise NoConfig, "Squall.config must be specified" if Squall.config.empty?
     end
 
-    # Sets the default param container for request. It is derived from the 
-    # class name. Given the class name *Sandwich* and a param *bread* the 
+    # Sets the default param container for request. It is derived from the
+    # class name. Given the class name *Sandwich* and a param *bread* the
     # resulting params would be 'bob[bread]=wheat'
     def key_for_class
       word = self.class.name.split("::").last.to_s.dup

data/lib/squall/{config.rb → support/config.rb}

@@ -22,5 +22,9 @@ module Squall
     def password(value)
       @config[:password] = value
     end
+
+    def debug(value)
+      @config[:debug] = value
+    end
   end
 end

data/lib/squall/support/version.rb

@@ -0,0 +1,3 @@
+module Squall
+  VERSION = '1.1.0'
+end

data/lib/squall/support/yaml.rb

@@ -0,0 +1,5 @@
+require 'yaml'
+
+if ::YAML.const_defined?(:ENGINE)
+  ::YAML::ENGINE.yamler = 'syck'
+end

data/lib/squall/template.rb

@@ -9,6 +9,10 @@ module Squall
 
     # Make a Template public so that it can be downloaded
     # via a HTTP url
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of template
     def make_public(id)
       response = request(:post, "/templates/#{id}/make_public.json")
       response.first[1]

data/lib/squall/transaction.rb

@@ -8,6 +8,10 @@ module Squall
     end
 
     # Return a Hash for the given Transaction
+    #
+    # ==== Params
+    #
+    # * +id*+ - ID of transaction
     def show(id)
       response = request :get, "/transactions/#{id}.json"
       response['transaction']