aws-sdk-s3 1.182.0 → 1.198.0

data/lib/aws-sdk-s3/customizations/object.rb

@@ -398,14 +398,14 @@ module Aws
         end
         true
       end
+      deprecated(:upload_stream, use: 'Aws::S3::TransferManager#upload_stream', version: 'next major version')
 
       # Uploads a file from disk to the current object in S3.
       #
       #     # small files are uploaded in a single API call
       #     obj.upload_file('/path/to/file')
       #
-      # Files larger than or equal to `:multipart_threshold` are uploaded
-      # using the Amazon S3 multipart upload APIs.
+      # Files larger than or equal to `:multipart_threshold` are uploaded using the Amazon S3 multipart upload APIs.
       #
       #     # large files are automatically split into parts
       #     # and the parts are uploaded in parallel
@@ -421,47 +421,37 @@ module Aws
       # You can provide a callback to monitor progress of the upload:
       #
       #     # bytes and totals are each an array with 1 entry per part
-      #     progress = Proc.new do |bytes, totals|
-      #       puts bytes.map.with_index { |b, i| "Part #{i+1}: #{b} / #{totals[i]}"}.join(' ') + "Total: #{100.0 * bytes.sum / totals.sum }%" }
+      #     progress = proc do |bytes, totals|
+      #       puts bytes.map.with_index { |b, i| "Part #{i+1}: #{b} / #{totals[i]}"}.join(' ') + "Total: #{100.0 * bytes.sum / totals.sum }%"
       #     end
       #     obj.upload_file('/path/to/file', progress_callback: progress)
       #
-      # @param [String, Pathname, File, Tempfile] source A file on the local
-      #   file system that will be uploaded as this object. This can either be
-      #   a String or Pathname to the file, an open File object, or an open
-      #   Tempfile object. If you pass an open File or Tempfile object, then
-      #   you are responsible for closing it after the upload completes. When
-      #   using an open Tempfile, rewind it before uploading or else the object
+      # @param [String, Pathname, File, Tempfile] source A file on the local file system that will be uploaded as
+      #   this object. This can either be a String or Pathname to the file, an open File object, or an open
+      #   Tempfile object. If you pass an open File or Tempfile object, then you are responsible for closing it
+      #   after the upload completes. When using an open Tempfile, rewind it before uploading or else the object
       #   will be empty.
       #
       # @param [Hash] options
-      #   Additional options for {Client#put_object}
-      #   when file sizes below the multipart threshold. For files larger than
-      #   the multipart threshold, options for {Client#create_multipart_upload},
-      #   {Client#complete_multipart_upload},
-      #   and {Client#upload_part} can be provided.
+      #   Additional options for {Client#put_object} when file sizes below the multipart threshold.
+      #   For files larger than the multipart threshold, options for {Client#create_multipart_upload},
+      #   {Client#complete_multipart_upload}, and {Client#upload_part} can be provided.
       #
-      # @option options [Integer] :multipart_threshold (104857600) Files larger
-      #   than or equal to `:multipart_threshold` are uploaded using the S3
-      #   multipart APIs.
-      #   Default threshold is 100MB.
+      # @option options [Integer] :multipart_threshold (104857600) Files larger han or equal to
+      #  `:multipart_threshold` are uploaded using the S3 multipart APIs. Default threshold is 100MB.
       #
-      # @option options [Integer] :thread_count (10) The number of parallel
-      #   multipart uploads. This option is not used if the file is smaller than
-      #   `:multipart_threshold`.
+      # @option options [Integer] :thread_count (10) The number of parallel multipart uploads.
+      #    This option is not used if the file is smaller than `:multipart_threshold`.
       #
       # @option options [Proc] :progress_callback
       #   A Proc that will be called when each chunk of the upload is sent.
       #   It will be invoked with [bytes_read], [total_sizes]
       #
-      # @raise [MultipartUploadError] If an object is being uploaded in
-      #   parts, and the upload can not be completed, then the upload is
-      #   aborted and this error is raised.  The raised error has a `#errors`
-      #   method that returns the failures that caused the upload to be
-      #   aborted.
+      # @raise [MultipartUploadError] If an object is being uploaded in parts, and the upload can not be completed,
+      #   then the upload is aborted and this error is raised.  The raised error has a `#errors` method that
+      #   returns the failures that caused the upload to be aborted.
       #
-      # @return [Boolean] Returns `true` when the object is uploaded
-      #   without any errors.
+      # @return [Boolean] Returns `true` when the object is uploaded without any errors.
       #
       # @see Client#put_object
       # @see Client#create_multipart_upload
@@ -469,26 +459,21 @@ module Aws
       # @see Client#upload_part
       def upload_file(source, options = {})
         uploading_options = options.dup
-        uploader = FileUploader.new(
-          multipart_threshold: uploading_options.delete(:multipart_threshold),
-          client: client
-        )
+        uploader = FileUploader.new(multipart_threshold: uploading_options.delete(:multipart_threshold), client: client)
         response = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
-          uploader.upload(
-            source,
-            uploading_options.merge(bucket: bucket_name, key: key)
-          )
+          uploader.upload(source, uploading_options.merge(bucket: bucket_name, key: key))
         end
         yield response if block_given?
         true
       end
+      deprecated(:upload_file, use: 'Aws::S3::TransferManager#upload_file', version: 'next major version')
 
       # Downloads a file in S3 to a path on disk.
       #
       #     # small files (< 5MB) are downloaded in a single API call
       #     obj.download_file('/path/to/file')
       #
-      # Files larger than 5MB are downloaded using multipart method
+      # Files larger than 5MB are downloaded using multipart method:
       #
       #     # large files are split into parts
       #     # and the parts are downloaded in parallel
@@ -498,67 +483,63 @@ module Aws
       #
       #     # bytes and part_sizes are each an array with 1 entry per part
       #     # part_sizes may not be known until the first bytes are retrieved
-      #     progress = Proc.new do |bytes, part_sizes, file_size|
-      #       puts bytes.map.with_index { |b, i| "Part #{i+1}: #{b} / #{part_sizes[i]}"}.join(' ') + "Total: #{100.0 * bytes.sum / file_size}%" }
+      #     progress = proc do |bytes, part_sizes, file_size|
+      #       puts bytes.map.with_index { |b, i| "Part #{i + 1}: #{b} / #{part_sizes[i]}" }.join(' ') + "Total: #{100.0 * bytes.sum / file_size}%"
       #     end
       #     obj.download_file('/path/to/file', progress_callback: progress)
       #
-      # @param [String] destination Where to download the file to.
+      # @param [String, Pathname, File, Tempfile] destination
+      #   Where to download the file to. This can either be a String or Pathname to the file, an open File object,
+      #   or an open Tempfile object. If you pass an open File or Tempfile object, then you are responsible for
+      #   closing it after the download completes.
       #
       # @param [Hash] options
-      #   Additional options for {Client#get_object} and #{Client#head_object}
-      #   may be provided.
+      #   Additional options for {Client#get_object} and #{Client#head_object} may be provided.
       #
-      # @option options [String] mode `auto`, `single_request`, `get_range`
-      #  `single_request` mode forces only 1 GET request is made in download,
-      #  `get_range` mode allows `chunk_size` parameter to configured in
-      #  customizing each range size in multipart_download,
-      #  By default, `auto` mode is enabled, which performs multipart_download
+      # @option options [String] :mode ("auto") `"auto"`, `"single_request"` or `"get_range"`
       #
-      # @option options [Integer] chunk_size required in get_range mode.
+      #  * `auto` mode is enabled by default,  which performs `multipart_download`
+      #  * `"single_request`" mode forces only 1 GET request is made in download
+      #  * `"get_range"` mode requires `:chunk_size` parameter to configured in customizing each range size
       #
-      # @option options [Integer] thread_count (10) Customize threads used in
-      #   the multipart download.
+      # @option options [Integer] :chunk_size required in `"get_range"` mode.
       #
-      # @option options [String] version_id The object version id used to
-      #   retrieve the object. For more about object versioning, see:
-      #   https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectVersioning.html
+      # @option options [Integer] :thread_count (10) Customize threads used in the multipart download.
       #
-      # @option options [String] checksum_mode (ENABLED) When `ENABLED` and
-      #   the object has a stored checksum, it will be used to validate the
-      #   download and will raise an `Aws::Errors::ChecksumError` if
-      #   checksum validation fails. You may provide a `on_checksum_validated`
-      #   callback if you need to verify that validation occurred and which
-      #   algorithm was used.  To disable checksum validation, set
-      #   `checksum_mode` to "DISABLED".
+      # @option options [String] :version_id The object version id used to retrieve the object.
       #
-      # @option options [Callable] on_checksum_validated Called each time a
-      #   request's checksum is validated with the checksum algorithm and the
-      #   response.  For multipart downloads, this will be called for each
-      #   part that is downloaded and validated.
+      #     @see https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectVersioning.html ObjectVersioning
+      #
+      # @option options [String] :checksum_mode ("ENABLED")
+      #   When `"ENABLED"` and the object has a stored checksum, it will be used to validate the download and will
+      #   raise an `Aws::Errors::ChecksumError` if checksum validation fails. You may provide a `on_checksum_validated`
+      #   callback if you need to verify that validation occurred and which algorithm was used.
+      #   To disable checksum validation, set `checksum_mode` to `"DISABLED"`.
+      #
+      # @option options [Callable] :on_checksum_validated
+      #   Called each time a request's checksum is validated with the checksum algorithm and the
+      #   response.  For multipart downloads, this will be called for each part that is downloaded and validated.
       #
       # @option options [Proc] :progress_callback
-      #   A Proc that will be called when each chunk of the download is received.
-      #   It will be invoked with [bytes_read], [part_sizes], file_size.
-      #   When the object is downloaded as parts (rather than by ranges), the
-      #   part_sizes will not be known ahead of time and will be nil in the
-      #   callback until the first bytes in the part are received.
+      #   A Proc that will be called when each chunk of the download is received. It will be invoked with
+      #   `bytes_read`, `part_sizes`, `file_size`. When the object is downloaded as parts (rather than by ranges),
+      #   the `part_sizes` will not be known ahead of time and will be `nil` in the callback until the first bytes
+      #   in the part are received.
       #
-      # @return [Boolean] Returns `true` when the file is downloaded without
-      #   any errors.
+      # @raise [MultipartDownloadError] Raised when an object validation fails outside of service errors.
+      #
+      # @return [Boolean] Returns `true` when the file is downloaded without any errors.
       #
       # @see Client#get_object
       # @see Client#head_object
       def download_file(destination, options = {})
         downloader = FileDownloader.new(client: client)
         Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
-          downloader.download(
-            destination,
-            options.merge(bucket: bucket_name, key: key)
-          )
+          downloader.download(destination, options.merge(bucket: bucket_name, key: key))
         end
         true
       end
+      deprecated(:download_file, use: 'Aws::S3::TransferManager#download_file', version: 'next major version')
 
       class Collection < Aws::Resources::Collection
         alias_method :delete, :batch_delete!

data/lib/aws-sdk-s3/customizations.rb

@@ -10,6 +10,7 @@ module Aws
     autoload :FileUploader, 'aws-sdk-s3/file_uploader'
     autoload :FileDownloader, 'aws-sdk-s3/file_downloader'
     autoload :LegacySigner, 'aws-sdk-s3/legacy_signer'
+    autoload :MultipartDownloadError, 'aws-sdk-s3/multipart_download_error'
     autoload :MultipartFileUploader, 'aws-sdk-s3/multipart_file_uploader'
     autoload :MultipartStreamUploader, 'aws-sdk-s3/multipart_stream_uploader'
     autoload :MultipartUploadError, 'aws-sdk-s3/multipart_upload_error'
@@ -17,13 +18,13 @@ module Aws
     autoload :ObjectMultipartCopier, 'aws-sdk-s3/object_multipart_copier'
     autoload :PresignedPost, 'aws-sdk-s3/presigned_post'
     autoload :Presigner, 'aws-sdk-s3/presigner'
+    autoload :TransferManager, 'aws-sdk-s3/transfer_manager'
 
     # s3 express session auth
     autoload :ExpressCredentials, 'aws-sdk-s3/express_credentials'
     autoload :ExpressCredentialsProvider, 'aws-sdk-s3/express_credentials_provider'
 
     # s3 access grants auth
-
     autoload :AccessGrantsCredentials, 'aws-sdk-s3/access_grants_credentials'
     autoload :AccessGrantsCredentialsProvider, 'aws-sdk-s3/access_grants_credentials_provider'
   end