aws-sdk 1.5.8 → 1.6.0

data/lib/aws/core/collection/with_limit_and_next_token.rb

@@ -14,11 +14,11 @@
 module AWS
   module Core
     module Collection
-      
+
       # = Collection::WithLimitAndNextToken
       #
       # This module is used by collections where the service may truncate
-      # responses but that also accept a upper limit of results to 
+      # responses but that also accept a upper limit of results to
       # return in a single request.
       #
       # See {AWS::Core::Collection} for documentation on the available

data/lib/aws/core/configuration.rb

@@ -55,7 +55,7 @@ module AWS
     #
     # The global default configuration can be found at {AWS.config}
     #
-    # @attr_reader [String,nil] access_key_id (nil) 
+    # @attr_reader [String,nil] access_key_id (nil)
     #   AWS access key id credential.
     #
     # @attr_reader [String,nil] secret_access_key (nil)
@@ -70,7 +70,7 @@ module AWS
     #   The service endpoint for AWS CloudFormation.
     #
     # @attr_reader [String] dynamo_db_endpoint ('dynamodb.us-east-1.amazonaws.com')
-    #   The service endpoint for Amazon DynamoDB.  
+    #   The service endpoint for Amazon DynamoDB.
     #
     # @attr_reader [String] dynamo_db_retry_throughput_errors (true) When
     #   true, AWS::DynamoDB::Errors::ProvisionedThroughputExceededException
@@ -80,7 +80,7 @@ module AWS
     #   The service endpoint for Amazon EC2.
     #
     # @attr_reader [String] elb_endpoint ('elasticloadbalancing.us-east-1.amazonaws.com')
-    #   The service endpoint for Elastic Load Balancing. 
+    #   The service endpoint for Elastic Load Balancing.
     #
     # @attr_reader [Object] http_handler The http handler that sends requests
     #   to AWS.  Defaults to an HTTP handler built on net/http.
@@ -90,11 +90,11 @@ module AWS
     #   longer be used.
     #
     # @attr_reader [Integer] http_open_timeout The number of seconds before
-    #   the +http_handler+ should timeout while trying to open a new HTTP 
+    #   the +http_handler+ should timeout while trying to open a new HTTP
     #   sesssion.
     #
     # @attr_reader [Integer] http_read_timeout The number of seconds before
-    #   the +http_handler+ should timeout while waiting for a HTTP 
+    #   the +http_handler+ should timeout while waiting for a HTTP
     #   response.
     #
     # @attr_reader [Boolean] http_wire_trace When +true+, the http handler
@@ -111,13 +111,16 @@ module AWS
     # @attr_reader [LogFormatter] log_formatter The log message formatter.
     #
     # @attr_reader [Integer] max_retries (3) The maximum number of times
-    #   service errors (500) should be retried.  There is an exponential 
+    #   service errors (500) should be retried.  There is an exponential
     #   backoff in between service request retries, so the more retries the
     #   longer it can take to fail.
     #
-    # @attr_reader [URI,nil] proxy_uri (nil) The URI of the proxy 
+    # @attr_reader [URI,nil] proxy_uri (nil) The URI of the proxy
     #    to send service requests through.
     #
+    # @attr_reader [URI,nil] route_53_endpoint ('route53.amazonaws.com')
+    #   The service endpoint for Amazon Route 53.
+    #
     # @attr_reader [String] s3_endpoint ('s3.amazonaws.com')
     #   The service endpoint for Amazon S3.
     #
@@ -125,19 +128,19 @@ module AWS
     #   +true+, requests will always use path style.  This can be useful
     #   for testing environments.
     #
-    # @attr_reader [Integer] s3_multipart_max_parts (1000) 
-    #   The maximum number of parts to split a file into when uploading 
+    # @attr_reader [Integer] s3_multipart_max_parts (1000)
+    #   The maximum number of parts to split a file into when uploading
     #   in parts to S3.
     #
     # @attr_reader [Integer] s3_multipart_threshold (16777216) When uploading
-    #   data to S3, if the number of bytes to send exceedes 
+    #   data to S3, if the number of bytes to send exceedes
     #   +:s3_multipart_threshold+ then a multi part session is automatically
     #   started and the data is sent up in chunks.  The size of each part
-    #   is specified by +:s3_multipart_min_part_size+. Defaults to 
+    #   is specified by +:s3_multipart_min_part_size+. Defaults to
     #   16777216 (16MB).
     #
-    # @attr_reader [Integer] s3_multipart_min_part_size (5242880) 
-    #   The absolute minimum size (in bytes) each S3 multipart 
+    # @attr_reader [Integer] s3_multipart_min_part_size (5242880)
+    #   The absolute minimum size (in bytes) each S3 multipart
     #   segment should be defaults to 5242880 (5MB).
     #
     # @attr_reader [Symbol] s3_server_side_encryption The algorithm to
@@ -161,7 +164,7 @@ module AWS
     #     s3 = AWS::S3.new(:s3_server_side_encryption => :aes256)
     #
     # @attr_reader [String] simple_db_endpoint ('sdb.amazonaws.com')
-    #   The service endpoint for Amazon SimpleDB.  
+    #   The service endpoint for Amazon SimpleDB.
     #
     # @attr_reader [Boolean] simple_db_consistent_reads (false) Determines
     #   if all SimpleDB read requests should be done consistently.
@@ -173,10 +176,10 @@ module AWS
     # @attr_reader [String] simple_workflow_endpoint ('swf.us-east-1.amazonaws.com')
     #   The service endpoint for Amazon Simple Workflow Service.
     #
-    # @attr_reader [CredentialProvider::Provider] credential_provider 
+    # @attr_reader [CredentialProvider::Provider] credential_provider
     #   Returns the object that is responsible for loading credentials.
     #
-    # @attr_reader [String] ssl_ca_file The path to a CA cert bundle in 
+    # @attr_reader [String] ssl_ca_file The path to a CA cert bundle in
     #   PEM format.
     #
     #   If +ssl_verify_peer+ is true (the default) this bundle will be
@@ -184,10 +187,10 @@ module AWS
     #   The AWS SDK for Ruby ships with a CA cert bundle, which is the
     #   default value for this option.
     #
-    # @attr_reader [String] ssl_ca_path (nil) 
+    # @attr_reader [String] ssl_ca_path (nil)
     #   The path the a CA cert directory.
     #
-    # @attr_reader [Boolean] ssl_verify_peer (true) When +true+ 
+    # @attr_reader [Boolean] ssl_verify_peer (true) When +true+
     #   the HTTP handler validate server certificates for HTTPS requests.
     #
     #   This option should only be disabled for diagnostic purposes;
@@ -206,22 +209,22 @@ module AWS
     #   The service endpoint for Amazon SQS.
     #
     # @attr_reader [String] sts_endpoint ('sts.amazonaws.com')
-    #   The service endpoint for AWS Security Token Service.  
+    #   The service endpoint for AWS Security Token Service.
     #
     # @attr_reader [Boolean] use_ssl (true) When +true+, all requests
     #   to AWS are sent using HTTPS instead vanilla HTTP.
     #
-    # @attr_reader [String] user_agent_prefix (nil) A string prefix to 
+    # @attr_reader [String] user_agent_prefix (nil) A string prefix to
     #   append to all requets against AWS services.  This should be set
     #   for clients and applications built ontop of the aws-sdk gem.
     #
     class Configuration
-  
+
       # Creates a new Configuration object.
       # @param options (see AWS.config)
       # @option options (see AWS.config)
       def initialize options = {}
-  
+
         @created = options.delete(:__created__) || {}
 
         # :signer is now a deprecated option, this ensures it will still
@@ -237,7 +240,7 @@ module AWS
             supplied[opt_name] = value
           end
         end
-  
+
       end
 
       # @return [Hash] Returns a hash with your configured credentials.
@@ -250,7 +253,7 @@ module AWS
         end
         credentials
       end
-  
+
       # Used to create a new Configuration object with the given modifications.
       # The current configuration object is not modified.
       #
@@ -272,20 +275,20 @@ module AWS
       # @return [Configuration] Copies the current configuration and returns
       #   a new one with modifications as provided in +:options+.
       def with options = {}
-  
+
         # symbolize option keys
         options = options.inject({}) {|h,kv| h[kv.first.to_sym] = kv.last; h }
-  
+
         values = supplied.merge(options)
-  
+
         if supplied == values
           self # nothing changed
         else
           self.class.new(values.merge(:__created__ => @created.dup))
         end
-  
+
       end
-  
+
       # @return [Hash] Returns a hash of all configuration values.
       def to_h
         self.class.accepted_options.inject({}) do |h,k|
@@ -293,40 +296,40 @@ module AWS
         end
       end
       alias_method :to_hash, :to_h
-  
+
       # @return [Boolean] Returns true if the two configuration objects have
       #   the same values.
       def eql? other
         other.is_a?(self.class) and self.supplied == other.supplied
       end
       alias_method :==, :eql?
-  
+
       # @private
       def inspect
         "<#{self.class.name}>"
       end
-  
+
       protected
 
       def supplied
         @supplied ||= {}
       end
-  
+
       class << self
-  
+
         # @private
         def accepted_options
           @options ||= Set.new
         end
-  
+
         # @private
         def add_option name, default_value = nil, options = {}, &transform
-  
+
           accepted_options << name
-  
+
           define_method(name) do |&default_override|
 
-            value = 
+            value =
               if supplied.has_key?(name)
                 supplied[name]
               elsif default_override
@@ -338,35 +341,35 @@ module AWS
             transform ? transform.call(self, value) : value
 
           end
-  
+
           alias_method("#{name}?", name) if options[:boolean]
-  
+
         end
-  
+
         # Configuration options that have dependencies are re-recreated
         # anytime one of their dependendent configuration values are
         # changed.
         # @private
         def add_option_with_needs name, needs, &create_block
-          
+
           accepted_options << name
-  
+
           define_method(name) do
-  
+
             return supplied[name] if supplied.has_key?(name)
-  
+
             needed = needs.inject({}) {|h,need| h.merge(need => send(need)) }
-  
+
             unless @created.key?(name) and @created[name][:needed] == needed
               @created[name] = {}
               @created[name][:object] = create_block.call(self,needed)
               @created[name][:needed] = needed
             end
-  
+
             @created[name][:object]
-            
+
           end
-  
+
         end
 
         def add_service name, ruby_name, default_endpoint
@@ -389,7 +392,7 @@ module AWS
                   'us-gov-west-1' # e.g. iam.us-gov.amazonaws.com
                 end
               elsif matches = endpoint.match(/^.+\.(.+)\.amazonaws.com$/)
-                matches[1] 
+                matches[1]
               else
                 'us-east-1'
               end
@@ -400,8 +403,8 @@ module AWS
             :"#{ruby_name}_endpoint",
             :"#{ruby_name}_port",
             :"#{ruby_name}_region",
-            :credential_provider, 
-            :http_handler, 
+            :credential_provider,
+            :http_handler,
             :http_read_timeout,
             :log_formatter,
             :log_level,
@@ -416,27 +419,27 @@ module AWS
             :user_agent_prefix,
           ]
 
-          create_block = lambda do |config,client_options| 
+          create_block = lambda do |config,client_options|
             AWS.const_get(name)::Client.new(:config => config)
           end
 
           add_option_with_needs :"#{ruby_name}_client", needs, &create_block
 
         end
-  
+
       end
 
       add_option :access_key_id
-  
+
       add_option :secret_access_key
-  
+
       add_option :session_token
-  
+
       add_option_with_needs :credential_provider,
         [:access_key_id, :secret_access_key, :session_token] do |cfg,static_creds|
 
         CredentialProviders::DefaultProvider.new(static_creds)
-  
+
       end
 
       add_option :http_open_timeout, 15
@@ -447,41 +450,41 @@ module AWS
 
       add_option :http_wire_trace, false, :boolean => true
 
-      add_option_with_needs :http_handler, 
+      add_option_with_needs :http_handler,
         [
-          :http_open_timeout, 
+          :http_open_timeout,
           :http_idle_timeout,
-          :http_wire_trace, 
-          :logger, 
+          :http_wire_trace,
+          :logger,
         ] do |config,handler_options|
 
         Http::NetHttpHandler.new(handler_options)
 
       end
-  
+
       add_option :logger
 
       add_option :log_level, :info
 
       add_option :log_formatter, LogFormatter.default
-  
+
       add_option :max_retries, 3
-  
+
       add_option :proxy_uri do |config,uri| uri ? URI.parse(uri.to_s) : nil end
-  
+
       add_option :ssl_verify_peer, true, :boolean => true
-  
-      add_option :ssl_ca_file, 
+
+      add_option :ssl_ca_file,
         File.expand_path(File.dirname(__FILE__) + "/../../../ca-bundle.crt")
 
       add_option :ssl_ca_path
-  
+
       add_option :stub_requests, false, :boolean => true
-  
+
       add_option :use_ssl, true, :boolean => true
-  
+
       add_option :user_agent_prefix
-  
+
     end
   end
 end

data/lib/aws/core/http/net_http_handler.rb

@@ -16,7 +16,7 @@ require 'net/http/connection_pool'
 module AWS
   module Core
     module Http
-  
+
       # = NetHttpHandler
       #
       # This is the default HTTP handler for the aws-sdk gem.  It uses
@@ -32,9 +32,9 @@ module AWS
 
         # @return [Net::HTTP::ConnectionPool]
         attr_reader :pool
-  
+
         # Given a populated request object and an empty response object,
-        # this method will make the request and them populate the 
+        # this method will make the request and them populate the
         # response.
         # @param [Request] request
         # @param [Response] response

data/lib/aws/core/http/request.rb

@@ -14,53 +14,44 @@
 module AWS
   module Core
     module Http
-  
+
       # Base class for all service reqeusts.  This class describes
       # a basic HTTP request, but will not make one.  It is consumed
       # by a HTTP handler class that sends the actual request
       # and parses the actual response.
       class Request
-  
+
         # Returns a new empty http request object.
         def initialize
-          @host = nil
+          @default_read_timeout = 60
           @http_method = 'POST'
-          @path = '/'
+          @use_ssl = true
           @headers = CaseInsensitiveHash.new
+          @uri = '/'
           @params = []
-          @use_ssl = true
-          @port = nil
-          @default_read_timeout = 60 
         end
 
         # @return [Integer] The number of seconds the service has to respond
-        #   before a timeout error is raised on the request.  Defaults to 
+        #   before a timeout error is raised on the request.  Defaults to
         #   60 seconds.
         attr_accessor :default_read_timeout
 
-        # @return [String] The snake-cased ruby name for the service
-        #   (e.g. 's3', 'iam', 'dynamo_db', etc).
-        attr_accessor :service_ruby_name
-  
-        # @return [String] hostname of the request
+        # @return [String] Returns hostname of the request.
         attr_accessor :host
-  
-        # @return [CaseInsensitiveHash] request headers
-        attr_accessor :headers
-  
-        # @return [Array] An array of request params, each param responds to
-        #   #name and #value.
-        attr_accessor :params
-  
-        # @return [String] GET, PUT POST, HEAD or DELETE, defaults to POST
+
+        # @return [Integer] Returns the port number this request will be
+        #   made via (usually 443 or 80).
+        attr_accessor :port
+
+        # @return [String] Returns the HTTP request method (e.g. 'GET', 'PUT',
+        #   'POST', 'HEAD' or 'DELETE').  Defaults to 'POST'.
         attr_accessor :http_method
-  
-        # @return [String] path of the request URI, defaults to /
-        attr_accessor :path
-  
-        # @return [nil, URI] The URI to the proxy server requests are 
-        #   sent through if configured.  Returns nil if there is no proxy.
-        attr_accessor :proxy_uri
+
+        # @return [Hash] Returns a hash of header values.
+        attr_accessor :headers
+
+        # @return [String] Returns the request URI (path + querystring).
+        attr_accessor :uri
 
         # @return [String] The region name this request is for.  Only needs
         #   to be populated for requests against signature v4 endpoints.
@@ -70,77 +61,85 @@ module AWS
         # @private
         attr_accessor :access_key_id
 
-        # Some subclasses override this method to obseve requirements
-        # set by the services (e.q. SimpleWorlfow and SQS have special
-        # long-pulling requirements and require special read timeouts).
         # @private
-        def read_timeout
-          default_read_timeout
-        end
-  
-        # @param [Boolean] state If the request should be sent over ssl or not.
-        def use_ssl= state
-          @use_ssl = state
-        end
-  
-        # @return [Boolean] If this request should be sent over ssl or not.
-        def use_ssl?
-          @use_ssl
-        end
+        # @return [Array<Param>] Returns an array of request params.  Requests
+        #   that use signature version 2 add params to the request and then
+        #   sign those before building the {#body}.  Normally the {#body}
+        #   should be set directly with the HTTP payload.
+        attr_accessor :params
 
-        # Override the default port (443 or 80).  If you pass nil then
-        # the default port will take precedence.
-        # @param [Integer,nil] port_number
-        def port= port_number
-          @port = port_number
-        end
+        # @return [String] Returns the HTTP request payload (body).
+        attr_accessor :body
+
+        # @return [String] Returns the AWS access key ID used to authorize the
+        #   request.
+        attr_accessor :access_key_id
+
+        # @return [String] The name of the service for Signature v4 signing.
+        #   This does not always match the ruby name (e.g.
+        #   simple_email_service and ses do not match).
+        attr_accessor :service_ruby_name
+
+        # @return [nil, URI] The URI to the proxy server requests are
+        #   sent through if configured.  Returns nil if there is no proxy.
+        attr_accessor :proxy_uri
+
+        # @return [Integer] The number of seconds the service has to respond
+        #   before a timeout error is raised on the request.  Defaults to
+        #   60 seconds.
+        attr_accessor :read_timeout
+
+        # @return [Boolean] Returns +true+ if this request should be made
+        #   with SSL enabled.
+        attr_accessor :use_ssl
+
+        alias_method :use_ssl?, :use_ssl
+
+        # @return [Boolean] Returns +true+ if the client should verify
+        #   the peer certificate.
+        attr_accessor :ssl_verify_peer
+
+        alias_method :ssl_verify_peer?, :ssl_verify_peer
+
+        # @return [String] Returns the path to a bundle of CA certs in PEM
+        #   format; the HTTP handler should use this to verify all HTTPS
+        #   requests if {#ssl_verify_peer?} is true.
+        attr_accessor :ssl_ca_file
+
+        # @return [String] Returns the path to a directory of CA certs.
+        #   The HTTP handler should use these to verify all HTTPS
+        #   requests if {#ssl_verify_peer?} is true.
+        attr_accessor :ssl_ca_path
 
         # @return [Integer] Returns the port the request will be made over.
         #   Defaults to 443 for SSL requests and 80 for non-SSL requests.
         def port
           @port || (use_ssl? ? 443 : 80)
         end
-  
-        # @param [Boolean] verify_peer If the client should verify the
-        #   peer certificate or not.
-        def ssl_verify_peer=(verify_peer)
-          @ssl_verify_peer = verify_peer
-        end
-  
-        # @return [Boolean] If the client should verify the peer
-        #   certificate or not.
-        def ssl_verify_peer?
-          @ssl_verify_peer
-        end
-  
-        # @param [String] ca_file Path to a bundle of CA certs in PEM
-        #   format; the HTTP handler should use this to verify all HTTPS
-        #   requests if {#ssl_verify_peer?} is true.
-        def ssl_ca_file=(ca_file)
-          @ssl_ca_file = ca_file
+
+        # Some subclasses override this method to obseve requirements
+        # set by the services (e.q. SimpleWorlfow and SQS have special
+        # long-pulling requirements and require special read timeouts).
+        # @private
+        def read_timeout
+          default_read_timeout
         end
-  
-        # @return [String] Path to a bundle of CA certs in PEM format;
-        #   the HTTP handler should use this to verify all HTTPS
-        #   requests if {#ssl_verify_peer?} is true.
-        def ssl_ca_file
-          @ssl_ca_file
+
+        # @return [String,nil] Returns the request body (payload).
+        def body
+          @body || url_encoded_params
         end
-  
-        # @param [String] ca_path Path to a bundle of CA certs in PEM
-        #   format; the HTTP handler should use this to verify all HTTPS
-        #   requests if {#ssl_verify_peer?} is true.
-        def ssl_ca_path=(ca_path)
-          @ssl_ca_path = ca_path
+
+        # @return [String] Returns the HTTP request path.
+        def path
+          uri.split(/\?/)[0]
         end
-  
-        # @return [String] Path to a bundle of CA certs in PEM format;
-        #   the HTTP handler should use this to verify all HTTPS
-        #   requests if {#ssl_verify_peer?} is true.
-        def ssl_ca_path
-          @ssl_ca_path
+
+        # @return [String] Returns the HTTP request querystring.
+        def querystring
+          uri.split(/\?/)[1]
         end
-  
+
         # Adds a request param.
         #
         # @overload add_param(param_name, param_value = nil)
@@ -152,6 +151,7 @@ module AWS
         #   Add a param (object)
         #   @param [Param] param_obj
         #
+        # @private
         def add_param name_or_param, value = nil
           if name_or_param.kind_of?(Param)
             @params << name_or_param
@@ -159,99 +159,68 @@ module AWS
             @params << Param.new(name_or_param, value)
           end
         end
-        alias_method :[]=, :add_param
-  
-        # @private
-        def get_param param_name
-          @params.detect{|p| p.name == param_name } ||
-            raise("undefined param #{param_name}")
-        end
-        
+
         # @private
-        def param_value_for param_name
-          param = @params.detect{|p| p.name == param_name }
-          param ? param.value : nil
-        end
-  
-        # @return [String] the request uri
-        def uri
-          querystring ? "#{path}?#{querystring}" : path
-        end
-  
-        # @return [String] Returns the request params url encoded, or nil if 
-        #   this request has no params.
+        # @return [String,nil] Returns the url encoded request params.  If there
+        #   are no params, then nil is returned.
         def url_encoded_params
-          if @params.empty?
-            nil
-          else
-            @params.sort.collect{|p| p.encoded }.join('&')
-          end
+          params.empty? ? nil : params.sort.collect(&:encoded).join('&')
         end
-  
-        # @return [String, nil] Returns the requesty querystring.
-        def querystring
-          nil
-        end
-  
-        # @return [String, nil] Returns the request body.
-        def body
-          url_encoded_params
-        end
-  
+
         # @private
         class CaseInsensitiveHash < Hash
-          
+
           def []= key, value
             super(key.to_s.downcase, value)
           end
-  
+
           def [] key
             super(key.to_s.downcase)
           end
-  
+
           def has_key?(key)
             super(key.to_s.downcase)
           end
           alias_method :key?, :has_key?
           alias_method :include?, :has_key?
           alias_method :member?, :has_key?
-  
+
         end
-  
+
         # Represents a single request paramater.  Some services accept this
         # in a form encoded body string, others as query parameters.
         # It is up to each service's Request class to determine how to
         # consume these params.
         # @private
         class Param
-  
+
           include UriEscape
-  
+
           attr_accessor :name, :value
-  
+
           def initialize name, value = nil
             @name = name
             @value = value
           end
-  
+
           def <=> other
             name <=> other.name
           end
-  
+
           def to_s
             value ? "#{name}=#{value}" : name
           end
-  
+
           def ==(other)
             other.kind_of?(Param) and to_s == other.to_s
           end
-  
+
           def encoded
             value ? "#{escape(name)}=#{escape(value)}" : escape(name)
           end
-  
+
         end
-  
+
       end
     end
   end