aws-sdk 1.8.5 → 1.9.0

data/lib/aws/s3/tree.rb

@@ -22,33 +22,33 @@ module AWS
     #
     # Given you have 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
     #
     # You might like to explore the contents of this bucket as a tree:
     #
-    #   tree = bucket.as_tree
+    #     tree = bucket.as_tree
     #
-    #   directories = tree.children.select(&:branch?).collect(&:prefix)
-    #   #=> ['photos', 'videos']
+    #     directories = tree.children.select(&:branch?).collect(&:prefix)
+    #     #=> ['photos', 'videos']
     #
-    #   files = tree.children.select(&:leaf?).collect(&:key)
-    #   #=> ['README.txt']
+    #     files = tree.children.select(&:leaf?).collect(&:key)
+    #     #=> ['README.txt']
     #
     # If you want to start further down, pass a prefix to {Bucket#as_tree}:
     #
-    #   tree = bucket.as_tree(:prefix => 'photos/2011')
+    #     tree = bucket.as_tree(:prefix => 'photos/2011')
     #
-    #   directories = tree.children.select(&:branch?).collect(&:prefix)
-    #   #=> ['photos/20011/fall', 'photos/20011/summer']
+    #     directories = tree.children.select(&:branch?).collect(&:prefix)
+    #     #=> ['photos/20011/fall', 'photos/20011/summer']
     #
-    #   files = tree.children.select(&:leaf?).collect(&:key)
-    #   #=> []
+    #     files = tree.children.select(&:leaf?).collect(&:key)
+    #     #=> []
     #
     # All non-leaf nodes ({Tree} and {Tree::BranchNode} instances)
     # have a {Tree::Parent#children} method that provides access to
@@ -58,11 +58,11 @@ module AWS
     # non-leaf nodes are common prefixes to multiple keys
     # (directories) and leaf nodes are object keys.
     #
-    # You can continue crawling the tree using the +children+
+    # You can continue crawling the tree using the `children`
     # collection on each branch node, which will contain the branch
     # nodes and leaf nodes below it.
     #
-    # You can construct a Tree object using the +as_tree+ method of
+    # You can construct a Tree object using the `as_tree` method of
     # any of the following classes:
     #
     # * {Bucket} or {ObjectCollection} (for {S3Object} leaf nodes)
@@ -77,13 +77,11 @@ module AWS
     # using.
     class Tree
 
-      AWS.register_autoloads(self) do
-        autoload :BranchNode, 'branch_node'
-        autoload :ChildCollection, 'child_collection'
-        autoload :LeafNode, 'leaf_node'
-        autoload :Node, 'node'
-        autoload :Parent, 'parent'
-      end
+      autoload :BranchNode, 'aws/s3/tree/branch_node'
+      autoload :ChildCollection, 'aws/s3/tree/child_collection'
+      autoload :LeafNode, 'aws/s3/tree/leaf_node'
+      autoload :Node, 'aws/s3/tree/node'
+      autoload :Parent, 'aws/s3/tree/parent'
 
       include Parent
 
@@ -95,7 +93,7 @@ module AWS
       #   tree.
       #
       # @option options [String] :prefix (nil) Set prefix to choose
-      #   where the top of the tree will be.  A value of +nil+ means
+      #   where the top of the tree will be.  A value of `nil` means
       #   that the tree will include all objects in the collection.
       #
       # @option options [String] :delimiter ('/') The string that

data/lib/aws/s3/tree/child_collection.rb

@@ -23,9 +23,9 @@ module AWS
         # @private
         def initialize parent, collection, options = {}
 
-          options = { 
+          options = {
             :prefix => nil,
-            :delimiter => '/', 
+            :delimiter => '/',
             :append => true,
           }.merge(options)
 
@@ -58,7 +58,7 @@ module AWS
         attr_reader :delimiter
 
         # @return [Boolean] Returns true if the tree is set to auto-append
-        #   the delimiter to the prefix when the prefix does not end with 
+        #   the delimiter to the prefix when the prefix does not end with
         #   the delimiter.
         def append?
           @append

data/lib/aws/s3/tree/leaf_node.rb

@@ -64,7 +64,7 @@ module AWS
           end
         end
 
-        # @return [ObjectVersion] Returns the object version this leaf 
+        # @return [ObjectVersion] Returns the object version this leaf
         #   node represents.
         def version
           if @member.kind_of?(ObjectVersion)
@@ -74,7 +74,7 @@ module AWS
           end
         end
 
-        # @return [MultipartUpload] Returns the object version this leaf 
+        # @return [MultipartUpload] Returns the object version this leaf
         #   node represents.
         def upload
           if @member.kind_of?(MultipartUpload)

data/lib/aws/s3/tree/parent.rb

@@ -46,7 +46,7 @@ module AWS
         attr_reader :collection
 
         # A tree may have a prefix of where in the bucket to be based
-        # from.  A value of +nil+ means that the tree will include all
+        # from.  A value of `nil` means that the tree will include all
         # objects in the collection.
         #
         # @return [String,nil]

data/lib/aws/s3/website_configuration.rb

@@ -22,13 +22,13 @@ module AWS
       #   Describes the redirect behavior for every request to this
       #   bucket's website endpoint. If this element is present, no
       #   other options are are allowed.
-      #   * +:host_name+ - (*required*, String) 
+      #   * `:host_name` - (*required*, String)
       #     Name of the host where requests will be redirected.
-      #   * +:protocol+ - (String)
+      #   * `:protocol` - (String)
       #     Protocol to use (http, https) when redirecting requests. The
       #     default is the protocol that is used in the original request.
       # @option options [Hash] :index_document
-      #   * +:suffix+ - (*required*, String) - A suffix that is appended to
+      #   * `:suffix` - (*required*, String) - A suffix that is appended to
       #     a request that is for a directory on the website endpoint
       #     (e.g. if the suffix is index.html and you make a request to
       #     samplebucket/images/ the data that is returned will be for
@@ -36,18 +36,18 @@ module AWS
       #     The suffix must not be empty and must not include a
       #     slash character.
       # @option options [Hash] :error_document
-      #   * +:key+ - (*required*, String) - The object key name to use
+      #   * `:key` - (*required*, String) - The object key name to use
       #     when a 4XX class error occurs.
       # @option options [Array<Hash>] :routing_rules
-      #   * +:redirect+ - (*required*, Hash)
-      #     * +:host_name+ - (String)
-      #     * +:protocol+ - (String)
-      #     * +:replace_key_prefix_with+ - (String)
-      #     * +:replace_key_with+ - (String)
-      #     * +:http_redirect_code+ - (String)
-      #   * +:condition+ - (Hash)
-      #     * +:key_prefix_equals+ - (String)
-      #     * +:http_error_code_returned_equals+ - (String)
+      #   * `:redirect` - (*required*, Hash)
+      #     * `:host_name` - (String)
+      #     * `:protocol` - (String)
+      #     * `:replace_key_prefix_with` - (String)
+      #     * `:replace_key_with` - (String)
+      #     * `:http_redirect_code` - (String)
+      #   * `:condition` - (Hash)
+      #     * `:key_prefix_equals` - (String)
+      #     * `:http_error_code_returned_equals` - (String)
       def initialize options = {}
         @options = deep_copy(options)
         if @options.empty?

data/lib/aws/simple_db.rb

@@ -18,30 +18,30 @@ module AWS
 
   # This class is the starting point for working with Amazon SimpleDB.
   #
-  # To use Amazon SimpleDB you must first 
-  # {sign up here}[http://aws.amazon.com/simpledb/].
+  # To use Amazon SimpleDB you must first
+  # [sign up here](http://aws.amazon.com/simpledb/).
   #
   # For more information about Amazon SimpleDB:
   #
-  # * {Amazon SimpleDB}[http://aws.amazon.com/simpledb/]
-  # * {Amazon SimpleDB Documentation}[http://aws.amazon.com/documentation/simpledb/]
+  # * [Amazon SimpleDB](http://aws.amazon.com/simpledb/)
+  # * [Amazon SimpleDB Documentation](http://aws.amazon.com/documentation/simpledb/)
   #
-  # = Credentials
+  # # Credentials
   #
-  # You can setup default credentials for all AWS services via 
+  # You can setup default credentials for all AWS services via
   # AWS.config:
   #
-  #   AWS.config(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
-  # 
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
   # Or you can set them directly on the SimpleDB interface:
   #
-  #   sdb = AWS::SimpleDB.new(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #     sdb = AWS::SimpleDB.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
   #
-  # = Understanding the SimpleDB Interface
+  # # Understanding the SimpleDB Interface
   #
   # SimpleDB stores data in a hierarchy of:
   #
@@ -49,66 +49,66 @@ module AWS
   #
   # These are modeled with the following classes:
   #
-  # * {DomainCollection} 
-  # * {Domain} 
-  # * {ItemCollection} 
-  # * {Item} 
-  # * {AttributeCollection} 
-  # * {Attribute} 
+  # * {DomainCollection}
+  # * {Domain}
+  # * {ItemCollection}
+  # * {Item}
+  # * {AttributeCollection}
+  # * {Attribute}
   #
   # The collection classes listed above make it easy to enumerate,
   # the objects they represent.  They also make it easy to perform
   # bulk operations on all objects in that collection.
   #
-  # = Domains
+  # # Domains
   #
   # Domains are like database tables.  A domain must exist before you can
   # write to it.  To create a domain:
   #
-  #   sdb = SimpleDB.new
-  #   domain = sdb.domains.create('mydomain')
+  #     sdb = SimpleDB.new
+  #     domain = sdb.domains.create('mydomain')
   #
   # For more information about working with domains see {DomainCollection}
   # and {Domain}.
   #
-  # = Items & Attributes
+  # # Items & Attributes
   #
-  # Items exist in SimpleDB when they have attributes.  You can delete an 
+  # Items exist in SimpleDB when they have attributes.  You can delete an
   # item by removing all of its attributes.  You create an item by adding
   # an attribute to it.
   #
   # The following example illustrates how you can reference an item that
   # does not exist yet:
   #
-  #   sdb = SimpleDB.new
+  #     sdb = SimpleDB.new
   #
-  #   # this domain is empty, it has no items
-  #   domain = sdb.domains.create('newdomain')
-  #   domain.items.collect(&:name)
-  #   #=> []
+  #     # this domain is empty, it has no items
+  #     domain = sdb.domains.create('newdomain')
+  #     domain.items.collect(&:name)
+  #     #=> []
   #
-  #   # this item doesn't exist yet, so it has no attributes
-  #   item = domain.items['newitem']
-  #   item.attributes.collect(&:name)
-  #   #=> []
+  #     # this item doesn't exist yet, so it has no attributes
+  #     item = domain.items['newitem']
+  #     item.attributes.collect(&:name)
+  #     #=> []
   #
-  #   # the item has no attributes
-  #   tags = item.attributes['tags']
-  #   tags.values
-  #   #=> []
+  #     # the item has no attributes
+  #     tags = item.attributes['tags']
+  #     tags.values
+  #     #=> []
   #
   # To create the item in SimpleDB you just need to add an attribute.
   #
-  #   tags.add %w(first new)
+  #     tags.add %w(first new)
   #
-  #   domain.items.collect(&:name)
-  #   #=> ['newitem']
+  #     domain.items.collect(&:name)
+  #     #=> ['newitem']
   #
-  #   item.attributes.collect(&:name)
-  #   #=> ['tags']
+  #     item.attributes.collect(&:name)
+  #     #=> ['tags']
   #
-  #   tags.values
-  #   #=> ['first', 'new']
+  #     tags.values
+  #     #=> ['first', 'new']
   #
   # For more information about working with items and attributes, see:
   #
@@ -117,53 +117,53 @@ module AWS
   # * {AttributeCollection}
   # * {Attribute}
   #
-  # = Lazy Execution
+  # # Lazy Execution
   #
   # Requests are not made until necessary.  This means you can drill down
   # all the way to an attribute, by name, without making any requests
   # to SimpleDB.
   #
-  #   # makes no request to SimpleDB
-  #   sdb = SimpleDB.new
-  #   colors = sdb.domains['mydomain'].items['car'].attributes['colors']
+  #     # makes no request to SimpleDB
+  #     sdb = SimpleDB.new
+  #     colors = sdb.domains['mydomain'].items['car'].attributes['colors']
   #
-  #   # one request to get the values for 'colors'
-  #   puts colors.values
+  #     # one request to get the values for 'colors'
+  #     puts colors.values
   #
-  #   # one request to add blue and green
-  #   colors.add 'blue', 'green'
+  #     # one request to add blue and green
+  #     colors.add 'blue', 'green'
   #
-  #   # one request to delete the colors attribute
-  #   colors.delete
+  #     # one request to delete the colors attribute
+  #     colors.delete
   #
   # @!attribute [r] client
   #   @return [Client] the low-level SimpleDB client object
   class SimpleDB
 
-    AWS.register_autoloads(self, 'aws/simple_db') do
-      autoload :Attribute,             'attribute'
-      autoload :AttributeCollection,   'attribute_collection'
-      autoload :Client,                'client'
-      autoload :ConsistentReadOption,  'consistent_read_option'
-      autoload :DeleteAttributes,      'delete_attributes'
-      autoload :Domain,                'domain'
-      autoload :DomainCollection,      'domain_collection'
-      autoload :DomainMetadata,        'domain_metadata'
-      autoload :Errors,                'errors' 
-      autoload :ExpectConditionOption, 'expect_condition_option'
-      autoload :Item,                  'item'
-      autoload :ItemCollection,        'item_collection'
-      autoload :ItemData,              'item_data'
-      autoload :PutAttributes,         'put_attributes'
-      autoload :Request,               'request'
-    end
+    autoload :Attribute, 'aws/simple_db/attribute'
+    autoload :AttributeCollection, 'aws/simple_db/attribute_collection'
+    autoload :Client, 'aws/simple_db/client'
+    autoload :ConsistentReadOption, 'aws/simple_db/consistent_read_option'
+    autoload :DeleteAttributes, 'aws/simple_db/delete_attributes'
+    autoload :Domain, 'aws/simple_db/domain'
+    autoload :DomainCollection, 'aws/simple_db/domain_collection'
+    autoload :DomainMetadata, 'aws/simple_db/domain_metadata'
+    autoload :Errors, 'aws/simple_db/errors'
+    autoload :ExpectConditionOption, 'aws/simple_db/expect_condition_option'
+    autoload :Item, 'aws/simple_db/item'
+    autoload :ItemCollection, 'aws/simple_db/item_collection'
+    autoload :ItemData, 'aws/simple_db/item_data'
+    autoload :PutAttributes, 'aws/simple_db/put_attributes'
+    autoload :Request, 'aws/simple_db/request'
 
     include Core::ServiceInterface
 
+    endpoint_prefix 'sdb'
+
     # Returns a collection object that represents the domains in your
     # account.
     #
-    # @return [DomainCollection] Returns a collection representing all your 
+    # @return [DomainCollection] Returns a collection representing all your
     #   domains.
     def domains
       DomainCollection.new(:config => config)
@@ -172,22 +172,22 @@ module AWS
     # Call this method with a block.  Code executed inside the block
     # make consistent reads until the block ends.
     #
-    #   AWS::SimpleDB.consistent_reads do
-    #     # ...
-    #   end
+    #     AWS::SimpleDB.consistent_reads do
+    #       # ...
+    #     end
     #
-    # === Other Modes
+    # ### Other Modes
     #
     # You can also use this same function to disable consistent reads inside
-    # a block.  This is useful if you have consistent reads enabled by 
+    # a block.  This is useful if you have consistent reads enabled by
     # default:
     #
-    #   AWS::SimpleDB.consistent_reads(false) do
-    #     # ...
-    #   end
-    # 
+    #     AWS::SimpleDB.consistent_reads(false) do
+    #       # ...
+    #     end
+    #
     # @param [Boolean] state (true) When true, all SimpleDB read operations
-    #   will be consistent reads inside the block.  When false, all 
+    #   will be consistent reads inside the block.  When false, all
     #   reads operations will not be consistent reads.  The previous state
     #   will be restored after the block executes.
     # @return Returns the final block value.

data/lib/aws/simple_db/attribute.rb

@@ -39,9 +39,11 @@ module AWS
       # Sets all values for this attribute, replacing current values.
       #
       # @example Setting a list of values
+      #
       #   attributes['colors'].set 'red', 'blue', 'green'
       #
       # @example Setting an array of values
+      #
       #   attributes['colors'].set ['red', 'blue']
       #
       # @param [String] values A list of attribute values to set.
@@ -51,7 +53,7 @@ module AWS
         nil
       end
 
-      # Appends values to this attribute.  Duplicate values are ignored 
+      # Appends values to this attribute.  Duplicate values are ignored
       # by SimpleDB.
       #
       # @example Adding a list of values
@@ -81,7 +83,7 @@ module AWS
       #   item.attributes['color'].delete('red', 'blue')
       #
       # @param values One ore more values to remove from this attribute.
-      #   If values is empty, then all attribute values are deleted 
+      #   If values is empty, then all attribute values are deleted
       #   (which deletes this attribute).
       # @return [nil]
       def delete *values
@@ -96,14 +98,14 @@ module AWS
         nil
       end
 
-      # Yields once for each value on this attribute. 
+      # Yields once for each value on this attribute.
       #
       # @yield [attribute_value] Yields once for each domain in the account.
       # @yieldparam [String] attribute_value
-      # @param [Hash] options 
+      # @param [Hash] options
       # @option options [Boolean] :consistent_read (false) A consistent read
       #   returns values that reflects all writes that received a successful
-      #   response prior to the read. 
+      #   response prior to the read.
       # @return [nil]
       def each options = {}, &block
 
@@ -127,10 +129,10 @@ module AWS
       #   item.attributes['ratings'].values
       #   #=> ['5', '3', '4']
       #
-      # @param [Hash] options 
+      # @param [Hash] options
       # @option options [Boolean] :consistent_read (false) A consistent read
       #   returns values that reflects all writes that received a successful
-      #   response prior to the read. 
+      #   response prior to the read.
       # @return [Array<String>] An array of attribute values
       def values options = {}
         values = []