fog 0.11.0 → 1.0.0

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

@@ -0,0 +1,52 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/parsers/storage/get_request_payment'
+
+        # Get configured payer for an S3 bucket
+        #
+        # ==== Parameters
+        # * 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
+        #
+        # ==== See Also
+        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html
+
+        def get_request_payment(bucket_name)
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::AWS::GetRequestPayment.new,
+            :query    => {'requestPayment' => nil}
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def get_request_payment(bucket_name)
+          response = Excon::Response.new
+          if bucket = self.data[:buckets][bucket_name]
+            response.status = 200
+            response.body = { 'Payer' => bucket['Payer'] }
+          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_service.rb

@@ -0,0 +1,57 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/parsers/storage/get_service'
+
+        # 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
+        #
+        # ==== See Also
+        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html
+        #
+        def get_service
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => @host,
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::AWS::GetService.new,
+            :url      => @host
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def get_service
+          response = Excon::Response.new
+          response.headers['Status'] = 200
+          buckets = self.data[:buckets].values.map do |bucket|
+            bucket.reject do |key, value|
+              !['CreationDate', 'Name'].include?(key)
+            end
+          end
+          response.body = {
+            'Buckets' => buckets,
+            'Owner'   => { 'DisplayName' => 'owner', 'ID' => 'some_id'}
+          }
+          response
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fog
+  module Storage
+    class AWS
+      private
+        def self.hash_to_acl(acl)
+          data =
+<<-DATA
+<AccessControlPolicy>
+  <Owner>
+    <ID>#{acl['Owner']['ID']}</ID>
+    <DisplayName>#{acl['Owner']['DisplayName']}</DisplayName>
+  </Owner>
+  <AccessControlList>
+DATA
+
+          acl['AccessControlList'].each do |grant|
+            data << "    <Grant>\n"
+            type = case grant['Grantee'].keys.sort
+            when ['DisplayName', 'ID']
+              'CanonicalUser'
+            when ['EmailAddress']
+              'AmazonCustomerByEmail'
+            when ['URI']
+              'Group'
+            end
+            data << "      <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"#{type}\">\n"
+            data << "        <ID>#{grant['Grantee']['ID']}</ID>\n"
+            data << "        <DisplayName>#{grant['Grantee']['DisplayName']}</DisplayName>\n"
+            data << "      </Grantee>\n"
+            data << "      <Permission>#{grant['Permission']}</Permission>\n"
+            data << "    </Grant>\n"
+          end
+          
+          data <<
+<<-DATA
+  </AccessControlList>
+</AccessControlPolicy>
+DATA
+          data
+        end
+    end
+  end      
+end
+

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

@@ -0,0 +1,47 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/parsers/storage/initiate_multipart_upload'
+
+        # 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.
+        #
+        # ==== 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
+        #
+        # ==== See Also
+        # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html
+        #
+        def initiate_multipart_upload(bucket_name, object_name, options = {})
+          request({
+            :expects    => 200,
+            :headers    => options,
+            :host       => "#{bucket_name}.#{@host}",
+            :method     => 'POST',
+            :parser     => Fog::Parsers::Storage::AWS::InitiateMultipartUpload.new,
+            :path       => CGI.escape(object_name),
+            :query      => {'uploads' => nil}
+          })
+        end
+
+      end # Real
+    end # Storage
+  end # AWS
+end # Fog

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

@@ -0,0 +1,60 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/parsers/storage/list_multipart_uploads'
+
+        # 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.
+        #
+        # ==== 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
+        #
+        # ==== See Also
+        # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html
+        #
+        def list_multipart_uploads(bucket_name, options = {})
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::AWS::ListMultipartUploads.new,
+            :query    => options.merge!({'uploads' => nil})
+          })
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/parsers/storage/list_parts'
+
+        # 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.
+        #
+        # ==== 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
+        #
+        # ==== See Also
+        # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html
+        #
+        def list_parts(bucket_name, object_name, upload_id, options = {})
+          options['uploadId'] = upload_id
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::AWS::ListParts.new,
+            :path     => CGI.escape(object_name),
+            :query    => options.merge!({'uploadId' => upload_id})
+          })
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/requests/storage/hash_to_acl'
+      
+        # 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
+        #       or
+        #         * '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']
+        #
+        # ==== See Also
+        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html
+
+        def put_bucket_acl(bucket_name, acl)
+          data = ""
+          headers = {}
+          
+          if acl.is_a?(Hash)
+            data = Fog::Storage::AWS.hash_to_acl(acl)
+          else
+            if !['private', 'public-read', 'public-read-write', 'authenticated-read'].include?(acl)
+              raise Excon::Errors::BadRequest.new('invalid x-amz-acl')
+            end
+            headers['x-amz-acl'] = acl
+          end
+
+          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    => {'acl' => nil}
+          })
+        end
+      end
+        
+      class Mock
+        def put_bucket_acl(bucket_name, acl)
+          if acl.is_a?(Hash)
+            self.data[:acls][:bucket][bucket_name] = Fog::Storage::AWS.hash_to_acl(acl)
+          else
+            if !['private', 'public-read', 'public-read-write', 'authenticated-read'].include?(acl)
+              raise Excon::Errors::BadRequest.new('invalid x-amz-acl')
+            end
+            self.data[:acls][:bucket][bucket_name] = acl
+          end        
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+
+        require 'fog/aws/requests/storage/hash_to_acl'
+
+        # Change access control list for an S3 object
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket to modify
+        # * object_name<~String> - name of object to get access control list for
+        # * 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
+        #       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']
+        # * options<~Hash>:
+        #   * 'versionId'<~String> - specify a particular version to retrieve
+        #
+        # ==== See Also
+        # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html
+
+        def put_object_acl(bucket_name, object_name, acl, options = {})
+          query = {'acl' => nil}
+          if version_id = options.delete('versionId')
+            query['versionId'] = version_id
+          end
+          
+          data = ""
+          headers = {}
+          
+          if acl.is_a?(Hash)
+            data = Fog::Storage::AWS.hash_to_acl(acl)
+          else
+            if !['private', 'public-read', 'public-read-write', 'authenticated-read'].include?(acl)
+              raise Excon::Errors::BadRequest.new('invalid x-amz-acl')
+            end
+            headers['x-amz-acl'] = acl
+          end
+
+          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',
+            :path       => CGI.escape(object_name),
+            :query    => query
+          })
+        end
+      end
+      
+      class Mock
+        def put_object_acl(bucket_name, object_name, acl, options = {})
+          if acl.is_a?(Hash)
+            self.data[:acls][:object][bucket_name][object_name] = Fog::Storage::AWS.hash_to_acl(acl)
+          else
+            if !['private', 'public-read', 'public-read-write', 'authenticated-read'].include?(acl)
+              raise Excon::Errors::BadRequest.new('invalid x-amz-acl')
+            end
+            self.data[:acls][:object][bucket_name][object_name] = acl
+          end        
+        end
+      end
+
+    end
+  end
+end