fog 1.9.0 → 1.10.0

data/lib/fog/rackspace/requests/compute_v2/delete_attachment.rb

@@ -2,6 +2,11 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Deletes a specified volume attachment from a specified server instance.
+        # @param [String] server_id id of server containing volume to delete
+        # @param [String] volume_id id of volume on server to delete
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Volume_Attachment.html
         def delete_attachment(server_id, volume_id)
           request(
             :expects => [202],

data/lib/fog/rackspace/requests/compute_v2/delete_image.rb

@@ -4,10 +4,8 @@ module Fog
       class Real
 
         # Delete an image
-        #
-        # ==== Parameters
-        # * image_id<~Integer> - Id of image to delete
-        #
+        # @param [String] image_id Id of image to delete
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Image-d1e4957.html        
         def delete_image(image_id)
           request(
             :expects  => 204,

data/lib/fog/rackspace/requests/compute_v2/delete_metadata_item.rb

@@ -2,6 +2,12 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Deletes a metadata item.
+        # @param [String<images, servers>] collection type of metadata
+        # @param [String] obj_id id of the object where the metadata is attached
+        # @param [String] key the key of the metadata to delete
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Metadata_Item-d1e5790.html
         def delete_metadata_item(collection, obj_id, key)
           request(
             :expects => 204,

data/lib/fog/rackspace/requests/compute_v2/delete_network.rb

@@ -0,0 +1,21 @@
+module Fog
+  module Compute
+    class RackspaceV2
+      class Real
+        def delete_network(id)
+          request(:method => 'DELETE', :path => "os-networksv2/#{id}", :expects => 202)
+        end
+      end
+
+      class Mock
+        def delete_network(id)
+          unless self.data[:networks].has_key?(id)
+            raise Fog::Compute::RackspaceV2::NotFound
+          end
+
+          response(:body => '', :status => 202)
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/compute_v2/delete_server.rb

@@ -2,6 +2,10 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Deletes a specified server instance from the system.
+        # @param [String] server_id the id of the server to delete
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Server-d1e2883.html
         def delete_server(server_id)
           request(
             :expects => [204],

data/lib/fog/rackspace/requests/compute_v2/get_attachment.rb

@@ -2,6 +2,18 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves attachment
+        # @param [String] server_id
+        # @param [String] volume_id
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * volumeAttachment [Hash]:
+        #       * device [String] - The name of the device, such as /dev/xvdb. Specify auto for auto-assignment.
+        #       * serverId [String] - The id of the server that attached the volume
+        #       * id [String] - The id of the attachment
+        #       * volumeId [String] - The id of the volume that was attached
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Volume_Attachment_Details.html
         def get_attachment(server_id, volume_id)
           request(
             :expects => [200, 203, 300],

data/lib/fog/rackspace/requests/compute_v2/get_flavor.rb

@@ -2,6 +2,20 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves flavor detail
+        # @param [Sring] flavor_id
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * flavor [Hash]:
+        #       * disk [Fixnum] - disk size in GB
+        #       * id [String] - id of flavor
+        #       * name [String] - name of flavor 
+        #       * ram [Fixnum] - amount of ram in MB
+        #       * swap [Fixnum] - amount of swap in GB
+        #       * vcpus [Fixnum] - number of virtual CPUs
+        #       * links [Array] - links to flavor
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Flavor_Details-d1e4317.html
         def get_flavor(flavor_id)
           request(
             :expects => [200, 203],

data/lib/fog/rackspace/requests/compute_v2/get_image.rb

@@ -2,6 +2,24 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves image detail
+        # @param [String] image_id
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * image [Hash]:
+        #       * OS-DCF:diskConfig [String] - The disk configuration value.
+        #       * created [String] - created timestamp
+        #       * id [String] - id of image
+        #       * metadata [Hash] - image metadata
+        #       * minDisk [Fixnum]
+        #       * minRam [Fixnum]
+        #       * name [String] - name of image
+        #       * progress [Fixnum] - progress complete. Value is from 0 to 100.
+        #       * status [String] - status of current image
+        #       * updated [String] - updated timestamp
+        #       * links [Array] - links to flavor
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Image_Details-d1e4848.html        
         def get_image(image_id)
           request(
             :expects => [200, 203],

data/lib/fog/rackspace/requests/compute_v2/get_metadata_item.rb

@@ -2,6 +2,15 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves single metadatum item by key.
+        # @param [String<images, servers>] collection type of metadata
+        # @param [String] obj_id id of the object where the metadata is attached
+        # @param [String] key the key of the metadata to retrieve
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * meta [Hash]:
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Metadata_Item-d1e5507.html
         def get_metadata_item(collection, obj_id, key)
           request(
             :expects => 200,

data/lib/fog/rackspace/requests/compute_v2/get_network.rb

@@ -0,0 +1,21 @@
+module Fog
+  module Compute
+    class RackspaceV2
+      class Real
+        def get_network(id)
+          request(:method => 'GET', :path => "os-networksv2/#{id}", :expects => 200)
+        end
+      end
+
+      class Mock
+        def get_network(id)
+          unless self.data[:networks].has_key?(id)
+            raise Fog::Compute::RackspaceV2::NotFound
+          end
+
+          response(:body => { 'network' => self.data[:networks][id] })
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/compute_v2/get_server.rb

@@ -2,6 +2,38 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves server detail
+        # @param [String] server_id
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * server [Hash]:
+        #       * OS-DCF:diskConfig [String] - The disk configuration value.
+        #       * OS-EXT-STS:power_state [Fixnum] - The power state.
+        #       * OS-EXT-STS:task_state [String] - The task state.        
+        #       * OS-EXT-STS:vm_state [String] - The VM state.
+        #       * accessIPv4 [String] - The public IP version 4 access address.
+        #       * accessIPv6 [String] - The public IP version 6 access address.
+        #       * addresses [Hash] - Public and private IP addresses, The version field indicates whether the IP address is version 4 or 6.        
+        #       * created [String] - created timestamp
+        #       * hostId [String] - The host id. 
+        #       * id [String] - id of image
+        #       * image [Hash]:
+        #         * id [String] - id of the image
+        #         * links [Hash] - links to image
+        #       * flavor [Hash]:
+        #         * id [String] - id of the flavor
+        #         * links [Hash] - links to flavor
+        #       * links [Hash] - links to server
+        #       * metadata [Hash] - server metadata
+        #       * name [String] - name of server
+        #       * progress [Fixnum] - progress complete. Value is from 0 to 100.
+        #       * rax-bandwidth:bandwidth [Array] - The amount of bandwidth used for the specified audit period.
+        #       * status [String] - The server status.
+        #       * tenant_id [String] - The tenant ID.
+        #       * updated [String] - updated timestamp
+        #       * user_id [Array] - The user ID.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Server_Details-d1e2623.html
         def get_server(server_id)
           request(
             :expects => [200, 203, 300],

data/lib/fog/rackspace/requests/compute_v2/list_addresses.rb

@@ -3,6 +3,11 @@ module Fog
     class RackspaceV2
       class Real
 
+        # Lists all networks and addresses associated with a specified server.
+        # @param [String] server_id
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * addresses [Hash] - key is the network name and the value are an array of addresses allocated for that network
         def list_addresses(server_id)
           request(
             :method   => 'GET',

data/lib/fog/rackspace/requests/compute_v2/list_addresses_by_network.rb

@@ -3,6 +3,18 @@ module Fog
     class RackspaceV2
       class Real
 
+        # Lists all addresses associated with a specified server and network
+        # @param [String] server_id
+        # @param [String] network_id        
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * network [Hash]:
+        #       * id [String] - id of network
+        #       * ip [Array]:
+        #         * [Hash]:
+        #           * version [Fixnum] - version of the address
+        #           * addr [String] - ip address
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Addresses_by_Network-d1e3118.html
         def list_addresses_by_network(server_id, network_id)
           request(
             :method   => 'GET',

data/lib/fog/rackspace/requests/compute_v2/list_attachments.rb

@@ -2,6 +2,18 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves list of attached volumes
+        # @param [String] server_id
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * volumeAttachment [Array]:
+        #       * [Hash]:
+        #         * device [String] - The name of the device, such as /dev/xvdb. Specify auto for auto-assignment.
+        #         * serverId [String] - The id of the server that attached the volume
+        #         * id [String] - The id of the attachment
+        #         * volumeId [String] - The id of the volume that was attached
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Volume_Attachments.html
         def list_attachments(server_id)
           request(
             :expects => [200, 203, 300],

data/lib/fog/rackspace/requests/compute_v2/list_flavors.rb

@@ -2,6 +2,16 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves a list of flavors
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * flavors [Array]:
+        #       * [Hash]:
+        #         * id [String] - flavor id
+        #         * links [Array] - flavor links
+        #         * name [String] - flavor name
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Flavors-d1e4188.html
         def list_flavors
           request(
             :expects => [200, 203],

data/lib/fog/rackspace/requests/compute_v2/list_images.rb

@@ -2,6 +2,16 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves a list of images
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * images [Array]:
+        #       * [Hash]:
+        #         * id [String] - flavor id
+        #         * links [Array] - image links
+        #         * name [String] - image name
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Flavors-d1e4188.html        
         def list_images
           request(
             :expects => [200, 203],

data/lib/fog/rackspace/requests/compute_v2/list_metadata.rb

@@ -2,6 +2,14 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves all metadata associated with a server or an image.
+        # @param [String<images, servers>] collection type of metadata
+        # @param [String] obj_id id of the object where the metadata is attached
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * meta [Hash]:
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Metadata-d1e5089.html       
         def list_metadata(collection, obj_id)
           request(
             :expects => [200, 203],

data/lib/fog/rackspace/requests/compute_v2/list_networks.rb

@@ -0,0 +1,18 @@
+module Fog
+  module Compute
+    class RackspaceV2
+      class Real
+        def list_networks
+          request(:method => 'GET', :path => 'os-networksv2', :expects => 200)
+        end
+      end
+
+      class Mock
+        def list_networks
+          networks = self.data[:networks].values
+          response(:body => { 'networks' => networks })
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/requests/compute_v2/list_servers.rb

@@ -2,6 +2,37 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Retrieves list of servers
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * server [Hash]:
+        #       * OS-DCF:diskConfig [String] - The disk configuration value.
+        #       * OS-EXT-STS:power_state [Fixnum] - The power state.
+        #       * OS-EXT-STS:task_state [String] - The task state.        
+        #       * OS-EXT-STS:vm_state [String] - The VM state.
+        #       * accessIPv4 [String] - The public IP version 4 access address.
+        #       * accessIPv6 [String] - The public IP version 6 access address.
+        #       * addresses [Hash] - Public and private IP addresses, The version field indicates whether the IP address is version 4 or 6.        
+        #       * created [String] - created timestamp
+        #       * hostId [String] - The host id. 
+        #       * id [String] - id of image
+        #       * image [Hash]:
+        #         * id [String] - id of the image
+        #         * links [Hash] - links to image
+        #       * flavor [Hash]:
+        #         * id [String] - id of the flavor
+        #         * links [Hash] - links to flavor
+        #       * links [Hash] - links to server
+        #       * metadata [Hash] - server metadata
+        #       * name [String] - name of server
+        #       * progress [Fixnum] - progress complete. Value is from 0 to 100.
+        #       * rax-bandwidth:bandwidth [Array] - The amount of bandwidth used for the specified audit period.
+        #       * status [String] - The server status.
+        #       * tenant_id [String] - The tenant ID.
+        #       * updated [String] - updated timestamp
+        #       * user_id [Array] - The user ID.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Servers-d1e2078.html       
         def list_servers
           request(
             :expects => [200, 203, 300],

data/lib/fog/rackspace/requests/compute_v2/reboot_server.rb

@@ -2,6 +2,11 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # Reboots server
+        # @param [String] server_id
+        # @param [String<SOFT,HARD>] type type of reboot
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Reboot_Server-d1e3371.html
         def reboot_server(server_id, type)
           data = {
             'reboot' => {

data/lib/fog/rackspace/requests/compute_v2/rebuild_server.rb

@@ -2,6 +2,43 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+        
+        # The rebuild operation removes all data on the server and replaces it with the specified image. 
+        # The serverRef and all IP addresses remain the same. If you specify name, metadata, accessIPv4, 
+        # or accessIPv6 in the rebuild request, new values replace existing values. Otherwise, these values do not change.
+        # @param [String] server_id id of the server to rebuild
+        # @param [String] image_id id of image used to rebuild the server
+        # @param [Hash] options
+        # @option options [String] accessIPv4 The IP version 4 address.
+        # @option options [String] accessIPv6 The IP version 6 address.
+        # @option options [String] adminPass The administrator password.
+        # @option options [Hash] metadata key value pairs of server metadata
+        # @option options [String] OS-DCF:diskConfig The disk configuration value. (AUTO or MANUAL)
+        # @option options [Hash] personality Hash containing data to inject into the file system of the cloud server instance during server creation.
+        # @return [Excon::Response] response:
+        #   * body [Hash]:        
+        #     * server [Hash]:
+        #       * name [String] - name of server
+        #       * imageRef [String] - id of image used to create server
+        #       * flavorRef [String] - id of flavor used to create server        
+        #       * OS-DCF:diskConfig [String] - The disk configuration value.
+        #       * name [String] - name of server
+        #       * metadata [Hash] - Metadata key and value pairs.
+        #       * personality [Array]:
+        #           * [Hash]:
+        #             * path - path of the file created
+        #             * contents - Base 64 encoded file contents
+        #       * networks [Array]:
+        #         * [Hash]:
+        #           * uuid [String] - uuid of attached network        
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Rebuild_Server-d1e3538.html
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Metadata-d1e2529.html
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Personality-d1e2543.html
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ch_extensions.html#diskconfig_attribute
+        #
+        #   * Status Transition:
+        #     * ACTIVE -> REBUILD -> ACTIVE
+        #     * ACTIVE -> REBUILD -> ERROR (on error)
         def rebuild_server(server_id, image_id, options={})
           data = {
             'rebuild' => options || {}

data/lib/fog/rackspace/requests/compute_v2/resize_server.rb

@@ -2,6 +2,16 @@ module Fog
   module Compute
     class RackspaceV2
       class Real
+
+        # Reverts server resize operation
+        # @param [String] server_id id of server to resize
+        # @param [String] flavor_id id of the desired flavor        
+        # @note All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize.                
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Revert_Resized_Server-d1e4024.html
+        #
+        # * Status Transition:
+        #   * VERIFY_RESIZE -> ACTIVE
+        #   * VERIFY_RESIZE -> ERROR (on error)        
         def resize_server(server_id, flavor_id)
           data = {
             'resize' => {