fog 1.8.0 → 1.9.0

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

@@ -11,7 +11,7 @@ module Fog
           unless object_name
             raise ArgumentError.new('object_name is required')
           end
-          host, path = if bucket_name =~ /^(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\-(?![\.])){1,61}[a-z0-9]$/
+          host, path = if bucket_name =~ Fog::AWS::COMPLIANT_BUCKET_NAMES
             ["#{bucket_name}.#{@host}", object_name]
           else
             [@host, "#{bucket_name}/#{object_name}"]
@@ -32,17 +32,14 @@ module Fog
 
         # Get an expiring object url from S3
         #
-        # ==== Parameters
-        # * bucket_name<~String> - Name of bucket containing object
-        # * object_name<~String> - Name of object to get expiring url for
-        # * expires<~Time> - An expiry time for this url
+        # @param bucket_name [String] Name of bucket containing object
+        # @param object_name [String] Name of object to get expiring url for
+        # @param expires [Time] An expiry time for this url
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~String> - url for object
+        # @return [Excon::Response] response:
+        #   * body [String] - url for object
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html
 
         include GetObjectUrl
 

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

@@ -7,16 +7,13 @@ module Fog
 
         # Get configured payer for an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to get payer for
+        # @param bucket_name [String] name of bucket to get payer for
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'Payer'<~String> - Specifies who pays for download and requests
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Payer [String] - Specifies who pays for download and requests
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html
 
         def get_request_payment(bucket_name)
           request({

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

@@ -7,18 +7,16 @@ module Fog
 
         # List information about S3 buckets for authorized user
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'Buckets'<~Hash>:
-        #       * 'Name'<~String> - Name of bucket
-        #       * 'CreationTime'<~Time> - Timestamp of bucket creation
-        #     * 'Owner'<~Hash>:
-        #       * 'DisplayName'<~String> - Display name of bucket owner
-        #       * 'ID'<~String> - Id of bucket owner
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Buckets [Hash]:
+        #       * Name [String] - Name of bucket
+        #       * CreationTime [Time] - Timestamp of bucket creation
+        #     * Owner [Hash]:
+        #       * DisplayName [String] - Display name of bucket owner
+        #       * ID [String] - Id of bucket owner
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html
         #
         def get_service
           request({

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

@@ -5,29 +5,26 @@ module Fog
 
         # Get headers for an object from S3
         #
-        # ==== Parameters
-        # * bucket_name<~String> - Name of bucket to read from
-        # * object_name<~String> - Name of object to read
-        # * options<~Hash>:
-        #   * 'If-Match'<~String> - Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed).
-        #   * 'If-Modified-Since'<~Time> - Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified).
-        #   * 'If-None-Match'<~String> - Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
-        #   * 'If-Unmodified-Since'<~Time> - Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
-        #   * 'Range'<~String> - Range of object to download
-        #   * 'versionId'<~String> - specify a particular version to retrieve
+        # @param bucket_name [String] Name of bucket to read from
+        # @param object_name [String] Name of object to read
+        # @param options [Hash]: 
+        # @option options [String] If-Match Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed).
+        # @option options [Time]   If-Modified-Since Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified).
+        # @option options [String] If-None-Match Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
+        # @option options [Time]   If-Unmodified-Since Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
+        # @option options [String] Range Range of object to download
+        # @option options [String] versionId specify a particular version to retrieve
+        # 
+        # @return [Excon::Response] response: 
+        #   * body [String] Contents of object
+        #   * headers [Hash]: 
+        #     * Content-Length [String] - Size of object contents
+        #     * Content-Type [String] - MIME type of object
+        #     * ETag [String] - Etag of object
+        #     * Last-Modified - [String] Last modified timestamp for object
+        # 
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~String> - Contents of object
-        #   * headers<~Hash>:
-        #     * 'Content-Length'<~String> - Size of object contents
-        #     * 'Content-Type'<~String> - MIME type of object
-        #     * 'ETag'<~String> - Etag of object
-        #     * 'Last-Modified'<~String> - Last modified timestamp for object
-        #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html
-
         def head_object(bucket_name, object_name, options={})
           unless bucket_name
             raise ArgumentError.new('bucket_name is required')

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

@@ -7,27 +7,24 @@ module Fog
 
         # Initiate a multipart upload to an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - Name of bucket to create object in
-        # * object_name<~String> - Name of object to create
-        # * options<~Hash>:
-        #   * 'Cache-Control'<~String> - Caching behaviour
-        #   * 'Content-Disposition'<~String> - Presentational information for the object
-        #   * 'Content-Encoding'<~String> - Encoding of object data
-        #   * 'Content-MD5'<~String> - Base64 encoded 128-bit MD5 digest of message (defaults to Base64 encoded MD5 of object.read)
-        #   * 'Content-Type'<~String> - Standard MIME type describing contents (defaults to MIME::Types.of.first)
-        #   * 'x-amz-acl'<~String> - Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
-        #   * "x-amz-meta-#{name}" - Headers to be returned with object, note total size of request without body must be less than 8 KB.
+        # @param bucket_name [String] Name of bucket to create object in
+        # @param object_name [String] Name of object to create
+        # @param options [Hash]: 
+        # @option options [String] Cache-Control Caching behaviour
+        # @option options [String] Content-Disposition Presentational information for the object
+        # @option options [String] Content-Encoding Encoding of object data
+        # @option options [String] Content-MD5 Base64 encoded 128-bit MD5 digest of message (defaults to Base64 encoded MD5 of object.read)
+        # @option options [String] Content-Type Standard MIME type describing contents (defaults to MIME::Types.of.first)
+        # @option options [String] x-amz-acl Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        # @option options [String] x-amz-meta-#{name} Headers to be returned with object, note total size of request without body must be less than 8 KB.
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'Bucket'<~String> - Bucket where upload was initiated
-        #     * 'Key'<~String> - Object key where the upload was initiated
-        #     * 'UploadId'<~String> - Id for initiated multipart upload
+        # @return [Excon::Response] response: 
+        #   * body [Hash]: 
+        #     * Bucket [String] - Bucket where upload was initiated
+        #     * Key [String] - Object key where the upload was initiated
+        #     * UploadId [String] - Id for initiated multipart upload
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html
         #
         def initiate_multipart_upload(bucket_name, object_name, options = {})
           request({
@@ -44,4 +41,4 @@ module Fog
       end # Real
     end # Storage
   end # AWS
-end # Fog
+end # Fog

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

@@ -7,40 +7,35 @@ module Fog
 
         # List multipart uploads for a bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - Name of bucket to list multipart uploads for
-        # * upload_id<~String> - upload id to list objects for
-        # * options<~Hash> - config arguments for list.  Defaults to {}.
-        #   * 'key-marker'<~String> - limits parts to only those that appear
-        #     lexicographically after this key.
-        #   * 'max-uploads'<~Integer> - limits number of uploads returned
-        #   * 'upload-id-marker'<~String> - limits uploads to only those that appear
-        #     lexicographically after this upload id.
+        # @params bucket_name [String] Name of bucket to list multipart uploads for
+        # @params upload_id [String] upload id to list objects for
+        # @params options [Hash] config arguments for list.  Defaults to {}.
+        # @option options key-marker[String] limits parts to only those that appear lexicographically after this key.
+        # @option options max-uploads [Integer] limits number of uploads returned
+        # @option options upload-id-marker [String] limits uploads to only those that appear lexicographically after this upload id.
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'Bucket'<~string> - Bucket where the multipart upload was initiated
-        #     * 'IsTruncated'<~Boolean> - Whether or not the listing is truncated
-        #     * 'KeyMarker'<~String> - first key in list, only upload ids after this lexographically will appear
-        #     * 'MaxUploads'<~Integer> - Maximum results to return
-        #     * 'NextKeyMarker'<~String> - last key in list, for further pagination
-        #     * 'NextUploadIdMarker'<~String> - last key in list, for further pagination
-        #     * 'Upload'<~Hash>:
-        #       * 'Initiated'<~Time> - Time when upload was initiated
-        #       * 'Initiator'<~Hash>:
-        #         * 'DisplayName'<~String> - Display name of upload initiator
-        #         * 'ID'<~String> - Id of upload initiator
-        #       * 'Key'<~String> - Key where multipart upload was initiated
-        #       * 'Owner'<~Hash>:
-        #         * 'DisplayName'<~String> - Display name of upload owner
-        #         * 'ID'<~String> - Id of upload owner
-        #       * 'StorageClass'<~String> - Storage class of object
-        #       * 'UploadId'<~String> - upload id of upload containing part
-        #     * 'UploadIdMarker'<String> - first key in list, only upload ids after this lexographically will appear
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Bucket [string] Bucket where the multipart upload was initiated
+        #     * IsTruncated [Boolean] Whether or not the listing is truncated
+        #     * KeyMarker [String] first key in list, only upload ids after this lexographically will appear
+        #     * MaxUploads [Integer] Maximum results to return
+        #     * NextKeyMarker [String] last key in list, for further pagination
+        #     * NextUploadIdMarker [String] last key in list, for further pagination
+        #     * Upload [Hash]:
+        #       * Initiated [Time] Time when upload was initiated
+        #       * Initiator [Hash]:
+        #         * DisplayName [String] Display name of upload initiator
+        #         * ID [String] Id of upload initiator
+        #       * Key [String] Key where multipart upload was initiated
+        #       * Owner [Hash]:
+        #         * DisplayName [String] Display name of upload owner
+        #         * ID [String] Id of upload owner
+        #       * StorageClass [String] Storage class of object
+        #       * UploadId [String] upload id of upload containing part
+        #     * UploadIdMarker [String] first key in list, only upload ids after this lexographically will appear
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html
         #
         def list_multipart_uploads(bucket_name, options = {})
           request({

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

@@ -7,37 +7,33 @@ module Fog
 
         # List parts for a multipart upload
         #
-        # ==== Parameters
-        # * bucket_name<~String> - Name of bucket to list parts for
-        # * object_name<~String> - Name of object to list parts for
-        # * upload_id<~String> - upload id to list objects for
-        # * options<~Hash> - config arguments for list.  Defaults to {}.
-        #   * 'max-parts'<~Integer> - limits number of parts returned
-        #   * 'part-number-marker'<~String> - limits parts to only those that appear
-        #     lexicographically after this part number.
+        # @param bucket_name [String] Name of bucket to list parts for
+        # @param object_name [String] Name of object to list parts for
+        # @param upload_id [String] upload id to list objects for
+        # @param options [Hash] config arguments for list.  Defaults to {}.
+        # @option options max-parts [Integer] limits number of parts returned
+        # @option options part-number-marker [String] limits parts to only those that appear lexicographically after this part number.
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * 'Bucket'<~string> - Bucket where the multipart upload was initiated
-        #     * 'Initiator'<~Hash>:
-        #       * 'DisplayName'<~String> - Display name of upload initiator
-        #       * 'ID'<~String> - Id of upload initiator
-        #     * 'IsTruncated'<~Boolean> - Whether or not the listing is truncated
-        #     * 'Key'<~String> - Key where multipart upload was initiated
-        #     * 'MaxParts'<~String> - maximum number of replies alllowed in response
-        #     * 'NextPartNumberMarker'<~String> - last item in list, for further pagination
-        #     * 'Part'<~Array>:
-        #       * 'ETag'<~String> - ETag of part
-        #       * 'LastModified'<~Timestamp> - Last modified for part
-        #       * 'PartNumber'<~String> - Part number for part
-        #       * 'Size'<~Integer> - Size of part
-        #     * 'PartNumberMarker'<~String> - Part number after which listing begins
-        #     * 'StorageClass'<~String> - Storage class of object
-        #     * 'UploadId'<~String> - upload id of upload containing part
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Bucket [string] Bucket where the multipart upload was initiated
+        #     * Initiator [Hash]:
+        #       * DisplayName [String] Display name of upload initiator
+        #       * ID [String] Id of upload initiator
+        #     * IsTruncated [Boolean] Whether or not the listing is truncated
+        #     * Key [String] Key where multipart upload was initiated
+        #     * MaxParts [String] maximum number of replies alllowed in response
+        #     * NextPartNumberMarker [String] last item in list, for further pagination
+        #     * Part [Array]:
+        #       * ETag [String] ETag of part
+        #       * LastModified [Timestamp] Last modified for part
+        #       * PartNumber [String] Part number for part
+        #       * Size [Integer] Size of part
+        #     * PartNumberMarker [String] Part number after which listing begins
+        #     * StorageClass [String] Storage class of object
+        #     * UploadId [String] upload id of upload containing part
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html
         #
         def list_parts(bucket_name, object_name, upload_id, options = {})
           options['uploadId'] = upload_id

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

@@ -7,24 +7,22 @@ module Fog
         # Form should look like: <form action="http://#{bucket_name}.s3.amazonaws.com/" method="post" enctype="multipart/form-data">
         # These hidden fields should then appear, followed by a field named 'file' which is either a textarea or file input.
         #
-        # ==== Parameters
-        # * options<~Hash>:
-        #   * acl<~String> - access control list, in ['private', 'public-read', 'public-read-write', 'authenticated-read', 'bucket-owner-read', 'bucket-owner-full-control']
-        #   * Cache-Control - same as REST header
-        #   * Content-Type - same as REST header
-        #   * Content-Disposition - same as REST header
-        #   * Content-Encoding - same as REST header
-        #   * Expires - same as REST header
-        #   * key - key for object, set to '${filename}' to use filename provided by user
-        #   * policy - security policy for upload
-        #   * success_action_redirect - url to redirct to upon success
-        #   * success_action_status - status code to return on success, in [200, 201, 204]
-        #   * x-amz-security-token - devpay security token
-        #   * x-amz-meta-... - meta data tags
+        # @param options Hash:
+        # @option options acl [String] access control list, in ['private', 'public-read', 'public-read-write', 'authenticated-read', 'bucket-owner-read', 'bucket-owner-full-control']
+        # @option options Cache-Control [String] same as REST header
+        # @option options Content-Type [String] same as REST header
+        # @option options Content-Disposition [String] same as REST header
+        # @option options Content-Encoding [String] same as REST header
+        # @option options Expires same as REST header
+        # @option options key key for object, set to '${filename}' to use filename provided by user
+        # @option options policy security policy for upload
+        # @option options success_action_redirect url to redirct to upon success
+        # @option options success_action_status status code to return on success, in [200, 201, 204]
+        # @option options x-amz-security token devpay security token
+        # @option options x-amz-meta... meta data tags
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/dev/HTTPPOSTForms.html
-
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/dev/HTTPPOSTForms.html
+        # 
         def post_object_hidden_fields(options = {})
           if options['policy']
             options['policy'] = Base64.encode64(Fog::JSON.encode(options['policy'])).gsub("\n", "")

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

@@ -5,19 +5,16 @@ module Fog
 
         # Create an S3 bucket
         #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to create
-        # * options<~Hash> - config arguments for bucket.  Defaults to {}.
-        #   * 'LocationConstraint'<~Symbol> - sets the location for the bucket
-        #   * 'x-amz-acl'<~String> - Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        # @param bucket_name [String] name of bucket to create
+        # @option options [Hash] config arguments for bucket.  Defaults to {}.
+        # @option options LocationConstraint [Symbol] sets the location for the bucket
+        # @option options x-amz-acl [String] Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * status<~Integer> - 200
+        # @return [Excon::Response] response:
+        #   * status [Integer] 200
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html
-
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html
+        # 
         def put_bucket(bucket_name, options = {})
           if location_constraint = options.delete('LocationConstraint')
             data =

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

@@ -6,26 +6,24 @@ module Fog
         require 'fog/aws/requests/storage/acl_utils'
 
         # Change access control list for an S3 bucket
-        #
-        # ==== Parameters
-        # * bucket_name<~String> - name of bucket to modify
-        # * acl<~Hash>:
-        #   * Owner<~Hash>:
-        #     * ID<~String>: id of owner
-        #     * DisplayName<~String>: display name of owner
-        #   * AccessControlList<~Array>:
-        #     * Grantee<~Hash>:
-        #         * 'DisplayName'<~String> - Display name of grantee
-        #         * 'ID'<~String> - Id of grantee
+        # 
+        # @param bucket_name [String] name of bucket to modify
+        # @param acl [Hash]
+        #   * Owner [Hash]:
+        #     * ID [String]: id of owner
+        #     * DisplayName [String]: display name of owner
+        #   * AccessControlList [Array]:
+        #     * Grantee [Hash]:
+        #       * DisplayName [String] Display name of grantee
+        #       * ID [String] Id of grantee
         #       or
-        #         * 'EmailAddress'<~String> - Email address of grantee
+        #       * EmailAddress [String] Email address of grantee
         #       or
-        #         * 'URI'<~String> - URI of group to grant access for
-        #     * Permission<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
-        # * acl<~String> - Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        #       * URI [String] URI of group to grant access for
+        #     * Permission [String] Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
+        # * acl [String] Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
         #
-        # ==== See Also
-        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html
 
         def put_bucket_acl(bucket_name, acl)
           data = ""

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

@@ -0,0 +1,49 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/requests/storage/cors_utils'
+
+        # Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
+        #
+        # @param bucket_name [String] name of bucket to modify
+        # @param cors [Hash]
+        #   * CORSConfiguration [Array]:
+        #     * ID [String]: A unique identifier for the rule.
+        #     * AllowedMethod [String]: An HTTP method that you want to allow the origin to execute.
+        #     * AllowedOrigin [String]: An origin that you want to allow cross-domain requests from.
+        #     * AllowedHeader [String]: Specifies which headers are allowed in a pre-flight OPTIONS request via the Access-Control-Request-Headers header.
+        #     * MaxAgeSeconds [String]: The time in seconds that your browser is to cache the preflight response for the specified resource.
+        #     * ExposeHeader [String]: One or more headers in the response that you want customers to be able to access from their applications.
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html
+
+        def put_bucket_cors(bucket_name, cors)
+          data = Fog::Storage::AWS.hash_to_cors(cors)
+
+          headers = {}
+          headers['Content-MD5'] = Base64.encode64(Digest::MD5.digest(data)).strip
+          headers['Content-Type'] = 'application/json'
+          headers['Date'] = Fog::Time.now.to_date_header
+
+          request({
+            :body     => data,
+            :expects  => 200,
+            :headers  => headers,
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :query    => {'cors' => nil}
+          })
+        end
+      end
+
+      class Mock
+        def put_bucket_cors(bucket_name, cors)
+          self.data[:cors][:bucket][bucket_name] = Fog::Storage::AWS.hash_to_cors(cors)
+        end
+      end
+
+    end
+  end
+end