aws-sdk 1.8.5 → 1.9.0

data/lib/aws/s3/client/xml.rb

@@ -141,7 +141,7 @@ module AWS
             element("DeleteMarker") { boolean_value }
             list
           end
-          element("Error") { list; rename(:errors) }  
+          element("Error") { list; rename(:errors) }
         end
 
         CompleteMultipartUpload = BaseGrammar.customize

data/lib/aws/s3/config.rb

@@ -13,7 +13,13 @@
 
 AWS::Core::Configuration.module_eval do
 
-  add_service 'S3', 's3', 's3.amazonaws.com'
+  add_service 'S3', 's3' do |region|
+    if region == 'us-east-1'
+      's3.amazonaws.com'
+    else
+      's3-%s.amazonaws.com' % region
+    end
+  end
 
   add_option :s3_force_path_style, false, :boolean => true
 

data/lib/aws/s3/cors_rule.rb

@@ -16,6 +16,8 @@ module AWS
 
     # Represents a single CORS rule for an S3 {Bucket}.
     #
+    # @example
+    #
     #   rule = bucket.cors.first
     #   rule.allowed_methods #=> ['GET', 'HEAD']
     #   rule.allowed_origins #=> ['*']

data/lib/aws/s3/cors_rule_collection.rb

@@ -16,50 +16,49 @@ module AWS
 
     # Manages the CORS rules for a single bucket.
     #
-    # == Getting Rules
+    # ## Getting Rules
     #
     # To get the CORS rules for a bucket, use the {Bucket#cors} method.  This
     # returns a CORSRuleCollection for the bucket.  The collection is
     # enumerable.
     #
-    #   # enumerating all rules for a buck
-    #   bucket.cors.each do |rule|
-    #     # rule is a CORSRule object
-    #   end
+    #     # enumerating all rules for a buck
+    #     bucket.cors.each do |rule|
+    #       # rule is a CORSRule object
+    #     end
     #
-    # == Setting Rules
+    # ## Setting Rules
     #
     # You can set the rules for a bucket (replacing all existing rules) using
     # the {#set} method.
     #
-    #   # accepts a list of one or more rules
-    #   bucket.rules.set(rule1, rule2)
+    #     # accepts a list of one or more rules
+    #     bucket.rules.set(rule1, rule2)
     #
-    #   # rules can be an array of rules
-    #   bucket.rules.set(rules)
+    #     # rules can be an array of rules
+    #     bucket.rules.set(rules)
     #
-    #   # passing an empty list or array removes all rules
-    #   bucket.rules.set([])
-    #   bucket.rules.clear # does the same thing
+    #     # passing an empty list or array removes all rules
+    #     bucket.rules.set([])
+    #     bucket.rules.clear # does the same thing
     #
     # Each rule can be a Hash, a {CORSRule} or another {CORSRuleCollection}.
     # See {Client#put_bucket_cors} for a list of keys for a rule hash.
     #
-    # == Adding Rules
+    # ## Adding Rules
     #
     # Adding rules is the same as setting rules.  Rules you add will be
     # appended to the end of the existing list of rules.
     #
-    #   # add one or more rules
-    #   bucket.rules.add(rules)
+    #     # add one or more rules
+    #     bucket.rules.add(rules)
     #
-    # == Deleting Rules
+    # ## Deleting Rules
     #
     # To remove a rule, use the {#delete_if} method.
     #
-    #   # delete rules that allow access from any domain
-    #   bucket.cors.delete_if{|rule| rule.allowed_origins.include?('*')
-    #
+    #     # delete rules that allow access from any domain
+    #     bucket.cors.delete_if{|rule| rule.allowed_origins.include?('*')
     class CORSRuleCollection
 
       include Core::Collection::Simple
@@ -77,18 +76,18 @@ module AWS
       # Replaces the CORS rules attached to this bucket.  You can pass
       # one or more rules as an array or a list.
       #
-      #   # replace all exisitng rules with a single rule
-      #   bucket.cors.set(
-      #     :allowed_methods => %w(GET),
-      #     :allowed_origins => %w(http://*.mydomain.com),
-      #     :max_age_seconds => 3600)
+      #     # replace all exisitng rules with a single rule
+      #     bucket.cors.set(
+      #       :allowed_methods => %w(GET),
+      #       :allowed_origins => %w(http://*.mydomain.com),
+      #       :max_age_seconds => 3600)
       #
       # If you pass an empty array, all of the rules will be removed from
       # the bucket.
       #
-      #    # these two lines are equivilent
-      #    bucket.cors.clear
-      #    bucket.cors.set([])
+      #      # these two lines are equivilent
+      #      bucket.cors.clear
+      #      bucket.cors.set([])
       #
       # @param [Hash,CORSRule,CORSRuleCollection] rules A list or array
       #   of one or more rules to set.  Each rule may be a Hash, a CORSRule
@@ -113,19 +112,19 @@ module AWS
 
       # Add one or more CORS rules to this bucket.
       #
-      #   # adding a single rule as a hash
-      #   bucket.cors.add(
-      #     :allowed_methods => %w(GET HEAD),
-      #     :allowed_origins => %w(*),
-      #     :max_age_seconds => 3600)
+      #     # adding a single rule as a hash
+      #     bucket.cors.add(
+      #       :allowed_methods => %w(GET HEAD),
+      #       :allowed_origins => %w(*),
+      #       :max_age_seconds => 3600)
       #
       # You can add multiple rules in a single call:
       #
-      #   # each rule may be a hash, CORSRule or a CORSRuleCollection,
-      #   bucket.cors.add(rules)
+      #     # each rule may be a hash, CORSRule or a CORSRuleCollection,
+      #     bucket.cors.add(rules)
       #
-      #   # alternatively you can pass a list of rules
-      #   bucket.cors.add(rule1, rule2, ...)
+      #     # alternatively you can pass a list of rules
+      #     bucket.cors.add(rule1, rule2, ...)
       #
       # @param (see #set)
       # @return (see #set)
@@ -134,14 +133,15 @@ module AWS
       end
       alias_method :create, :add
 
-      # Deletes every rule for which the block evaluates to +true+.
+      # Deletes every rule for which the block evaluates to `true`.
+      #
+      # @example Remove all rules that are open to the 'world'
       #
-      #   # remove all rules that are open to the 'world'
       #   bucket.cors.delete_if{|rule| rule.allowed_origins.include?('*') }
       #
       # @yield [rule]
       # @yieldparam [CORSRule] rule
-      # @yieldreturn [Boolean] Return +true+ for each rule you want to delete.
+      # @yieldreturn [Boolean] Return `true` for each rule you want to delete.
       # @return (see #set)
       def delete_if &block
         rules = []
@@ -153,6 +153,8 @@ module AWS
 
       # Removes all CORS rules attached to this bucket.
       #
+      # @example
+      #
       #   bucket.cors.count #=> 3
       #   bucket.cors.clear
       #   bucket.cors.count #=> 0

data/lib/aws/s3/data_options.rb

@@ -126,8 +126,8 @@ module AWS
 
       end
 
-      # @return [Boolean] Returns +true+ if the object responds to
-      #   +#read+ and +#eof?+.
+      # @return [Boolean] Returns `true` if the object responds to
+      #   `#read` and `#eof?`.
       def io_like? io
         io.respond_to?(:read) and io.respond_to?(:eof?)
       end
@@ -153,16 +153,13 @@ module AWS
           @eof = false
         end
 
-        def read bytes = nil
-          if bytes
-            buffer = StringIO.new
-            @write_block.call(buffer, bytes)
-            buffer.rewind
-            @eof = true if buffer.size < bytes
-            buffer.size == 0 ? nil : buffer.read
+        def read bytes = nil, output_buffer = nil
+          data = if bytes
+            (@eof) ? nil : read_chunk(bytes)
           else
-            read_all
+            (@eof) ? ""  : read_all
           end
+          output_buffer ? output_buffer.replace(data || '') : data
         end
 
         def eof?
@@ -171,9 +168,17 @@ module AWS
 
         protected
 
+        def read_chunk bytes
+          buffer = StringIO.new
+          @write_block.call(buffer, bytes)
+          buffer.rewind
+          @eof = true if buffer.size < bytes
+          buffer.read
+        end
+
         def read_all
           buffer = StringIO.new
-          buffer << read(1024 * 1024 * 5) until eof?
+          buffer << read_chunk(1024 * 1024 * 5) until @eof
           buffer.rewind
           buffer.read
         end

data/lib/aws/s3/encryption_utils.rb

@@ -31,7 +31,7 @@ module AWS
       # @return [String] Returns the data encrypted with the key given.
       def encrypt data, key
         rsa = OpenSSL::PKey::RSA
-        ## Encrypting data key
+        # Encrypting data key
         case key
         when rsa # Asymmetric encryption
           key.public_encrypt(data)
@@ -97,7 +97,7 @@ module AWS
       #
       # @param [String] iv IV for the cipher.
       #
-      # @return [OpenSSL::Cipher] Will return a configured +OpenSSL::Cipher+.
+      # @return [OpenSSL::Cipher] Will return a configured `OpenSSL::Cipher`.
       def get_aes_cipher mode, block_mode, key = nil, iv = nil
 
         # If no key given, default to 256 bit

data/lib/aws/s3/errors.rb

@@ -18,13 +18,13 @@ module AWS
     # types that S3 can return.  You can use these classes to rescue
     # specific errors, for example:
     #
-    #  begin
-    #    S3.new.buckets.mybucket.
-    #      objects.myobj.write("HELLO")
-    #  rescue S3::Errors::NoSuchBucket => e
-    #    S3.new.buckets.create("mybucket")
-    #    retry
-    #  end
+    #     begin
+    #       S3.new.buckets.mybucket.
+    #         objects.myobj.write("HELLO")
+    #     rescue S3::Errors::NoSuchBucket => e
+    #       S3.new.buckets.create("mybucket")
+    #       retry
+    #     end
     #
     # All errors raised as a result of error responses from the
     # service are instances of either {ClientError} or {ServerError}.

data/lib/aws/s3/multipart_upload.rb

@@ -70,17 +70,17 @@ module AWS
         true
       end
 
-      # @return The upload initiator.  This object will have +:id+
-      #   and +:display_name+ methods; if the initiator is an IAM
-      #   user, the +:id+ method will return the ARN of the user, and
+      # @return The upload initiator.  This object will have `:id`
+      #   and `:display_name` methods; if the initiator is an IAM
+      #   user, the `:id` method will return the ARN of the user, and
       #   if the initiator is an AWS account, this method will return
       #   the same data as {#owner}.
       def initiator
         client.list_parts(base_opts).initiator
       end
 
-      # @return The upload owner.  This object will have +:id+
-      #   and +:display_name+ methods.
+      # @return The upload owner.  This object will have `:id`
+      #   and `:display_name` methods.
       def owner
         client.list_parts(base_opts).owner
       end
@@ -88,8 +88,8 @@ module AWS
       # @return [Symbol] The class of storage used to store the
       #   uploaded object.  Possible values:
       #
-      #   * +:standard+
-      #   * +:reduced_redundancy?+
+      #   * `:standard`
+      #   * `:reduced_redundancy?`
       def storage_class
         client.list_parts(base_opts).storage_class.downcase.to_sym
       end
@@ -129,57 +129,54 @@ module AWS
       #
       # @overload add_part(data, options = {})
       #
-      #   @param data The data to upload.  Valid values include:
+      #   @param data The data to upload.
+      #     Valid values include:
       #
-      #     * A string
+      #       * A string
+      #       * A Pathname object
+      #       * Any object responding to `read` and `eof?`; the object
+      #         must support the following access methods:
       #
-      #     * A Pathname object
+      #             read                     # all at once
+      #             read(length) until eof?  # in chunks
       #
-      #     * Any object responding to +read+ and +eof?+; the object
-      #       must support the following access methods:
-      #
-      #        read                     # all at once
-      #        read(length) until eof?  # in chunks
-      #
-      #       If you specify data this way, you must also include
-      #       the +:content_length+ option.
+      #         If you specify data this way, you must also include
+      #         the `:content_length` option.
       #
       #   @param [Hash] options Additional options for the upload.
       #
       #   @option options [Integer] :content_length If provided,
       #     this option must match the total number of bytes written
       #     to S3 during the operation.  This option is required if
-      #     +:data+ is an IO-like object without a +size+ method.
+      #     `:data` is an IO-like object without a `size` method.
       #
       # @overload add_part(options)
       #
       #   @param [Hash] options Options for the upload.  Either
-      #     +:data+ or +:file+ is required.
+      #     `:data` or `:file` is required.
       #
       #   @option options :data The data to upload.  Valid values
       #     include:
       #
-      #     * A string
-      #
-      #     * A Pathname object
-      #
-      #     * Any object responding to +read+ and +eof?+; the object
-      #       must support the following access methods:
+      #       * A string
+      #       * A Pathname object
+      #       * Any object responding to `read` and `eof?`; the object
+      #         must support the following access methods:
       #
-      #        read                     # all at once
-      #        read(length) until eof?  # in chunks
+      #              read                     # all at once
+      #              read(length) until eof?  # in chunks
       #
-      #       If you specify data this way, you must also include
-      #       the +:content_length+ option.
+      #         If you specify data this way, you must also include
+      #         the `:content_length` option.
       #
       #   @option options [String] :file Can be specified instead of
-      #     +:data+; its value specifies the path of a file to
+      #     `:data`; its value specifies the path of a file to
       #     upload.
       #
       #   @option options [Integer] :content_length If provided,
       #     this option must match the total number of bytes written
       #     to S3 during the operation.  This option is required if
-      #     +:data+ is an IO-like object without a +size+ method.
+      #     `:data` is an IO-like object without a `size` method.
       #
       #   @option options [Integer] :part_number The part number.
       def add_part(data_or_options, options = {})
@@ -257,7 +254,7 @@ module AWS
       #   enabled, returns the {ObjectVersion} representing the
       #   version that was uploaded.  If versioning is disabled,
       #   returns the object.  If no upload was attempted (e.g. if it
-      #   was aborted or if no parts were uploaded), returns +nil+.
+      #   was aborted or if no parts were uploaded), returns `nil`.
       def close
         if aborted?
           nil

data/lib/aws/s3/multipart_upload_collection.rb

@@ -17,14 +17,16 @@ module AWS
     # Represents the uploads in progress for a bucket.
     #
     # @example Finding uploads by prefix
-    #  bucket.multipart_uploads.with_prefix("photos/").
-    #    map { |upload| upload.object.key }
-    #  # => ["photos/1.jpg", "photos/2.jpg", ...]
+    #
+    #   bucket.multipart_uploads.with_prefix("photos/").
+    #     map { |upload| upload.object.key }
+    #   # => ["photos/1.jpg", "photos/2.jpg", ...]
     #
     # @example Browsing with a tree interface
-    #  bucket.multipart_uploads.with_prefix("photos").as_tree.
-    #    children.select(&:branch?).map(&:prefix)
-    #  # => ["photos/2010", "photos/2011", ...]
+    #
+    #   bucket.multipart_uploads.with_prefix("photos").as_tree.
+    #     children.select(&:branch?).map(&:prefix)
+    #   # => ["photos/2010", "photos/2011", ...]
     #
     # @see Tree
     class MultipartUploadCollection

data/lib/aws/s3/object_collection.rb

@@ -16,45 +16,45 @@ module AWS
 
     # Represents a collection of S3 objects.
     #
-    # == Getting an S3Object by Key
+    # ## 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'
+    #     # this will not make any requests against S3
+    #     object = bucket.objects['foo.jpg']
+    #     object.key #=> 'foo.jpg'
     #
-    # == Finding objects with a Prefix
+    # ## 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
+    #     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']
+    #     bucket.objects.with_prefix('videos').collect(&:key)
+    #     #=> ['videos/comedy.mpg', 'videos/dancing.mpg']
     #
-    # == Exploring Objects with a Tree Interface
+    # ## 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
+    #     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
+    #     tree = bucket.objects.with_prefix('photos').as_tree
     #
-    #   directories = tree.children.select(&:branch?).collect(&:prefix)
-    #   #=> ['photos/2010', 'photos/2011']
+    #     directories = tree.children.select(&:branch?).collect(&:prefix)
+    #     #=> ['photos/2010', 'photos/2011']
     #
     class ObjectCollection
 
@@ -105,25 +105,25 @@ module AWS
 
       # Deletes the objects provided in as few requests as possible.
       #
-      #   # delete 2 objects (by key) in a single request
-      #   bucket.objects.delete('abc', 'xyz')
+      #     # 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']
+      #     to_delete = []
+      #     to_delete << buckets.objects['foo']
+      #     to_delete << buckets.objects['bar']
       #
-      #   bucket.objects.delete(to_delete)
+      #     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
+      #       * 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
@@ -195,8 +195,8 @@ module AWS
       # 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$/ }
+      #     # delete text files in the 2009 "folder"
+      #     bucket.objects.with_prefix('2009/').delete_if {|o| o.key =~ /\.txt$/ }
       #
       # @yieldparam [S3Object] object
       #