aws-sdk-euca 1.8.5

data/lib/aws/simple_email_service/client.rb

@@ -0,0 +1,276 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class SimpleEmailService
+
+    # Client class for Amazon Simple E-mail Service (SES).
+    class Client < Core::QueryClient
+
+      REGION_US_E1 = 'email.us-east-1.amazonaws.com'
+
+      # @private
+      CACHEABLE_REQUESTS = Set[]
+
+      # client methods #
+
+      # @!method delete_identity(options = {})
+      # Calls the DeleteIdentity API operation.
+      # @param [Hash] options
+      #   * +:identity+ - *required* - (String) The identity to be removed from
+      #     the list of identities for the AWS Account.
+      # @return [Core::Response]
+
+      # @!method delete_verified_email_address(options = {})
+      # Calls the DeleteVerifiedEmailAddress API operation.
+      # @param [Hash] options
+      #   * +:email_address+ - *required* - (String) An email address to be
+      #     removed from the list of verified addresses.
+      # @return [Core::Response]
+
+      # @!method get_identity_dkim_attributes(options = {})
+      # Calls the GetIdentityDkimAttributes API operation.
+      # @param [Hash] options
+      #   * +:identities+ - *required* - (Array<String>) A list of one or more
+      #     verified identities - email addresses, domains, or both.
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:dkim_attributes+ - (Hash<String,Hash>)
+      #     * +:dkim_enabled+ - (Boolean)
+      #     * +:dkim_verification_status+ - (String)
+      #     * +:dkim_tokens+ - (Array<String>)
+
+      # @!method get_identity_notification_attributes(options = {})
+      # Calls the GetIdentityNotificationAttributes API operation.
+      # @param [Hash] options
+      #   * +:identities+ - *required* - (Array<String>) A list of one or more
+      #     identities.
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:notification_attributes+ - (Hash<String,Hash>)
+      #     * +:bounce_topic+ - (String)
+      #     * +:complaint_topic+ - (String)
+      #     * +:forwarding_enabled+ - (Boolean)
+
+      # @!method get_identity_verification_attributes(options = {})
+      # Calls the GetIdentityVerificationAttributes API operation.
+      # @param [Hash] options
+      #   * +:identities+ - *required* - (Array<String>) A list of identities.
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:verification_attributes+ - (Hash<String,Hash>)
+      #     * +:verification_status+ - (String)
+      #     * +:verification_token+ - (String)
+
+      # @!method get_send_quota(options = {})
+      # Calls the GetSendQuota API operation.
+      # @param [Hash] options
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:max_24_hour_send+ - (Numeric)
+      #   * +:max_send_rate+ - (Numeric)
+      #   * +:sent_last_24_hours+ - (Numeric)
+
+      # @!method get_send_statistics(options = {})
+      # Calls the GetSendStatistics API operation.
+      # @param [Hash] options
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:send_data_points+ - (Array<Hash>)
+      #     * +:timestamp+ - (Time)
+      #     * +:delivery_attempts+ - (Integer)
+      #     * +:bounces+ - (Integer)
+      #     * +:complaints+ - (Integer)
+      #     * +:rejects+ - (Integer)
+
+      # @!method list_identities(options = {})
+      # Calls the ListIdentities API operation.
+      # @param [Hash] options
+      #   * +:identity_type+ - (String) The type of the identities to list.
+      #     Possible values are "EmailAddress" and "Domain". If this parameter
+      #     is omitted, then all identities will be listed.
+      #   * +:next_token+ - (String) The token to use for pagination.
+      #   * +:max_items+ - (Integer) The maximum number of identities per page.
+      #     Possible values are 1-100 inclusive.
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:identities+ - (Array<String>)
+      #   * +:next_token+ - (String)
+
+      # @!method list_verified_email_addresses(options = {})
+      # Calls the ListVerifiedEmailAddresses API operation.
+      # @param [Hash] options
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:verified_email_addresses+ - (Array<String>)
+
+      # @!method send_email(options = {})
+      # Calls the SendEmail API operation.
+      # @param [Hash] options
+      #   * +:source+ - *required* - (String) The identity's email address.
+      #   * +:destination+ - *required* - (Hash) The destination for this
+      #     email, composed of To:, CC:, and BCC: fields.
+      #     * +:to_addresses+ - (Array<String>) The To: field(s) of the
+      #       message.
+      #     * +:cc_addresses+ - (Array<String>) The CC: field(s) of the
+      #       message.
+      #     * +:bcc_addresses+ - (Array<String>) The BCC: field(s) of the
+      #       message.
+      #   * +:message+ - *required* - (Hash) The message to be sent.
+      #     * +:subject+ - *required* - (Hash) The subject of the message: A
+      #       short summary of the content, which will appear in the
+      #       recipient's inbox.
+      #       * +:data+ - *required* - (String) The textual data of the
+      #         content.
+      #       * +:charset+ - (String) The character set of the content.
+      #     * +:body+ - *required* - (Hash) The message body.
+      #       * +:text+ - (Hash) The content of the message, in text format.
+      #         Use this for text-based email clients, or clients on
+      #         high-latency networks (such as mobile devices).
+      #         * +:data+ - *required* - (String) The textual data of the
+      #           content.
+      #         * +:charset+ - (String) The character set of the content.
+      #       * +:html+ - (Hash) The content of the message, in HTML format.
+      #         Use this for email clients that can process HTML. You can
+      #         include clickable links, formatted text, and much more in an
+      #         HTML message.
+      #         * +:data+ - *required* - (String) The textual data of the
+      #           content.
+      #         * +:charset+ - (String) The character set of the content.
+      #   * +:reply_to_addresses+ - (Array<String>) The reply-to email
+      #     address(es) for the message. If the recipient replies to the
+      #     message, each reply-to address will receive the reply.
+      #   * +:return_path+ - (String) 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 ReturnPath parameter.
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:message_id+ - (String)
+
+      # @!method send_raw_email(options = {})
+      # Calls the SendRawEmail API operation.
+      # @param [Hash] options
+      #   * +:source+ - (String) The identity's email address. If you specify
+      #     the Source parameter, 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 text of the
+      #     message.
+      #   * +:destinations+ - (Array<String>) A list of destinations for the
+      #     message.
+      #   * +:raw_message+ - *required* - (Hash) The raw text of the message.
+      #     The client is responsible for ensuring the following: Message must
+      #     contain a header and a body, separated by a blank line. All
+      #     required header fields must be present. Each part of a multipart
+      #     MIME message must be formatted properly. MIME content types must be
+      #     among those supported by Amazon SES. Refer to the Amazon SES
+      #     Developer Guide for more details. Content must be base64-encoded,
+      #     if MIME requires it.
+      #     * +:data+ - *required* - (String) The raw data of the message. The
+      #       client must ensure that the message format complies with Internet
+      #       email standards regarding email header fields, MIME types, MIME
+      #       encoding, and base64 encoding (if necessary). For more
+      #       information, go to theAmazon SES Developer Guide.
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:message_id+ - (String)
+
+      # @!method set_identity_dkim_enabled(options = {})
+      # Calls the SetIdentityDkimEnabled API operation.
+      # @param [Hash] options
+      #   * +:identity+ - *required* - (String) The identity for which DKIM
+      #     signing should be enabled or disabled.
+      #   * +:dkim_enabled+ - *required* - (Boolean) Sets whether DKIM signing
+      #     is enabled for an identity. Set to +true+ to enable DKIM signing
+      #     for this identity; +false+ to disable it.
+      # @return [Core::Response]
+
+      # @!method set_identity_feedback_forwarding_enabled(options = {})
+      # Calls the SetIdentityFeedbackForwardingEnabled API operation.
+      # @param [Hash] options
+      #   * +:identity+ - *required* - (String) The identity for which to set
+      #     feedback notification forwarding. Examples: user@example.com,
+      #     example.com.
+      #   * +:forwarding_enabled+ - *required* - (Boolean) Sets whether Amazon
+      #     SES will forward feedback notifications as email. +true+ specifies
+      #     that Amazon SES will forward feedback notifications as email, in
+      #     addition to any Amazon SNS topic publishing otherwise specified.
+      #     +false+ specifies that Amazon SES will publish feedback
+      #     notifications only through Amazon SNS. This value can only be set
+      #     to +false+ when topics are specified for both Bounce and Complaint
+      #     topic types.
+      # @return [Core::Response]
+
+      # @!method set_identity_notification_topic(options = {})
+      # Calls the SetIdentityNotificationTopic API operation.
+      # @param [Hash] options
+      #   * +:identity+ - *required* - (String) The identity for which the
+      #     topic will be set. Examples: user@example.com, example.com.
+      #   * +:notification_type+ - *required* - (String) The type of feedback
+      #     notifications that will be published to the specified topic.
+      #   * +:sns_topic+ - (String) The Amazon Resource Name (ARN) of the
+      #     Amazon Simple Notification Service (Amazon SNS) topic. If the
+      #     parameter is omitted from the request or a null value is passed,
+      #     the topic is cleared and publishing is disabled.
+      # @return [Core::Response]
+
+      # @!method verify_domain_dkim(options = {})
+      # Calls the VerifyDomainDkim API operation.
+      # @param [Hash] options
+      #   * +:domain+ - *required* - (String) The name of the domain to be
+      #     verified for Easy DKIM signing.
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:dkim_tokens+ - (Array<String>)
+
+      # @!method verify_domain_identity(options = {})
+      # Calls the VerifyDomainIdentity API operation.
+      # @param [Hash] options
+      #   * +:domain+ - *required* - (String) The domain to be verified.
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:verification_token+ - (String)
+
+      # @!method verify_email_address(options = {})
+      # Calls the VerifyEmailAddress API operation.
+      # @param [Hash] options
+      #   * +:email_address+ - *required* - (String) The email address to be
+      #     verified.
+      # @return [Core::Response]
+
+      # @!method verify_email_identity(options = {})
+      # Calls the VerifyEmailIdentity API operation.
+      # @param [Hash] options
+      #   * +:email_address+ - *required* - (String) The email address to be
+      #     verified.
+      # @return [Core::Response]
+
+      # end client methods #
+
+      define_client_methods('2010-12-01')
+
+    end
+  end
+end

data/lib/aws/simple_email_service/config.rb

@@ -0,0 +1,19 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'SimpleEmailService', 'simple_email_service',
+    'email.us-east-1.amazonaws.com'
+
+end

data/lib/aws/simple_email_service/email_address_collection.rb

@@ -0,0 +1,69 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class SimpleEmailService
+
+    # Helps you manage your verified SimpleEmailService email addresses.
+    # @note This class is deprecated. Please use 
+    #   {SimpleEmailService#identities} instead.
+    class EmailAddressCollection
+
+      include Core::Model
+      include Enumerable
+
+      # Requests for an email address to be verified.  An email will be
+      # sent to the given +email_address+ with a link to click.  Once
+      # the link has been followed the +email_address+ will be verified.
+      #
+      # @param [String] email_address The email address to verify.
+      # @return [nil]
+      # @note This method is deprecated.
+      def verify email_address
+        client.verify_email_address(:email_address => email_address)
+        nil
+      end
+      alias_method :create, :verify
+
+      # @param [String] email_address An email address to remove from the list
+      #   of verified email addresses.  Useful for cleanup as there is a 100
+      #   email address limit.
+      # @return [nil]
+      # @note This method is deprecated.
+      def delete email_address
+        client.delete_verified_email_address(:email_address => email_address)
+        nil
+      end
+
+      # @note This method is deprecated.
+      def include?
+        # this is so jruby can detect that verified? is an alias
+        super
+      end
+      alias_method :verified?, :include?
+
+      # Yields each verified email address as a string.
+      # @return [nil]
+      #   yielded.
+      # @note This method is deprecated.
+      def each &block
+        response = client.list_verified_email_addresses({})
+        response.verified_email_addresses.each do |email_address|
+          yield(email_address)
+        end
+        nil
+      end
+
+    end
+  end
+end

data/lib/aws/simple_email_service/errors.rb

@@ -0,0 +1,22 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class SimpleEmailService
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/simple_email_service/identity.rb

@@ -0,0 +1,209 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class SimpleEmailService
+
+    # @attr_reader [String] verification_status
+    #
+    # @attr_reader [String,nil] verification_token
+    #
+    # @attr [String] bounce_topic_arn
+    #
+    # @attr [String] complaint_topic_arn
+    #
+    # @attr [Boolean] forwarding_enabled When +false+, complaint and bounce
+    #   notifications will not be forwarded via email.  Can only be set to
+    #   +false+ when there is both a +bounce_topic+ and +complaint_topic+.
+    #
+    # @attr [Boolean] dkim_enabled When set to +true+, Easy DKIM signing will
+    #   be enabled for email sent from this identity.
+    #
+    # @attr_reader [Array<String>] dkim_tokens Returns a set of DNS records,
+    #   or tokens, that must be published in the domain name's DNS to 
+    #   complete the DKIM verification process.  Call {#verify_dkim} if this
+    #   returns an empty list.
+    #
+    # @attr_reader [String] dkim_verification_status
+    #
+    class Identity < Core::Resource
+
+      # @private
+      def initialize email_address_or_domain, options = {}
+        @identity = email_address_or_domain
+        super
+      end
+
+      # @return [String] Returns the email address or domain name for
+      #   this identity.
+      attr_reader :identity
+
+      attribute :verification_status
+
+      attribute :verification_token, :static => true
+
+      mutable_attribute :dkim_enabled, :alias => :dkim_enabled?
+
+      attribute :dkim_tokens
+
+      attribute :dkim_verification_status
+
+      mutable_attribute :bounce_topic_arn, :from => :bounce_topic
+
+      mutable_attribute :complaint_topic_arn, :from => :complaint_topic
+
+      mutable_attribute :forwarding_enabled
+
+      alias_method :forwarding_enabled?, :forwarding_enabled
+
+      provider(:get_identity_verification_attributes) do |provider|
+        provider.provides :verification_token
+        provider.provides :verification_status
+        provider.find{|resp| resp[:verification_attributes][identity] }
+      end
+
+      provider(:get_identity_notification_attributes) do |provider|
+        provider.provides :bounce_topic_arn
+        provider.provides :complaint_topic_arn
+        provider.provides :forwarding_enabled
+        provider.find{|resp| resp[:notification_attributes][identity] }
+      end
+
+      provider(:get_identity_dkim_attributes) do |provider|
+        provider.provides :dkim_enabled
+        provider.provides :dkim_verification_status
+        provider.provides :dkim_tokens
+        provider.find{|resp| resp[:dkim_attributes][identity] }
+      end
+
+      # @return [Array<String>] Returns an array of DKIM tokens.
+      def verify_dkim
+        if domain?
+          resp = client.verify_domain_dkim(:domain => identity)
+          reps[:dkim_tokens]
+        else
+          raise "unable to verify dkim for an email address"
+        end
+      end
+
+      # @param [String,SNS::Topic] topic The topic (ARN string or topic
+      #   object) that bounce notifications should be published to.
+      def bounce_topic= topic
+        arn = topic.respond_to?(:arn) ? topic.arn : topic
+        self.bounce_topic_arn = arn
+      end
+
+      # @return [SNS::Topic,nil]
+      def bounce_topic
+        if arn = bounce_topic_arn
+          SNS::Topic.new(arn, :config => config)
+        end
+      end
+
+      # @param [String,SNS::Topic] topic The topic (ARN string or topic
+      #   object) that complaint notifications should be published to.
+      def complaint_topic= topic
+        arn = topic.respond_to?(:arn) ? topic.arn : topic
+        self.complaint_topic_arn = arn
+      end
+
+      # @return [SNS::Topic,nil]
+      def complaint_topic
+        if arn = complaint_topic_arn
+          SNS::Topic.new(arn, :config => config)
+        end
+      end
+
+      # @return [Boolean] Returns +true+ if this {Identity} represents an
+      #   email address.
+      def email_address?
+        identity.match(/@/) ? true : false
+      end
+
+      # @return [Boolean] Returns +true+ if this {Identity} represents a
+      #   domain.
+      def domain?
+        !email_address?
+      end
+
+      # @return [Boolean] Returns +true+ if this email address/domain has
+      #   been verified.
+      def verified?
+        verification_status == 'Success'
+      end
+
+      # @return [Boolean] Returns +true+ if verification for this email
+      #   address/domain is still pending.
+      def pending?
+        verification_status == 'Pending'
+      end
+
+      # Deletes the current identity.
+      # @return [nil]
+      def delete
+        client.delete_identity(:identity => identity)
+        nil
+      end
+
+      # @return [Boolean] Returns true if the identity exists.
+      def exists?
+        options = { :identities => [identity] }
+        resp = client.get_identity_verification_attributes(options)
+        !!resp[:verification_attributes][identity]
+      end
+
+      protected
+
+      def resource_identifiers
+        [[:identity, identity]]
+      end
+
+      def get_resource attr
+
+        method_name =
+          case attr.name.to_s
+          when /dkim/         then :get_identity_dkim_attributes
+          when /verification/ then :get_identity_verification_attributes
+          else                     :get_identity_notification_attributes
+          end
+
+        client.send(method_name, :identities => [identity])
+
+      end
+
+      def update_resource attr, value
+        client_opts = {}
+        client_opts[:identity] = identity
+        case attr.name
+        when :bounce_topic_arn
+          method = :set_identity_notification_topic
+          client_opts[:notification_type] = 'Bounce'
+          client_opts[:sns_topic] = value if value
+        when :complaint_topic_arn
+          method = :set_identity_notification_topic
+          client_opts[:notification_type] = 'Complaint'
+          client_opts[:sns_topic] = value if value
+        when :forwarding_enabled
+          method = :set_identity_feedback_forwarding_enabled
+          client_opts[:forwarding_enabled] = value
+        when :dkim_enabled
+          method = :set_identity_dkim_enabled
+          client_opts[:dkim_enabled] = value
+        else raise "unhandled attribute: #{attr.name}"
+        end
+        client.send(method, client_opts)
+      end
+
+    end
+  end
+end