right_http_connection 1.2.3 → 1.2.4

data/History.txt

@@ -49,4 +49,11 @@ Initial public release
 
 - Added support for setting retry & timeout parameters in the constructor
 - Improve handling of data streams during upload: if there is a failure and a retry, reset
-  the seek pointer for the subsequent re-request
+  the seek pointer for the subsequent re-request
+
+== 1.2.4 
+
+*  r4984, konstantin, 2008-08-11 14:49:18 +0400
+  * fixed a bug: <NoMethodError: You have a nil object when you didn't expect it!
+                  The error occurred while evaluating nil.body_stream>
+

data/Rakefile

@@ -12,10 +12,10 @@ include FileUtils
 require File.join(File.dirname(__FILE__), 'lib', 'right_http_connection')
 
 AUTHOR = 'RightScale'  # can also be an array of Authors
-EMAIL = "support@rightscale.com"
+EMAIL = "rubygems@rightscale.com"
 DESCRIPTION = "RightScale's robust HTTP/S connection module"
 GEM_NAME = 'right_http_connection' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'rightaws' # The unix name for your project
+RUBYFORGE_PROJECT = 'rightscale' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 
@@ -29,10 +29,23 @@ RDOC_OPTS = ['--quiet', '--title', 'right_http_connection documentation',
     "--main", "README",
     "--inline-source"]
 
+# Suppress Hoe's self-inclusion as a dependency for our Gem. This also keeps
+# Rake & rubyforge out of the dependency list. Users must manually install
+# these gems to run tests, etc.
+# TRB 2/19/09: also do this for the extra_dev_deps array present in newer hoes.
+# Older versions of RubyGems will try to install developer-dependencies as
+# required runtime dependencies....
 class Hoe
-  def extra_deps 
-    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
-  end 
+  def extra_deps
+    @extra_deps.reject do |x|
+      Array(x).first == 'hoe'
+    end
+  end
+  def extra_dev_deps
+    @extra_dev_deps.reject do |x|
+      Array(x).first == 'hoe'
+    end
+  end
 end
 
 # Generate all the Rake tasks

data/lib/right_http_connection.rb

@@ -34,7 +34,7 @@ module RightHttpConnection #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 2
-    TINY  = 3
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
@@ -42,7 +42,7 @@ end
 
 
 module Rightscale
- 
+
 =begin rdoc
 HttpConnection maintains a persistent HTTP connection to a remote
 server.  Each instance maintains its own unique connection to the
@@ -75,16 +75,16 @@ the full number of potential reconnects and retries available to
 them.
 =end
 
-  class HttpConnection 
+  class HttpConnection
 
     # Number of times to retry the request after encountering the first error
-    HTTP_CONNECTION_RETRY_COUNT   = 3   
+    HTTP_CONNECTION_RETRY_COUNT   = 3
     # Throw a Timeout::Error if a connection isn't established within this number of seconds
-    HTTP_CONNECTION_OPEN_TIMEOUT  = 5   
+    HTTP_CONNECTION_OPEN_TIMEOUT  = 5
     # Throw a Timeout::Error if no data have been read on this connnection within this number of seconds
-    HTTP_CONNECTION_READ_TIMEOUT  = 120  
-    # Length of the post-error probationary period during which all requests will fail 
-    HTTP_CONNECTION_RETRY_DELAY   = 15  
+    HTTP_CONNECTION_READ_TIMEOUT  = 120
+    # Length of the post-error probationary period during which all requests will fail
+    HTTP_CONNECTION_RETRY_DELAY   = 15
 
     #--------------------
     # class methods
@@ -95,10 +95,10 @@ them.
     @@params[:http_connection_open_timeout] = HTTP_CONNECTION_OPEN_TIMEOUT
     @@params[:http_connection_read_timeout] = HTTP_CONNECTION_READ_TIMEOUT
     @@params[:http_connection_retry_delay]  = HTTP_CONNECTION_RETRY_DELAY
-   
+
     # Query the global (class-level) parameters:
-    # 
-    #  :user_agent => 'www.HostName.com'    # String to report as HTTP User agent 
+    #
+    #  :user_agent => 'www.HostName.com'    # String to report as HTTP User agent
     #  :ca_file    => 'path_to_file'        # Path to a CA certification file in PEM format. The file can contain several CA certificates.  If this parameter isn't set, HTTPS certs won't be verified.
     #  :logger     => Logger object         # If omitted, HttpConnection logs to STDOUT
     #  :exception  => Exception to raise    # The type of exception to raise
@@ -110,7 +110,7 @@ them.
     def self.params
       @@params
     end
-   
+
     # Set the global (class-level) parameters
     def self.params=(params)
       @@params = params
@@ -125,7 +125,7 @@ them.
     attr_accessor :logger
 
      # Params hash:
-     #  :user_agent => 'www.HostName.com'    # String to report as HTTP User agent 
+     #  :user_agent => 'www.HostName.com'    # String to report as HTTP User agent
      #  :ca_file    => 'path_to_file'        # A path of a CA certification file in PEM format. The file can contain several CA certificates.
      #  :logger     => Logger object         # If omitted, HttpConnection logs to STDOUT
      #  :exception  => Exception to raise    # The type of exception to raise if a request repeatedly fails. RuntimeError is raised if this parameter is omitted.
@@ -142,7 +142,7 @@ them.
       @params[:http_connection_retry_delay]  ||= @@params[:http_connection_retry_delay]
       @http   = nil
       @server = nil
-      @logger = get_param(:logger) || 
+      @logger = get_param(:logger) ||
                 (RAILS_DEFAULT_LOGGER if defined?(RAILS_DEFAULT_LOGGER)) ||
                 Logger.new(STDOUT)
     end
@@ -164,7 +164,7 @@ them.
     def socket_read_size=(newsize)
       Net::BufferedIO.socket_read_size=(newsize)
     end
- 
+
     # Query for the maximum size (in bytes) of a single read from local data
     # sources like files.  This is important, for example, in a streaming PUT of a
     # large buffer.
@@ -190,27 +190,27 @@ them.
     def error_count
       @@state[@server] ? @@state[@server][:count] : 0
     end
-    
+
     # time of last error for server, nil if all is ok
     def error_time
       @@state[@server] && @@state[@server][:time]
     end
-    
+
     # message for last error for server, "" if all is ok
     def error_message
       @@state[@server] ? @@state[@server][:message] : ""
     end
-    
+
     # add an error for a server
     def error_add(message)
       @@state[@server] = { :count => error_count+1, :time => Time.now, :message => message }
     end
-    
+
     # reset the error state for a server (i.e. a request succeeded)
     def error_reset
       @@state.delete(@server)
     end
-    
+
     # Error message stuff...
     def banana_message
       return "#{@server} temporarily unavailable: (#{error_message})"
@@ -219,7 +219,7 @@ them.
     def err_header
       return "#{self.class.name} :"
     end
-    
+
       # Adds new EOF timestamp.
       # Returns the number of seconds to wait before new conection retry:
       #  0.5, 1, 2, 4, 8
@@ -232,29 +232,29 @@ them.
     def eof_time
       @@eof[@server] && @@eof[@server].last
     end
-    
+
       # Returns true if we are receiving EOFs during last @params[:http_connection_retry_delay] seconds
       # and there were no successful response from server
     def raise_on_eof_exception?
       @@eof[@server].blank? ? false : ( (Time.now.to_i-@params[:http_connection_retry_delay]) > @@eof[@server].last.to_i )
-    end 
-    
+    end
+
       # Reset a list of EOFs for this server.
       # This is being called when we have got an successful response from server.
     def eof_reset
       @@eof.delete(@server)
     end
-    
-    # Detects if an object is 'streamable' - can we read from it, and can we know the size?  
+
+    # Detects if an object is 'streamable' - can we read from it, and can we know the size?
     def setup_streaming(request)
       if(request.body && request.body.respond_to?(:read))
         body = request.body
-        request.content_length = body.respond_to?(:lstat) ? body.lstat.size : body.size 
+        request.content_length = body.respond_to?(:lstat) ? body.lstat.size : body.size
         request.body_stream = request.body
         true
       end
     end
-    
+
     def get_fileptr_offset(request_params)
       request_params[:request].body.pos
     rescue Exception => e
@@ -262,7 +262,7 @@ them.
       # Just return 0 and get on with life.
       0
     end
-    
+
     def reset_fileptr_offset(request, offset = 0)
       if(request.body_stream && request.body_stream.respond_to?(:pos))
         begin
@@ -272,7 +272,7 @@ them.
                              " -- #{err_header} #{e.inspect}")
           raise e
         end
-      end  
+      end
     end
 
     # Start a fresh connection. The object closes any existing connection and
@@ -284,12 +284,12 @@ them.
       @server   = request_params[:server]
       @port     = request_params[:port]
       @protocol = request_params[:protocol]
-      
+
       @logger.info("Opening new #{@protocol.upcase} connection to #@server:#@port")
       @http = Net::HTTP.new(@server, @port)
       @http.open_timeout = @params[:http_connection_open_timeout]
       @http.read_timeout = @params[:http_connection_read_timeout]
-      
+
       if @protocol == 'https'
         verifyCallbackProc = Proc.new{ |ok, x509_store_ctx|
           code = x509_store_ctx.error
@@ -303,7 +303,7 @@ them.
         if ca_file
           @http.verify_mode     = OpenSSL::SSL::VERIFY_PEER
           @http.verify_callback = verifyCallbackProc
-          @http.ca_file         = ca_file 
+          @http.ca_file         = ca_file
         end
       end
       # open connection
@@ -312,55 +312,55 @@ them.
 
   public
 
-=begin rdoc    
+=begin rdoc
     Send HTTP request to server
 
      request_params hash:
      :server   => 'www.HostName.com'   # Hostname or IP address of HTTP server
-     :port     => '80'                 # Port of HTTP server 
-     :protocol => 'https'              # http and https are supported on any port 
+     :port     => '80'                 # Port of HTTP server
+     :protocol => 'https'              # http and https are supported on any port
      :request  => 'requeststring'      # Fully-formed HTTP request to make
 
     Raises RuntimeError, Interrupt, and params[:exception] (if specified in new).
-    
+
 =end
     def request(request_params, &block)
       # We save the offset here so that if we need to retry, we can return the file pointer to its initial position
       mypos = get_fileptr_offset(request_params)
       loop do
         # if we are inside a delay between retries: no requests this time!
-        if error_count > @params[:http_connection_retry_count] && 
+        if error_count > @params[:http_connection_retry_count] &&
            error_time + @params[:http_connection_retry_delay] > Time.now
           # store the message (otherwise it will be lost after error_reset and
           # we will raise an exception with an empty text)
           banana_message_text = banana_message
           @logger.warn("#{err_header} re-raising same error: #{banana_message_text} " +
-                      "-- error count: #{error_count}, error age: #{Time.now.to_i - error_time.to_i}")  
+                      "-- error count: #{error_count}, error age: #{Time.now.to_i - error_time.to_i}")
           exception = get_param(:exception) || RuntimeError
           raise exception.new(banana_message_text)
         end
-        
+
         # try to connect server(if connection does not exist) and get response data
         begin
           request_params[:protocol] ||= (request_params[:port] == 443 ? 'https' : 'http')
+
+          request = request_params[:request]
+          request['User-Agent'] = get_param(:user_agent) || ''
+
           # (re)open connection to server if none exists or params has changed
-          unless @http          && 
+          unless @http          &&
                  @http.started? &&
                  @server   == request_params[:server] &&
                  @port     == request_params[:port]   &&
                  @protocol == request_params[:protocol]
             start(request_params)
           end
-          
-          # get response and return it
-          request  = request_params[:request]
-          request['User-Agent'] = get_param(:user_agent) || ''
 
           # Detect if the body is a streamable object like a file or socket.  If so, stream that
           # bad boy.
           setup_streaming(request)
           response = @http.request(request, &block)
-          
+
           error_reset
           eof_reset
           return response
@@ -373,26 +373,26 @@ them.
         # 'slept'.  It is still not clear which way we should treat errors
         # like RST and resolution failures.  For now, there is no additional
         # delay for these errors although this may change in the future.
-        
+
         # EOFError means the server closed the connection on us.
         rescue EOFError => e
           @logger.debug("#{err_header} server #{@server} closed connection")
           @http = nil
-          
+
             # if we have waited long enough - raise an exception...
           if raise_on_eof_exception?
             exception = get_param(:exception) || RuntimeError
-            @logger.warn("#{err_header} raising #{exception} due to permanent EOF being received from #{@server}, error age: #{Time.now.to_i - eof_time.to_i}")  
+            @logger.warn("#{err_header} raising #{exception} due to permanent EOF being received from #{@server}, error age: #{Time.now.to_i - eof_time.to_i}")
             raise exception.new("Permanent EOF is being received from #{@server}.")
           else
               # ... else just sleep a bit before new retry
             sleep(add_eof)
             # We will be retrying the request, so reset the file pointer
             reset_fileptr_offset(request, mypos)
-          end 
+          end
         rescue Exception => e  # See comment at bottom for the list of errors seen...
           @http = nil
-          # if ctrl+c is pressed - we have to reraise exception to terminate proggy 
+          # if ctrl+c is pressed - we have to reraise exception to terminate proggy
           if e.is_a?(Interrupt) && !( e.is_a?(Errno::ETIMEDOUT) || e.is_a?(Timeout::Error))
             @logger.debug( "#{err_header} request to server #{@server} interrupted by ctrl-c")
             raise
@@ -407,7 +407,7 @@ them.
 
           # We will be retrying the request, so reset the file pointer
           reset_fileptr_offset(request, mypos)
-          
+
         end
       end
     end
@@ -416,7 +416,7 @@ them.
       if @http && @http.started?
         reason = ", reason: '#{reason}'" unless reason.blank?
         @logger.info("Closing #{@http.use_ssl? ? 'HTTPS' : 'HTTP'} connection to #{@http.address}:#{@http.port}#{reason}")
-        @http.finish 
+        @http.finish
       end
     end
 
@@ -430,6 +430,6 @@ them.
   #  #<Errno::ECONNRESET: Connection reset by peer>
   #  #<OpenSSL::SSL::SSLError: SSL_write:: bad write retry>
   end
-  
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: right_http_connection
 version: !ruby/object:Gem::Version 
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors: 
 - RightScale
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-27 00:00:00 -07:00
+date: 2009-02-24 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
 description: RightScale's robust HTTP/S connection module
-email: support@rightscale.com
+email: rubygems@rightscale.com
 executables: []
 
 extensions: []
@@ -32,7 +32,7 @@ files:
 - lib/right_http_connection.rb
 - setup.rb
 has_rdoc: true
-homepage: http://rightaws.rubyforge.org
+homepage: http://rightscale.rubyforge.org
 post_install_message: 
 rdoc_options: 
 - --main
@@ -53,8 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: rightaws
-rubygems_version: 1.0.1
+rubyforge_project: rightscale
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: RightScale's robust HTTP/S connection module