aws 2.5.8 → 2.6.0

data/lib/s3/s3_interface.rb

@@ -113,6 +113,14 @@ module Aws
       out_string << '?torrent' if path[/[&?]torrent($|&|=)/]
       out_string << '?location' if path[/[&?]location($|&|=)/]
       out_string << '?logging' if path[/[&?]logging($|&|=)/] # this one is beta, no support for now
+      #... also deal with params for multipart uploads API
+      out_string << '?uploads' if path[/\?uploads$/]
+      if path[/\?uploadId=(.*)$/]
+        out_string << "?uploadId=#{$1}"
+      end
+      if path[/\?partNumber=(\d*)&uploadId=(.*)$/]
+        out_string << "?partNumber=#{$1}&uploadId=#{$2}"
+      end
       out_string
     end
 
@@ -338,7 +346,7 @@ module Aws
       begin
         internal_bucket = bucket.dup
         unless internal_options.nil? || internal_options.empty?
-          internal_bucket << '?' 
+          internal_bucket << '?'
           internal_bucket << internal_options.map { |k, v| "#{k.to_s}=#{CGI::escape v.to_s}" }.join('&')
         end
         req_hash            = generate_rest_request('GET', headers.merge(:url=>internal_bucket))
@@ -518,6 +526,112 @@ module Aws
       r[:verified_md5] ? (return r) : (raise AwsError.new("Uploaded object failed MD5 checksum verification: #{r.inspect}"))
     end
 
+    # Initiates a multipart upload and returns an upload ID or an exception
+    # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html
+    #
+    # s3.initiate_multipart('my_awesome_bucket', 'hugeObject') => WL7dk8sqbtk3Rg641HHWaNeG6RxI4fzS8V0YvuQAfs5Hbk6WNZOU1z_AhGv
+    #
+    # The returned uploadId must be retained for use in uploading parts; see
+    # http://docs.amazonwebservices.com/AmazonS3/latest/dev/mpuoverview.html
+    #
+    def initiate_multipart(bucket, key, headers={})
+      req_hash = generate_rest_request('POST', headers.merge(:url =>"#{bucket}/#{CGI::escape key}?uploads"))
+      request_info(req_hash, S3InitiateMultipartUploadParser.new)
+      rescue
+        on_exception
+    end
+
+    # Uploads a part in a multipart upload - returns an Etag for the part or an exception
+    # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html
+    #
+    # Among the parameters required, clients must supply the uploadId (obtained from the initiate_multipart method call) as
+    # well as the partNumber for this part (user-specified, determining the sequence for reassembly).
+    #
+    # s3.upload_part('my_awesome_bucket', 'hugeObject', "WL7dk8sqbtk3Rg641HHWaNeG6RxI", "2", File.open('localfilename.dat'))
+    #     => "b54357faf0632cce46e942fa68356b38"
+    #
+    # The return Etag must be retained for use in the completion of the multipart upload; see
+    # http://docs.amazonwebservices.com/AmazonS3/latest/dev/mpuoverview.html
+    #
+    def upload_part(bucket, key, uploadId, partNumber, data, headers={})
+      if (data.respond_to?(:binmode))
+        data.binmode
+      end
+      if data.is_a?(String)
+        data = StringIO.new(data)
+      end
+      data_size = data.respond_to?(:lstat) ? data.lstat.size :
+      (data.respond_to?(:size) ? data.size : 0)
+      if (data_size >= USE_100_CONTINUE_PUT_SIZE)
+        headers['expect'] = '100-continue'
+      end
+      req_hash = generate_rest_request('PUT', headers.merge(:url =>"#{bucket}/#{CGI::escape key}?partNumber=#{partNumber}&uploadId=#{uploadId}",
+                                                            :data  => data,
+                                                            'Content-Length' => data_size.to_s))
+      request_info(req_hash, S3UploadPartParser.new)
+      rescue
+        on_exception
+    end
+
+
+    # Completes a multipart upload, returning true or an exception
+    # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html
+    #
+    # Clients must specify the uploadId (obtained from the initiate_multipart call) and the reassembly manifest hash
+    # which specifies the each partNumber corresponding etag (obtained from the upload_part call):
+    #
+    # s3.complete_multipart('my_awesome_bucket', 'hugeObject', "WL7dk8sqbtk3Rg641HHWaNeG6RxI",
+    #                       {"1"=>"a54357aff0632cce46d942af68356b38", "2"=>"0c78aef83f66abc1fa1e8477f296d394"}) => true
+    #
+    # See http://docs.amazonwebservices.com/AmazonS3/latest/dev/mpuoverview.html
+    #
+    def complete_multipart(bucket, key, uploadId, manifest_hash, headers={})
+      parts_string = manifest_hash.inject("") do |res, (part,etag)|
+       res<< <<END_PARTS
+        <Part>
+          <PartNumber>#{part}</PartNumber>
+          <ETag>"#{etag}"</ETag>
+        </Part>
+END_PARTS
+       res
+      end
+      data = <<EOS
+      <CompleteMultipartUpload>
+        #{parts_string}
+      </CompleteMultipartUpload>
+EOS
+      req_hash = generate_rest_request('POST', headers.merge(:url  => "#{bucket}/#{CGI::escape key}?uploadId=#{uploadId}",
+                                                             :data => data))
+      request_info(req_hash, RightHttp2xxParser.new)
+      rescue
+        on_exception
+    end
+
+    # List parts of a multipart upload, returning a hash or an exception
+    # http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html
+    #
+    # response looks like: 
+    #
+    #   { :bucket=>"mariosFoo_awesome_test_bucket_000A1", 
+    #     :key=>"mariosFoosegmented", 
+    #     :upload_id=>"jQKX7JdJBTrbvLn9apUPIXkt14FHdp6nMZVg--" 
+    #     :parts=>  [   {:part_number=>"1", :last_modified=>"2012-10-30T15:06:28.000Z", 
+    #                       :etag=>"\"78f871f6f01673a4aca05b1f8e26df08\"", :size=>"6276589"}, 
+    #                   {:part_number=>"2", :last_modified=>"2012-10-30T15:08:22.000Z", 
+    #                       :etag=>"\"e7b94a1e959ca066026da3ec63aad321\"", :size=>"7454095"}] }          
+    #
+    # Clients must specify the uploadId (obtained from the initiate_multipart call) 
+    #
+    # s3.list_parts('my_awesome_bucket', 'hugeObject', "WL7dk8sqbtk3Rg641HHWaNeG6RxI",
+    #
+    # See http://docs.amazonwebservices.com/AmazonS3/latest/dev/mpuoverview.html
+    #
+    def list_parts(bucket, key, uploadId, headers={})
+      req_hash = generate_rest_request('GET', headers.merge(:url=>"#{bucket}/#{CGI::escape key}?uploadId=#{uploadId}"))
+      request_info(req_hash, S3ListMultipartPartsParser.new)
+    end
+
+
     # Retrieves object data from Amazon. Returns a +hash+  or an exception.
     #
     #  s3.get('my_awesome_bucket', 'log/curent/1.log') #=>
@@ -544,7 +658,6 @@ module Aws
     # end
     # foo.close
     #
-
     def get(bucket, key, headers={}, &block)
       req_hash = generate_rest_request('GET', headers.merge(:url=>"#{bucket}/#{CGI::escape key}"))
       request_info(req_hash, S3HttpResponseBodyParser.new, &block)
@@ -1235,6 +1348,53 @@ module Aws
       end
     end
 
+    class S3InitiateMultipartUploadParser < AwsParser # :nodoc:
+      def reset
+        @result = ""
+      end
+
+      def tagend(name)
+        @result = @text if name == 'UploadId'
+      end
+
+    end
+
+    class S3ListMultipartPartsParser < AwsParser # :nodoc:
+      def reset
+        @result = {}
+        @result[:parts] = []
+        @current_part={}
+      end
+
+      def tagstart(name, attributes)
+        @current_part={} if name=='Part'
+      end
+
+      def tagend(name)
+        case name
+          when 'PartNumber'
+            @current_part[:part_number] = @text
+          when 'ETag'
+            @current_part[:etag] = @text
+          when 'Size'
+            @current_part[:size] = @text
+          when 'LastModified'
+            @current_part[:last_modified] = @text
+          when 'Bucket'
+            @result[:bucket] = @text
+          when 'Key'
+            @result[:key] = @text
+          when 'UploadId'
+            @result[:upload_id] = @text
+          when 'Part'
+            @result[:parts] << @current_part
+        end
+      end
+
+    end
+
+
+
     #-----------------------------------------------------------------
     #      PARSERS: Non XML
     #-----------------------------------------------------------------
@@ -1274,6 +1434,12 @@ module Aws
       end
     end
 
+    class S3UploadPartParser < S3HttpResponseParser # :nodoc:
+      def parse(response)
+        @result = headers_to_string(response.to_hash)["etag"].gsub!("\"", "")
+      end
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws
 version: !ruby/object:Gem::Version
-  version: 2.5.8
+  version: 2.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-04 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools