fog-maestrodev 1.7.0.20121114190951 → 1.8.0.20130109172219

data/lib/fog/aws/requests/storage/delete_object.rb

@@ -5,16 +5,13 @@ module Fog
 
         # Delete an object from S3
         #
-        # ==== Parameters
-        # * bucket_name<~String> - Name of bucket containing object to delete
-        # * object_name<~String> - Name of object to delete
+        # @param bucket_name [String] Name of bucket containing object to delete
+        # @param object_name [String] Name of object to delete
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * status<~Integer> - 204
+        # @return [Excon::Response] response:
+        #   * status [Integer] - 204
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html
 
         def delete_object(bucket_name, object_name, options = {})
           if version_id = options.delete('versionId')

data/lib/fog/aws/requests/storage/get_bucket.rb

@@ -7,38 +7,35 @@ module Fog
 
         # List information about objects in an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to list object keys from
-        # * options<~Hash> - config arguments for list.  Defaults to {}.
-        #   * 'delimiter'<~String> - causes keys with the same string between the prefix
+        # @param bucket_name [String] name of bucket to list object keys from
+        # @param options [Hash] config arguments for list.  Defaults to {}.
+        # @option options delimiter [String] causes keys with the same string between the prefix
         #     value and the first occurence of delimiter to be rolled up
-        #   * 'marker'<~String> - limits object keys to only those that appear
+        # @option options marker [String] limits object keys to only those that appear
         #     lexicographically after its value.
-        #   * 'max-keys'<~Integer> - limits number of object keys returned
-        #   * 'prefix'<~String> - limits object keys to those beginning with its value.
+        # @option options max-keys [Integer] limits number of object keys returned
+        # @option options prefix [String] limits object keys to those beginning with its value.
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'Delimeter'<~String> - Delimiter specified for query
-        #     * 'IsTruncated'<~Boolean> - Whether or not the listing is truncated
-        #     * 'Marker'<~String> - Marker specified for query
-        #     * 'MaxKeys'<~Integer> - Maximum number of keys specified for query
-        #     * 'Name'<~String> - Name of the bucket
-        #     * 'Prefix'<~String> - Prefix specified for query
-        #     * 'CommonPrefixes'<~Array> - Array of strings for common prefixes
-        #     * 'Contents'<~Array>:
-        #       * 'ETag'<~String>: Etag of object
-        #       * 'Key'<~String>: Name of object
-        #       * 'LastModified'<~String>: Timestamp of last modification of object
-        #       * 'Owner'<~Hash>:
-        #         * 'DisplayName'<~String> - Display name of object owner
-        #         * 'ID'<~String> - Id of object owner
-        #       * 'Size'<~Integer> - Size of object
-        #       * 'StorageClass'<~String> - Storage class of object
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Delimeter [String] - Delimiter specified for query
+        #     * IsTruncated [Boolean] - Whether or not the listing is truncated
+        #     * Marker [String]- Marker specified for query
+        #     * MaxKeys [Integer] - Maximum number of keys specified for query
+        #     * Name [String] - Name of the bucket
+        #     * Prefix [String] - Prefix specified for query
+        #     * CommonPrefixes [Array] - Array of strings for common prefixes
+        #     * Contents [Array]:
+        #       * ETag [String] - Etag of object
+        #       * Key [String] - Name of object
+        #       * LastModified [String] - Timestamp of last modification of object
+        #       * Owner [Hash]:
+        #         * DisplayName [String] - Display name of object owner
+        #         * ID [String] - Id of object owner
+        #       * Size [Integer] - Size of object
+        #       * StorageClass [String] - Storage class of object
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html
 
         def get_bucket(bucket_name, options = {})
           unless bucket_name

data/lib/fog/aws/requests/storage/get_bucket_acl.rb

@@ -7,27 +7,24 @@ module Fog
 
         # Get access control list for an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to get access control list for
+        # @param bucket_name [String] name of bucket to get access control list for
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'AccessControlPolicy'<~Hash>
-        #       * 'Owner'<~Hash>:
-        #         * 'DisplayName'<~String> - Display name of object owner
-        #         * 'ID'<~String> - Id of object owner
-        #       * 'AccessControlList'<~Array>:
-        #         * 'Grant'<~Hash>:
-        #           * 'Grantee'<~Hash>:
-        #              * 'DisplayName'<~String> - Display name of grantee
-        #              * 'ID'<~String> - Id of grantee
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * AccessControlPolicy [Hash]:
+        #       * Owner [Hash]:
+        #         * DisplayName [String] - Display name of object owner
+        #         * ID [String] - Id of object owner
+        #       * AccessControlList [Array]:
+        #         * Grant [Hash]:
+        #           * Grantee [Hash]:
+        #             * DisplayName [String] - Display name of grantee
+        #             * ID [String] - Id of grantee
         #             or
-        #              * 'URI'<~String> - URI of group to grant access for
-        #           * 'Permission'<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
+        #             * URI [String] - URI of group to grant access for
+        #           * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html
 
         def get_bucket_acl(bucket_name)
           unless bucket_name

data/lib/fog/aws/requests/storage/get_bucket_cors.rb

@@ -0,0 +1,65 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/parsers/storage/cors_configuration'
+
+        # Gets the CORS configuration for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to get access control list for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * CORSConfiguration [Array]:
+        #       * CORSRule [Hash]:
+        #         * AllowedHeader [String] - Which headers are allowed in a pre-flight OPTIONS request through the Access-Control-Request-Headers header.
+        #         * AllowedMethod [String] - Identifies an HTTP method that the domain/origin specified in the rule is allowed to execute.
+        #         * AllowedOrigin [String] - One or more response headers that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
+        #         * ExposeHeader [String] - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
+        #         * ID [String] - An optional unique identifier for the rule. The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration.
+        #         * MaxAgeSeconds [Integer] - The time in seconds that your browser is to cache the preflight response for the specified resource.
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html
+
+        def get_bucket_cors(bucket_name)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          request({
+            :expects    => 200,
+            :headers    => {},
+            :host       => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Storage::AWS::CorsConfiguration.new,
+            :query      => {'cors' => nil}
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        require 'fog/aws/requests/storage/cors_utils'
+
+        def get_bucket_cors(bucket_name)
+          response = Excon::Response.new
+          if cors = self.data[:cors][:bucket][bucket_name]
+            response.status = 200
+            if cors.is_a?(String)
+              response.body = Fog::Storage::AWS.cors_to_hash(cors)
+            else
+              response.body = cors
+            end
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+          response
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/storage/get_bucket_lifecycle.rb

@@ -7,20 +7,17 @@ module Fog
 
         # Get bucket lifecycle configuration
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to get lifecycle configuration for
+        # @param bucket_name [String] name of bucket to get lifecycle configuration for
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'Rules'<~Array> - object expire rules
-        #        * 'ID'<~String>      - Unique identifier for the rule
-        #        * 'Prefix'<~String>  - Prefix identifying one or more objects to which the rule applies
-        #        * 'Enabled'<~Boolean> - if rule is currently being applied
-        #        * 'Days'<~Integer>   - lifetime, in days, of the objects that are subject to the rule
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Rules - object expire rules [Array]:
+        #       * ID [String] - Unique identifier for the rule
+        #       * Prefix [String] - Prefix identifying one or more objects to which the rule applies
+        #       * Enabled [Boolean] - if rule is currently being applied
+        #       * Days [Integer] - lifetime, in days, of the objects that are subject to the rule
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html
 
         def get_bucket_lifecycle(bucket_name)
           request({

data/lib/fog/aws/requests/storage/get_bucket_location.rb

@@ -7,16 +7,13 @@ module Fog
 
         # Get location constraint for an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to get location constraint for
+        # @param bucket_name [String] name of bucket to get location constraint for
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'LocationConstraint'<~String> - Location constraint of the bucket
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * LocationConstraint [String] - Location constraint of the bucket
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html
 
         def get_bucket_location(bucket_name)
           request({

data/lib/fog/aws/requests/storage/get_bucket_logging.rb

@@ -7,27 +7,24 @@ module Fog
 
         # Get logging status for an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to get logging status for
+        # @param bucket_name [String] name of bucket to get logging status for
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'BucketLoggingStatus'<~Hash>: (will be empty if logging is disabled)
-        #       * 'LoggingEnabled'<~Hash>:
-        #         * 'TargetBucket'<~String> - bucket where logs are stored
-        #         * 'TargetPrefix'<~String> - prefix logs are stored with
-        #         * 'TargetGrants'<~Array>:
-        #           * 'Grant'<~Hash>:
-        #             * 'Grantee'<~Hash>:
-        #                 * 'DisplayName'<~String> - Display name of grantee
-        #                 * 'ID'<~String> - Id of grantee
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * BucketLoggingStatus (will be empty if logging is disabled) [Hash]:
+        #       * LoggingEnabled [Hash]:
+        #         * TargetBucket [String] - bucket where logs are stored
+        #         * TargetPrefix [String] - prefix logs are stored with
+        #         * TargetGrants [Array]:
+        #           * Grant [Hash]:
+        #             * Grantee [Hash]:
+        #               * DisplayName [String] - Display name of grantee
+        #               * ID [String] - Id of grantee
         #               or
-        #                 * 'URI'<~String> - URI of group to grant access for
-        #             * 'Permission'<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
+        #               * URI [String] - URI of group to grant access for
+        #             * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html
 
         def get_bucket_logging(bucket_name)
           unless bucket_name

data/lib/fog/aws/requests/storage/get_bucket_object_versions.rb

@@ -7,52 +7,46 @@ module Fog
 
         # List information about object versions in an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to list object keys from
-        # * options<~Hash> - config arguments for list.  Defaults to {}.
-        #   * 'delimiter'<~String> - causes keys with the same string between the prefix
-        #     value and the first occurence of delimiter to be rolled up
-        #   * 'key-marker'<~String> - limits object keys to only those that appear
-        #     lexicographically after its value.
-        #   * 'max-keys'<~Integer> - limits number of object keys returned
-        #   * 'prefix'<~String> - limits object keys to those beginning with its value.
-        #   * 'version-id-marker'<~String> - limits object versions to only those that
-        #     appear lexicographically after its value
+        # @param bucket_name [String] name of bucket to list object keys from
+        # @param options [Hash] config arguments for list
+        # @option options delimiter [String] causes keys with the same string between the prefix value and the first occurence of delimiter to be rolled up
+        # @option options key-marker [String] limits object keys to only those that appear lexicographically after its value.
+        # @option options max-keys [Integer] limits number of object keys returned
+        # @option options prefix [String] limits object keys to those beginning with its value.
+        # @option options version-id-marker [String] limits object versions to only those that appear lexicographically after its value
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'Delimeter'<~String> - Delimiter specified for query
-        #     * 'KeyMarker'<~String> - Key marker specified for query
-        #     * 'MaxKeys'<~Integer> - Maximum number of keys specified for query
-        #     * 'Name'<~String> - Name of the bucket
-        #     * 'Prefix'<~String> - Prefix specified for query
-        #     * 'VersionIdMarker'<~String> - Version id marker specified for query
-        #     * 'IsTruncated'<~Boolean> - Whether or not this is the totality of the bucket
-        #     * 'Versions'<~Array>:
-        #         * 'DeleteMarker'<~Hash>:
-        #           * 'IsLatest'<~Boolean> - Whether or not this is the latest version
-        #           * 'Key'<~String> - Name of object
-        #           * 'LastModified'<~String>: Timestamp of last modification of object
-        #           * 'Owner'<~Hash>:
-        #             * 'DisplayName'<~String> - Display name of object owner
-        #             * 'ID'<~String> - Id of object owner
-        #           * 'VersionId'<~String> - The id of this version
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Delimeter [String] - Delimiter specified for query
+        #     * KeyMarker [String] - Key marker specified for query
+        #     * MaxKeys [Integer] - Maximum number of keys specified for query
+        #     * Name [String] - Name of the bucket
+        #     * Prefix [String] - Prefix specified for query
+        #     * VersionIdMarker [String] - Version id marker specified for query
+        #     * IsTruncated [Boolean] - Whether or not this is the totality of the bucket
+        #     * Versions [Array]:
+        #       * DeleteMarker [Hash]:
+        #         * IsLatest [Boolean] - Whether or not this is the latest version
+        #         * Key [String] - Name of object
+        #         * LastModified [String]: Timestamp of last modification of object
+        #         * Owner [Hash]:
+        #           * DisplayName [String] - Display name of object owner
+        #           * ID [String] - Id of object owner
+        #         * VersionId [String] - The id of this version
         #       or
-        #         * 'Version'<~Hash>:
-        #           * 'ETag'<~String>: Etag of object
-        #           * 'IsLatest'<~Boolean> - Whether or not this is the latest version
-        #           * 'Key'<~String> - Name of object
-        #           * 'LastModified'<~String>: Timestamp of last modification of object
-        #           * 'Owner'<~Hash>:
-        #             * 'DisplayName'<~String> - Display name of object owner
-        #             * 'ID'<~String> - Id of object owner
-        #           * 'Size'<~Integer> - Size of object
-        #           * 'StorageClass'<~String> - Storage class of object
-        #           * 'VersionId'<~String> - The id of this version
+        #       * Version [Hash]:
+        #         * ETag [String]: Etag of object
+        #         * IsLatest [Boolean] - Whether or not this is the latest version
+        #         * Key [String] - Name of object
+        #         * LastModified [String]: Timestamp of last modification of object
+        #         * Owner [Hash]:
+        #           * DisplayName [String] - Display name of object owner
+        #           * ID [String] - Id of object owner
+        #         * Size [Integer] - Size of object
+        #         * StorageClass [String] - Storage class of object
+        #         * VersionId [String] - The id of this version
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html
 
         def get_bucket_object_versions(bucket_name, options = {})
           unless bucket_name

data/lib/fog/aws/requests/storage/get_bucket_policy.rb

@@ -5,15 +5,12 @@ module Fog
 
         # Get bucket policy for an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to get policy for
+        # @param bucket_name [String] name of bucket to get policy for
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash> - policy document
+        # @return [Excon::Response] response:
+        #   * body [Hash] - policy document
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html
 
         def get_bucket_policy(bucket_name)
           unless bucket_name

data/lib/fog/aws/requests/storage/get_bucket_versioning.rb

@@ -7,17 +7,14 @@ module Fog
 
         # Get versioning status for an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to get versioning status for
+        # @param bucket_name [String] name of bucket to get versioning status for
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'VersioningConfiguration'<~Hash>
-        #         * Status<~String>: Versioning status in ['Enabled', 'Suspended', nil]
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * VersioningConfiguration [Hash]:
+        #       * Status [String] - Versioning status in ['Enabled', 'Suspended', nil]
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html
 
         def get_bucket_versioning(bucket_name)
           unless bucket_name

data/lib/fog/aws/requests/storage/get_bucket_website.rb

@@ -7,19 +7,17 @@ module Fog
 
         # Get website configuration for an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to get website configuration for
+        # 
+        # @param bucket_name [String] name of bucket to get website configuration for
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * IndexDocument<~Hash>
-        #       * Suffix<~String> - Suffix appended when directory is requested
-        #     * ErrorDocument<~Hash>
-        #       * Key<~String> - Object key to return for 4XX class errors
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * IndexDocument [Hash]:
+        #       * Suffix [String] - Suffix appended when directory is requested
+        #     * ErrorDocument [Hash]:
+        #       * Key [String] - Object key to return for 4XX class errors
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html
 
         def get_bucket_website(bucket_name)
           unless bucket_name