excon 0.22.1 → 0.23.0

data/Gemfile.lock

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

data/README.md

@@ -83,6 +83,13 @@ Both one-off and persistent connections support many other options. Here are a f
     # set longer write_timeout (default is 60 seconds)
     connection.request(:write_timeout => 360)
 
+    # Enable the socket option TCP_NODELAY on the underlying socket.
+    #
+    # This can improve response time when sending frequent short
+    # requests in time-sensitive scenarios.
+    #
+    connection = Excon.new('http://geemus.com/', :tcp_nodelay => true)
+
 These options can be combined to make pretty much any request you might need.
 
 Excon can also expect one or more HTTP status code in response, raising an exception if the response does not meet the criteria.
@@ -251,7 +258,7 @@ Copyright
 
 (The MIT License)
 
-Copyright (c) 2010-2011 {geemus (Wesley Beary)}[http://github.com/geemus]
+Copyright (c) 2010-2013 {geemus (Wesley Beary)}[http://github.com/geemus]
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/changelog.txt

@@ -1,3 +1,13 @@
+0.23.0 06/10/2013
+=================
+
+defer writing request/headers to allow all-in-one
+allow opt-in for request/response error info
+add configurable TCP_NODELAY
+consolidate warning display
+respect ruby verbosity conventions
+fix copyright years in notice
+
 0.22.1 05/17/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.22.1'
-  s.date              = '2013-05-17'
+  s.version           = '0.23.0'
+  s.date              = '2013-06-10'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -111,6 +111,7 @@ Gem::Specification.new do |s|
     tests/data/excon.cert.crt
     tests/data/excon.cert.key
     tests/data/xs
+    tests/errors_tests.rb
     tests/header_tests.rb
     tests/middlewares/idempotent_tests.rb
     tests/middlewares/instrumentation_tests.rb
@@ -134,6 +135,7 @@ Gem::Specification.new do |s|
     tests/requests_tests.rb
     tests/servers/bad.rb
     tests/servers/eof.rb
+    tests/servers/error.rb
     tests/test_helper.rb
     tests/thread_safety_tests.rb
     tests/timeout_tests.rb

data/lib/excon.rb

@@ -18,6 +18,8 @@ module Excon
       @defaults ||= {
         :chunk_size         => CHUNK_SIZE || DEFAULT_CHUNK_SIZE,
         :connect_timeout    => 60,
+        :debug_request      => false,
+        :debug_response     => false,
         :headers            => {},
         :idempotent         => false,
         :instrumentor_name  => 'excon',
@@ -34,6 +36,7 @@ module Excon
         :retry_limit        => DEFAULT_RETRY_LIMIT,
         :ssl_ca_file        => DEFAULT_CA_FILE,
         :ssl_verify_peer    => RbConfig::CONFIG['host_os'] !~ /mswin|win32|dos|cygwin|mingw/i,
+        :tcp_nodelay        => false,
         :uri_parser         => URI,
         :write_timeout      => 60
       }
@@ -64,9 +67,14 @@ require 'excon/standard_instrumentor'
 module Excon
   class << self
 
+    def display_warning(warning)
+      # Ruby convention mandates complete silence when VERBOSE == nil
+      $stderr.puts(warning) if !ENV['VERBOSE'].nil?
+    end
+
     # Status of mocking
     def mock
-      $stderr.puts("Excon#mock is deprecated, pass Excon.defaults[:mock] instead (#{caller.first})")
+      display_warning("Excon#mock is deprecated, pass Excon.defaults[:mock] instead (#{caller.first}")
       self.defaults[:mock]
     end
 
@@ -74,33 +82,33 @@ module Excon
     # false is the default and works as expected
     # true returns a value from stubs or raises
     def mock=(new_mock)
-      $stderr.puts("Excon#mock is deprecated, pass Excon.defaults[:mock]= instead (#{caller.first})")
+      display_warning("Excon#mock is deprecated, pass Excon.defaults[:mock]= instead (#{caller.first})")
       self.defaults[:mock] = new_mock
     end
 
     # @return [String] The filesystem path to the SSL Certificate Authority
     def ssl_ca_path
-      $stderr.puts("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 (#{caller.first})")
       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)
-      $stderr.puts("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 (#{caller.first})")
       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
-      $stderr.puts("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 (#{caller.first})")
       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)
-      $stderr.puts("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 (#{caller.first})")
       self.defaults[:ssl_verify_peer] = new_ssl_verify_peer
     end
 

data/lib/excon/connection.rb

@@ -4,29 +4,29 @@ module Excon
     attr_reader :data
 
     def connection
-      $stderr.puts("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 (#{caller.first})")
       @data
     end
     def connection=(new_params)
-      $stderr.puts("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 (#{caller.first})")
       @data = new_params
     end
 
     def params
-      $stderr.puts("Excon::Connection#params is deprecated use Excon::Connection#data instead (#{caller.first})")
+      display_waring("Excon::Connection#params is deprecated use Excon::Connection#data instead (#{caller.first})")
       @data
     end
     def params=(new_params)
-      $stderr.puts("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 (#{caller.first})")
       @data = new_params
     end
 
     def proxy
-      $stderr.puts("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 (#{caller.first})")
       @data[:proxy]
     end
     def proxy=(new_proxy)
-      $stderr.puts("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 (#{caller.first})") if !ENV['VERBOSE'].nil?
       @data[:proxy] = new_proxy
     end
 
@@ -149,12 +149,9 @@ module Excon
           # add additional "\r\n" to indicate end of headers
           request << CR_NL
 
-          # write out the request, sans body
-          socket.write(request)
-
-          # write out the body
           if datum.has_key?(:request_block)
-            while true
+            socket.write(request) # write out request + headers
+            while true # write out body with chunked encoding
               chunk = datum[:request_block].call
               if FORCE_ENC
                 chunk.force_encoding('BINARY')
@@ -167,11 +164,10 @@ module Excon
               end
             end
           elsif !datum[:body].nil?
-            if datum[:body].is_a?(String)
-              unless datum[:body].empty?
-                socket.write(datum[:body])
-              end
-            else
+            if datum[:body].is_a?(String) # write out string body
+              socket.write(request << datum[:body]) # write out request + headers + body
+            else # write out file body
+              socket.write(request) # write out request + headers
               if datum[:body].respond_to?(:binmode)
                 datum[:body].binmode
               end
@@ -182,6 +178,8 @@ module Excon
                 socket.write(chunk)
               end
             end
+          else # write out nil body
+            socket.write(request) # write out request + headers
           end
         end
       rescue => error
@@ -232,7 +230,7 @@ module Excon
       end
 
       if block_given?
-        $stderr.puts("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 (#{caller.first})")
         datum[:response_block] = Proc.new
       end
 
@@ -289,12 +287,12 @@ module Excon
     end
 
     def retry_limit=(new_retry_limit)
-      $stderr.puts("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 (#{caller.first})")
       @data[:retry_limit] = new_retry_limit
     end
 
     def retry_limit
-      $stderr.puts("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 (#{caller.first})")
       @data[:retry_limit] ||= DEFAULT_RETRY_LIMIT
     end
 
@@ -343,7 +341,7 @@ module Excon
     def invalid_keys_warning(argument, valid_keys)
       invalid_keys = argument.keys - valid_keys
       unless invalid_keys.empty?
-        $stderr.puts("The following keys are invalid: #{invalid_keys.map(&:inspect).join(', ')}")
+        Excon.display_warning("The following keys are invalid: #{invalid_keys.map(&:inspect).join(', ')}")
       end
     end
 

data/lib/excon/constants.rb

@@ -37,6 +37,8 @@ module Excon
     :client_cert,
     :connect_timeout,
     :connection,
+    :debug_request,
+    :debug_response,
     :error,
     :exception,
     :expects,
@@ -64,6 +66,7 @@ module Excon
     :retries_remaining,
     :retry_limit,
     :scheme,
+    :tcp_nodelay,
     :uri_parser,
     :user,
     :ssl_ca_file,
@@ -72,7 +75,7 @@ module Excon
     :write_timeout
   ]
 
-  VERSION = '0.22.1'
+  VERSION = '0.23.0'
 
   unless ::IO.const_defined?(:WaitReadable)
     class ::IO

data/lib/excon/errors.rb

@@ -121,7 +121,23 @@ module Excon
       }
 
       error, message = @errors[response[:status]] || [Excon::Errors::HTTPStatusError, 'Unknown']
-      error.new("Expected(#{request[:expects].inspect}) <=> Actual(#{response[:status]} #{message})", request, response)
+
+      message = "Expected(#{request[:expects].inspect}) <=> Actual(#{response[:status]} #{message})"
+
+      if request[:debug_request]
+        # scrub authorization
+        req = request.dup
+        req.reject! {|key, value| [:connection, :stack].include?(key)}
+        if req.has_key?(:headers) && req[:headers].has_key?('Authorization')
+          req[:headers] = req[:headers].dup
+          req[:headers]['Authorization'] = REDACTED
+        end
+        message << "\n  request => #{req.inspect}"
+      end
+
+      message << "\n  response => #{response.inspect}" if request[:debug_response]
+
+      error.new(message, request, response)
     end
 
   end

data/lib/excon/response.rb

@@ -106,7 +106,7 @@ module Excon
     end
 
     def params
-      $stderr.puts("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 (#{caller.first})")
       data
     end
 

data/lib/excon/socket.rb

@@ -6,11 +6,11 @@ module Excon
     attr_accessor :data
 
     def params
-      $stderr.puts("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 (#{caller.first})")
       @data
     end
     def params=(new_params)
-      $stderr.puts("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 (#{caller.first})")
       @data = new_params
     end
 
@@ -198,6 +198,12 @@ module Excon
         # this will be our last encountered exception
         raise exception
       end
+
+      if @data[:tcp_nodelay]
+        @socket.setsockopt(::Socket::IPPROTO_TCP,
+                           ::Socket::TCP_NODELAY,
+                           true)
+      end
     end
 
   end

data/lib/excon/ssl_socket.rb

@@ -82,7 +82,7 @@ module Excon
     def check_nonblock_support
       # backwards compatability for things lacking nonblock
       if !DEFAULT_NONBLOCK && @data[:nonblock]
-        $stderr.puts("Excon nonblock is not supported by your OpenSSL::SSL::SSLSocket")
+        Excon.display_warning("Excon nonblock is not supported by your OpenSSL::SSL::SSLSocket")
         @data[:nonblock] = false
       end
     end

data/tests/errors_tests.rb

@@ -0,0 +1,49 @@
+Shindo.tests('HTTPStatusError request/response debugging') do
+
+  with_server('error') do
+
+    tests('message does not include response or response info').returns(true) do
+      begin
+        Excon.get('http://127.0.0.1:9292/error/not_found', :expects => 200)
+      rescue => err
+        err.message.include?('Expected(200) <=> Actual(404 Not Found)') &&
+        !err.message.include?('request =>') &&
+        !err.message.include?('response =>')
+      end
+    end
+
+    tests('message includes only response info').returns(true) do
+      begin
+        Excon.get('http://127.0.0.1:9292/error/not_found', :expects => 200,
+                  :debug_response => true)
+      rescue => err
+        err.message.include?('Expected(200) <=> Actual(404 Not Found)') &&
+        !err.message.include?('request =>') &&
+        !!(err.message =~ /response =>(.*)server says not found/)
+      end
+    end
+
+    tests('message includes only request info').returns(true) do
+      begin
+        Excon.get('http://127.0.0.1:9292/error/not_found', :expects => 200,
+                  :debug_request => true)
+      rescue => err
+        err.message.include?('Expected(200) <=> Actual(404 Not Found)') &&
+        !!(err.message =~ /request =>(.*)error\/not_found/) &&
+        !err.message.include?('response =>')
+      end
+    end
+
+    tests('message include request and response info').returns(true) do
+      begin
+        Excon.get('http://127.0.0.1:9292/error/not_found', :expects => 200,
+                  :debug_request => true, :debug_response => true)
+      rescue => err
+        err.message.include?('Expected(200) <=> Actual(404 Not Found)') &&
+        !!(err.message =~ /request =>(.*)not_found/) &&
+        !!(err.message =~ /response =>(.*)server says not found/)
+      end
+    end
+
+  end
+end

data/tests/requests_tests.rb

@@ -28,4 +28,19 @@ with_rackup('basic.ru') do
     end
 
   end
+
+  Shindo.tests('requests should succeed with tcp_nodelay') do
+
+    connection = Excon.new('http://127.0.0.1:9292', :tcp_nodelay => true)
+
+    tests('GET /content-length/100') do
+      responses = connection.requests([
+        {:method => :get, :path => '/content-length/100'}
+      ])
+
+      tests('get content length is 100').returns('100') do
+        responses.last.headers['Content-Length']
+      end
+    end
+  end
 end

data/tests/servers/error.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "eventmachine"
+
+module ErrorServer
+  def receive_data(data)
+    case data
+    when %r{^GET /error/not_found\s}
+      send_data "HTTP/1.1 404 Not Found\r\n"
+      send_data "\r\n"
+      send_data "server says not found"
+      close_connection(true)
+    end
+  end
+end
+
+EM.run do
+  EM.start_server("127.0.0.1", 9292, ErrorServer)
+  $stderr.puts "ready"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.23.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,6 +192,7 @@ files:
 - tests/data/excon.cert.crt
 - tests/data/excon.cert.key
 - tests/data/xs
+- tests/errors_tests.rb
 - tests/header_tests.rb
 - tests/middlewares/idempotent_tests.rb
 - tests/middlewares/instrumentation_tests.rb
@@ -215,6 +216,7 @@ files:
 - tests/requests_tests.rb
 - tests/servers/bad.rb
 - tests/servers/eof.rb
+- tests/servers/error.rb
 - tests/test_helper.rb
 - tests/thread_safety_tests.rb
 - tests/timeout_tests.rb
@@ -233,7 +235,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1091167854522942329
+      hash: -3656231066806112421
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: