fog 1.10.0 → 1.10.1

data/lib/fog/rackspace/models/storage/metadata.rb

@@ -20,20 +20,36 @@ module Fog
         CONTAINER_KEY_REGEX = /^#{CONTAINER_META_PREFIX}(.*)/
         OBJECT_KEY_REGEX = /^#{OBJECT_META_PREFIX}(.*)/
         
+
+        # @!attribute [rw] data
+        # @return [Hash] underlying data store for metadata class
+        attr_reader :data
+
+        # @!attribute [rw] parent
+        # @return [Fog::Storage::Rackspace::Directory,Fog::Storage::Rackspace::File] the parent object of the metadata
+        attr_reader :parent
         
-        attr_reader :data, :parent
-        
+        # Initialize
+        # @param [Fog::Storage::Rackspace::Directory,Fog::Storage::Rackspace::File] parent object of the metadata
+        # @param [Hash] hash containing initial metadata values
         def initialize(parent, hash={})
           @data = hash || {}
           @deleted_hash = {}
           @parent = parent
         end
-                
+
+
+        # Delete key value pair from metadata
+        # @param [String] key to be deleted
+        # @return [Object] returns value for key
+        # @note Metadata must be deleted using this method in order to properly remove it from Cloud Files
         def delete(key)
           data.delete(key)
           @deleted_hash[key] = nil
         end
-                
+
+        # Returns metadata in a format expected by Cloud Files
+        # @return [Hash] Metadata in a format expected by Cloud Files
         def to_headers
           headers = {}          
           h = data.merge(@deleted_hash) 
@@ -45,6 +61,9 @@ module Fog
           headers
         end
         
+        # Creates metadata object from Cloud File Headers
+        # @param [Fog::Storage::Rackspace::Directory,Fog::Storage::Rackspace::File] parent object of the metadata
+        # @param [Hash] headers Cloud File headers
         def self.from_headers(parent, headers)
           metadata = Metadata.new(parent)
           headers.each_pair do |k, v|
@@ -55,10 +74,14 @@ module Fog
           metadata
         end   
         
+        # Returns true if method is implemented by Metadata class
+        # @param [Symbol] method_sym
+        # @param [Boolean] include_private
         def respond_to?(method_sym, include_private = false)
           super(method_sym, include_private) || data.respond_to?(method_sym, include_private)
         end
-                
+
+        # Invoked by Ruby when obj is sent a message it cannot handle.
         def method_missing(method, *args, &block)
           data.send(method, *args, &block)
         end                             

data/lib/fog/rackspace/requests/block_storage/create_snapshot.rb

@@ -2,6 +2,30 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Create a snapshot from a volume
+        #
+        # @param [String] volume_id Id of server to create image from
+        # @param [Hash] options
+        # @option options [String] :display_name display name for snapshot
+        # @option options [String] :display_description display description for snapshot
+        # @option options [Boolean] :force Set to true to force service to create snapshot
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * 'snapshot' [Hash]:
+        #       * 'volume_id' [String]: - the volume_id of the snapshot
+        #         * 'display_description' [String]: - display description of snapshot
+        #         * 'status' [String]: - status of snapshot
+        #         * 'id' [String]: - id of snapshot
+        #         * 'size' [Fixnum]: - size of the snapshot in GB
+        #         * 'display_name' [String]: - display name of snapshot
+        #         * 'created_at' [String]: - creation time of snapshot
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @note All writes to the volume should be flushed before creating the snapshot, either by un-mounting any file systems on the volume or by detaching the volume.
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/POST_createSnapshot__v1__tenant_id__snapshots.html
         def create_snapshot(volume_id, options = {})
           data = {
             'snapshot' => {

data/lib/fog/rackspace/requests/block_storage/create_volume.rb

@@ -2,6 +2,34 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Create volume
+        #
+        # @param [Integer] size size of volume in GB. Minimum size is 100
+        # @param [Hash] options
+        # @option options [String] :display_name display name for volume
+        # @option options [String] :display_description display description for volume
+        # @option options [String] :volume_type type of volume
+        # @option options [String] :snapshot_id The optional snapshot from which to create a volume.
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * 'volume' [Hash]:
+        #       * 'volume_type' [String]: - type of volume
+        #       * 'display_description' [String]: - volume description
+        #       * 'metadata' [Hash]: - volume metadata
+        #       * 'availability_zone'[String]: - region of the volume
+        #       * 'status' [String]: - status of volume
+        #       * 'id' [String]: - id of volume
+        #       * 'attachments' [Array<Hash]: - array of hashes containing attachment information
+        #       * 'size' [Fixnum]: - size of volume in GB (100 GB minimum)
+        #       * 'snapshot_id' [String]: - The optional snapshot from which to create a volume.
+        #       * 'display_name' [String]: - display name of volume
+        #       * 'created_at' [String]: - the volume creation time
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/POST_createVolume__v1__tenant_id__volumes.html
         def create_volume(size, options = {})
           data = {
             'volume' => {
@@ -13,6 +41,7 @@ module Fog
           data['volume']['display_description'] = options[:display_description] unless options[:display_description].nil?
           data['volume']['volume_type'] = options[:volume_type] unless options[:volume_type].nil?
           data['volume']['availability_zone'] = options[:availability_zone] unless options[:availability_zone].nil?
+          data['volume']['snapshot_id'] = options[:snapshot_id] unless options[:snapshot_id].nil?
 
           request(
             :body => Fog::JSON.encode(data),

data/lib/fog/rackspace/requests/block_storage/delete_snapshot.rb

@@ -2,6 +2,16 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Delete snapshot
+        #
+        # @param [String] snapshot_id Id of snapshot to delete
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/POST_createSnapshot__v1__tenant_id__snapshots.html
         def delete_snapshot(snapshot_id)
           request(
             :expects => [202],

data/lib/fog/rackspace/requests/block_storage/delete_volume.rb

@@ -2,6 +2,17 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Delete volume
+        #
+        # @param [String] volume_id Id of volume to delete
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @note You cannot delete a volume until all of its dependent snaphosts have been deleted.
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/DELETE_deleteVolume__v1__tenant_id__volumes.html
         def delete_volume(volume_id)
           request(
             :expects => [202],

data/lib/fog/rackspace/requests/block_storage/get_snapshot.rb

@@ -2,6 +2,26 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Retrieves snapshot detail
+        # @param [String] snapshot_id
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * 'snapshot' [Hash]:
+        #       * 'volume_id' [String]: -  volume_id of the snapshot
+        #       * 'display_description' [String]: - snapshot display description
+        #       * 'status' [String]: - snapshot status
+        #       * 'os-extended-snapshot-attributes:project_id' [String]: -
+        #       * 'id' [String]: - snapshot id
+        #       * 'size' [Fixnum]: - size of the snapshot in GB
+        #       * 'os-extended-snapshot-attributes:progress' [String]: -
+        #       * 'display_name' [String]: - display name of snapshot
+        #       * 'created_at' [String]: - creation time of snapshot
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getSnapshot__v1__tenant_id__snapshots.html
         def get_snapshot(snapshot_id)
           request(
             :expects => [200],

data/lib/fog/rackspace/requests/block_storage/get_volume.rb

@@ -2,6 +2,30 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Retrieves volume detail
+        # @param [String] volume_id
+        # @return [Excon::Response] response:
+        #   * body  [Hash]:
+        #     * 'volume' [Hash]:
+        #       * 'volume_type' [String]: - volume type
+        #       * 'display_description' [String]: - volume display description
+        #       * 'metadata' [Hash]: - volume metadata
+        #       * 'availability_zone' [String]: - region of volume
+        #       * 'status' [String]: - status of volume
+        #       * 'id' [String]: - id of volume
+        #       * 'attachments' [Array<Hash]: - array of hashes containing attachment information
+        #       * 'size' [Fixnum]: - size of volume in GB (100 GB minimum)
+        #       * 'snapshot_id' [String]: - The optional snapshot from which to create a volume.
+        #       * 'os-vol-host-attr:host' [String]: -
+        #       * 'display_name' [String]: - display name of volume
+        #       * 'created_at' [String]: - the volume creation time
+        #       * 'os-vol-tenant-attr:tenant_id' [String]: -
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        #   @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getVolume__v1__tenant_id__volumes.html
         def get_volume(volume_id)
           request(
             :expects => [200],

data/lib/fog/rackspace/requests/block_storage/get_volume_type.rb

@@ -2,6 +2,20 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Retrieves volume type detail
+        # @param [String] volume_type_id
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * 'volume_type' [Hash]: -
+        #       * 'name' [String]: - name of volume type
+        #       * 'extra_specs' [Hash]: -
+        #       * 'id' [String]: - id of volume type
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getVolumeType__v1__tenant_id__types.html
         def get_volume_type(volume_type_id)
           request(
             :expects => [200],

data/lib/fog/rackspace/requests/block_storage/list_snapshots.rb

@@ -2,6 +2,23 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Retrieves list of snapshots
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * 'snapshots' [Array]: -
+        #       * 'volume_id' [String]: - volume_id of the snapshot
+        #       * 'display_description' [String]: - display description of snapshot
+        #       * 'status' [String]: - status of snapshot
+        #       * 'id' [String]: - id of snapshot
+        #       * 'size' [Fixnum]: - size of the snapshot in GB
+        #       * 'display_name' [String]: - display name of snapshot
+        #       * 'created_at' [String]: - creation time of snapshot
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getSnapshotsSimple__v1__tenant_id__snapshots.html
         def list_snapshots
           request(
             :expects => [200],

data/lib/fog/rackspace/requests/block_storage/list_volume_types.rb

@@ -2,6 +2,19 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Retrieves list of volume types
+        # @return [Excon::Response] response
+        #   * body [Hash]:
+        #     * 'volume_types' [Array]: -
+        #       * 'name' [String]: - name of volume type
+        #       * 'extra_specs' [Hash]: -
+        #       * 'id' [Fixnum]: - id of volume type
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getVolumeTypes__v1__tenant_id__types.html
         def list_volume_types
           request(
             :expects => [200],

data/lib/fog/rackspace/requests/block_storage/list_volumes.rb

@@ -2,6 +2,27 @@ module Fog
   module Rackspace
     class BlockStorage
       class Real
+
+        # Retrieves list of volumes
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * 'volumes' [Array]: -
+        #       * 'volume_type' [String]: - volume type
+        #       * 'display_description' [String]: - display desciption for volume
+        #       * 'metadata' [Hash]: - metadata for volume
+        #       * 'availability_zone' [String]: - region for volume
+        #       * 'status' [String]: - status of volume
+        #       * 'id' [String]: - id of volume
+        #       * 'attachments' [Array]: - array of hashes containing attachment information
+        #       * 'size' [Fixnum]: -  size of volume in GB (100 GB minimum)
+        #       * 'snapshot_id' [String]: - optional snapshot from which to create a volume.
+        #       * 'display_name' [String]: - display name of bolume
+        #       * 'created_at' [String]: - volume creation time
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
+        # @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getVolumesSimple__v1__tenant_id__volumes.html
         def list_volumes
           request(
             :expects => [200],

data/lib/fog/rackspace/requests/cdn/delete_object.rb

@@ -8,7 +8,11 @@ module Fog
         # ==== Parameters
         # * container<~String> - Name of container to delete
         # * object<~String> - Name of object to delete
-        #
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
         def delete_object(container, object)
           request(
             :expects  => 204,

data/lib/fog/rackspace/requests/cdn/get_containers.rb

@@ -15,6 +15,11 @@ module Fog
         # * response<~Excon::Response>:
         #   * body<~Array>:
         #     * container<~String>: Name of container
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
         def get_containers(options = {})
           response = request(
             :expects  => [200, 204],

data/lib/fog/rackspace/requests/cdn/head_container.rb

@@ -17,6 +17,11 @@ module Fog
         #     * 'X-Log-Retention'<~Boolean> - ?
         #     * 'X-User-Agent-ACL'<~String> - ?
         #     * 'X-Referrer-ACL'<~String> - ?
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
         def head_container(container)
           response = request(
             :expects  => 204,

data/lib/fog/rackspace/requests/cdn/post_container.rb

@@ -7,13 +7,18 @@ module Fog
         #
         # ==== Parameters
         # * name<~String> - Name for container, should be < 256 bytes and must not contain '/'
-        # # options<~Hash>:
+        # * options<~Hash>:
         #   * 'X-CDN-Enabled'<~Boolean> - cdn status for container
         #   * 'X-CDN-URI'<~String> - cdn url for this container
         #   * 'X-TTL'<~String> - integer seconds before data expires, defaults to 86400 (1 day), in 3600..259200
         #   * 'X-Log-Retention'<~Boolean> - ?
         #   * 'X-User-Agent-ACL'<~String> - ?
         #   * 'X-Referrer-ACL'<~String> - ?
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
         def post_container(name, options = {})
           response = request(
             :expects  => [201, 202],

data/lib/fog/rackspace/requests/cdn/put_container.rb

@@ -7,13 +7,18 @@ module Fog
         #
         # ==== Parameters
         # * name<~String> - Name for container, should be < 256 bytes and must not contain '/'
-        # # options<~Hash>:
+        # * options<~Hash>:
         #   * 'X-CDN-Enabled'<~Boolean> - cdn status for container
         #   * 'X-CDN-URI'<~String> - cdn url for this container
         #   * 'X-TTL'<~String> - integer seconds before data expires, defaults to 86400 (1 day), in 3600..259200
         #   * 'X-Log-Retention'<~Boolean> - ?
         #   * 'X-User-Agent-ACL'<~String> - ?
         #   * 'X-Referrer-ACL'<~String> - ?
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
         def put_container(name, options = {})
           response = request(
             :expects  => [201, 202],

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

@@ -14,6 +14,10 @@ module Fog
         #       * 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
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
         # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Attach_Volume_to_Server.html
         def attach_volume(server_id, volume_id, device)
           data = {

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

@@ -7,6 +7,10 @@ module Fog
         # @param [String] server_id 
         # @param [String] password
         # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
         # @note Though Rackspace does not enforce complexity requirements for the password, the operating system might. If the password is not complex enough, the server might enter an ERROR state.
         # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Change_Password-d1e3234.html        
         def change_server_password(server_id, password)

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

@@ -5,6 +5,11 @@ module Fog
         
         # Confirm server resize operation
         # @param [String] server_id The id of the server to revert
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Errors::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Errors::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Errors::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Errors::ServiceError]
         # @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
         #