excon 0.31.0 → 0.32.0

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.31.0'
-  s.date              = '2013-12-16'
+  s.version           = '0.32.0'
+  s.date              = '2014-02-27'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -68,8 +68,11 @@ Gem::Specification.new do |s|
   ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
+    CONTRIBUTING.md
+    CONTRIBUTORS.md
     Gemfile
     Gemfile.lock
+    LICENSE.md
     README.md
     Rakefile
     benchmarks/class_vs_lambda.rb
@@ -99,6 +102,7 @@ Gem::Specification.new do |s|
     lib/excon/errors.rb
     lib/excon/middlewares/base.rb
     lib/excon/middlewares/decompress.rb
+    lib/excon/middlewares/escape_path.rb
     lib/excon/middlewares/expects.rb
     lib/excon/middlewares/idempotent.rb
     lib/excon/middlewares/instrumentor.rb
@@ -121,6 +125,7 @@ Gem::Specification.new do |s|
     tests/header_tests.rb
     tests/middlewares/canned_response_tests.rb
     tests/middlewares/decompress_tests.rb
+    tests/middlewares/escape_path_tests.rb
     tests/middlewares/idempotent_tests.rb
     tests/middlewares/instrumentation_tests.rb
     tests/middlewares/mock_tests.rb

data/lib/excon.rb

@@ -11,8 +11,6 @@ require 'uri'
 require 'zlib'
 require 'stringio'
 
-BasicSocket.do_not_reverse_lookup = true
-
 # Define defaults first so they will be available to other files
 module Excon
   class << self
@@ -65,6 +63,7 @@ require 'excon/connection'
 require 'excon/errors'
 require 'excon/middlewares/base'
 require 'excon/middlewares/decompress'
+require 'excon/middlewares/escape_path'
 require 'excon/middlewares/expects'
 require 'excon/middlewares/idempotent'
 require 'excon/middlewares/instrumentor'

data/lib/excon/connection.rb

@@ -269,7 +269,7 @@ module Excon
 
         if datum[:persistent]
           if key = datum[:response][:headers].keys.detect {|k| k.casecmp('Connection') == 0 }
-            if split_header_value(datum[:response][:headers][key]).any? {|t| t.casecmp('close') }
+            if split_header_value(datum[:response][:headers][key]).any? {|t| t.casecmp('close') == 0 }
               reset
             end
           end
@@ -305,7 +305,7 @@ module Excon
 
       if @data[:persistent]
         if key = responses.last[:headers].keys.detect {|k| k.casecmp('Connection') == 0 }
-          if split_header_value(responses.last[:headers][key]).any? {|t| t.casecmp('close') }
+          if split_header_value(responses.last[:headers][key]).any? {|t| t.casecmp('close') == 0 }
             reset
           end
         end

data/lib/excon/constants.rb

@@ -1,6 +1,6 @@
 module Excon
 
-  VERSION = '0.31.0'
+  VERSION = '0.32.0'
 
   CR_NL = "\r\n"
 
@@ -70,6 +70,7 @@ module Excon
     :host,
     :omit_default_port,
     :nonblock,
+    :reuseaddr,
     :password,
     :port,
     :proxy,

data/lib/excon/middlewares/escape_path.rb

@@ -0,0 +1,11 @@
+module Excon
+  module Middleware
+    class EscapePath < Excon::Middleware::Base
+      def request_call(datum)
+        # make sure path is encoded, prevent double encoding
+        datum[:path] = Excon::Utils.escape_uri(Excon::Utils.unescape_uri(datum[:path]))
+        @stack.request_call(datum)
+      end
+    end
+  end
+end

data/lib/excon/response.rb

@@ -28,6 +28,12 @@ module Excon
     def remote_ip
       @data[:remote_ip]
     end
+    def local_port
+      @data[:local_port]
+    end
+    def local_address
+      @data[:local_address]
+    end
 
     def self.parse(socket, datum)
       # this will discard any trailing lines from the previous response if any.
@@ -35,10 +41,12 @@ module Excon
       status = match[1].to_i
 
       datum[:response] = {
-        :body       => '',
-        :headers    => {},
-        :status     => status,
-        :remote_ip  => socket.respond_to?(:remote_ip) && socket.remote_ip
+        :body          => '',
+        :headers       => {},
+        :status        => status,
+        :remote_ip     => socket.respond_to?(:remote_ip) && socket.remote_ip,
+        :local_port    => socket.respond_to?(:local_port) && socket.local_port,
+        :local_address => socket.respond_to?(:local_address) && socket.local_address
       }
 
       parse_headers(socket, datum)
@@ -126,10 +134,12 @@ module Excon
         :body     => '',
         :headers  => {}
       }.merge(params)
-      @body      = @data[:body]
-      @headers   = @data[:headers]
-      @status    = @data[:status]
-      @remote_ip = @data[:remote_ip]
+      @body          = @data[:body]
+      @headers       = @data[:headers]
+      @status        = @data[:status]
+      @remote_ip     = @data[:remote_ip]
+      @local_port    = @data[:local_port]
+      @local_address = @data[:local_address]
     end
 
     def [](key)

data/lib/excon/socket.rb

@@ -145,24 +145,40 @@ module Excon
             @socket.write(data)
           end
         rescue Timeout::Error
-          Excon::Errors::Timeout.new('write timeout reached')
+          raise(Excon::Errors::Timeout.new('write timeout reached'))
         end
       end
     end
 
+    def local_port
+      ::Socket.unpack_sockaddr_in(@socket.to_io.getsockname)[0]
+    rescue ArgumentError => e
+      raise unless e.message == 'not an AF_INET/AF_INET6 sockaddr'
+    end
+
+    def local_address
+      ::Socket.unpack_sockaddr_in(@socket.to_io.getsockname)[1]
+    rescue ArgumentError => e
+      raise unless e.message == 'not an AF_INET/AF_INET6 sockaddr'
+    end
+
     private
 
     def connect
       @socket = nil
       exception = nil
 
-      addrinfo = if @data[:proxy]
+      if @data[:proxy]
         family = @data[:proxy][:family] || ::Socket::Constants::AF_UNSPEC
-        ::Socket.getaddrinfo(@data[:proxy][:host], @data[:proxy][:port], family, ::Socket::Constants::SOCK_STREAM)
+        args = [@data[:proxy][:host], @data[:proxy][:port], family, ::Socket::Constants::SOCK_STREAM]
       else
         family = @data[:family] || ::Socket::Constants::AF_UNSPEC
-        ::Socket.getaddrinfo(@data[:host], @data[:port], family, ::Socket::Constants::SOCK_STREAM)
+        args = [@data[:host], @data[:port], family, ::Socket::Constants::SOCK_STREAM]
       end
+      if RUBY_VERSION >= '1.9.2' && defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby'
+        args << nil << nil << false # no reverse lookup
+      end
+      addrinfo = ::Socket.getaddrinfo(*args)
 
       addrinfo.each do |_, port, _, ip, a_family, s_type|
         @remote_ip = ip
@@ -173,16 +189,23 @@ module Excon
 
           socket = ::Socket.new(a_family, s_type, 0)
 
-          if @nonblock
-            socket.connect_nonblock(sockaddr)
-          else
-            begin
-              Timeout.timeout(@data[:connect_timeout]) do
+          if @data[:reuseaddr]
+            socket.setsockopt(::Socket::Constants::SOL_SOCKET, ::Socket::Constants::SO_REUSEADDR, true)
+            if defined?(::Socket::Constants::SO_REUSEPORT)
+              socket.setsockopt(::Socket::Constants::SOL_SOCKET, ::Socket::Constants::SO_REUSEPORT, true)
+            end
+          end
+
+          begin
+            Timeout.timeout(@data[:connect_timeout]) do
+              if @nonblock
+                socket.connect_nonblock(sockaddr)
+              else
                 socket.connect(sockaddr)
               end
-            rescue Timeout::Error
-              raise Excon::Errors::Timeout.new('connect timeout reached')
             end
+          rescue Timeout::Error
+            raise Excon::Errors::Timeout.new('connect timeout reached')
           end
 
           @socket = socket

data/lib/excon/ssl_socket.rb

@@ -10,8 +10,21 @@ module Excon
 
       # create ssl context
       ssl_context = OpenSSL::SSL::SSLContext.new
+
+      # disable less secure options, when supported
+      ssl_context_options = OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:options]
+      if defined?(OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS)
+        ssl_context_options &= ~OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS
+      end
+      if defined?(OpenSSL::SSL::OP_NO_COMPRESSION)
+        ssl_context_options |= OpenSSL::SSL::OP_NO_COMPRESSION
+      end
+      ssl_context.options = ssl_context_options
+
       ssl_context.ciphers = @data[:ciphers]
-      ssl_context.ssl_version = @data[:ssl_version] if @data[:ssl_version]
+      if @data[:ssl_version]
+        ssl_context.ssl_version = @data[:ssl_version]
+      end
       if @data[:ssl_verify_peer]
         # turn verification on
         ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
@@ -74,7 +87,27 @@ module Excon
       # convert Socket to OpenSSL::SSL::SSLSocket
       @socket = OpenSSL::SSL::SSLSocket.new(@socket, ssl_context)
       @socket.sync_close = true
-      @socket.connect
+      begin
+        Timeout.timeout(@data[:connect_timeout]) do
+          if @nonblock
+            while true
+              begin
+                @socket.connect_nonblock
+                break # connect succeeded
+              rescue OpenSSL::SSL::SSLError => error
+                # would block, rescue and retry as select is non-helpful
+                unless error.message == 'read would block'
+                  raise error
+                end
+              end
+            end
+          else
+            @socket.connect
+          end
+        end
+      rescue Timeout::Error
+        raise Excon::Errors::Timeout.new('connect timeout reached')
+      end
 
       # Server Name Indication (SNI) RFC 3546
       if @socket.respond_to?(:hostname=)

data/lib/excon/utils.rb

@@ -2,7 +2,12 @@ module Excon
   module Utils
     extend self
 
-    ESCAPED = /%([0-9a-fA-F]{2})/
+    control   = (0x0..0x1f).map {|c| c.chr }.join + "\x7f"
+    delims    = '<>#%"'
+    unwise    = '{}|\\^[]`'
+    nonascii  = (0x80..0xff).map {|c| c.chr }.join
+    UNESCAPED = /([#{ Regexp.escape(control + ' ' + delims + unwise + nonascii) }])/
+    ESCAPED   = /%([0-9a-fA-F]{2})/
 
     def valid_connection_keys(params = {})
       Excon::VALID_CONNECTION_KEYS
@@ -65,6 +70,14 @@ module Excon
                     (?:,\s*|\Z)'xn).flatten
     end
 
+    # Escapes HTTP reserved and unwise characters in +str+
+    def escape_uri(str)
+      str = str.dup
+      str.force_encoding('BINARY') if FORCE_ENC
+      str.gsub!(UNESCAPED) { "%%%02X" % $1[0].ord }
+      str
+    end
+
     # Unescapes HTTP reserved and unwise characters in +str+
     def unescape_uri(str)
       str = str.dup

data/tests/basic_tests.rb

@@ -119,3 +119,72 @@ Shindo.tests('Excon basics (Unix socket)') do
     end
   end
 end
+
+Shindo.tests('Excon basics (reusable local port)') do
+  class CustomSocket < Socket
+    def initialize
+      super(AF_INET, SOCK_STREAM, 0)
+      setsockopt(SOL_SOCKET, SO_REUSEADDR, true)
+      if defined?(SO_REUSEPORT)
+        setsockopt(SOL_SOCKET, SO_REUSEPORT, true)
+      end
+    end
+
+    def bind(address, port)
+      super(Socket.pack_sockaddr_in(port, address))
+    end
+
+    def connect(address, port)
+      super(Socket.pack_sockaddr_in(port, address))
+    end
+
+    def http_get(path)
+      print "GET /content-length/10 HTTP/1.0\r\n\r\n"
+      read.split("\r\n\r\n", 2)[1]
+    end
+
+    def self.ip_address_list
+      if Socket.respond_to?(:ip_address_list)
+        Socket.ip_address_list.select(&:ipv4?).map(&:ip_address)
+      else
+        `ifconfig`.scan(/inet.*?(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/).flatten
+      end
+    end
+
+    def self.find_alternate_ip(ip)
+      ip_address_list.detect {|a| a != ip } || '127.0.0.1'
+    end
+  end
+
+  with_rackup('basic.ru') do
+    connection = Excon.new("http://127.0.0.1:9292/echo",
+                           :reuseaddr => true, # enable address and port reuse
+                           :persistent => true # keep the socket open
+                           )
+    response = connection.get
+
+    tests('has a local port').returns(true) do
+      response.local_port.to_s =~ /\d{4,5}/ ? true : false
+    end
+
+    tests('local port can be re-bound').returns('x' * 10) do
+      # create a socket with address/port reuse enabled
+      s = CustomSocket.new
+
+      # bind to the same local port and address used in the get above (won't work without reuse options on both sockets)
+      s.bind(response.local_address, response.local_port)
+
+      # connect to the server on a different address than was used for the initial connection to avoid duplicate 5-tuples of: {protcol, src_port, src_addr, dst_port, dst_addr}
+      s.connect(CustomSocket.find_alternate_ip(response.local_address), 9292)
+
+      # send the request
+      body = s.http_get("/content-length/10")
+
+      # close both the sockets
+      s.close
+      connection.reset
+
+      body
+    end
+  end
+end

data/tests/middlewares/escape_path_tests.rb

@@ -0,0 +1,34 @@
+Shindo.tests('Excon Decompress Middleware') do
+  env_init
+  with_rackup('basic.ru') do
+    tests('encoded uri passed to connection') do
+      tests('GET /echo%20dirty').returns(200) do
+        connection = Excon::Connection.new({
+          :host             => '127.0.0.1',
+          :middlewares      => Excon.defaults[:middlewares] + [Excon::Middleware::EscapePath],
+          :nonblock         => false,
+          :port             => 9292,
+          :scheme           => 'http',
+          :ssl_verify_peer  => false
+        })
+        response = connection.request(:method => :get, :path => '/echo%20dirty')
+        response[:status]
+      end
+    end
+
+    tests('unencoded uri passed to connection') do
+      tests('GET /echo dirty').returns(200) do
+        connection = Excon::Connection.new({
+          :host             => '127.0.0.1',
+          :middlewares      => Excon.defaults[:middlewares] + [Excon::Middleware::EscapePath],
+          :nonblock         => false,
+          :port             => 9292,
+          :scheme           => 'http',
+          :ssl_verify_peer  => false
+        })
+        response = connection.request(:method => :get, :path => '/echo dirty')
+        response[:status]
+      end
+    end
+  end
+end

data/tests/rackups/basic.rb

@@ -22,6 +22,10 @@ class Basic < Sinatra::Base
     echo
   end
 
+  get('/echo dirty') do
+    echo
+  end
+
   private
 
   def echo

data/tests/servers/good.rb

@@ -34,6 +34,7 @@ module GoodServer
         (@request_count ||= '0').next!
         start_response
         send_data "Content-Length: #{ @request_count.size }\r\n"
+        send_data "Connection: Keep-Alive\r\n"
         send_data "\r\n"
         send_data @request_count
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.31.0
-  prerelease: 
+  version: 0.32.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
@@ -11,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -24,7 +22,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -32,7 +29,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: delorean
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -40,7 +36,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,7 +43,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -56,7 +50,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -64,7 +57,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -72,7 +64,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -80,7 +71,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -88,7 +78,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -96,7 +85,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -104,7 +92,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -112,7 +99,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: shindo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -120,7 +106,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -128,7 +113,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -136,7 +120,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -148,8 +131,11 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- CONTRIBUTING.md
+- CONTRIBUTORS.md
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - benchmarks/class_vs_lambda.rb
@@ -179,6 +165,7 @@ files:
 - lib/excon/errors.rb
 - lib/excon/middlewares/base.rb
 - lib/excon/middlewares/decompress.rb
+- lib/excon/middlewares/escape_path.rb
 - lib/excon/middlewares/expects.rb
 - lib/excon/middlewares/idempotent.rb
 - lib/excon/middlewares/instrumentor.rb
@@ -201,6 +188,7 @@ files:
 - tests/header_tests.rb
 - tests/middlewares/canned_response_tests.rb
 - tests/middlewares/decompress_tests.rb
+- tests/middlewares/escape_path_tests.rb
 - tests/middlewares/idempotent_tests.rb
 - tests/middlewares/instrumentation_tests.rb
 - tests/middlewares/mock_tests.rb
@@ -237,29 +225,25 @@ files:
 homepage: https://github.com/geemus/excon
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1399644688570873046
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: excon
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 2
 summary: speed, persistence, http(s)