aws-sdk-v1 1.52.0

data/lib/aws/s3/object_upload_collection.rb

@@ -0,0 +1,77 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class S3
+
+    # Represents uploads in progress for a single object.
+    #
+    # @example Cancel all uploads for an object
+    #  object.multipart_uploads.each(&:abort)
+    #
+    # @example Get an upload by ID
+    #  object.multipart_uploads[id]
+    class ObjectUploadCollection
+
+      include Enumerable
+      include Core::Model
+
+      # @return [S3Object] The object to which the uploads belong.
+      attr_reader :object
+
+      # @api private
+      def initialize(object, opts = {})
+        @all_uploads =
+          MultipartUploadCollection.new(object.bucket).
+          with_prefix(object.key)
+        @object = object
+        super
+      end
+
+      # Creates a new multipart upload.  It is usually more
+      # convenient to use {S3Object#multipart_upload}.
+      def create(options = {})
+        options[:storage_class] = :reduced_redundancy if
+          options.delete(:reduced_redundancy)
+        initiate_opts = {
+          :bucket_name => object.bucket.name,
+          :key => object.key
+        }.merge(options)
+        id = client.initiate_multipart_upload(initiate_opts).upload_id
+        MultipartUpload.new(object, id)
+      end
+
+      # Iterates the uploads in the collection.
+      #
+      # @yieldparam [MultipartUpload] upload An upload in the
+      #   collection.
+      # @return [nil]
+      def each(options = {}, &block)
+        @all_uploads.each(options) do |upload|
+          yield(upload) if upload.object.key == @object.key
+        end
+        nil
+      end
+
+      # @return [MultipartUpload] An object representing the upload
+      #   with the given ID.
+      #
+      # @param [String] id The ID of an upload to get.
+      def [] id
+        MultipartUpload.new(object, id)
+      end
+
+    end
+
+  end
+end

data/lib/aws/s3/object_version.rb

@@ -0,0 +1,154 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class S3
+
+    # Represents a single version of an S3Object.
+    #
+    # When you enable versioning on a S3 bucket, writing to an object
+    # will create an object version instead of replacing the existing
+    # object.
+    class ObjectVersion
+
+      include Core::Model
+
+      # @param [S3Object] object The object this is a version of.
+      # @param [String] version_id The unique id for this version.
+      # @param [Hash] options
+      # @option options [Boolean] :delete_marker Is this version a
+      #   delete marker?
+      # @option options [DateTime] :last_modified Date and time the
+      #   object was last modified.
+      def initialize(object, version_id, options = {})
+        @object = object
+        @version_id = version_id
+        @delete_marker = options[:delete_marker]
+        @last_modified = options[:last_modified]
+        super
+      end
+
+      # @return [S3Object] the object this is a version of.
+      attr_reader :object
+
+      # @return [DateTime] timestamp of this version
+      attr_reader :last_modified
+
+      def bucket
+        object.bucket
+      end
+
+      # @return [String] The unique version identifier.
+      attr_reader :version_id
+
+      # @return (see S3Object#key)
+      def key
+        object.key
+      end
+
+      # (see S3Object#url_for)
+      def url_for method, options = {}
+        object.url_for(method, options.merge(:version_id => version_id))
+      end
+
+      # @see S3Object#head
+      # @return (see S3Object#head)
+      def head
+        object.head(:version_id => @version_id)
+      end
+
+      # @see S3Object#etag
+      # @return (see S3Object#etag)
+      def etag
+        head.etag
+      end
+
+      # @return (see S3Object#content_length)
+      def content_length
+        head.content_length
+      end
+
+      # @note (see S3Object#content_type)
+      # @see S3Object#content_type
+      # @return (see S3Object#content_type)
+      def content_type
+        head.content_type
+      end
+
+      # @see S3Object#metadata
+      # @return (see S3Object#metadata)
+      def metadata
+        object.metadata(:version_id => @version_id)
+      end
+
+      # Reads the data from this object version.
+      # @see S3Object#read
+      # @options (see S3Object#read)
+      # @return (see S3Object#read)
+      def read options = {}, &block
+        object.read(options.merge(:version_id => @version_id), &block)
+      end
+
+      # Deletes this object version from S3.
+      # @option options [String] :mfa The serial number and current token code of
+      #   the Multi-Factor Authentication (MFA) device for the user. Format
+      #   is "SERIAL TOKEN" - with a space between the serial and token.
+      # @return (see S3Object#delete)
+      def delete(options = {})
+        object.delete(:version_id => @version_id,
+                      :mfa        => options[:mfa]
+                     )
+      end
+
+      # @return [Boolean] Returns this if this is the latest version of
+      #   the object, false if the object has been written to since
+      #   this version was created.
+      def latest?
+        object.versions.latest.version_id == self.version_id
+      end
+
+      # If you delete an object in a versioned bucket, a delete marker
+      # is created.
+      # @return [Boolean] Returns true if this version is a delete marker.
+      def delete_marker?
+        if @delete_marker.nil?
+          begin
+            # S3 responds with a 405 (method not allowed) when you try
+            # to HEAD an s3 object version that is a delete marker
+            metadata['foo']
+            @delete_marker = false
+          rescue Errors::MethodNotAllowed => error
+            @delete_marker = true
+          end
+        end
+        @delete_marker
+      end
+
+      # @return [Boolean] Returns true if the other object version has
+      #   the same s3 object key and version id.
+      def ==(other)
+        other.kind_of?(ObjectVersion) and
+          other.object == object and
+          other.version_id == version_id
+      end
+
+      alias_method :eql?, :==
+
+      # @api private
+      def inspect
+        "<#{self.class}:#{object.bucket.name}:#{object.key}:#{version_id}>"
+      end
+
+    end
+  end
+end

data/lib/aws/s3/object_version_collection.rb

@@ -0,0 +1,89 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class S3
+
+    # For S3 buckets with versioning enabled, objects will store versions
+    # each time you write to them.
+    #
+    #     object = bucket.objects['myobj']
+    #     object.write('1')
+    #     object.write('2')
+    #     object.write('3')
+    #
+    #     object.versions.collect(&:read)
+    #     #=> ['1', '2', '3']
+    #
+    # To see all the version id for a particular object, access the any particular version,
+    # and see the latest version:
+    #
+    #     object.versions.each do |version| puts version.version_id end
+    #     #=> T2TwAiZ3SmNr7tOfe0QBa4RZnSb3GSLq
+    #     #=> kAEHC_ysT65bT4P3zyYOP1ELA6ajar_6
+    #     #=> itHPX6m8na_sog0cAtkgP3QITEE8v5ij
+    #
+    #     object.versions['itHPX6m8na_sog0cAtkgP3QITEE8v5ij']
+    #     #=> <AWS::S3::ObjectVersion:<<bucket>>:myobj:itHPX6m8na_sog0cAtkgP3QITEE8v5ij>
+    #
+    #     object.versions.latest
+    #     #=> <AWS::S3::ObjectVersion:<<bucket>>:myobj:T2TwAiZ3SmNr7tOfe0QBa4RZnSb3GSLq>
+    #
+    # If you know the id of a particular version you can get that object.
+    #
+    #     bucket.objects['myobj'].version[version_id].delete
+    #
+    class ObjectVersionCollection
+
+      include Core::Model
+      include Enumerable
+
+      # @return [S3Object] The object this collection belongs to.
+      attr_reader :object
+
+      # @param [S3Object] object
+      def initialize object, options = {}
+        @object = object
+        super(options)
+      end
+
+      # Returns an object that represents a single version of the {#object}.
+      # @param [String] version_id
+      # @return [ObjectVersion]
+      def [] version_id
+        ObjectVersion.new(object, version_id)
+      end
+
+      # @note Generally you will just want to grab the object key its key.
+      # @return [ObjectVersion] Returns the latest version of this object.
+      def latest
+        self.find{|version| true }
+      end
+
+      # Yields once for each version of the {#object}.
+      #
+      # @yield [object_version]
+      # @yieldparam [ObectVersion] object_version
+      # @return [nil]
+      def each &block
+        object.bucket.versions.with_prefix(object.key).each do |version|
+          if version.key == object.key
+            yield(version)
+          end
+        end
+        nil
+      end
+
+    end
+  end
+end

data/lib/aws/s3/paginated_collection.rb

@@ -0,0 +1,75 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class S3
+
+    # @api private
+    module PaginatedCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      protected
+      def _each_item markers, limit, options = {}, &block
+
+        options = list_options(options)
+        options.merge!(markers) unless markers.nil? or markers.empty?
+        options[limit_param] = limit || 1000
+
+        response = list_request(options)
+
+        each_member_in_page(response, &block)
+
+        response.data[:truncated] ? next_markers(response) : nil
+
+      end
+
+      protected
+      def each_member_in_page(page, &block); end
+
+      protected
+      def list_request(options)
+        raise NotImplementedError
+      end
+
+      protected
+      def list_options options
+        opts = {}
+        opts[:bucket_name] = bucket.name if respond_to?(:bucket)
+        opts
+      end
+
+      protected
+      def limit_param
+        raise NotImplementedError
+      end
+
+      protected
+      def pagination_markers
+        [:key_marker]
+      end
+
+      protected
+      def next_markers page
+        pagination_markers.inject({}) do |markers, marker_name|
+          if marker = page.data[:"next_#{marker_name}"]
+            markers[marker_name] = marker if marker
+          end
+          markers
+        end
+      end
+
+    end
+
+  end
+end

data/lib/aws/s3/policy.rb

@@ -0,0 +1,74 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class S3
+
+    # (see Core::Policy)
+    class Policy < Core::Policy
+
+      class Statement < Core::Policy::Statement
+
+        ACTION_MAPPING = {
+          :list_buckets => "s3:ListAllMyBuckets",
+          :create_bucket => "s3:CreateBucket",
+          :delete_bucket => "s3:DeleteBucket",
+          :list_objects => "s3:ListBucket",
+          :list_object_versions => "s3:ListBucketVersions",
+          :list_multipart_uploads => "s3:ListBucketMultipartUploads",
+          :get_object => "s3:GetObject",
+          :get_object_version => "s3:GetObjectVersion",
+          :put_object => "s3:PutObject",
+          :get_object_acl => "s3:GetObjectAcl",
+          :get_object_version_acl => "s3:GetObjectVersionAcl",
+          :set_object_acl => "s3:PutObjectAcl",
+          :set_object_acl_version => "s3:PutObjectAclVersion",
+          :delete_object => "s3:DeleteObject",
+          :delete_object_version => "s3:DeleteObjectVersion",
+          :list_multipart_upload_parts => "s3:ListMultipartUploadParts",
+          :abort_multipart_upload => "s3:AbortMultipartUpload",
+          :get_bucket_acl => "s3:GetBucketAcl",
+          :set_bucket_acl => "s3:PutBucketAcl",
+          :get_bucket_versioning => "s3:GetBucketVersioning",
+          :set_bucket_versioning => "s3:PutBucketVersioning",
+          :get_bucket_requester_pays => "s3:GetBucketRequesterPays",
+          :set_bucket_requester_pays => "s3:PutBucketRequesterPays",
+          :get_bucket_location => "s3:GetBucketLocation",
+          :get_bucket_policy => "s3:GetBucketPolicy",
+          :set_bucket_policy => "s3:PutBucketPolicy",
+          :get_bucket_notification => "s3:GetBucketNotification",
+          :set_bucket_notification => "s3:PutBucketNotification"
+        }
+
+        protected
+        def resource_arn resource
+          prefix = 'arn:aws:s3:::'
+          case resource
+          when Bucket
+            "#{prefix}#{resource.name}"
+          when S3Object
+            "#{prefix}#{resource.bucket.name}/#{resource.key}"
+          when ObjectCollection
+            "#{prefix}#{resource.bucket.name}/#{resource.prefix}*"
+          when /^arn:/
+            resource
+          else
+            "arn:aws:s3:::#{resource}"
+          end
+        end
+
+      end
+
+    end
+  end
+end