mss-sdk 1.0.0

data/lib/mss/s3/object_collection.rb

@@ -0,0 +1,355 @@
+# 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
+#
+#
+# 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 MSS
+  class S3
+
+    # Represents a collection of S3 objects.
+    #
+    # ## Getting an S3Object by Key
+    #
+    # If you know the key of the object you want, you can reference it this way:
+    #
+    #     # this will not make any requests against S3
+    #     object = bucket.objects['foo.jpg']
+    #     object.key #=> 'foo.jpg'
+    #
+    # ## Finding objects with a Prefix
+    #
+    # Given a bucket with the following keys:
+    #
+    #     photos/sunset.jpg
+    #     photos/sunrise.jpg
+    #     photos/winter.jpg
+    #     videos/comedy.mpg
+    #     videos/dancing.mpg
+    #
+    # You can list objects that share a prefix:
+    #
+    #     bucket.objects.with_prefix('videos').collect(&:key)
+    #     #=> ['videos/comedy.mpg', 'videos/dancing.mpg']
+    #
+    # ## Exploring Objects with a Tree Interface
+    #
+    # Given a bucket with the following keys:
+    #
+    #     README.txt
+    #     videos/wedding.mpg
+    #     videos/family_reunion.mpg
+    #     photos/2010/house.jpg
+    #     photos/2011/fall/leaves.jpg
+    #     photos/2011/summer/vacation.jpg
+    #     photos/2011/summer/family.jpg
+    #
+    #     tree = bucket.objects.with_prefix('photos').as_tree
+    #
+    #     directories = tree.children.select(&:branch?).collect(&:prefix)
+    #     #=> ['photos/2010', 'photos/2011']
+    #
+    class ObjectCollection
+
+      include Core::Model
+      include Enumerable
+      include PrefixAndDelimiterCollection
+
+      # @param [Bucket] bucket The S3 bucket this object collection belongs to.
+      # @param [Hash] options
+      def initialize(bucket, options = {})
+        @bucket = bucket
+        super
+      end
+
+      # @return [Bucket] The bucket this collection belongs to.
+      attr_reader :bucket
+
+      # Writes a new object to S3.
+      #
+      # The first param is the key you want to write this object to.
+      # All other params/options are documented in {S3Object#write}.
+      #
+      # @see S3Object#write
+      #
+      # @param [String] key Where in S3 to write the object.
+      # @return (see S3Object#write)
+      def create key, *args, &block
+        self[key].write(*args, &block)
+      end
+
+      # Returns an S3Object given its name.  For example:
+      #
+      # @example
+      #
+      #   object = bucket.objects['file.txt']
+      #   object.class #=> S3Object
+      #
+      # @param [String] key The object key.
+      # @return [S3Object]
+      def [] key
+        S3Object.new(bucket, key.to_s)
+      end
+
+      # (see PrefixedCollection#with_prefix)
+      def with_prefix prefix, mode = :replace
+        super(prefix, mode)
+      end
+
+      # Deletes the objects provided in as few requests as possible.
+      #
+      #     # delete 2 objects (by key) in a single request
+      #     bucket.objects.delete('abc', 'xyz')
+      #
+      # You can delete objects also by passing their S3Object representation:
+      #
+      #     to_delete = []
+      #     to_delete << buckets.objects['foo']
+      #     to_delete << buckets.objects['bar']
+      #
+      #     bucket.objects.delete(to_delete)
+      #
+      # @overload delete(objects)
+      #   @param [Mixed] objects One or more objects to delete.  Each object
+      #     can be one of the following:
+      #
+      #       * An object key (string)
+      #       * A hash with :key and :version_id (for versioned objects)
+      #       * An {S3Object} instance
+      #       * An {ObjectVersion} instance
+      #
+      # @overload delete(objects, options)
+      #   Deletes multiple objects, with additional options. The array can
+      #   contain any of the types of objects the first method invocation style
+      #   accepts.
+      #   @param [Array] objects One or more objects to delete.
+      #   @param [Hash] options Optional headers to pass on.
+      #
+      # @raise [BatchDeleteError] If any of the objects failed to delete,
+      #   a BatchDeleteError will be raised with a summary of the errors.
+      #
+      # @return [nil]
+      #
+      def delete *objects
+
+        # Detect and retrieve options from the end of the splat.
+        if
+          objects.size == 2 and
+          objects[0].is_a?(Array) and
+          objects[1].is_a?(Hash)
+        then
+          client_opts = objects.pop
+        else
+          client_opts = {}
+        end
+
+        objects = objects.flatten.collect do |obj|
+          case obj
+          when String        then { :key => obj }
+          when Hash          then obj
+          when S3Object      then { :key => obj.key }
+          when ObjectVersion then { :key => obj.key, :version_id => obj.version_id }
+          else
+            msg = "objects must be keys (strings or hashes with :key and " +
+                  ":version_id), S3Objects or ObjectVersions, got " +
+                  obj.class.name
+            raise ArgumentError, msg
+          end
+        end
+
+        batch_helper = BatchHelper.new(1000) do |batch|
+          client_opts[:bucket_name] = bucket.name
+          client_opts[:quiet] = true
+          client_opts[:objects] = batch
+          client.delete_objects(client_opts)
+        end
+
+        error_counts = {}
+        batch_helper.after_batch do |response|
+          response.errors.each do |error|
+            error_counts[error.code] ||= 0
+            error_counts[error.code] += 1
+          end
+        end
+
+        objects.each do |object|
+          batch_helper.add(object)
+        end
+
+        batch_helper.complete!
+
+        raise Errors::BatchDeleteError.new(error_counts) unless
+          error_counts.empty?
+
+        nil
+
+      end
+
+      # Deletes each object in the collection that returns a true value
+      # from block passed to this method.  Deletes are batched for efficiency.
+      #
+      #     # delete text files in the 2009 "folder"
+      #     bucket.objects.with_prefix('2009/').delete_if {|o| o.key =~ /\.txt$/ }
+      #
+      # @yieldparam [S3Object] object
+      #
+      # @raise [BatchDeleteError] If any of the objects failed to delete,
+      #   a BatchDeleteError will be raised with a summary of the errors.
+      #
+      def delete_if &block
+
+        error_counts = {}
+
+        batch_helper = BatchHelper.new(1000) do |objects|
+          begin
+            delete(objects)
+          rescue Errors::BatchDeleteError => error
+            error.error_counts.each_pair do |code,count|
+              error_counts[code] ||= 0
+              error_counts[code] += count
+            end
+          end
+        end
+
+        each do |object|
+          batch_helper.add(object) if yield(object)
+        end
+
+        batch_helper.complete!
+
+        raise Errors::BatchDeleteError.new(error_counts) unless
+          error_counts.empty?
+
+        nil
+
+      end
+
+      # Deletes all objects represented by this collection.
+      #
+      # @example Delete all objects from a bucket
+      #
+      #   bucket.objects.delete_all
+      #
+      # @example Delete objects with a given prefix
+      #
+      #   bucket.objects.with_prefix('2009/').delete_all
+      #
+      # @raise [BatchDeleteError] If any of the objects failed to delete,
+      #   a BatchDeleteError will be raised with a summary of the errors.
+      #
+      # @return [Array] Returns an array of results
+      #
+      def delete_all
+
+        error_counts = {}
+
+        each_batch do |objects|
+          begin
+            delete(objects)
+          rescue Errors::BatchDeleteError => error
+            error.error_counts.each_pair do |code,count|
+              error_counts[code] ||= 0
+              error_counts[code] += count
+            end
+          end
+        end
+
+        raise Errors::BatchDeleteError.new(error_counts) unless
+          error_counts.empty?
+
+        nil
+
+      end
+
+      # Iterates the collection, yielding instances of S3Object.
+      #
+      # Use break or raise an exception to terminate the enumeration.
+      #
+      # @param [Hash] options
+      # @option options [Integer] :limit (nil) The maximum number of
+      #   objects to yield.
+      # @option options [Integer] :batch_size (1000) The number of objects to
+      #   fetch each request to S3.  Maximum is 1000 keys at time.
+      # @return [nil]
+      def each options = {}, &block
+        super
+      end
+
+      private
+
+      def each_member_in_page(page, &block)
+        super
+        page.contents.each do |content|
+          content_length = content[:size].to_i if content[:size]
+          etag = content[:etag]
+          last_modified = content[:last_modified]
+          yield(S3Object.new(bucket, content.key, { :content_length => content_length, :etag => etag, :last_modified => last_modified}))
+        end
+      end
+
+      def list_request options
+        client.list_objects(options)
+      end
+
+      def limit_param
+        :max_keys
+      end
+
+      def next_markers page
+        if page[:next_marker]
+          marker = page[:next_marker]
+        elsif page[:contents].size > 0
+          marker = page[:contents].last[:key]
+        else
+          raise 'Unable to find marker in S3 list objects response'
+        end
+
+        { :marker => marker }
+      end
+
+      # processes items in batches of 1k items
+      # @api private
+      class BatchHelper
+
+        def initialize batch_size, &block
+          @batch_size = batch_size
+          @block = block
+          @batch = []
+        end
+
+        def after_batch &block
+          @after_batch = block
+        end
+
+        def add item
+          @batch << item
+          if @batch.size == @batch_size
+            process_batch
+            @batch = []
+          end
+          item
+        end
+
+        def complete!
+          process_batch unless @batch.empty?
+        end
+
+        private
+
+        def process_batch
+          response = @block.call(@batch)
+          @after_batch.call(response) if @after_batch
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/mss/s3/object_metadata.rb

@@ -0,0 +1,102 @@
+# 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
+#
+#
+# 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 MSS
+  class S3
+
+    # Returns an object that represents the metadata for an S3 object.
+    class ObjectMetadata
+
+      include Core::Model
+
+      # @param [S3Object] object
+      # @param [Hash] options
+      # @option options [String] :version_id A specific version of the object
+      #   to get metadata for
+      def initialize object, options = {}
+        @object = object
+        @version_id = options[:version_id]
+        super
+      end
+
+      # @return [S3Object]
+      attr_reader :object
+
+      # Returns the value for the given name stored in the S3Object's
+      # metadata:
+      #
+      #     bucket.objects['myobject'].metadata['purpose']
+      #     # returns nil if the given metadata key has not been set
+      #
+      # @param [String,Symbol] name The name of the metadata field to
+      #   get.
+      #
+      # @return [String,nil] Returns the metadata for the given name.
+      def [] name
+        to_h[name.to_s]
+      end
+
+      # Changes the value of the given name stored in the S3Object's
+      # metadata:
+      #
+      #     object = bucket.object['myobject']
+      #     object.metadata['purpose'] = 'research'
+      #     object.metadata['purpose']               # => 'research'
+      #
+      # @deprecated In order to safely update an S3 object's metadata, you
+      #   should use {S3Object#copy_from}. This operation does not preserve
+      #   the ACL, storage class (standard vs. reduced redundancy) or server
+      #   side encryption settings. Using this method on anything other than
+      #   vanilla S3 objects risks clobbering other metadata values set on the
+      #   object.
+      #
+      # @note The name and value of each metadata field must conform
+      #   to US-ASCII.
+      #
+      # @param [String,Symbol] name The name of the metadata field to
+      #   set.
+      #
+      # @param [String] value The new value of the metadata field.
+      #
+      # @return [String,nil] Returns the value that was set.
+      def []= name, value
+        raise "cannot change the metadata of an object version; "+
+          "use S3Object#write to create a new version with different metadata" if
+          @version_id
+        metadata = to_h.dup
+        metadata[name.to_s] = value
+        object.copy_from(object.key,
+                         :metadata => metadata)
+        value
+      end
+
+      # Proxies the method to {#[]}.
+      # @return (see #[])
+      def method_missing name, *args, &blk
+        return super if !args.empty? || blk
+        self[name]
+      end
+
+      # @return [Hash] Returns the user-generated metadata stored with
+      #   this S3 Object.
+      def to_h
+        options = {}
+        options[:bucket_name] = object.bucket.name
+        options[:key] = object.key
+        options[:version_id] = @version_id if @version_id
+        client.head_object(options).meta
+      end
+
+    end
+
+  end
+end

data/lib/mss/s3/object_upload_collection.rb

@@ -0,0 +1,76 @@
+# 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
+#
+#
+# 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 MSS
+  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/mss/s3/object_version.rb

@@ -0,0 +1,153 @@
+# 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
+#
+#
+# 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 MSS
+  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