aws-sdk-s3 1.75.0

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

@@ -0,0 +1,333 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::S3
+
+  class ObjectAcl
+
+    extend Aws::Deprecations
+
+    # @overload def initialize(bucket_name, object_key, options = {})
+    #   @param [String] bucket_name
+    #   @param [String] object_key
+    #   @option options [Client] :client
+    # @overload def initialize(options = {})
+    #   @option options [required, String] :bucket_name
+    #   @option options [required, String] :object_key
+    #   @option options [Client] :client
+    def initialize(*args)
+      options = Hash === args.last ? args.pop.dup : {}
+      @bucket_name = extract_bucket_name(args, options)
+      @object_key = extract_object_key(args, options)
+      @data = options.delete(:data)
+      @client = options.delete(:client) || Client.new(options)
+      @waiter_block_warned = false
+    end
+
+    # @!group Read-Only Attributes
+
+    # @return [String]
+    def bucket_name
+      @bucket_name
+    end
+
+    # @return [String]
+    def object_key
+      @object_key
+    end
+
+    # Container for the bucket owner's display name and ID.
+    # @return [Types::Owner]
+    def owner
+      data[:owner]
+    end
+
+    # A list of grants.
+    # @return [Array<Types::Grant>]
+    def grants
+      data[:grants]
+    end
+
+    # If present, indicates that the requester was successfully charged for
+    # the request.
+    # @return [String]
+    def request_charged
+      data[:request_charged]
+    end
+
+    # @!endgroup
+
+    # @return [Client]
+    def client
+      @client
+    end
+
+    # Loads, or reloads {#data} for the current {ObjectAcl}.
+    # Returns `self` making it possible to chain methods.
+    #
+    #     object_acl.reload.data
+    #
+    # @return [self]
+    def load
+      resp = @client.get_object_acl(
+        bucket: @bucket_name,
+        key: @object_key
+      )
+      @data = resp.data
+      self
+    end
+    alias :reload :load
+
+    # @return [Types::GetObjectAclOutput]
+    #   Returns the data for this {ObjectAcl}. Calls
+    #   {Client#get_object_acl} if {#data_loaded?} is `false`.
+    def data
+      load unless @data
+      @data
+    end
+
+    # @return [Boolean]
+    #   Returns `true` if this resource is loaded.  Accessing attributes or
+    #   {#data} on an unloaded resource will trigger a call to {#load}.
+    def data_loaded?
+      !!@data
+    end
+
+    # @deprecated Use [Aws::S3::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource
+    #   remains unchanged.
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) do |instance|
+    #       instance.state.name == 'running'
+    #     end
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is
+    # set by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    # @yieldparam [Resource] resource to be used in the waiting condition.
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
+    #   terminates because the waiter has entered a state that it will not
+    #   transition out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
+    #   encountered while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
+    # @!group Actions
+
+    # @example Request syntax with placeholder values
+    #
+    #   object_acl.put({
+    #     acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
+    #     access_control_policy: {
+    #       grants: [
+    #         {
+    #           grantee: {
+    #             display_name: "DisplayName",
+    #             email_address: "EmailAddress",
+    #             id: "ID",
+    #             type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
+    #             uri: "URI",
+    #           },
+    #           permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP
+    #         },
+    #       ],
+    #       owner: {
+    #         display_name: "DisplayName",
+    #         id: "ID",
+    #       },
+    #     },
+    #     content_md5: "ContentMD5",
+    #     grant_full_control: "GrantFullControl",
+    #     grant_read: "GrantRead",
+    #     grant_read_acp: "GrantReadACP",
+    #     grant_write: "GrantWrite",
+    #     grant_write_acp: "GrantWriteACP",
+    #     request_payer: "requester", # accepts requester
+    #     version_id: "ObjectVersionId",
+    #   })
+    # @param [Hash] options ({})
+    # @option options [String] :acl
+    #   The canned ACL to apply to the object. For more information, see
+    #   [Canned ACL][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
+    # @option options [Types::AccessControlPolicy] :access_control_policy
+    #   Contains the elements that set the ACL permissions for an object per
+    #   grantee.
+    # @option options [String] :content_md5
+    #   The base64-encoded 128-bit MD5 digest of the data. This header must be
+    #   used as a message integrity check to verify that the request body was
+    #   not corrupted in transit. For more information, go to [RFC
+    #   1864.&gt;][1]
+    #
+    #
+    #
+    #   [1]: http://www.ietf.org/rfc/rfc1864.txt
+    # @option options [String] :grant_full_control
+    #   Allows grantee the read, write, read ACP, and write ACP permissions on
+    #   the bucket.
+    # @option options [String] :grant_read
+    #   Allows grantee to list the objects in the bucket.
+    # @option options [String] :grant_read_acp
+    #   Allows grantee to read the bucket ACL.
+    # @option options [String] :grant_write
+    #   Allows grantee to create, overwrite, and delete any object in the
+    #   bucket.
+    # @option options [String] :grant_write_acp
+    #   Allows grantee to write the ACL for the applicable bucket.
+    # @option options [String] :request_payer
+    #   Confirms that the requester knows that they will be charged for the
+    #   request. Bucket owners need not specify this parameter in their
+    #   requests. For information about downloading objects from requester
+    #   pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
+    #   in the *Amazon S3 Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
+    # @option options [String] :version_id
+    #   VersionId used to reference a specific version of the object.
+    # @return [Types::PutObjectAclOutput]
+    def put(options = {})
+      options = options.merge(
+        bucket: @bucket_name,
+        key: @object_key
+      )
+      resp = @client.put_object_acl(options)
+      resp.data
+    end
+
+    # @!group Associations
+
+    # @return [Object]
+    def object
+      Object.new(
+        bucket_name: @bucket_name,
+        key: @object_key,
+        client: @client
+      )
+    end
+
+    # @deprecated
+    # @api private
+    def identifiers
+      {
+        bucket_name: @bucket_name,
+        object_key: @object_key
+      }
+    end
+    deprecated(:identifiers)
+
+    private
+
+    def extract_bucket_name(args, options)
+      value = args[0] || options.delete(:bucket_name)
+      case value
+      when String then value
+      when nil then raise ArgumentError, "missing required option :bucket_name"
+      else
+        msg = "expected :bucket_name to be a String, got #{value.class}"
+        raise ArgumentError, msg
+      end
+    end
+
+    def extract_object_key(args, options)
+      value = args[1] || options.delete(:object_key)
+      case value
+      when String then value
+      when nil then raise ArgumentError, "missing required option :object_key"
+      else
+        msg = "expected :object_key to be a String, got #{value.class}"
+        raise ArgumentError, msg
+      end
+    end
+
+    class Collection < Aws::Resources::Collection; end
+  end
+end

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'thread'
+
+module Aws
+  module S3
+    # @api private
+    class ObjectCopier
+
+      # @param [S3::Object] object
+      def initialize(object, options = {})
+        @object = object
+        @options = options.merge(client: @object.client)
+      end
+
+      def copy_from(source, options = {})
+        copy_object(source, @object, merge_options(source, options))
+      end
+
+      def copy_to(target, options = {})
+        copy_object(@object, target, merge_options(target, options))
+      end
+
+      private
+
+      def copy_object(source, target, options)
+        target_bucket, target_key = copy_target(target)
+        options[:bucket] = target_bucket
+        options[:key] = target_key
+        options[:copy_source] = copy_source(source)
+        if options.delete(:multipart_copy)
+          apply_source_client(source, options)
+          ObjectMultipartCopier.new(@options).copy(options)
+        else
+          @object.client.copy_object(options)
+        end
+      end
+
+      def copy_source(source)
+        case source
+        when String then source
+        when Hash
+          src = "#{source[:bucket]}/#{escape(source[:key])}"
+          src += "?versionId=#{source[:version_id]}" if source.key?(:version_id)
+          src
+        when S3::Object, S3::ObjectSummary
+          "#{source.bucket_name}/#{escape(source.key)}"
+        when S3::ObjectVersion
+          "#{source.bucket_name}/#{escape(source.object_key)}?versionId=#{source.id}"
+        else
+          msg = "expected source to be an Aws::S3::Object, Hash, or String"
+          raise ArgumentError, msg
+        end
+      end
+
+      def copy_target(target)
+        case target
+        when String then target.match(/([^\/]+?)\/(.+)/)[1,2]
+        when Hash then target.values_at(:bucket, :key)
+        when S3::Object then [target.bucket_name, target.key]
+        else
+          msg = "expected target to be an Aws::S3::Object, Hash, or String"
+          raise ArgumentError, msg
+        end
+      end
+
+      def merge_options(source_or_target, options)
+        if Hash === source_or_target
+          source_or_target.inject(options.dup) do |opts, (key, value)|
+            opts[key] = value unless [:bucket, :key, :version_id].include?(key)
+            opts
+          end
+        else
+          options.dup
+        end
+      end
+
+      def apply_source_client(source, options)
+
+        if source.respond_to?(:client)
+          options[:copy_source_client] ||= source.client
+        end
+
+        if options[:copy_source_region]
+          config = @object.client.config
+          config = config.each_pair.inject({}) { |h, (k,v)| h[k] = v; h }
+          config[:region] = options.delete(:copy_source_region)
+          options[:copy_source_client] ||= S3::Client.new(config)
+        end
+
+        options[:copy_source_client] ||= @object.client
+
+      end
+
+      def escape(str)
+        Seahorse::Util.uri_path_escape(str)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require 'thread'
+require 'cgi'
+
+module Aws
+  module S3
+    # @api private
+    class ObjectMultipartCopier
+
+      FIVE_MB = 5 * 1024 * 1024 # 5MB
+
+      FILE_TOO_SMALL = "unable to multipart copy files smaller than 5MB"
+
+      MAX_PARTS = 10_000
+
+      # @option options [Client] :client
+      # @option [Integer] :min_part_size (52428800) Size of copied parts.
+      #   Defaults to 50MB.
+      #   will be constructed from the given `options' hash.
+      # @option [Integer] :thread_count (10) Number of concurrent threads to
+      #   use for copying parts.
+      def initialize(options = {})
+        @thread_count = options.delete(:thread_count) || 10
+        @min_part_size = options.delete(:min_part_size) || (FIVE_MB * 10)
+        @client = options[:client] || Client.new
+      end
+
+      # @return [Client]
+      attr_reader :client
+
+      # @option (see S3::Client#copy_object)
+      def copy(options = {})
+        size = source_size(options)
+        options[:upload_id] = initiate_upload(options)
+        begin
+          parts = copy_parts(size, default_part_size(size), options)
+          complete_upload(parts, options)
+        rescue => error
+          abort_upload(options)
+          raise error
+        end
+      end
+
+      private
+
+      def initiate_upload(options)
+        options = options_for(:create_multipart_upload, options)
+        @client.create_multipart_upload(options).upload_id
+      end
+
+      def copy_parts(size, default_part_size, options)
+        queue = PartQueue.new(compute_parts(size, default_part_size, options))
+        threads = []
+        @thread_count.times do
+          threads << copy_part_thread(queue)
+        end
+        threads.map(&:value).flatten.sort_by{ |part| part[:part_number] }
+      end
+
+      def copy_part_thread(queue)
+        Thread.new do
+          begin
+            completed = []
+            while part = queue.shift
+              completed << copy_part(part)
+            end
+            completed
+          rescue => error
+            queue.clear!
+            raise error
+          end
+        end
+      end
+
+      def copy_part(part)
+        {
+          etag: @client.upload_part_copy(part).copy_part_result.etag,
+          part_number: part[:part_number],
+        }
+      end
+
+      def complete_upload(parts, options)
+        options = options_for(:complete_multipart_upload, options)
+        options[:multipart_upload] = { parts: parts }
+        @client.complete_multipart_upload(options)
+      end
+
+      def abort_upload(options)
+        @client.abort_multipart_upload({
+          bucket: options[:bucket],
+          key: options[:key],
+          upload_id: options[:upload_id],
+        })
+      end
+
+      def compute_parts(size, default_part_size, options)
+        part_number = 1
+        offset = 0
+        parts = []
+        options = options_for(:upload_part_copy, options)
+        while offset < size
+          parts << options.merge({
+            part_number: part_number,
+            copy_source_range: byte_range(offset, default_part_size, size),
+          })
+          part_number += 1
+          offset += default_part_size
+        end
+        parts
+      end
+
+      def byte_range(offset, default_part_size, size)
+        if offset + default_part_size < size
+          "bytes=#{offset}-#{offset + default_part_size - 1}"
+        else
+          "bytes=#{offset}-#{size - 1}"
+        end
+      end
+
+      def source_size(options)
+        return options.delete(:content_length) if options[:content_length]
+
+        client = options[:copy_source_client] || @client
+
+        if vid_match = options[:copy_source].match(/([^\/]+?)\/(.+)\?versionId=(.+)/)
+          bucket, key, version_id = vid_match[1,3]
+        else
+          bucket, key = options[:copy_source].match(/([^\/]+?)\/(.+)/)[1,2]
+        end
+
+        key = CGI.unescape(key)
+        opts = { bucket: bucket, key: key }
+        opts[:version_id] = version_id if version_id
+        client.head_object(opts).content_length
+      end
+
+      def default_part_size(source_size)
+        if source_size < FIVE_MB
+          raise ArgumentError, FILE_TOO_SMALL
+        else
+          [(source_size.to_f / MAX_PARTS).ceil, @min_part_size].max.to_i
+        end
+      end
+
+      def options_for(operation_name, options)
+        API_OPTIONS[operation_name].inject({}) do |hash, opt_name|
+          hash[opt_name] = options[opt_name] if options.key?(opt_name)
+          hash
+        end
+      end
+
+      # @api private
+      def self.options_for(shape_name)
+        Client.api.metadata['shapes'][shape_name].member_names
+      end
+
+      API_OPTIONS = {
+        create_multipart_upload: Types::CreateMultipartUploadRequest.members,
+        upload_part_copy: Types::UploadPartCopyRequest.members,
+        complete_multipart_upload: Types::CompleteMultipartUploadRequest.members,
+      }
+
+      class PartQueue
+
+        def initialize(parts = [])
+          @parts = parts
+          @mutex = Mutex.new
+        end
+
+        def shift
+          @mutex.synchronize { @parts.shift }
+        end
+
+        def clear!
+          @mutex.synchronize { @parts.clear }
+        end
+
+      end
+    end
+  end
+end