aws-sdk 1.8.5 → 1.9.0

data/lib/aws/route_53/hosted_zone.rb

@@ -14,10 +14,10 @@
 module AWS
   class Route53
 
-    # = Delete existing hosted zone
+    # # Delete existing hosted zone
     #
-    #   hosted_zone = AWS::Route53::HostedZone.new(hosted_zone_id)
-    #   hosted_zone.delete
+    #     hosted_zone = AWS::Route53::HostedZone.new(hosted_zone_id)
+    #     hosted_zone.delete
     #
     # @attr_reader [String] name The hosted zone name.
     #
@@ -84,7 +84,7 @@ module AWS
         end
       end
 
-      # @return [Boolean] Returns +true+ if this hosted zone exists.
+      # @return [Boolean] Returns `true` if this hosted zone exists.
       def exists?
         get_resource.data[:hosted_zone][:id] == path
       end

data/lib/aws/route_53/hosted_zone_collection.rb

@@ -16,15 +16,15 @@ require 'time'
 module AWS
   class Route53
 
-    # = Create new hosted zone
+    # # Create new hosted zone
     #
-    #   r53 = AWS::Route53.new
-    #   hosted_zone = r53.hosted_zones.create('example.com.')
+    #     r53 = AWS::Route53.new
+    #     hosted_zone = r53.hosted_zones.create('example.com.')
     #
-    # = Find existing hosted zone
+    # # Find existing hosted zone
     #
-    #   r53 = AWS::Route53.new
-    #   hosted_zone = r53.hosted_zones['example.com.']
+    #     r53 = AWS::Route53.new
+    #     hosted_zone = r53.hosted_zones['example.com.']
     #
     class HostedZoneCollection
 
@@ -83,7 +83,7 @@ module AWS
         resp.data[:hosted_zones].each do |details|
           hosted_zone = HostedZone.new_from(
             :list_hosted_zones,
-            details, 
+            details,
             details[:id],
             :config => config)
 

data/lib/aws/route_53/resource_record_set.rb

@@ -14,18 +14,18 @@
 module AWS
   class Route53
 
-    # = Modify resource record set
+    # # Modify resource record set
     #
-    #   rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
-    #   rrset = rrsets['foo.example.com.', 'A']
-    #   rrset.ttl = 3600
-    #   rrset.update
+    #     rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
+    #     rrset = rrsets['foo.example.com.', 'A']
+    #     rrset.ttl = 3600
+    #     rrset.update
     #
-    # = Delete existing resource record set
+    # # Delete existing resource record set
     #
-    #   rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
-    #   rrset = rrsets['foo.example.com.', 'A']
-    #   rrset.delete
+    #     rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
+    #     rrset = rrsets['foo.example.com.', 'A']
+    #     rrset.delete
     #
     # @attr_reader [Hash] alias_target
     #
@@ -137,7 +137,7 @@ module AWS
         }
       end
 
-      # @return [Boolean] Returns +true+ if this rrset exists.
+      # @return [Boolean] Returns `true` if this rrset exists.
       def exists?
         !get_resource.data[:resource_record_sets].find { |details|
           if set_identifier

data/lib/aws/route_53/resource_record_set_collection.rb

@@ -16,15 +16,15 @@ require 'time'
 module AWS
   class Route53
 
-    # = Create new resource record set
+    # # Create new resource record set
     #
-    #   rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
-    #   rrset = rrsets.create('foo.example.com.', 'A', :ttl => 300, :resource_records => [{:value => '127.0.0.1'}])
+    #     rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
+    #     rrset = rrsets.create('foo.example.com.', 'A', :ttl => 300, :resource_records => [{:value => '127.0.0.1'}])
     #
-    # = Find existing resource record set
+    # # Find existing resource record set
     #
-    #   rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
-    #   rrset = rrsets['foo.example.com.', 'A']
+    #     rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
+    #     rrset = rrsets['foo.example.com.', 'A']
     #
     class ResourceRecordSetCollection
 

data/lib/aws/s3.rb

@@ -18,134 +18,134 @@ module AWS
 
   # Provides an expressive, object-oriented interface to Amazon S3.
   #
-  # To use Amazon S3 you must first 
-  # {sign up here}[http://aws.amazon.com/s3/].
+  # To use Amazon S3 you must first
+  # [sign up here](http://aws.amazon.com/s3/).
   #
   # For more information about Amazon S3, see:
   #
-  # * {Amazon S3}[http://aws.amazon.com/s3/]
-  # * {Amazon S3 Documentation}[http://aws.amazon.com/documentation/s3/]
+  # * [Amazon S3](http://aws.amazon.com/s3/)
+  # * [Amazon S3 Documentation](http://aws.amazon.com/documentation/s3/)
   #
-  # = 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 S3 interface:
   #
-  #   s3 = AWS::S3.new(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #     s3 = AWS::S3.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
   #
-  # = Buckets
+  # # Buckets
   #
   # Before you can upload files to S3, you need to create a bucket.
   #
-  #   s3 = AWS::S3.new
-  #   bucket = s3.buckets.create('my-bucket')
+  #     s3 = AWS::S3.new
+  #     bucket = s3.buckets.create('my-bucket')
   #
   # If a bucket already exists, you can get a reference to the bucket.
   #
-  #   bucket = s3.buckets['my-bucket'] # no request made
+  #     bucket = s3.buckets['my-bucket'] # no request made
   #
   # You can also enumerate all buckets in your account.
   #
-  #   s3.buckets.each do |bucket|
-  #     puts bucket.name
-  #   end
+  #     s3.buckets.each do |bucket|
+  #       puts bucket.name
+  #     end
   #
-  # See {BucketCollection} and {Bucket} for more information on working 
+  # See {BucketCollection} and {Bucket} for more information on working
   # with buckets.
   #
-  # = Objects
+  # # Objects
   #
   # Buckets contain objects.  Each object in a bucket has a unique key.
   #
-  # == Getting an Object
+  # ## Getting an Object
   #
   # If the object already exists, you can get a reference to the object.
   #
-  #   # makes no request, returns an AWS::S3::S3Object
-  #   obj = bucket.objects['key']
+  #     # makes no request, returns an AWS::S3::S3Object
+  #     obj = bucket.objects['key']
   #
-  # == Reading and Writing an Object
+  # ## Reading and Writing an Object
   #
-  # The example above returns an {S3Object}.  You call {S3Object#write} and 
+  # The example above returns an {S3Object}.  You call {S3Object#write} and
   # {S3Object#read} to upload to and download from S3 respectively.
   #
-  #   # streaming upload a file to S3
-  #   obj.write(Pathname.new('/path/to/file.txt'))
+  #     # streaming upload a file to S3
+  #     obj.write(Pathname.new('/path/to/file.txt'))
   #
-  #   # streaming download from S3 to a file on disk
-  #   File.open('file.txt', 'w') do |file|
-  #     obj.read do |chunk|
-  #        file.write(chunk)
+  #     # streaming download from S3 to a file on disk
+  #     File.open('file.txt', 'w') do |file|
+  #       obj.read do |chunk|
+  #          file.write(chunk)
+  #       end
   #     end
-  #   end
   #
-  # == Enumerating Objects
+  # ## Enumerating Objects
   #
   # You can enumerate objects in your buckets.
   #
-  #   # enumerate ALL objects in the bucket (even if the bucket contains 
-  #   # more than 1k objects)
-  #   bucket.objects.each do |obj|
-  #     puts obj.key
-  #   end
+  #     # enumerate ALL objects in the bucket (even if the bucket contains
+  #     # more than 1k objects)
+  #     bucket.objects.each do |obj|
+  #       puts obj.key
+  #     end
   #
-  #   # enumerate at most 20 objects with the given prefix
-  #   bucket.objects.with_prefix('photos/').each(:limit => 20) do |photo|
-  #     puts photo.key
-  #   end
+  #     # enumerate at most 20 objects with the given prefix
+  #     bucket.objects.with_prefix('photos/').each(:limit => 20) do |photo|
+  #       puts photo.key
+  #     end
   #
   # See {ObjectCollection} and {S3Object} for more information on working
   # with objects.
   #
   class S3
 
-    AWS.register_autoloads(self) do
-      autoload :AccessControlList,            'access_control_list'
-      autoload :ACLObject,                    'acl_object'
-      autoload :ACLOptions,                   'acl_options'
-      autoload :Bucket,                       'bucket'
-      autoload :BucketCollection,             'bucket_collection'
-      autoload :BucketTagCollection,          'bucket_tag_collection'
-      autoload :BucketLifecycleConfiguration, 'bucket_lifecycle_configuration'
-      autoload :BucketVersionCollection,      'bucket_version_collection'
-      autoload :Client,                       'client'
-      autoload :CORSRule,                     'cors_rule'
-      autoload :CORSRuleCollection,           'cors_rule_collection'
-      autoload :DataOptions,                  'data_options'
-      autoload :EncryptionUtils,              'encryption_utils'
-      autoload :CipherIO,                     'cipher_io'
-      autoload :Errors,                       'errors'
-      autoload :MultipartUpload,              'multipart_upload'
-      autoload :MultipartUploadCollection,    'multipart_upload_collection'
-      autoload :ObjectCollection,             'object_collection'
-      autoload :ObjectMetadata,               'object_metadata'
-      autoload :ObjectUploadCollection,       'object_upload_collection'
-      autoload :ObjectVersion,                'object_version'
-      autoload :ObjectVersionCollection,      'object_version_collection'
-      autoload :PaginatedCollection,          'paginated_collection'
-      autoload :Policy,                       'policy'
-      autoload :PrefixAndDelimiterCollection, 'prefix_and_delimiter_collection'
-      autoload :PrefixedCollection,           'prefixed_collection'
-      autoload :PresignedPost,                'presigned_post'
-      autoload :Request,                      'request'
-      autoload :S3Object,                     's3_object'
-      autoload :Tree,                         'tree'
-      autoload :UploadedPart,                 'uploaded_part'
-      autoload :UploadedPartCollection,       'uploaded_part_collection'
-      autoload :WebsiteConfiguration,         'website_configuration'
-    end
+    autoload :AccessControlList, 'aws/s3/access_control_list'
+    autoload :ACLObject, 'aws/s3/acl_object'
+    autoload :ACLOptions, 'aws/s3/acl_options'
+    autoload :Bucket, 'aws/s3/bucket'
+    autoload :BucketCollection, 'aws/s3/bucket_collection'
+    autoload :BucketTagCollection, 'aws/s3/bucket_tag_collection'
+    autoload :BucketLifecycleConfiguration, 'aws/s3/bucket_lifecycle_configuration'
+    autoload :BucketVersionCollection, 'aws/s3/bucket_version_collection'
+    autoload :Client, 'aws/s3/client'
+    autoload :CORSRule, 'aws/s3/cors_rule'
+    autoload :CORSRuleCollection, 'aws/s3/cors_rule_collection'
+    autoload :DataOptions, 'aws/s3/data_options'
+    autoload :EncryptionUtils, 'aws/s3/encryption_utils'
+    autoload :CipherIO, 'aws/s3/cipher_io'
+    autoload :Errors, 'aws/s3/errors'
+    autoload :MultipartUpload, 'aws/s3/multipart_upload'
+    autoload :MultipartUploadCollection, 'aws/s3/multipart_upload_collection'
+    autoload :ObjectCollection, 'aws/s3/object_collection'
+    autoload :ObjectMetadata, 'aws/s3/object_metadata'
+    autoload :ObjectUploadCollection, 'aws/s3/object_upload_collection'
+    autoload :ObjectVersion, 'aws/s3/object_version'
+    autoload :ObjectVersionCollection, 'aws/s3/object_version_collection'
+    autoload :PaginatedCollection, 'aws/s3/paginated_collection'
+    autoload :Policy, 'aws/s3/policy'
+    autoload :PrefixAndDelimiterCollection, 'aws/s3/prefix_and_delimiter_collection'
+    autoload :PrefixedCollection, 'aws/s3/prefixed_collection'
+    autoload :PresignedPost, 'aws/s3/presigned_post'
+    autoload :Request, 'aws/s3/request'
+    autoload :S3Object, 'aws/s3/s3_object'
+    autoload :Tree, 'aws/s3/tree'
+    autoload :UploadedPart, 'aws/s3/uploaded_part'
+    autoload :UploadedPartCollection, 'aws/s3/uploaded_part_collection'
+    autoload :WebsiteConfiguration, 'aws/s3/website_configuration'
 
     include Core::ServiceInterface
 
-    # @return [BucketCollection] Returns a collection that represents all 
+    endpoint_prefix 's3'
+
+    # @return [BucketCollection] Returns a collection that represents all
     #  buckets in the account.
     def buckets
       BucketCollection.new(:config => @config)

data/lib/aws/s3/access_control_list.rb

@@ -16,20 +16,20 @@ module AWS
 
     # Represents an access control list for S3 objects and buckets.  For example:
     #
-    #   acl = AccessControlList.new
-    #   acl.grant(:full_control).
-    #     to(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
-    #   acl.to_xml                   # => '<AccessControlPolicy>...'
+    #     acl = AccessControlList.new
+    #     acl.grant(:full_control).
+    #       to(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
+    #     acl.to_xml                   # => '<AccessControlPolicy>...'
     #
     # You can also construct an AccessControlList from a hash:
     #
-    #   AccessControlList.new(
-    #     :owner => { :id => "8a6925ce4adf588a4f21c32aa379004fef" },
-    #     :grants => [{ :grantee => {
-    #                     :canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef",
-    #                   },
-    #                   :permission => :full_control }]
-    #   )
+    #     AccessControlList.new(
+    #       :owner => { :id => "8a6925ce4adf588a4f21c32aa379004fef" },
+    #       :grants => [{
+    #         :grantee => { :canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef" },
+    #         :permission => :full_control,
+    #       }]
+    #     )
     #
     # @see ACLObject
     #
@@ -40,9 +40,11 @@ module AWS
     #
     # @attr [list of AccessControlList::Grant] grants The list of
     #   grants.  You can set this as a list of hashes, for example:
-    #    acl.grants = [{ :grantee => { :canonical_user_id =>
-    #                                  "8a6925ce4adf588a4f21c32aa379004fef" },
-    #                    :permission => :full_control }]
+    #
+    #       acl.grants = [{
+    #         :grantee => { :canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef" },
+    #         :permission => :full_control,
+    #       }]
     class AccessControlList
 
       # Represents an ACL owner.  In the default ACL, this is the
@@ -67,22 +69,25 @@ module AWS
       #   you read an ACL from S3, all grantees will be identified
       #   this way, and the display_name attribute will also be provided.
       #
-      #    Grantee.new(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
+      #       Grantee.new(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
       #
       # * You can specify the e-mail address of an AWS customer, for example:
-      #    Grantee.new(:amazon_customer_email => 'foo@example.com')
+      #
+      #       Grantee.new(:amazon_customer_email => 'foo@example.com')
       #
       # * You can specify a group URI, for example:
-      #    Grantee.new(:group_uri => 'http://acs.amazonaws.com/groups/global/AllUsers')
+      #
+      #        Grantee.new(:group_uri => 'http://acs.amazonaws.com/groups/global/AllUsers')
+      #
       #   For more details about group URIs, see:
       #   http://docs.amazonwebservices.com/AmazonS3/latest/dev/ACLOverview.html
       #
       # When constructing a grantee, you must provide a value for
       # exactly one of the following attributes:
       #
-      # * +amazon_customer_email+
-      # * +canonical_user_id+
-      # * +group_uri+
+      # * `amazon_customer_email`
+      # * `canonical_user_id`
+      # * `group_uri`
       #
       # @attr [String] amazon_customer_email The e-mail address of
       #   an AWS customer.
@@ -137,7 +142,7 @@ module AWS
 
         # @private
         def type_for_attr(attr)
-          { 
+          {
             :amazon_customer_email => "AmazonCustomerByEmail",
             :canonical_user_id => "CanonicalUser",
             :group_uri => "Group",
@@ -156,7 +161,7 @@ module AWS
 
         # The permission expressed as a symbol following Ruby
         # conventions.  For example, S3's FULL_CONTROL permission
-        # will be returned as +:full_control+.
+        # will be returned as `:full_control`.
         attr_reader :name
 
         # @private
@@ -172,8 +177,8 @@ module AWS
 
       end
 
-      # Represents a single grant in an ACL.  Both +grantee+ and
-      # +permission+ are required for each grant when setting an
+      # Represents a single grant in an ACL.  Both `grantee` and
+      # `permission` are required for each grant when setting an
       # ACL.
       #
       # See
@@ -184,15 +189,16 @@ module AWS
       # @attr [Grantee] grantee The user or users who are granted
       #   access according to this grant.  You can specify this as a
       #   hash:
-      #     grant.grantee = { :amazon_customer_email => "foo@example.com" }
+      #
+      #       grant.grantee = { :amazon_customer_email => "foo@example.com" }
       #
       # @attr [Permission or Symbol] permission The type of
       #   permission that is granted by this grant.  Valid values are:
-      #   * +:read+
-      #   * +:write+
-      #   * +:read_acp+
-      #   * +:write_acp+
-      #   * +:full_control+
+      #   * `:read`
+      #   * `:write`
+      #   * `:read_acp`
+      #   * `:write_acp`
+      #   * `:full_control`
       class Grant
 
         include ACLObject
@@ -226,7 +232,8 @@ module AWS
         #
         # @param [Grantee or Hash] grantee A Grantee object or hash;
         #   for example:
-        #    acl.grant(:full_control).to(:amazon_customer_email => "foo@example.com")
+        #
+        #       acl.grant(:full_control).to(:amazon_customer_email => "foo@example.com")
         def to(grantee)
           @grant.grantee = grantee
           @acl.grants << @grant
@@ -235,12 +242,13 @@ module AWS
       end
 
       # Convenience method for constructing a new grant and adding
-      # it to the ACL.  Example usage:
+      # it to the ACL.
+      #
+      # @example
       #
-      #   acl.grants.size               # => 0
-      #   acl.grant(:full_control).
-      #     to(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
-      #   acl.grants.size               # => 1
+      #   acl.grants.size # => 0
+      #   acl.grant(:full_control).to(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
+      #   acl.grants.size # => 1
       #
       # @return [GrantBuilder]
       def grant(permission)