aws-sdk-s3 1.36.0 → 1.95.1

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

@@ -1,8 +1,25 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module Aws
   module S3
     class Bucket
+      # Save the old initialize method so that we can call 'super'.
+      old_initialize = instance_method(:initialize)
+      # Make the method redefinable
+      alias_method :initialize, :initialize
+      # Define a new initialize method that extracts out a bucket ARN.
+      define_method(:initialize) do |*args|
+        old_initialize.bind(self).call(*args)
+        resolved_region, arn = Plugins::ARN.resolve_arn!(
+          name,
+          client.config.region,
+          client.config.s3_use_arn_region
+        )
+        @resolved_region = resolved_region
+        @arn = arn
+      end
 
       # Deletes all objects and versioned objects from this bucket
       #
@@ -31,10 +48,10 @@ module Aws
       #   each attempt.
       #
       # @return [void]
-      def delete! options = { }
+      def delete!(options = {})
         options = {
           initial_wait: 1.3,
-          max_attempts: 3,
+          max_attempts: 3
         }.merge(options)
 
         attempts = 0
@@ -43,36 +60,57 @@ module Aws
           delete
         rescue Errors::BucketNotEmpty
           attempts += 1
-          if attempts >= options[:max_attempts]
-            raise
-          else
-            Kernel.sleep(options[:initial_wait] ** attempts)
-            retry
-          end
+          raise if attempts >= options[:max_attempts]
+
+          Kernel.sleep(options[:initial_wait]**attempts)
+          retry
         end
       end
 
       # Returns a public URL for this bucket.
       #
-      #     bucket = s3.bucket('bucket-name')
-      #     bucket.url
-      #     #=> "https://bucket-name.s3.amazonaws.com"
+      # @example
+      #
+      #   bucket = s3.bucket('bucket-name')
+      #   bucket.url
+      #   #=> "https://bucket-name.s3.amazonaws.com"
+      #
+      # It will also work when provided an Access Point ARN.
+      #
+      # @example
+      #
+      #   bucket = s3.bucket(
+      #     'arn:aws:s3:us-east-1:123456789012:accesspoint:myendpoint'
+      #   )
+      #   bucket.url
+      #   #=> "https://myendpoint-123456789012.s3-accesspoint.us-west-2.amazonaws.com"
       #
       # You can pass `virtual_host: true` to use the bucket name as the
       # host name.
       #
-      #     bucket = s3.bucket('my.bucket.com')
+      #     bucket = s3.bucket('my-bucket.com')
       #     bucket.url(virtual_host: true)
-      #     #=> "http://my.bucket.com"
+      #     #=> "http://my-bucket.com"
       #
       # @option options [Boolean] :virtual_host (false) When `true`,
       #   the bucket name will be used as the host name. This is useful
       #   when you have a CNAME configured for this bucket.
       #
+      # @option options [Boolean] :secure (true) When `false`, http
+      #   will be used with virtual_host.  This is required when
+      #   the bucket name has a dot (.) in it.
+      #
       # @return [String] the URL for this bucket.
       def url(options = {})
         if options[:virtual_host]
-          "http://#{name}"
+          scheme = options.fetch(:secure, true) ? 'https' : 'http'
+          "#{scheme}://#{name}"
+        elsif @arn
+          Plugins::ARN.resolve_url!(
+            client.config.endpoint.dup,
+            @arn,
+            @resolved_region
+          ).to_s
         else
           s3_bucket_url
         end
@@ -93,7 +131,7 @@ module Aws
           client.config.credentials,
           client.config.region,
           name,
-          {url: url}.merge(options)
+          { url: url }.merge(options)
         )
       end
 
@@ -101,6 +139,7 @@ module Aws
       def load
         @data = client.list_buckets.buckets.find { |b| b.name == name }
         raise "unable to load bucket #{name}" if @data.nil?
+
         self
       end
 
@@ -114,12 +153,16 @@ module Aws
           url.path += '/' unless url.path[-1] == '/'
           url.path += Seahorse::Util.uri_escape(name)
         end
+        if (client.config.region == 'us-east-1') &&
+           (client.config.s3_us_east_1_regional_endpoint == 'legacy')
+          url.host = Plugins::IADRegionalEndpoint.legacy_host(url.host)
+        end
         url.to_s
       end
 
       def bucket_as_hostname?(https)
         Plugins::BucketDns.dns_compatible?(name, https) &&
-        !client.config.force_path_style
+          !client.config.force_path_style
       end
 
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aws
   module S3
     class MultipartUpload

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

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 module Aws
   module S3
     class Object
-
       alias size content_length
 
+      # Make the method redefinable
+      alias_method :copy_from, :copy_from
+
       # Copies another object to this object. Use `multipart_copy: true`
       # for large objects. This is required for objects that exceed 5GB.
       #
-      # @param [S3::Object, S3::ObjectVersion, S3::ObjectSummary, String, Hash] source
-      #   Where to copy object data from. `source` must be one of the following:
+      # @param [S3::Object, S3::ObjectVersion, S3::ObjectSummary, String, Hash]
+      #   source Where to copy object data from. `source` must be one of the
+      #   following:
       #
       #   * {Aws::S3::Object}
       #   * {Aws::S3::ObjectSummary}
@@ -25,7 +30,8 @@ module Aws
       #
       # @option options [Integer] :content_length Only used when
       #   `:multipart_copy` is `true`. Passing this options avoids a HEAD
-      #   request to query the source object size.
+      #   request to query the source object size. Raises an `ArgumentError` if
+      #   this option is provided when `:multipart_copy` is `false` or not set.
       #
       # @option options [S3::Client] :copy_source_client Only used when
       #   `:multipart_copy` is `true` and the source object is in a
@@ -103,8 +109,9 @@ module Aws
         ObjectCopier.new(self, options).copy_to(target, options)
       end
 
-      # Copies and deletes the current object. The object will only be
-      # deleted if the copy operation succeeds.
+      # Copies and deletes the current object. The object will only be deleted
+      # if the copy operation succeeds.
+      #
       # @param (see Object#copy_to)
       # @option (see Object#copy_to)
       # @return [void]
@@ -129,10 +136,7 @@ module Aws
           client.config.credentials,
           client.config.region,
           bucket_name,
-          {
-            key: key,
-            url: bucket.url,
-          }.merge(options)
+          { key: key, url: bucket.url }.merge(options)
         )
       end
 
@@ -149,21 +153,35 @@ module Aws
       #     obj.presigned_url(:put, acl: 'public-read')
       #     #=> "https://bucket-name.s3.amazonaws.com/object-key?..."
       #
-      # @param [Symbol] http_method
-      #   The HTTP method to generate a presigned URL for. Valid values
-      #   are `:get`, `:put`, `:head`, and `:delete`.
+      # @example Pre-signed UploadPart PUT
+      #
+      #     # the object uploaded using this URL will be publicly accessible
+      #     obj.presigned_url(:upload_part, part_number: 1, upload_id: 'uploadIdToken')
+      #     #=> "https://bucket-name.s3.amazonaws.com/object-key?..."
+      #
+      # @param [Symbol] method
+      #   The S3 operation to generate a presigned URL for. Valid values
+      #   are `:get`, `:put`, `:head`, `:delete`, `:create_multipart_upload`, 
+      #   `:list_multipart_uploads`, `:complete_multipart_upload`,
+      #   `:abort_multipart_upload`, `:list_parts`, and `:upload_part`.
       #
       # @param [Hash] params
       #   Additional request parameters to use when generating the pre-signed
       #   URL. See the related documentation in {Client} for accepted
       #   params.
       #
-      #   | HTTP Method   | Client Method          |
-      #   |---------------|------------------------|
-      #   | `:get`        | {Client#get_object}    |
-      #   | `:put`        | {Client#put_object}    |
-      #   | `:head`       | {Client#head_object}   |
-      #   | `:delete`     | {Client#delete_object} |
+      #   | Method                       | Client Method                      |
+      #   |------------------------------|------------------------------------|
+      #   | `:get`                       | {Client#get_object}                |
+      #   | `:put`                       | {Client#put_object}                |
+      #   | `:head`                      | {Client#head_object}               |
+      #   | `:delete`                    | {Client#delete_object}             |
+      #   | `:create_multipart_upload`   | {Client#create_multipart_upload}   |
+      #   | `:list_multipart_uploads`    | {Client#list_multipart_uploads}    |
+      #   | `:complete_multipart_upload` | {Client#complete_multipart_upload} |
+      #   | `:abort_multipart_upload`    | {Client#abort_multipart_upload}    |
+      #   | `:list_parts`                | {Client#list_parts}                |
+      #   | `:upload_part`               | {Client#upload_part}               |
       #
       # @option params [Boolean] :virtual_host (false) When `true` the
       #   presigned URL will use the bucket name as a virtual host.
@@ -184,12 +202,17 @@ module Aws
       #
       # @return [String]
       #
-      def presigned_url(http_method, params = {})
+      def presigned_url(method, params = {})
         presigner = Presigner.new(client: client)
-        presigner.presigned_url("#{http_method.downcase}_object", params.merge(
-          bucket: bucket_name,
-          key: key,
-        ))
+
+        if %w(delete head get put).include?(method.to_s)
+          method = "#{method}_object".to_sym
+        end
+
+        presigner.presigned_url(
+          method.downcase,
+          params.merge(bucket: bucket_name, key: key)
+        )
       end
 
       # Returns the public (un-signed) URL for this object.
@@ -197,15 +220,22 @@ module Aws
       #     s3.bucket('bucket-name').object('obj-key').public_url
       #     #=> "https://bucket-name.s3.amazonaws.com/obj-key"
       #
-      # To use virtual hosted bucket url (disables https):
+      # To use virtual hosted bucket url.
+      # Uses https unless secure: false is set.  If the bucket
+      # name contains dots (.) then you will need to set secure: false.
       #
-      #     s3.bucket('my.bucket.com').object('key').public_url(virtual_host: true)
-      #     #=> "http://my.bucket.com/key"
+      #     s3.bucket('my-bucket.com').object('key')
+      #       .public_url(virtual_host: true)
+      #     #=> "https://my-bucket.com/key"
       #
       # @option options [Boolean] :virtual_host (false) When `true`, the bucket
       #   name will be used as the host name. This is useful when you have
       #   a CNAME configured for the bucket.
       #
+      # @option options [Boolean] :secure (true) When `false`, http
+      #   will be used with virtual_host.  This is required when
+      #   the bucket name has a dot (.) in it.
+      #
       # @return [String]
       def public_url(options = {})
         url = URI.parse(bucket.url(options))
@@ -216,11 +246,12 @@ module Aws
 
       # Uploads a stream in a streaming fashion to the current object in S3.
       #
-      #     # Passed chunks automatically split into multipart upload parts
-      #     # and the parts are uploaded in parallel. This allows for streaming uploads
-      #     # that never touch the disk.
+      # Passed chunks automatically split into multipart upload parts and the
+      # parts are uploaded in parallel. This allows for streaming uploads that
+      # never touch the disk.
       #
-      #  Note that this is known to have issues in JRuby until jruby-9.1.15.0, so avoid using this with older versions of JRuby.
+      # Note that this is known to have issues in JRuby until jruby-9.1.15.0,
+      # so avoid using this with older versions of JRuby.
       #
       # @example Streaming chunks of data
       #     obj.upload_stream do |write_stream|
@@ -235,17 +266,15 @@ module Aws
       #       IO.copy_stream(STDIN, write_stream)
       #     end
       #
-      # @option options [Integer] :thread_count
-      #   The number of parallel multipart uploads
-      #   Default `:thread_count` is `10`.
+      # @option options [Integer] :thread_count (10) The number of parallel
+      #   multipart uploads
       #
-      # @option options [Boolean] :tempfile
-      #   Normally read data is stored in memory when building the parts in order to complete
-      #   the underlying multipart upload. By passing `:tempfile => true` data read will be
+      # @option options [Boolean] :tempfile (false) Normally read data is stored
+      #   in memory when building the parts in order to complete the underlying
+      #   multipart upload. By passing `:tempfile => true` data read will be
       #   temporarily stored on disk reducing the memory footprint vastly.
-      #   Default `:tempfile` is `false`.
       #
-      # @option options [Integer] :part_size
+      # @option options [Integer] :part_size (5242880)
       #   Define how big each part size but the last should be.
       #   Default `:part_size` is `5 * 1024 * 1024`.
       #
@@ -264,9 +293,12 @@ module Aws
           client: client,
           thread_count: uploading_options.delete(:thread_count),
           tempfile: uploading_options.delete(:tempfile),
-          part_size: uploading_options.delete(:part_size),
+          part_size: uploading_options.delete(:part_size)
+        )
+        uploader.upload(
+          uploading_options.merge(bucket: bucket_name, key: key),
+          &block
         )
-        uploader.upload(uploading_options.merge(bucket: bucket_name, key: key), &block)
         true
       end
 
@@ -275,22 +307,49 @@ module Aws
       #     # small files are uploaded in a single API call
       #     obj.upload_file('/path/to/file')
       #
-      # Files larger than `: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
       #     obj.upload_file('/path/to/very_large_file')
       #
-      # @param [String,Pathname,File,Tempfile] source A file or path to a file
-      #   on the local file system that should be uploaded to this object.
-      #   If you pass an open file object, then it is your responsibility
-      #   to close the file object once the upload completes.
+      # The response of the S3 upload API is yielded if a block given.
+      #
+      #     # API response will have etag value of the file
+      #     obj.upload_file('/path/to/file') do |response|
+      #       etag = response.etag
+      #     end
+      #
+      # 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 }%" }
+      #     end
+      #     obj.upload_file('/path/to/file')
+      #
+      # @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.
       #
       # @option options [Integer] :multipart_threshold (15728640) Files larger
-      #   than `:multipart_threshold` are uploaded using the S3 multipart APIs.
+      #   than or equal to `:multipart_threshold` are uploaded using the S3
+      #   multipart APIs.
       #   Default threshold is 15MB.
       #
+      # @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`
@@ -299,13 +358,17 @@ module Aws
       #
       # @return [Boolean] Returns `true` when the object is uploaded
       #   without any errors.
-      #
       def upload_file(source, options = {})
         uploading_options = options.dup
         uploader = FileUploader.new(
           multipart_threshold: uploading_options.delete(:multipart_threshold),
-          client: client)
-        uploader.upload(source, uploading_options.merge(bucket: bucket_name, key: key))
+          client: client
+        )
+        response = uploader.upload(
+          source,
+          uploading_options.merge(bucket: bucket_name, key: key)
+        )
+        yield response if block_given?
         true
       end
 
@@ -320,7 +383,7 @@ module Aws
       #     # and the parts are downloaded in parallel
       #     obj.download_file('/path/to/very_large_file')
       #
-      # @param [String] destination Where to download the file to
+      # @param [String] destination Where to download the file to.
       #
       # @option options [String] mode `auto`, `single_request`, `get_range`
       #  `single_request` mode forces only 1 GET request is made in download,
@@ -328,21 +391,23 @@ module Aws
       #  customizing each range size in multipart_download,
       #  By default, `auto` mode is enabled, which performs multipart_download
       #
-      # @option options [String] chunk_size required in get_range mode
+      # @option options [String] chunk_size required in get_range mode.
       #
-      # @option options [String] thread_count Customize threads used in multipart
-      #   download, if not provided, 10 is default value
+      # @option options [Integer] thread_count (10) Customize threads used in
+      #   the multipart download.
       #
-      # @option options [String] version_id The object version id used to retrieve
-      #   the object, to know more about object versioning, see:
+      # @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
       #
-      # @return [Boolean] Returns `true` when the file is downloaded
-      #   without any errors.
+      # @return [Boolean] Returns `true` when the file is downloaded without
+      #   any errors.
       def download_file(destination, options = {})
         downloader = FileDownloader.new(client: client)
         downloader.download(
-          destination, options.merge(bucket: bucket_name, key: key))
+          destination,
+          options.merge(bucket: bucket_name, key: key)
+        )
         true
       end
     end

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

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
 module Aws
   module S3
     class ObjectSummary
 
       alias content_length size
 
+      # Make the method redefinable
+      alias_method :copy_from, :copy_from
+
       # @param (see Object#copy_from)
       # @options (see Object#copy_from)
       # @return (see Object#copy_from)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Aws::S3::Types::ListObjectVersionsOutput
 
   # TODO : Remove this customization once the resource code

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

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 # utility classes
 require 'aws-sdk-s3/bucket_region_cache'
 require 'aws-sdk-s3/encryption'
+require 'aws-sdk-s3/encryption_v2'
 require 'aws-sdk-s3/file_part'
 require 'aws-sdk-s3/file_uploader'
 require 'aws-sdk-s3/file_downloader'
@@ -26,6 +29,6 @@ require 'aws-sdk-s3/customizations/types/list_object_versions_output'
   Aws::S3::ObjectVersion::Collection,
 ].each do |klass|
   klass.send(:alias_method, :delete, :batch_delete!)
-  klass.send(:extend, Aws::Deprecations)
+  klass.extend Aws::Deprecations
   klass.send(:deprecated, :delete, use: :batch_delete!)
 end

data/lib/aws-sdk-s3/encryption/client.rb

@@ -1,6 +1,14 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
 module Aws
   module S3
 
+    # [MAINTENANCE MODE] There is a new version of the Encryption Client.
+    # AWS strongly recommends upgrading to the {Aws::S3::EncryptionV2::Client},
+    # which provides updated data security best practices.
+    # See documentation for {Aws::S3::EncryptionV2::Client}.
     # Provides an encryption client that encrypts and decrypts data client-side,
     # storing the encrypted data in Amazon S3.
     #
@@ -178,8 +186,10 @@ module Aws
       class Client
 
         extend Deprecations
+        extend Forwardable
+        def_delegators :@client, :config, :delete_object, :head_object, :build_request
 
-        # Creates a new encryption client. You must provide on of the following
+        # Creates a new encryption client. You must provide one of the following
         # options:
         #
         # * `:encryption_key`
@@ -223,6 +233,13 @@ module Aws
           @envelope_location = extract_location(options)
           @instruction_file_suffix = extract_suffix(options)
         end
+        deprecated :initialize,
+                   message:
+                     '[MAINTENANCE MODE] This version of the S3 Encryption client is currently in maintenance mode. ' \
+	                     'AWS strongly recommends upgrading to the Aws::S3::EncryptionV2::Client, ' \
+	                     'which provides updated data security best practices. ' \
+	                     'See documentation for Aws::S3::EncryptionV2::Client.'
+
 
         # @return [S3::Client]
         attr_reader :client
@@ -327,7 +344,7 @@ module Aws
           elsif options[:encryption_key]
             DefaultKeyProvider.new(options)
           else
-            msg = "you must pass a :kms_key_id, :key_provider, or :encryption_key"
+            msg = 'you must pass a :kms_key_id, :key_provider, or :encryption_key'
             raise ArgumentError, msg
           end
         end
@@ -347,8 +364,8 @@ module Aws
           if [:metadata, :instruction_file].include?(location)
             location
           else
-            msg = ":envelope_location must be :metadata or :instruction_file "
-            msg << "got #{location.inspect}"
+            msg = ':envelope_location must be :metadata or :instruction_file '\
+                  "got #{location.inspect}"
             raise ArgumentError, msg
           end
         end
@@ -358,7 +375,7 @@ module Aws
           if String === suffix
             suffix
           else
-            msg = ":instruction_file_suffix must be a String"
+            msg = ':instruction_file_suffix must be a String'
             raise ArgumentError, msg
           end
         end