aws-sdk 1.8.5 → 1.9.0

data/lib/aws/simple_db/item_data.rb

@@ -20,12 +20,12 @@ module AWS
     # list of items whose titles are palindromes using only a single
     # request to SimpleDB (not counting pagination):
     #
-    #  items.enum_for(:select).
-    #    select { |data| data.title == data.title.to_s.reverse }.
-    #    map { |data| data.item }
+    #     items.enum_for(:select).
+    #       select { |data| data.title == data.title.to_s.reverse }.
+    #       map { |data| data.item }
     #
     # The {ItemCollection#select} call yields instances of ItemData,
-    # and the +map+ call in the example above gets the list of
+    # and the `map` call in the example above gets the list of
     # corresponding {Item} instances.
     class ItemData
 

data/lib/aws/simple_db/put_attributes.rb

@@ -27,9 +27,9 @@ module AWS
         attribute_hashes = []
         attributes.each_pair do |attribute_name,values|
           [values].flatten.each do |value|
-            attribute_hashes << { 
-              :name => attribute_name.to_s, 
-              :value => value.to_s, 
+            attribute_hashes << {
+              :name => attribute_name.to_s,
+              :value => value.to_s,
               :replace => replace,
             } unless [:if, :unless].include?(attribute_name)
           end

data/lib/aws/simple_email_service.rb

@@ -15,34 +15,34 @@ require 'aws/core'
 require 'aws/simple_email_service/config'
 
 module AWS
-  
-  # This class is the starting point for working with Amazon 
+
+  # This class is the starting point for working with Amazon
   # SimpleEmailService (SES).
   #
-  # To use Amazon SimpleEmailService you must first 
-  # {sign up here}[http://aws.amazon.com/ses/]
+  # To use Amazon SimpleEmailService you must first
+  # [sign up here](http://aws.amazon.com/ses/)
   #
   # For more information about Amazon SimpleEmailService:
   #
-  # * {Amazon SimpleEmailService}[http://aws.amazon.com/ses/]
-  # * {Amazon SimpleEmailService Documentation}[http://aws.amazon.com/documentation/ses/]
+  # * [Amazon SimpleEmailService](http://aws.amazon.com/ses/)
+  # * [Amazon SimpleEmailService Documentation](http://aws.amazon.com/documentation/ses/)
   #
-  # = 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 SimpleEmailService interface:
   #
-  #   ses = AWS::SimpleEmailService.new(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #     ses = AWS::SimpleEmailService.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
   #
-  # = Rails
+  # # Rails
   #
   # If you want to use Amazon SimpleEmailService to send email from your
   # Rails application you just need to do 2 things:
@@ -50,140 +50,140 @@ module AWS
   # 1. Configure your AWS credentials with {AWS.config}
   # 2. Set SES as the delivery method:
   #
-  #   config.action_mailer.delivery_method = :amazon_ses
+  #     config.action_mailer.delivery_method = :amazon_ses
   #
   # This has only been tested with Rails 2.3 and Rails 3.0.
   #
   #
-  # = Identities
+  # # Identities
   #
   # Before you can send emails, you need to verify one or more identities.
   # Identities are email addresses or domain names that you have control over.
-  # Until you have {requested production access}[http://docs.amazonwebservices.com/ses/latest/DeveloperGuide/InitialSetup.Customer.html]
-  # you will only be able to send emails to and from verified email addresses 
+  # Until you have [requested production access](http://docs.amazonwebservices.com/ses/latest/DeveloperGuide/InitialSetup.Customer.html)
+  # you will only be able to send emails to and from verified email addresses
   # and domains.
   #
-  # == Verifying Email Addresses
+  # ## Verifying Email Addresses
   #
   # You can verify an email address for sending/receiving emails using
   # the identities collection.
   #
-  #   identity = ses.identities.verify('email@yourdomain.com')
-  #   identity.verified? #=> false
+  #     identity = ses.identities.verify('email@yourdomain.com')
+  #     identity.verified? #=> false
   #
   # You will be sent an email address with a link.  Follow the link to
   # verify the email address.
   #
-  # == Verifying Domains
+  # ## Verifying Domains
   #
   # You can also verify an entire domain for sending and receiving emails.
-  # 
-  #   identity = ses.identities.verify('yourdomain.com')
-  #   identity.verification_token
-  #   #=> "216D+lZbhUL0zOoAkC83/0TAl5lJSzLmzsOjtXM7AeM="
+  #
+  #     identity = ses.identities.verify('yourdomain.com')
+  #     identity.verification_token
+  #     #=> "216D+lZbhUL0zOoAkC83/0TAl5lJSzLmzsOjtXM7AeM="
   #
   # You will be expected to update the DNS records for your domain with
   # the given verification token.  See the service documentation for
   # more details.
   #
-  # == Listing Identities
-  # 
+  # ## Listing Identities
+  #
   # You can enumerate all identities:
   #
-  #   ses.identities.map(&:identity)
-  #   #=> ['email@foo.com', 'somedomain.com']
+  #     ses.identities.map(&:identity)
+  #     #=> ['email@foo.com', 'somedomain.com']
   #
   # You can filter the types of identities enumerated:
   #
-  #   domains = ses.identities.domains.map(&:identity)
-  #   email_addresses = ses.identities.email_addresses.map(&:identity)
+  #     domains = ses.identities.domains.map(&:identity)
+  #     email_addresses = ses.identities.email_addresses.map(&:identity)
   #
   # You can get the verification status and token from identities as well.
   #
-  #   # for an email address
-  #   identity = ses.identities['youremail@yourdomain.com']
-  #   identity.verified? #=> true/false
+  #     # for an email address
+  #     identity = ses.identities['youremail@yourdomain.com']
+  #     identity.verified? #=> true/false
   #
-  #   # for a domain
-  #   identity = ses.identities['yourdomain.com']
-  #   identity.verified? #=> true/false
-  #   identity.verification_token #=> '...'
+  #     # for a domain
+  #     identity = ses.identities['yourdomain.com']
+  #     identity.verified? #=> true/false
+  #     identity.verification_token #=> '...'
   #
-  # = Sending Email
+  # # Sending Email
   #
   # To send a basic email you can use {#send_email}.
   #
-  #   ses.send_email(
-  #     :subject => 'A Sample Email',
-  #     :from => 'sender@domain.com',
-  #     :to => 'receipient@domain.com',
-  #     :body_text => 'Sample email text.',
-  #     :body_html => '<h1>Sample Email</h1>') 
+  #     ses.send_email(
+  #       :subject => 'A Sample Email',
+  #       :from => 'sender@domain.com',
+  #       :to => 'receipient@domain.com',
+  #       :body_text => 'Sample email text.',
+  #       :body_html => '<h1>Sample Email</h1>')
   #
   # If you need to send email with attachments or have other special needs
   # that send_email does not support you can use {#send_raw_email}.
   #
-  #   ses.send_raw_email(<<EMAIL)
-  #   Subject: A Sample Email
-  #   From: sender@domain.com
-  #   To: receipient@domain.com
+  #     ses.send_raw_email(<<EMAIL)
+  #     Subject: A Sample Email
+  #     From: sender@domain.com
+  #     To: receipient@domain.com
   #
-  #   Sample email text.
-  #   EMAIL
+  #     Sample email text.
+  #     EMAIL
   #
   # If you prefer, you can also set the sender and recipient in ruby
   # when sending raw emails:
   #
-  #   ses.send_raw_email(<<EMAIL, :to => 'to@foo.com', :from => 'from@foo.com')
-  #   Subject: A Sample Email
+  #     ses.send_raw_email(<<EMAIL, :to => 'to@foo.com', :from => 'from@foo.com')
+  #     Subject: A Sample Email
   #
-  #   Sample email text.
-  #   EMAIL
+  #     Sample email text.
+  #     EMAIL
   #
-  # = Quotas
+  # # Quotas
   #
   # Based on several factors, Amazon SES determines how much email you can
   # send and how quickly you can send it. These sending limits are defined
   # as follows:
   #
-  # * +:max_send_rate+ - Maximum number of emails you can send per second.
-  # * +:max_24_hour_send+ - Maximum number of emails you can send in a 
+  # * `:max_send_rate` - Maximum number of emails you can send per second.
+  # * `:max_24_hour_send` - Maximum number of emails you can send in a
   #   24-hour period.
   #
   # To get your current quotas (and how many emails you have sent in the last
   # 24 hours):
   #
-  #   ses.quotas
-  #   # => {:max_24_hour_send=>200, :max_send_rate=>1.0, :sent_last_24_hours=>22}
+  #     ses.quotas
+  #     # => {:max_24_hour_send=>200, :max_send_rate=>1.0, :sent_last_24_hours=>22}
   #
-  # = Statistics
+  # # Statistics
   #
   # You can get statistics about individual emails:
   #
-  #   ses.statistics.each do |stats|
-  #     puts "Sent: #{stats[:sent]}"
-  #     puts "Delivery Attempts: #{stats[:delivery_attempts]}"
-  #     puts "Rejects: #{stats[:rejects]}"
-  #     puts "Bounces: #{stats[:bounces]}"
-  #     puts "Complaints: #{stats[:complaints]}"
-  #   end
+  #     ses.statistics.each do |stats|
+  #       puts "Sent: #{stats[:sent]}"
+  #       puts "Delivery Attempts: #{stats[:delivery_attempts]}"
+  #       puts "Rejects: #{stats[:rejects]}"
+  #       puts "Bounces: #{stats[:bounces]}"
+  #       puts "Complaints: #{stats[:complaints]}"
+  #     end
   #
   # @!attribute [r] client
   #   @return [Client] the low-level SimpleEmailService client object
   class SimpleEmailService
 
-    AWS.register_autoloads(self, 'aws/simple_email_service') do
-      autoload :Client,                 'client'
-      autoload :Errors,                 'errors'
-      autoload :EmailAddressCollection, 'email_address_collection'
-      autoload :Identity,               'identity'
-      autoload :IdentityCollection,     'identity_collection'
-      autoload :Quotas,                 'quotas'
-      autoload :Request,                'request'
-    end
+    autoload :Client, 'aws/simple_email_service/client'
+    autoload :Errors, 'aws/simple_email_service/errors'
+    autoload :EmailAddressCollection, 'aws/simple_email_service/email_address_collection'
+    autoload :Identity, 'aws/simple_email_service/identity'
+    autoload :IdentityCollection, 'aws/simple_email_service/identity_collection'
+    autoload :Quotas, 'aws/simple_email_service/quotas'
+    autoload :Request, 'aws/simple_email_service/request'
 
     include Core::ServiceInterface
 
+    endpoint_prefix 'email'
+
     # @note This method is deprecated.  Use {#identities} instead.
     # @return [EmailAddressCollection] Returns a collection that represents
     #   all of the verified email addresses for your account.
@@ -196,24 +196,24 @@ module AWS
       IdentityCollection.new(:config => config)
     end
 
-    # Sends an email.  
+    # Sends an email.
     #
-    #   ses.send_email(
-    #     :subject => 'A Sample Email',
-    #     :to => 'john@doe.com', 
-    #     :from => 'no@reply.com',
-    #     :body_text => 'sample text ...',
-    #     :body_html => '<p>sample text ...</p>')
+    #     ses.send_email(
+    #       :subject => 'A Sample Email',
+    #       :to => 'john@doe.com',
+    #       :from => 'no@reply.com',
+    #       :body_text => 'sample text ...',
+    #       :body_html => '<p>sample text ...</p>')
     #
-    # You can also pass multiple email addresses for the +:to+, +:cc+, 
-    # +:bcc+ and +:reply_to+ options.  Email addresses can also be 
+    # You can also pass multiple email addresses for the `:to`, `:cc`,
+    # `:bcc` and `:reply_to` options.  Email addresses can also be
     # formatted with names.
     #
-    #   ses.send_email(
-    #     :subject => 'A Sample Email',
-    #     :to => ['"John Doe" <john@doe.com>', '"Jane Doe" <jane@doe.com>'],
-    #     :from => 'no@reply.com',
-    #     :body_text => 'sample text ...')
+    #     ses.send_email(
+    #       :subject => 'A Sample Email',
+    #       :to => ['"John Doe" <john@doe.com>', '"Jane Doe" <jane@doe.com>'],
+    #       :from => 'no@reply.com',
+    #       :body_text => 'sample text ...')
     #
     # @param [Hash] options
     # @option options [required,String] :subject The subject of the message.
@@ -226,28 +226,28 @@ module AWS
     # @option options [String,Array] :bcc The address(es) to bcc (blind
     #   carbon copy) the email to.
     # @option options [String,Array] :reply_to The reply-to email address(es)
-    #   for the message. If the recipient replies to the message, each 
+    #   for the message. If the recipient replies to the message, each
     #   reply-to address will receive the reply.
-    # @option options [String] :return_path The email address to which 
+    # @option options [String] :return_path The email address to which
     #   bounce notifications are to be forwarded. If the message cannot be
     #   delivered to the recipient, then an error message will be returned
     #   from the recipient's ISP; this message will then be forwarded to
-    #   the email address specified by the +:return_path+ option.
+    #   the email address specified by the `:return_path` option.
     # @option options [String] :body_text The email text contents.
-    #   You must provide +:body_text+, +:body_html+ or both.
+    #   You must provide `:body_text`, `:body_html` or both.
     # @option options [String] :body_html The email html contents.
-    #   You must provide +:body_text+, +:body_html+ or both.
-    # @option options [String] :subject_charset The character set of the 
-    #   +:subject+ string.  If the text must contain any other characters,
-    #   then you must also specify the character set. Examples include 
+    #   You must provide `:body_text`, `:body_html` or both.
+    # @option options [String] :subject_charset The character set of the
+    #   `:subject` string.  If the text must contain any other characters,
+    #   then you must also specify the character set. Examples include
     #   UTF-8, ISO-8859-1, and Shift_JIS. Defaults to 7-bit ASCII.
     # @option options [String] :body_text_charset The character set of the
-    #   +:body_text+ string.  If the text must contain any other characters,
-    #   then you must also specify the character set. Examples include 
+    #   `:body_text` string.  If the text must contain any other characters,
+    #   then you must also specify the character set. Examples include
     #   UTF-8, ISO-8859-1, and Shift_JIS. Defaults to 7-bit ASCII.
     # @option options [String] :body_html_charset The character set of the
-    #   +:body_html+ string.  If the text must contain any other characters,
-    #   then you must also specify the character set. Examples include 
+    #   `:body_html` string.  If the text must contain any other characters,
+    #   then you must also specify the character set. Examples include
     #   UTF-8, ISO-8859-1, and Shift_JIS. Defaults to 7-bit ASCII.
     # @option options [String] :body_html
     # @return [nil]
@@ -285,50 +285,50 @@ module AWS
 
     end
 
-    # Sends a raw email (email message, with header and content specified). 
+    # Sends a raw email (email message, with header and content specified).
     # Useful for sending multipart MIME emails.  The raw text of the message
-    # must comply with Internet email standards; otherwise, the message 
+    # must comply with Internet email standards; otherwise, the message
     # cannot be sent.
     #
-    #   raw = <<-EMAIL
-    #   Date: Wed, 1 Jun 2011 09:13:07 -0700
-    #   Subject: A Sample Email
-    #   From: "John Doe" <johndoe@domain.com>
-    #   To: "Jane Doe" <janedoe@domain.com>
-    #   Accept-Language: en-US
-    #   Content-Language: en-US
-    #   Content-Type: text/plain; charset="utf-8"
-    #   Content-Transfer-Encoding: base64
-    #   MIME-Version: 1.0
+    #     raw = <<-EMAIL
+    #     Date: Wed, 1 Jun 2011 09:13:07 -0700
+    #     Subject: A Sample Email
+    #     From: "John Doe" <johndoe@domain.com>
+    #     To: "Jane Doe" <janedoe@domain.com>
+    #     Accept-Language: en-US
+    #     Content-Language: en-US
+    #     Content-Type: text/plain; charset="utf-8"
+    #     Content-Transfer-Encoding: base64
+    #     MIME-Version: 1.0
     #
-    #   c2FtcGxlIHRleHQNCg==
-    #   EMAIL
+    #     c2FtcGxlIHRleHQNCg==
+    #     EMAIL
     #
-    #   ses.send_raw_email(raw)
+    #     ses.send_raw_email(raw)
     #
-    # Amazon SES has a limit on the total number of recipients per 
-    # message: The combined number of To:, CC: and BCC: email addresses 
-    # cannot exceed 50. If you need to send an email message to a larger 
-    # audience, you can divide your recipient list into groups of 50 or 
-    # fewer, and then call Amazon SES repeatedly to send the message to 
+    # Amazon SES has a limit on the total number of recipients per
+    # message: The combined number of To:, CC: and BCC: email addresses
+    # cannot exceed 50. If you need to send an email message to a larger
+    # audience, you can divide your recipient list into groups of 50 or
+    # fewer, and then call Amazon SES repeatedly to send the message to
     # each group.
     #
-    # @param [required, String] raw_message The raw text of the message. 
+    # @param [required, String] raw_message The raw text of the message.
     #   You can pass in any object whos #to_s returns a valid formatted
     #   email (e.g. ruby Mail gem).  The raw message should:
     #   * Contain a header and a body, separated by a blank line
     #   * Contain all required internet email headers
     #   * Each part of a multipart MIME message must be formatted properly
-    #   * MIME content types must be among those supported by Amazon SES. 
+    #   * MIME content types must be among those supported by Amazon SES.
     #     Refer to the Amazon SES Developer Guide for more details.
     #   * Use content that is base64-encoded, if MIME requires it
     # @option options [String,Array] :to One or more email addresses to
     #   send the email to.
-    # @option options [String] :from The sender's email address.  
-    #   If you specify the :from option, then bounce notifications and 
-    #   complaints will be sent to this email address. This takes 
-    #   precedence over any Return-Path header that you might include in 
-    #   the +raw_message+.
+    # @option options [String] :from The sender's email address.
+    #   If you specify the :from option, then bounce notifications and
+    #   complaints will be sent to this email address. This takes
+    #   precedence over any Return-Path header that you might include in
+    #   the `raw_message`.
     # @return [nil]
     def send_raw_email raw_message, options = {}
 
@@ -361,14 +361,14 @@ module AWS
       Quotas.new(:config => config).to_h
     end
 
-    # Returns an array of email statistics. Each object in this array is a 
+    # Returns an array of email statistics. Each object in this array is a
     # hash with the following keys:
     #
-    # * +:delivery_attempts+
-    # * +:rejects+
-    # * +:bounces+
-    # * +:complaints+
-    # * +:timestamp+
+    # * `:delivery_attempts`
+    # * `:rejects`
+    # * `:bounces`
+    # * `:complaints`
+    # * `:timestamp`
     #
     # @return [Array of Hashes] An array of email statistic hashes.
     def statistics
@@ -389,7 +389,7 @@ module AWS
     def require_one_of options, *keys
       unless keys.any?{|key| options[key] }
         parts = keys.collect{|key| ":#{key}" }.join(', ')
-        raise ArgumentError, "you must provide at least one of #{parts}" 
+        raise ArgumentError, "you must provide at least one of #{parts}"
       end
     end