aws_sdk 3.1.5

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

@@ -0,0 +1,114 @@
+# Copyright 2011-2012 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 'httparty'
+
+module AWS
+  module Core
+    module Http
+  
+      # Makes HTTP requests using HTTParty.  This is the default
+      # handler, so you don't need to do anything special to configure
+      # it.  However, you can directly instantiate this class in order
+      # to send extra options to HTTParty, for example to enable an HTTP
+      # proxy:
+      #
+      #   AWS.config(
+      #     :http_handler => AWS::Http::HTTPartyHandler.new(
+      #       :http_proxyaddr => "http://myproxy.com",
+      #       :http_proxyport => 80
+      #     )
+      #   )
+      #
+      class HTTPartyHandler
+  
+        # @return [Hash] The default options to send to HTTParty on each
+        #   request.
+        attr_reader :default_request_options
+  
+        # Constructs a new HTTP handler using HTTParty.
+        #
+        # @param [Hash] options Default options to send to HTTParty on
+        #   each request.  These options will be sent to +get+, +post+,
+        #   +head+, +put+, or +delete+ when a request is made.  Note
+        #   that +:body+, +:headers+, +:parser+, and +:ssl_ca_file+ are
+        #   ignored.  If you need to set the CA file, you should use the
+        #   +:ssl_ca_file+ option to {AWS.config} or
+        #   {Configuration} instead.
+        def initialize options = {}
+          @default_request_options = options
+        end
+  
+        include HTTParty
+  
+        class NoOpParser < HTTParty::Parser
+          SupportedFormats = {}
+        end
+  
+        def handle(request, response)
+  
+          opts = default_request_options.merge({
+            :body => request.body,
+            :parser => NoOpParser
+          })
+  
+          if request.proxy_uri
+            opts[:http_proxyaddr] = request.proxy_uri.host
+            opts[:http_proxyport] = request.proxy_uri.port
+          end
+  
+          if request.use_ssl?
+            protocol = 'https'
+            opts[:ssl_ca_file] = request.ssl_ca_file if request.ssl_verify_peer?
+          else
+            protocol = 'http'
+          end
+
+          url = "#{protocol}://#{request.host}:#{request.port}#{request.uri}"
+  
+          # get, post, put, delete, head
+          method = request.http_method.downcase
+  
+          # Net::HTTP adds this header for us when the body is
+          # provided, but it messes up signing
+          headers = { 'content-type' => '' }
+  
+          # headers must have string values (net http calls .strip on them)
+          request.headers.each_pair do |key,value|
+            headers[key] = value.to_s
+          end
+  
+          opts[:headers] = headers
+  
+          begin
+            http_response = self.class.send(method, url, opts)
+          rescue Timeout::Error, Errno::ETIMEDOUT => e
+            response.timeout = true
+          else
+            response.body = http_response.body
+            response.status = http_response.code.to_i
+            response.headers = http_response.to_hash
+          end
+        end
+      end
+    end
+  end
+
+  # We move this from AWS::Http to AWS::Core::Http, but we want the 
+  # previous default handler to remain accessible from its old namesapce
+  # @private
+  module Http
+    class HTTPartyHandler < Core::Http::HTTPartyHandler; end
+  end
+
+end

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

@@ -0,0 +1,85 @@
+# Copyright 2011-2012 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
+  
+      # The default http request handler for the aws-sdk gem.  It is based
+      # on Net::Http.
+      class NetHttpHandler
+
+        @@pool = Net::HTTP::ConnectionPool.new
+
+        # @private
+        def self.pool
+          @@pool
+        end
+  
+        def handle request, response
+
+          options = {}
+          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
+
+          connection = self.class.pool.connection_for(request.host, options)
+          connection.read_timeout = request.read_timeout
+
+          begin
+            http_response = connection.request(build_request(request))
+            response.body = http_response.body
+            response.status = http_response.code.to_i
+            response.headers = http_response.to_hash
+          rescue Timeout::Error, Errno::ETIMEDOUT => e
+            response.timeout = true
+          end
+
+        end
+
+        # @private
+        protected
+        def build_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
+
+          req_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 raise "unsupported http method: #{request.http_method}"
+          end
+
+          net_http_req = req_class.new(request.uri, headers)
+          net_http_req.body = request.body
+          net_http_req
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,250 @@
+# Copyright 2011-2012 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
+          @host = nil
+          @http_method = 'POST'
+          @path = '/'
+          @headers = CaseInsensitiveHash.new
+          @params = []
+          @use_ssl = true
+          @port = nil
+          @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 
+        #   60 seconds.
+        attr_accessor :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
+        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
+        attr_accessor :http_method
+  
+        # @return [String] path of the request URI, defaults to /
+        attr_accessor :path
+  
+        # @return [String] the AWS access key ID used to authorize the
+        #   request
+        attr_accessor :access_key_id
+  
+        # @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 [String] The region name this request is for.  Only needs
+        #   to be populated for requests against signature v4 endpoints.
+        attr_accessor :region
+  
+        # @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
+
+        # 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 [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
+        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
+        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
+        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
+        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
+        #
+        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
+        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.
+        def url_encoded_params
+          if @params.empty?
+            nil
+          else
+            @params.sort.collect{|p| p.encoded }.join('&')
+          end
+        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
+end