aws-sdk-euca 1.8.5

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

@@ -0,0 +1,128 @@
+# 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.
+
+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
+      # Ruby's Net::HTTP to make requests.  It uses persistent connections
+      # and a connection pool.
+      #
+      class NetHttpHandler
+
+        # @private
+        PASS_THROUGH_ERRORS = [
+          NoMethodError, FloatDomainError, TypeError, NotImplementedError,
+          SystemExit, Interrupt, SyntaxError, RangeError, NoMemoryError,
+          ArgumentError, ZeroDivisionError, LoadError, NameError,
+          LocalJumpError, SignalException, ScriptError,
+          SystemStackError, RegexpError, IndexError,
+        ]
+
+        # (see Net::HTTP::ConnectionPool.new)
+        def initialize options = {}
+          @pool = Net::HTTP::ConnectionPool.new(options)
+        end
+
+        # @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
+        # response.
+        # @param [Request] request
+        # @param [Response] response
+        # @return [nil]
+        def handle request, response, &read_block
+
+          options = {}
+          options[:port] = request.port
+          options[:ssl] = request.use_ssl?
+          options[:proxy_uri] = request.proxy_uri
+          options[:ssl_verify_peer] = request.ssl_verify_peer?
+          options[:ssl_ca_file] = request.ssl_ca_file if request.ssl_ca_file
+          options[:ssl_ca_path] = request.ssl_ca_path if request.ssl_ca_path
+
+          begin
+
+            connection = pool.connection_for(request.host, options)
+            connection.read_timeout = request.read_timeout
+
+            connection.request(build_net_http_request(request)) do |http_resp|
+              response.status = http_resp.code.to_i
+              response.headers = http_resp.to_hash
+              if block_given? and response.status < 300
+                http_resp.read_body(&read_block)
+              else
+                response.body = http_resp.read_body
+              end
+            end
+
+          # The first rescue clause is required because Timeout::Error is
+          # a SignalException (in Ruby 1.8, not 1.9).  Generally, SingalExceptions
+          # should not be retried, except for timeout errors.
+          rescue Timeout::Error => error
+            response.network_error = error
+          rescue *PASS_THROUGH_ERRORS => error
+            raise error
+          rescue Exception => error
+            response.network_error = error
+          end
+
+          nil
+
+        end
+
+        protected
+
+        # Given an AWS::Core::HttpRequest, this method translates
+        # it into a Net::HTTPRequest (Get, Put, Post, Head or Delete).
+        # @param [Request] request
+        # @return [Net::HTTPRequest]
+        def build_net_http_request request
+
+          # Net::HTTP adds a content-type header automatically unless its set
+          # and this messes with request signature signing.  Also, it expects
+          # all header values to be strings (it call strip on them).
+          headers = { 'content-type' => '' }
+          request.headers.each_pair do |key,value|
+            headers[key] = value.to_s
+          end
+
+          request_class = case request.http_method
+            when 'GET'    then Net::HTTP::Get
+            when 'PUT'    then Net::HTTP::Put
+            when 'POST'   then Net::HTTP::Post
+            when 'HEAD'   then Net::HTTP::Head
+            when 'DELETE' then Net::HTTP::Delete
+            else
+              msg = "unsupported http method: #{request.http_method}"
+              raise ArgumentError, msg
+            end
+
+          net_http_req = request_class.new(request.uri, headers)
+          net_http_req.body_stream = request.body_stream
+          net_http_req
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,263 @@
+# 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
+  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
+          @default_read_timeout = 60
+          @http_method = 'POST'
+          @use_ssl = true
+          @headers = CaseInsensitiveHash.new
+          @uri = '/'
+          @params = []
+        end
+
+        # @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 :default_read_timeout
+
+        # @return [String] hostname of the request
+        attr_accessor :host
+
+        # @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 [CaseInsensitiveHash] request headers
+        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.
+        attr_accessor :region
+
+        # @return [String] Returns the AWS access key ID used to authorize the
+        #   request.
+        # @private
+        attr_accessor :access_key_id
+
+        # @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.
+        # @private
+        attr_accessor :params
+
+        # @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
+
+        # 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] Returns the HTTP request path.
+        def path
+          uri.split(/\?/)[0]
+        end
+
+        # @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)
+        #   Add a param (name/value)
+        #   @param [String] param_name
+        #   @param [String] param_value Leave blank for sub resources
+        #
+        # @overload add_param(param_obj)
+        #   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
+          else
+            @params << Param.new(name_or_param, value)
+          end
+        end
+
+        # @private
+        # @return [String,nil] Returns the url encoded request params.  If there
+        #   are no params, then nil is returned.
+        def url_encoded_params
+          params.empty? ? nil : params.sort.collect(&:encoded).join('&')
+        end
+
+        # @param [String] body
+        def body= body
+          @body = body
+          if body
+            headers['content-length'] = body.bytesize if body
+          else
+            headers.delete('content-length')
+          end
+        end
+
+        # @note Calling #body on a request with a #body_stream
+        #   will cause the entire stream to be read into memory.
+        # @return [String,nil] Returns the request body.
+        def body
+          if @body
+            @body
+          elsif @body_stream
+            @body = @body_stream.read
+            if @body_stream.respond_to?(:rewind)
+              @body_stream.rewind
+            else
+              @body_stream = StringIO.new(@body)
+            end
+            @body
+          else
+            nil
+          end
+        end
+
+        # Sets the request body as an IO object that will be streamed.
+        # @note You must also set the #headers['content-length']
+        # @param [IO] stream An object that responds to #read and #eof.
+        def body_stream= stream
+          @body_stream = stream
+        end
+
+        # @return [IO,nil]
+        def body_stream
+          if @body_stream
+            @body_stream
+          elsif @body
+            StringIO.new(@body)
+          else
+            nil
+          end
+        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
+end

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

@@ -0,0 +1,81 @@
+# 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
+  module Core
+    module Http
+
+      # Represents the http response from a service request.
+      #
+      # Responses have:
+      #
+      # * status (200, 404, 500, etc)
+      # * headers (hash of response headers)
+      # * body (the response body)
+      class Response
+
+        # @return [Integer] Returns the http response status code.
+        attr_accessor :status
+
+        # @return [Hash] ({}) Returns the HTTP response headers.
+        attr_accessor :headers
+
+        # @return [String,nil] Returns the HTTP response body.
+        attr_accessor :body
+
+        # @return [Exception,nil]
+        attr_accessor :network_error
+
+        # @return [Boolean] Returns +true+ if the request could not be made
+        #   because of a networking issue (including timeouts).
+        def network_error?
+          @network_error ? true : false
+        end
+
+        # The #network_error attribute was previously #timeout, aliasing 
+        # for backwards compatability
+        alias_method :timeout=, :network_error=
+
+        # @param [Hash] options
+        # @option options [Integer] :status (200) HTTP status code
+        # @option options [Hash] :headers ({}) HTTP response headers
+        # @option options [String] :body ('') HTTP response body
+        def initialize options = {}, &block
+          @status = options[:status] || 200
+          @headers = options[:headers] || {}
+          @body = options[:body]
+          yield(self) if block_given?
+          self
+        end
+
+        # Returns the header value with the given name.
+        #
+        # The value is matched case-insensitively so if the headers hash
+        # contains a key like 'Date' and you request the value for
+        # 'date' the 'Date' value will be returned.
+        #
+        # @param [String,Symbol] name The name of the header to fetch a value for.
+        # @return [String,nil] The value of the given header
+        def header name
+          headers.each_pair do |header_name, header_value|
+            if header_name.downcase == name.to_s.downcase
+              return header_value.is_a?(Array) ? header_value.first : header_value
+            end
+          end
+          nil
+        end
+
+      end
+    end
+  end
+end