excon 0.33.0 → 0.34.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2YwNTZjYTAxYWZmNGIwNjc1NTZiN2EzNTkzYTgzM2YyNGFiYzZiMw==
+    N2M4Mjg5MGIyMmMzZmU0MzU3MWQ3MzkwMWMxNzk1NWI3N2NjYmEyNQ==
   data.tar.gz: !binary |-
-    NjkwYzY3MDg3NzIwNzZmNzU3MTRiMzQxMjc5MjliMTBlYzNlNGMwNQ==
+    YmIwZDllZDA5YWE5YTc4OTgyNTA5MDJhZmU3ZGVmYjBkNTFkYTNkZA==
 SHA512:
   metadata.gz: !binary |-
-    YzZmM2U5MmIxNjRjMzQ0OWI3Yjg1ODE4ODBmN2IzM2RjYjcyNzRjYjlkOGVi
-    YTE1OWJkNTBiNTgwYzUyMjY1NzUxOTIyN2U5NjY1MTNiMzRhYjU1ZDEyOGVi
-    ZTY1YTQ3NWE1MjBmNGFiNzgwMWMxNjdhM2NjOTI1NTA2YjMyODY=
+    YzZmZDc4ZDFhMjRkM2IxNWRmMzM3ZGFlNWQ3YWFiYmEzM2UwOWUwYTQzNjU0
+    NGU1NzllYzNkNDBhYjE3ZWFlMGMwNTBjNDI2NDBlZmYwYzAzMjMxYTBiNzlh
+    YTU0MjU4OGJmYzc0MjNmYmVhMzVkNzZiN2NiZTI5ZWE2Y2M5MDc=
   data.tar.gz: !binary |-
-    MTlhYzI2Y2Y0NWM2Y2ViZTAyM2MzNTdjN2YzMmIwOGQ1MTgzNzQwNDE1ODlj
-    OThhZTg1NDRkYTRhNWUzNzE2NGU5NTRiMjY2Y2Y2MjVkN2E5ZWQzYzUwYjY2
-    NTI3ZmJjYjA1MjA1MzBhZWZiYmU5YTY0YWRmZGM2YTcwOGFhYzI=
+    NWU4NGRiM2RjMmY5OGVlYWQzMjFjY2Q3OThhMjBjY2UwNmY5MDllNTk5NGEx
+    MTYzNmU4Y2MzNDBjNzA4ZWU4M2QyOTM2YTc3YTBmZDAwMDllNDc2MWQ0ODMz
+    OWY0MTExMTIyOWU5ZDk5ZTI1OWI4MmEzNTZjNTA0ODVlOWJkMTA=

data/CONTRIBUTORS.md

@@ -17,6 +17,7 @@
 * Dave Myron <therealdave.myron@gmail.com>
 * Dave Newton <davelnewton@gmail.com>
 * Dimitrij Denissenko <dimitrij@blacksquaremedia.com>
+* Dominik Richter <dominik.richter@gmail.com>
 * Eugene Howe <eugene@xtreme-computers.net>
 * Evan Phoenix <evan@fallingsnow.net>
 * Fabian Wiesel <fabian.wiesel@sap.com>
@@ -37,6 +38,7 @@
 * Joshua Napoli <jnapoli@swipely-napoli.local>
 * Konstantin Shabanov <etehtsea@gmail.com>
 * Kyle Rames <kyle.rames@rackspace.com>
+* Lewis Marshall <lewis@lmars.net>
 * Lincoln Stoll <me@lstoll.net>
 * Louis Sobel <sobel@mit.edu>
 * Mathias Meyer <meyer@paperplanes.de>

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 gem 'jruby-openssl', :platform => :jruby
 gem 'unicorn', :platforms => [:mri, :rbx]
 gem 'rubysl', '~> 2.0', :platform => :rbx
+gem 'rack', '~> 1.5'
 
 # group :benchmark do
 #   gem 'em-http-request'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    excon (0.33.0)
+    excon (0.34.0)
 
 GEM
   remote: http://rubygems.org/
@@ -22,14 +22,14 @@ GEM
       bouncy-castle-java (>= 1.5.0147)
     json (1.7.3)
     json (1.7.3-java)
-    kgio (2.8.0)
+    kgio (2.9.2)
     minitest (4.7.5)
     multi_json (1.3.6)
     open4 (1.3.0)
-    rack (1.4.1)
+    rack (1.5.2)
     rack-protection (1.2.0)
       rack
-    raindrops (0.11.0)
+    raindrops (0.13.0)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -245,7 +245,7 @@ GEM
       rack-protection (~> 1.2)
       tilt (~> 1.3, >= 1.3.3)
     tilt (1.3.3)
-    unicorn (4.6.3)
+    unicorn (4.8.3)
       kgio (~> 2.6)
       rack
       raindrops (~> 0.7)
@@ -261,6 +261,7 @@ DEPENDENCIES
   excon!
   jruby-openssl
   open4
+  rack (~> 1.5)
   rake
   rdoc
   rubysl (~> 2.0)

data/changelog.txt

@@ -1,3 +1,13 @@
+0.34.0 05/29/2014
+=================
+
+add support for setting ssl_verify_callback
+stream partial results imediately, when available
+update rack/unicorn in tests to support streaming tests
+skip streaming tests on jruby (as they depend on unicorn)
+update travis tests to use newest rubinius
+improve formatting/readibility of standard instrumentor output
+
 0.33.0 05/15/2014
 =================
 

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.33.0'
-  s.date              = '2014-04-15'
+  s.version           = '0.34.0'
+  s.date              = '2014-05-29'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -145,6 +145,7 @@ Gem::Specification.new do |s|
     tests/rackups/response_header.ru
     tests/rackups/ssl.ru
     tests/rackups/ssl_verify_peer.ru
+    tests/rackups/streaming.ru
     tests/rackups/thread_safety.ru
     tests/rackups/timeout.ru
     tests/rackups/webrick_patch.rb

data/lib/excon.rb

@@ -157,13 +157,13 @@ module Excon
       end
       if url = request_params.delete(:url)
         uri = URI.parse(url)
-        request_params.update(
+        request_params = {
           :host              => uri.host,
           :path              => uri.path,
           :port              => uri.port,
           :query             => uri.query,
           :scheme            => uri.scheme
-        )
+        }.merge!(request_params)
         if uri.user || uri.password
           request_params[:headers] ||= {}
           user, pass = Utils.unescape_form(uri.user.to_s), Utils.unescape_form(uri.password.to_s)

data/lib/excon/constants.rb

@@ -1,6 +1,6 @@
 module Excon
 
-  VERSION = '0.33.0'
+  VERSION = '0.34.0'
 
   CR_NL = "\r\n"
 
@@ -77,6 +77,7 @@ module Excon
     :scheme,
     :socket,
     :ssl_ca_file,
+    :ssl_verify_callback,
     :ssl_verify_peer,
     :ssl_version,
     :tcp_nodelay,

data/lib/excon/errors.rb

@@ -9,7 +9,7 @@ module Excon
 
       def initialize(socket_error=nil)
         if socket_error.message =~ /certificate verify failed/
-          super("Unable to verify certificate, please set `Excon.defaults[:ssl_ca_path] = path_to_certs`, `ENV['SSL_CERT_DIR'] = path_to_certs`, `Excon.defaults[:ssl_ca_file] = path_to_file`, `ENV['SSL_CERT_FILE'] = path_to_file` or `Excon.defaults[:ssl_verify_peer] = false` (less secure).")
+          super("Unable to verify certificate, please set `Excon.defaults[:ssl_ca_path] = path_to_certs`, `ENV['SSL_CERT_DIR'] = path_to_certs`, `Excon.defaults[:ssl_ca_file] = path_to_file`, `ENV['SSL_CERT_FILE'] = path_to_file`, `Excon.defaults[:ssl_verify_callback] = callback` (see OpenSSL::SSL::SSLContext#verify_callback), or `Excon.defaults[:ssl_verify_peer] = false` (less secure).")
         else
           super("#{socket_error.message} (#{socket_error.class})")
         end

data/lib/excon/response.rb

@@ -105,7 +105,9 @@ module Excon
               response_block.call(chunk, nil, nil)
             end
           else
-            datum[:response][:body] << socket.read
+            while chunk = socket.read(datum[:chunk_size])
+              datum[:response][:body] << chunk
+            end
           end
         end
       end

data/lib/excon/socket.rb

@@ -53,10 +53,13 @@ module Excon
             raise(error)
           end
         rescue Errno::EAGAIN, Errno::EWOULDBLOCK, IO::WaitReadable
-          if IO.select([@socket], nil, nil, @data[:read_timeout])
-            retry
-          else
-            raise(Excon::Errors::Timeout.new("read timeout reached"))
+          if @read_buffer.empty?
+            # if we didn't read anything, try again...
+            if IO.select([@socket], nil, nil, @data[:read_timeout])
+              retry
+            else
+              raise(Excon::Errors::Timeout.new("read timeout reached"))
+            end
           end
         rescue EOFError
           @eof = true

data/lib/excon/ssl_socket.rb

@@ -47,6 +47,10 @@ module Excon
             Excon.display_warning("Excon unable to add file to cert store, ignoring: #{ca_file}\n[#{e.class}] #{e.message}")
           end
         end
+
+        if verify_callback = @data[:ssl_verify_callback]
+          ssl_context.verify_callback = verify_callback
+        end
       else
         # turn verification off
         ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE

data/lib/excon/standard_instrumentor.rb

@@ -2,14 +2,48 @@ module Excon
   class StandardInstrumentor
     def self.instrument(name, params = {}, &block)
       params = params.dup
+
+      # reduce duplication/noise of output
+      params.delete(:connection)
+      params.delete(:stack)
+
       if params.has_key?(:headers) && params[:headers].has_key?('Authorization')
         params[:headers] = params[:headers].dup
         params[:headers]['Authorization'] = REDACTED
       end
+
       if params.has_key?(:password)
         params[:password] = REDACTED
       end
-      $stderr.puts("#{name}  #{params.inspect}")
+
+      $stderr.puts(name)
+      indent = 0
+      pretty_printer = lambda do |hash|
+        indent += 2
+        max_key_length = hash.keys.map {|key| key.inspect.length}.max
+        hash.keys.sort_by {|key| key.to_s}.each do |key|
+          value = hash[key]
+          $stderr.write("#{' ' * indent}#{key.inspect.ljust(max_key_length)} => ")
+          case value
+          when Array
+            $stderr.puts("[")
+            value.each do |v|
+              $stderr.puts("#{' ' * indent}  #{v.inspect}")
+            end
+            $stderr.write("#{' ' * indent}]")
+          when Hash
+            $stderr.puts("{")
+            pretty_printer.call(value)
+            $stderr.write("#{' ' * indent}}")
+          else
+            $stderr.write("#{value.inspect}")
+          end
+          $stderr.puts
+        end
+        indent -= 2
+      end
+      pretty_printer.call(params)
+
       if block_given?
         yield
       end

data/tests/basic_tests.rb

@@ -18,6 +18,51 @@ Shindo.tests('Excon basics') do
   end
 end
 
+Shindo.tests('Excon streaming basics') do
+  pending if RUBY_PLATFORM == 'java' # need to find suitable server for jruby
+  with_unicorn('streaming.ru') do
+    # expected values: the response, in pieces, and a timeout after each piece
+    res = %w{Hello streamy world}
+    timeout = 1
+
+    # expect the full response as a string
+    # and expect it to take a (timeout * pieces) seconds
+    tests('simple blocking request on streaming endpoint').returns([res.join(''),'response time ok']) do
+      start = Time.now
+      ret = Excon.get('http://127.0.0.1:9292/streamed/simple').body
+
+      if Time.now - start <= timeout*3
+        [ret, 'streaming response came too quickly']
+      else
+        [ret, 'response time ok']
+      end
+    end
+
+    # expect each response piece to arrive to the body right away
+    # and wait for timeout until next one arrives
+    tests('simple request with response_block on streaming endpoint').returns([res,'response times ok']) do
+      ret = []
+      timing = 'response times ok'
+      start = Time.now
+      Excon.get('http://127.0.0.1:9292/streamed/simple', :response_block => lambda do |c,r,t|
+        # check if the timing is ok
+        # each response arrives after timeout and before timeout + 1
+        cur_time = Time.now - start
+        if cur_time < ret.length * timeout or cur_time > (ret.length+1) * timeout
+          timing = 'response time not ok!'
+        end
+        # add the response
+        ret.push(c)
+      end)
+      # validate the final timing
+      if Time.now - start <= timeout*3
+        timing = 'final timing was not ok!'
+      end
+      [ret, timing]
+    end
+  end
+end
+
 Shindo.tests('Excon basics (Basic Auth Pass)') do
   with_rackup('basic_auth.ru') do
     basic_tests('http://test_user:test_password@127.0.0.1:9292')
@@ -102,7 +147,7 @@ Shindo.tests('Excon basics (Unix socket)') do
   pending if RUBY_PLATFORM == 'java' # need to find suitable server for jruby
 
   file_name = '/tmp/unicorn.sock'
-  with_unicorn('basic.ru', file_name) do
+  with_unicorn('basic.ru', 'unix://'+file_name) do
     basic_tests("unix:/", :socket => file_name)
 
     tests('explicit uri passed to connection') do

data/tests/middlewares/instrumentation_tests.rb

@@ -155,7 +155,7 @@ Shindo.tests('Excon instrumentation') do
           connection.get(:idempotent => true)
         end
 
-        captured_stderr.string.split("\n").map {|event| event.split(' ').first}
+        captured_stderr.string.split("\n").reject {|line| line =~ %r{^  }}.map {|event| event.split(' ').first}
       ensure
         $stderr = original_stderr
       end

data/tests/rackups/streaming.ru

@@ -0,0 +1,20 @@
+use Rack::ContentType, "text/plain"
+
+app = lambda do |env|
+  response_headers = {}
+  response_headers["rack.hijack"] = lambda do |io|
+    # Write directly to IO of the response
+    begin
+      ['Hello','streamy','world'].each do |x|
+        io.write(x)
+        io.flush
+        sleep 1
+      end
+    ensure
+      io.close
+    end
+  end
+  [200, response_headers, nil]
+end
+
+run app

data/tests/test_helper.rb

@@ -263,10 +263,11 @@ ensure
   end
 end
 
-def with_unicorn(name, file_name='/tmp/unicorn.sock')
+def with_unicorn(name, listen='127.0.0.1:9292')
   unless RUBY_PLATFORM == 'java'
     GC.disable if RUBY_VERSION < '1.9'
-    pid, w, r, e = Open4.popen4("unicorn", "-l", "unix://#{file_name}", rackup_path(name))
+    unix_socket = listen.sub('unix://', '') if listen.start_with? 'unix://'
+    pid, w, r, e = Open4.popen4("unicorn", "--no-default-middleware","-l", listen, rackup_path(name))
     until e.gets =~ /worker=0 ready/; end
   else
     # need to find suitable server for jruby
@@ -278,8 +279,8 @@ ensure
     GC.enable if RUBY_VERSION < '1.9'
     Process.wait(pid)
   end
-  if File.exist?(file_name)
-    File.delete(file_name)
+  if not unix_socket.nil? and File.exist?(unix_socket)
+    File.delete(unix_socket)
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -208,6 +208,7 @@ files:
 - tests/rackups/response_header.ru
 - tests/rackups/ssl.ru
 - tests/rackups/ssl_verify_peer.ru
+- tests/rackups/streaming.ru
 - tests/rackups/thread_safety.ru
 - tests/rackups/timeout.ru
 - tests/rackups/webrick_patch.rb