excon 0.16.3 → 0.16.4

data/changelog.txt

@@ -1,4 +1,18 @@
-0.16.2 09/27/2012
+0.16.4 09/25/2012
+=================
+
+better behavior nonblock and use DEFAULT_NONBLOCK constant
+update deprecation/warnings to use $stderr
+consistency fixes for REDACT
+add REDACT behavior to standard_instrumentor
+
+0.16.3 09/20/2012
+=================
+
+remove overly paranoid const checking
+change chunk_size to be a param for consistency
+
+0.16.2 08/27/2012
 =================
 
 provide more helpful backtraces on connection requests
@@ -9,13 +23,12 @@ rearrange excon.rb to initialize defaults sooner
 set nonblock at init time for ssl socket
 fixes around nonbleck to properly skip/warn if unavailable but selected
 
-
-0.16.1 09/15/2012
+0.16.1 08/15/2012
 =================
 
 default to SSLv3 usage
 
-0.16.0 09/14/2012
+0.16.0 08/14/2012
 =================
 
 add nonblock => false to use blocking requests with Timeout.timeout

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.16.3'
-  s.date              = '2012-09-20'
+  s.version           = '0.16.4'
+  s.date              = '2012-09-25'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long

data/lib/excon.rb

@@ -21,7 +21,7 @@ module Excon
         :headers            => {},
         :instrumentor_name  => 'excon',
         :mock               => false,
-        :nonblock           => true,
+        :nonblock           => DEFAULT_NONBLOCK,
         :read_timeout       => 60,
         :retry_limit        => DEFAULT_RETRY_LIMIT,
         :ssl_ca_file        => DEFAULT_CA_FILE,
@@ -52,7 +52,7 @@ module Excon
 
     # Status of mocking
     def mock
-      puts("Excon#mock is deprecated, pass Excon.defaults[:mock] instead (#{caller.first})")
+      $stderr.puts("Excon#mock is deprecated, pass Excon.defaults[:mock] instead (#{caller.first})")
       self.defaults[:mock]
     end
 
@@ -60,33 +60,33 @@ module Excon
     # false is the default and works as expected
     # true returns a value from stubs or raises
     def mock=(new_mock)
-      puts("Excon#mock is deprecated, pass Excon.defaults[:mock]= instead (#{caller.first})")
+      $stderr.puts("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
-      puts("Excon#ssl_ca_path is deprecated, use Excon.defaults[:ssl_ca_path] instead (#{caller.first})")
+      $stderr.puts("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)
-      puts("Excon#ssl_ca_path= is deprecated, use Excon.defaults[:ssl_ca_path]= instead (#{caller.first})")
+      $stderr.puts("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
-      puts("Excon#ssl_verify_peer= is deprecated, use Excon.defaults[:ssl_verify_peer]= instead (#{caller.first})")
+      $stderr.puts("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)
-      puts("Excon#ssl_verify_peer is deprecated, use Excon.defaults[:ssl_verify_peer] instead (#{caller.first})")
+      $stderr.puts("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

@@ -82,7 +82,7 @@ module Excon
       end
 
       if block_given?
-        puts("Excon requests with a block are deprecated, pass :response_block instead (#{caller.first})")
+        $stderr.puts("Excon requests with a block are deprecated, pass :response_block instead (#{caller.first})")
         params[:response_block] = Proc.new
       end
 
@@ -138,26 +138,31 @@ module Excon
     end
 
     def retry_limit=(new_retry_limit)
-      puts("Excon::Connection#retry_limit= is deprecated, pass :retry_limit to the initializer (#{caller.first})")
+      $stderr.puts("Excon::Connection#retry_limit= is deprecated, pass :retry_limit to the initializer (#{caller.first})")
       @connection[:retry_limit] = new_retry_limit
     end
 
     def retry_limit
-      puts("Excon::Connection#retry_limit is deprecated, pass :retry_limit to the initializer (#{caller.first})")
+      $stderr.puts("Excon::Connection#retry_limit is deprecated, pass :retry_limit to the initializer (#{caller.first})")
       @connection[:retry_limit] ||= DEFAULT_RETRY_LIMIT
     end
 
     def inspect
-      c_clean = @connection.dup
-      c_clean[:headers] = @connection[:headers].dup
-      if ! @connection[:headers]['Authorization'].nil?
-        c_clean[:headers]['Authorization'] = 'REDACTED'
+      vars = instance_variables.inject({}) do |accum, var|
+        accum.merge!(var.to_sym => instance_variable_get(var))
       end
-      vars = instance_variables.map do |x|
-        vals = x.to_s.eql?("@connection") ? c_clean : instance_variable_get(x)
-        "#{x}=#{vals.inspect}"
+      if vars[:'@connection'][:headers].has_key?('Authorization')
+        vars[:'@connection'] = vars[:'@connection'].dup
+        vars[:'@connection'][:headers] = vars[:'@connection'][:headers].dup
+        vars[:'@connection'][:headers]['Authorization'] = REDACTED
       end
-      "#{self.to_s}".gsub(/>\z/, " " + vars.join(", ") + '>')
+      inspection = '#<Excon::Connection:'
+      inspection << (object_id << 1).to_s(16)
+      vars.each do |key, value|
+        inspection << ' ' << key.to_s << '=' << value.inspect
+      end
+      inspection << '>'
+      inspection
     end
 
     private

data/lib/excon/constants.rb

@@ -11,6 +11,10 @@ module Excon
     CHUNK_SIZE = DEFAULT_CHUNK_SIZE
   end
 
+  DEFAULT_NONBLOCK = OpenSSL::SSL::SSLSocket.public_method_defined?(:connect_nonblock) &&
+    OpenSSL::SSL::SSLSocket.public_method_defined?(:read_nonblock) &&
+    OpenSSL::SSL::SSLSocket.public_method_defined?(:write_nonblock)
+
   DEFAULT_RETRY_LIMIT = 4
 
   FORCE_ENC = CR_NL.respond_to?(:force_encoding)
@@ -23,7 +27,9 @@ module Excon
 
   NO_ENTITY = [204, 205, 304].freeze
 
-  VERSION = '0.16.3'
+  REDACTED = 'REDACTED'
+
+  VERSION = '0.16.4'
 
   unless ::IO.const_defined?(:WaitReadable)
     class ::IO

data/lib/excon/ssl_socket.rb

@@ -91,13 +91,9 @@ module Excon
 
     def check_nonblock_support
       # backwards compatability for things lacking nonblock
-      unless OpenSSL::SSL::SSLSocket.public_method_defined?(:connect_nonblock) &&
-             OpenSSL::SSL::SSLSocket.public_method_defined?(:read_nonblock) &&
-             OpenSSL::SSL::SSLSocket.public_method_defined?(:write_nonblock)
-        unless params[:nonblock] == false
-          puts("Excon nonblock is not supported by your OpenSSL::SSL::SSLSocket")
-          params[:nonblock] = false
-        end
+      if !DEFAULT_NONBLOCK && params[:nonblock]
+        $stderr.puts("Excon nonblock is not supported by your OpenSSL::SSL::SSLSocket")
+        params[:nonblock] = false
       end
     end
 

data/lib/excon/standard_instrumentor.rb

@@ -1,6 +1,11 @@
 module Excon
   class StandardInstrumentor
     def self.instrument(name, params = {}, &block)
+      if params.has_key?(:headers) && params[:headers].has_key?('Authorization')
+        params = params.dup
+        params[:headers] = params[:headers].dup
+        params[:headers]['Authorization'] = REDACTED
+      end
       $stderr.puts("#{name}  #{params}")
       if block_given?
         yield

data/tests/authorization_header_tests.rb

@@ -8,11 +8,11 @@ with_rackup('basic_auth.ru') do
     cases.each do |desc,url,auth_header|
       conn = Excon.new(url)
       test("authorization header concealed for #{desc}") do
-        ! conn.inspect.to_s.include? auth_header
+        !conn.inspect.include?(auth_header)
       end
 
-      tests("authorization header correct for #{desc}").returns(auth_header) do
-        conn.connection[:headers]['Authorization']
+      test("authorization header remains correct for #{desc}") do
+        conn.connection[:headers]['Authorization'] == auth_header
       end
 
     end

data/tests/instrumentation_tests.rb

@@ -136,26 +136,60 @@ Shindo.tests('Excon instrumentation') do
     (@events.first.duration/1000 - REQUEST_DELAY_SECONDS).abs < 1
   end
 
-  tests('standard instrumentor').returns(
-    ['excon.request', 'excon.retry', 'excon.retry', 'excon.retry', 'excon.error']) do
-
-    begin
-      original_stderr = $stderr
-      $stderr = captured_stderr = StringIO.new
-      stub_failure
-      connection = Excon.new(
-        'http://127.0.0.1:9292',
-        :instrumentor => Excon::StandardInstrumentor,
-        :mock         => true
-      )
-      raises(Excon::Errors::SocketError) do
-        connection.get(:idempotent => true)
+  tests('standard instrumentor') do
+
+    tests('success').returns(
+      ['excon.request', 'excon.retry', 'excon.retry', 'excon.retry', 'excon.error']) do
+
+      begin
+        original_stderr = $stderr
+        $stderr = captured_stderr = StringIO.new
+        stub_failure
+        connection = Excon.new(
+          'http://127.0.0.1:9292',
+          :instrumentor => Excon::StandardInstrumentor,
+          :mock         => true
+        )
+        raises(Excon::Errors::SocketError) do
+          connection.get(:idempotent => true)
+        end
+
+        captured_stderr.string.split("\n").map {|event| event.split(' ').first}
+      ensure
+        $stderr = original_stderr
+      end
+    end
+
+    tests('authorization header REDACT') do
+
+      begin
+        original_stderr = $stderr
+        $stderr = @captured_stderr = StringIO.new
+        stub_failure
+        @connection = Excon.new(
+          'http://user:pass@127.0.0.1:9292',
+          :instrumentor => Excon::StandardInstrumentor,
+          :mock         => true
+        )
+        raises(Excon::Errors::SocketError) do
+          @connection.get(:idempotent => true)
+        end
+      ensure
+        $stderr = original_stderr
+      end
+
+      @auth_header = 'Basic dXNlcjpwYXNz'
+
+      tests('does not appear in response') do
+        !@captured_stderr.include?(@auth_header)
+      end
+
+      test('does not mutate Authorization value') do
+        @connection.connection[:headers]['Authorization'] == @auth_header
       end
 
-      captured_stderr.string.split("\n").map {|event| event.split(' ').first}
-    ensure
-      $stderr = original_stderr
     end
+
   end
 
   tests('use our own instrumentor').returns(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.16.3
+  version: 0.16.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2012-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70229726929200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,15 +23,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70229726929200
 - !ruby/object:Gem::Dependency
   name: delorean
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70229726928740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -39,15 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70229726928740
 - !ruby/object:Gem::Dependency
   name: open4
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70229726928320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,15 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70229726928320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70229726927900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -71,15 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70229726927900
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70229726927480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,15 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70229726927480
 - !ruby/object:Gem::Dependency
   name: shindo
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70229726943440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -103,15 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70229726943440
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70229726943020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -119,12 +89,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70229726943020
 description: EXtended http(s) CONnections
 email: geemus@gmail.com
 executables: []
@@ -204,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -910496643222039172
+      hash: 2397568301879595027
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -213,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: excon
-rubygems_version: 1.8.23
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 2
 summary: speed, persistence, http(s)