excon 0.28.0 → 0.29.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    excon (0.28.0)
+    excon (0.29.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -8,6 +8,7 @@ Excon was designed to be simple, fast and performant. It works great as a genera
 [![Build Status](https://secure.travis-ci.org/geemus/excon.png)](http://travis-ci.org/geemus/excon)
 [![Dependency Status](https://gemnasium.com/geemus/excon.png)](https://gemnasium.com/geemus/excon)
 [![Gem Version](https://fury-badge.herokuapp.com/rb/excon.png)](http://badge.fury.io/rb/excon)
+[![Gittip](http://img.shields.io/gittip/geemus.png)](https://www.gittip.com/geemus/)
 
 Getting Started
 ---------------
@@ -83,9 +84,6 @@ connection.request(:idempotent => true)
 # this request can be repeated safely, retry up to 6 times
 connection.request(:idempotent => true, :retry_limit => 6)
 
-# opt-out of nonblocking operations for performance and/or as a workaround
-connection.request(:nonblock => false)
-
 # set longer read_timeout (default is 60 seconds)
 connection.request(:read_timeout => 360)
 
@@ -104,6 +102,9 @@ connection = Excon.new('http://geemus.com/', :omit_default_port => true)
 
 # set longer connect_timeout (default is 60 seconds)
 connection = Excon.new('http://geemus.com/', :connect_timeout => 360)
+
+# opt-out of nonblocking operations for performance and/or as a workaround
+connection = Excon.new('http://geemus.com/', :nonblock => false)
 ```
 
 Chunked Requests

data/changelog.txt

@@ -1,3 +1,16 @@
+0.29.0 11/07/2013
+=================
+
+make nonblock invalid as request key
+add backtrace to all warnings
+do not allow idempotent + pipeline
+close socket after pipeline if needed
+fix Socket#read to match IO.read EOF behavior
+use Socket#read for non-blocking readline
+respect read_timeout for status read
+read response until status line, discard chunked trailer
+fix redirect follower to properly change host
+
 0.28.0 10/28/2013
 =================
 

data/excon.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'excon'
-  s.version           = '0.28.0'
-  s.date              = '2013-10-28'
+  s.version           = '0.29.0'
+  s.date              = '2013-11-07'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long

data/lib/excon.rb

@@ -80,13 +80,13 @@ module Excon
     def display_warning(warning)
       # Respect Ruby's $VERBOSE setting, unless EXCON_DEBUG is set
       if !$VERBOSE.nil? || ENV['EXCON_DEBUG']
-        $stderr.puts "[excon][WARNING] #{ warning }"
+        $stderr.puts '[excon][WARNING] ' << warning << "\n#{ caller.join("\n") }"
       end
     end
 
     # Status of mocking
     def mock
-      display_warning("Excon#mock is deprecated, use Excon.defaults[:mock] instead (#{caller.first})")
+      display_warning('Excon#mock is deprecated, use Excon.defaults[:mock] instead.')
       self.defaults[:mock]
     end
 
@@ -94,33 +94,33 @@ module Excon
     # false is the default and works as expected
     # true returns a value from stubs or raises
     def mock=(new_mock)
-      display_warning("Excon#mock is deprecated, use Excon.defaults[:mock]= instead (#{caller.first})")
+      display_warning('Excon#mock is deprecated, use Excon.defaults[:mock]= instead.')
       self.defaults[:mock] = new_mock
     end
 
     # @return [String] The filesystem path to the SSL Certificate Authority
     def ssl_ca_path
-      display_warning("Excon#ssl_ca_path is deprecated, use Excon.defaults[:ssl_ca_path] instead (#{caller.first})")
+      display_warning('Excon#ssl_ca_path is deprecated, use Excon.defaults[:ssl_ca_path] instead.')
       self.defaults[:ssl_ca_path]
     end
 
     # Change path to the SSL Certificate Authority
     # @return [String] The filesystem path to the SSL Certificate Authority
     def ssl_ca_path=(new_ssl_ca_path)
-      display_warning("Excon#ssl_ca_path= is deprecated, use Excon.defaults[:ssl_ca_path]= instead (#{caller.first})")
+      display_warning('Excon#ssl_ca_path= is deprecated, use Excon.defaults[:ssl_ca_path]= instead.')
       self.defaults[:ssl_ca_path] = new_ssl_ca_path
     end
 
     # @return [true, false] Whether or not to verify the peer's SSL certificate / chain
     def ssl_verify_peer
-      display_warning("Excon#ssl_verify_peer is deprecated, use Excon.defaults[:ssl_verify_peer] instead (#{caller.first})")
+      display_warning('Excon#ssl_verify_peer is deprecated, use Excon.defaults[:ssl_verify_peer] instead.')
       self.defaults[:ssl_verify_peer]
     end
 
     # Change the status of ssl peer verification
     # @see Excon#ssl_verify_peer (attr_reader)
     def ssl_verify_peer=(new_ssl_verify_peer)
-      display_warning("Excon#ssl_verify_peer= is deprecated, use Excon.defaults[:ssl_verify_peer]= instead (#{caller.first})")
+      display_warning('Excon#ssl_verify_peer= is deprecated, use Excon.defaults[:ssl_verify_peer]= instead.')
       self.defaults[:ssl_verify_peer] = new_ssl_verify_peer
     end
 

data/lib/excon/connection.rb

@@ -5,29 +5,29 @@ module Excon
     attr_reader :data
 
     def connection
-      Excon.display_warning("Excon::Connection#connection is deprecated use Excon::Connection#data instead (#{caller.first})")
+      Excon.display_warning('Excon::Connection#connection is deprecated use Excon::Connection#data instead.')
       @data
     end
     def connection=(new_params)
-      Excon.display_warning("Excon::Connection#connection= is deprecated. Use of this method may cause unexpected results. (#{caller.first})")
+      Excon.display_warning('Excon::Connection#connection= is deprecated. Use of this method may cause unexpected results.')
       @data = new_params
     end
 
     def params
-      Excon.display_warning("Excon::Connection#params is deprecated use Excon::Connection#data instead (#{caller.first})")
+      Excon.display_warning('Excon::Connection#params is deprecated use Excon::Connection#data instead.')
       @data
     end
     def params=(new_params)
-      Excon.display_warning("Excon::Connection#params= is deprecated. Use of this method may cause unexpected results. (#{caller.first})")
+      Excon.display_warning('Excon::Connection#params= is deprecated. Use of this method may cause unexpected results.')
       @data = new_params
     end
 
     def proxy
-      Excon.display_warning("Excon::Connection#proxy is deprecated use Excon::Connection#data[:proxy] instead (#{caller.first})")
+      Excon.display_warning('Excon::Connection#proxy is deprecated use Excon::Connection#data[:proxy] instead.')
       @data[:proxy]
     end
     def proxy=(new_proxy)
-      Excon.display_warning("Excon::Connection#proxy= is deprecated. Use of this method may cause unexpected results. (#{caller.first})")
+      Excon.display_warning('Excon::Connection#proxy= is deprecated. Use of this method may cause unexpected results.')
       @data[:proxy] = new_proxy
     end
 
@@ -232,13 +232,19 @@ module Excon
       end
 
       if block_given?
-        Excon.display_warning("Excon requests with a block are deprecated, pass :response_block instead (#{caller.first})")
+        Excon.display_warning('Excon requests with a block are deprecated, pass :response_block instead.')
         datum[:response_block] = Proc.new
       end
 
-      if datum[:request_block] && datum[:idempotent]
-        Excon.display_warning("Excon requests with a :request_block can not be :idempotent (#{caller.first})")
-        datum[:idempotent] = false
+      if datum[:idempotent]
+        if datum[:request_block]
+          Excon.display_warning('Excon requests with a :request_block can not be :idempotent.')
+          datum[:idempotent] = false
+        end
+        if datum[:pipeline]
+          Excon.display_warning("Excon requests can not be :idempotent when pipelining.")
+          datum[:idempotent] = false
+        end
       end
 
       datum[:connection] = self
@@ -274,11 +280,17 @@ module Excon
     # Sends the supplied requests to the destination host using pipelining.
     #   @pipeline_params [Array<Hash>] pipeline_params An array of one or more optional params, override defaults set in Connection.new, see #request for details
     def requests(pipeline_params)
-      pipeline_params.map do |params|
+      responses = pipeline_params.map do |params|
         request(params.merge!(:pipeline => true))
       end.map do |datum|
         Excon::Response.new(response(datum)[:response])
       end
+
+      if responses.last[:headers]['Connection'] == 'close'
+        reset
+      end
+
+      responses
     end
 
     def reset
@@ -295,12 +307,12 @@ module Excon
     end
 
     def retry_limit=(new_retry_limit)
-      Excon.display_warning("Excon::Connection#retry_limit= is deprecated, pass :retry_limit to the initializer (#{caller.first})")
+      Excon.display_warning('Excon::Connection#retry_limit= is deprecated, pass :retry_limit to the initializer.')
       @data[:retry_limit] = new_retry_limit
     end
 
     def retry_limit
-      Excon.display_warning("Excon::Connection#retry_limit is deprecated, use Excon::Connection#data[:retry_limit]. (#{caller.first})")
+      Excon.display_warning('Excon::Connection#retry_limit is deprecated, use Excon::Connection#data[:retry_limit].')
       @data[:retry_limit] ||= DEFAULT_RETRY_LIMIT
     end
 
@@ -349,7 +361,7 @@ module Excon
       end
       invalid_keys = params.keys - valid_keys
       unless invalid_keys.empty?
-        Excon.display_warning("Invalid Excon #{validation} keys: #{invalid_keys.map(&:inspect).join(', ')}\n#{ caller.join("\n") }")
+        Excon.display_warning("Invalid Excon #{validation} keys: #{invalid_keys.map(&:inspect).join(', ')}")
         # FIXME: for now, just warn, don't mutate, give things (ie fog) a chance to catch up
         #params = params.dup
         #invalid_keys.each {|key| params.delete(key) }

data/lib/excon/constants.rb

@@ -1,6 +1,6 @@
 module Excon
 
-  VERSION = '0.28.0'
+  VERSION = '0.29.0'
 
   CR_NL = "\r\n"
 
@@ -49,7 +49,6 @@ module Excon
     :method,
     :middlewares,
     :mock,
-    :nonblock,
     :path,
     :pipeline,
     :query,
@@ -73,6 +72,7 @@ module Excon
     :family,
     :host,
     :omit_default_port,
+    :nonblock,
     :password,
     :port,
     :proxy,

data/lib/excon/middlewares/redirect_follower.rb

@@ -21,6 +21,7 @@ module Excon
             params[:headers].delete('Authorization')
             params[:headers].delete('Proxy-Connection')
             params[:headers].delete('Proxy-Authorization')
+            params[:headers].delete('Host')
             params.merge!(
               :scheme     => uri.scheme,
               :host       => uri.host,

data/lib/excon/response.rb

@@ -30,13 +30,16 @@ module Excon
     end
 
     def self.parse(socket, datum)
+      # this will discard any trailing lines from the previous response if any.
+      until match = /^HTTP\/\d+\.\d+\s(\d{3})\s/.match(socket.readline); end
+      status = match[1].to_i
+
       datum[:response] = {
         :body       => '',
         :headers    => {},
-        :status     => socket.read(12)[9, 11].to_i,
+        :status     => status,
         :remote_ip  => socket.respond_to?(:remote_ip) && socket.remote_ip
       }
-      socket.readline # read the rest of the status line and CRLF
 
       until ((data = socket.readline).chop!).empty?
         key, value = data.split(/:\s*/, 2)
@@ -56,11 +59,11 @@ module Excon
         # if expects matched and there is a block, use it
         if expected_status && datum.has_key?(:response_block)
           if transfer_encoding_chunked
-            # 2 == "/r/n".length
+            # 2 == "\r\n".length
             while (chunk_size = socket.readline.chop!.to_i(16)) > 0
               datum[:response_block].call(socket.read(chunk_size + 2).chop!, nil, nil)
             end
-            socket.read(2)
+            socket.read(2) # empty chunk-body
           elsif remaining = content_length
             while remaining > 0
               datum[:response_block].call(socket.read([datum[:chunk_size], remaining].min), [remaining - datum[:chunk_size], 0].max, content_length)
@@ -73,10 +76,11 @@ module Excon
           end
         else # no block or unexpected status
           if transfer_encoding_chunked
+            # 2 == "\r\n".length
             while (chunk_size = socket.readline.chop!.to_i(16)) > 0
-              datum[:response][:body] << socket.read(chunk_size + 2).chop! # 2 == "/r/n".length
+              datum[:response][:body] << socket.read(chunk_size + 2).chop!
             end
-            socket.read(2) # 2 == "/r/n".length
+            socket.read(2) # empty chunk-body
           elsif remaining = content_length
             while remaining > 0
               datum[:response][:body] << socket.read([datum[:chunk_size], remaining].min)
@@ -106,7 +110,7 @@ module Excon
     end
 
     def params
-      Excon.display_warning("Excon::Response#params is deprecated use Excon::Response#data instead (#{caller.first})")
+      Excon.display_warning('Excon::Response#params is deprecated use Excon::Response#data instead.')
       data
     end
 

data/lib/excon/socket.rb

@@ -7,21 +7,21 @@ module Excon
     attr_accessor :data
 
     def params
-      Excon.display_warning("Excon::Socket#params is deprecated use Excon::Socket#data instead (#{caller.first})")
+      Excon.display_warning('Excon::Socket#params is deprecated use Excon::Socket#data instead.')
       @data
     end
     def params=(new_params)
-      Excon.display_warning("Excon::Socket#params= is deprecated use Excon::Socket#data= instead (#{caller.first})")
+      Excon.display_warning('Excon::Socket#params= is deprecated use Excon::Socket#data= instead.')
       @data = new_params
     end
 
     attr_reader :remote_ip
 
     def_delegators(:@socket, :close,    :close)
-    def_delegators(:@socket, :readline, :readline)
 
     def initialize(data = {})
       @data = data
+      @nonblock = data[:nonblock]
       @read_buffer = ''
       @eof = false
 
@@ -30,8 +30,8 @@ module Excon
 
     def read(max_length=nil)
       if @eof
-        return nil
-      elsif @data[:nonblock]
+        return max_length ? nil : ''
+      elsif @nonblock
         begin
           if max_length
             until @read_buffer.length >= max_length
@@ -61,8 +61,13 @@ module Excon
         rescue EOFError
           @eof = true
         end
+
         if max_length
-          @read_buffer.slice!(0, max_length)
+          if @read_buffer.empty?
+            nil # EOF met at beginning
+          else
+            @read_buffer.slice!(0, max_length)
+          end
         else
           # read until EOFError, so return everything
           @read_buffer.slice!(0, @read_buffer.length)
@@ -78,8 +83,32 @@ module Excon
       end
     end
 
+    def readline
+      if @eof
+        raise EOFError, 'end of file reached'
+      else
+        line = ''
+        if @nonblock
+          while char = read(1)
+            line << char
+            break if char == $/
+          end
+          raise EOFError, 'end of file reached' if line.empty?
+        else
+          begin
+            Timeout.timeout(@data[:read_timeout]) do
+              line = @socket.readline
+            end
+          rescue Timeout::Error
+            raise Excon::Errors::Timeout.new('read timeout reached')
+          end
+        end
+        line
+      end
+    end
+
     def write(data)
-      if @data[:nonblock]
+      if @nonblock
         if FORCE_ENC
           data.force_encoding('BINARY')
         end
@@ -144,7 +173,7 @@ module Excon
 
           socket = ::Socket.new(a_family, s_type, 0)
 
-          if @data[:nonblock]
+          if @nonblock
             socket.connect_nonblock(sockaddr)
           else
             begin

data/lib/excon/ssl_socket.rb

@@ -2,9 +2,6 @@ module Excon
   class SSLSocket < Socket
 
     def initialize(data = {})
-      @data = data
-      check_nonblock_support
-
       super
 
       # create ssl context
@@ -30,7 +27,7 @@ module Excon
           begin
             ssl_context.cert_store.add_file(ca_file)
           rescue => e
-            Excon.display_warning("Excon unable to add file to cert store, ignoring: #{ca_file}\n[#{e.class}] #{e.message}\n#{e.backtrace.join("\n")}")
+            Excon.display_warning("Excon unable to add file to cert store, ignoring: #{ca_file}\n[#{e.class}] #{e.message}")
           end
         end
       else
@@ -88,22 +85,12 @@ module Excon
       @socket
     end
 
-    def read(max_length=nil)
-      check_nonblock_support
-      super
-    end
-
-    def write(data)
-      check_nonblock_support
-      super
-    end
-
     private
 
     def check_nonblock_support
       # backwards compatability for things lacking nonblock
-      if !DEFAULT_NONBLOCK && @data[:nonblock]
-        @data[:nonblock] = false
+      if !DEFAULT_NONBLOCK && @nonblock
+        @nonblock = false
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -245,7 +245,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 527099065426297719
+      hash: -2194157728593914934
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: