excon 0.10.1 → 0.11.0

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 
 gemspec
 
-gem 'jruby-openssl', '< 0.7.4', :platform => :jruby
+gem 'jruby-openssl', :platform => :jruby
 
 group :benchmark do
   gem 'em-http-request'

data/README.md

@@ -62,16 +62,37 @@ If you need to accept as response one or more HTTP status codes you can declare
 
     connection.request(expects => [200, 201], :method => :get, :path => path, :query => {})
 
+Chunked Requests
+----------------
+
+You can make `Transfer-Encoding: chunked` requests by passing a block that will deliver chunks, delivering an empty chunk to signal completion.
+
+    file = File.open('data')
+
+    chunker = lambda do
+      # Excon::CHUNK_SIZE defaults to 1048576, ie 1MB
+      # to_s will convert the nil receieved after everything is read to the final empty chunk
+      file.read(Excon::CHUNK_SIZE).to_s
+    end
+
+    Excon.post('http://geemus.com', :request_block => chunker)
+
+    file.close
+
+Iterating in this way allows you to have more granular control over writes and to write things where you can not calculate the overall length up front.
+
 Streaming Responses
 -------------------
 
 You can stream responses by passing a block that will receive each chunk.
 
-    Excon.get('http://geemus.com') do |chunk, remaining_bytes, total_bytes|
+    streamer = lambda do |chunk, remaining_bytes, total_bytes|
       puts chunk
       puts "Remaining: #{remaining_bytes.to_f / total_bytes}%"
     end
 
+    Excon.get('http://geemus.com', :response_block => streamer)
+
 Iterating over each chunk will allow you to do work on the response incrementally without buffering the entire response first. For very large responses this can lead to significant memory savings.
 
 Proxy Support

data/changelog.txt

@@ -1,3 +1,10 @@
+0.11.0 03/15/12
+===============
+
+* add request_block to support chunked requests
+* deprecate implicit block in favor of explicit response_block
+* loosen activesupport and jruby-openssl development dependencies
+
 0.10.1 03/13/12
 ===============
 

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.10.1'
-  s.date              = '2012-03-13'
+  s.version           = '0.11.0'
+  s.date              = '2012-03-15'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -53,7 +53,7 @@ Gem::Specification.new do |s|
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
   # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
-  s.add_development_dependency('activesupport', '~>3.1.3')
+  s.add_development_dependency('activesupport')
   s.add_development_dependency('delorean')
   s.add_development_dependency('open4')
   s.add_development_dependency('rake')
@@ -103,6 +103,7 @@ Gem::Specification.new do |s|
     tests/instrumentation_tests.rb
     tests/proxy_tests.rb
     tests/query_string_tests.rb
+    tests/rackups/basic.rb
     tests/rackups/basic.ru
     tests/rackups/basic_auth.ru
     tests/rackups/proxy.ru

data/lib/excon/connection.rb

@@ -79,6 +79,11 @@ module Excon
         params[:path].insert(0, '/')
       end
 
+      if block_given?
+        puts("Excon requests with a block are deprecated, pass :response_block instead (#{caller.first})")
+        params[:response_block] = Proc.new
+      end
+
       if params.has_key?(:instrumentor)
         if (retries_remaining ||= params[:retry_limit]) < params[:retry_limit]
           event_name = "#{params[:instrumentor_name]}.retry"
@@ -86,10 +91,10 @@ module Excon
           event_name = "#{params[:instrumentor_name]}.request"
         end
         params[:instrumentor].instrument(event_name, params) do
-          request_kernel(params, &block)
+          request_kernel(params)
         end
       else
-        request_kernel(params, &block)
+        request_kernel(params)
       end
     rescue => request_error
       if params[:idempotent] && [Excon::Errors::SocketError,
@@ -140,10 +145,10 @@ module Excon
 
   private
 
-    def request_kernel(params, &block)
+    def request_kernel(params)
       begin
         response = if params[:mock]
-          invoke_stub(params, &block)
+          invoke_stub(params)
         else
           socket.params = params
           # start with "METHOD /path"
@@ -174,23 +179,22 @@ module Excon
           # finish first line with "HTTP/1.1\r\n"
           request << HTTP_1_1
 
-          # calculate content length and set to handle non-ascii
-          unless params[:headers].has_key?('Content-Length')
+          if params.has_key?(:request_block)
+            params[:headers]['Transfer-Encoding'] = 'chunked'
+          elsif ! (params[:method].to_s.casecmp('GET') == 0 && params[:body].nil?)
             # The HTTP spec isn't clear on it, but specifically, GET requests don't usually send bodies;
             # if they don't, sending Content-Length:0 can cause issues.
-            unless (params[:method].to_s.casecmp('GET') == 0 && params[:body].nil?)
-              params[:headers]['Content-Length'] = case params[:body]
-              when File
-                params[:body].binmode
-                File.size(params[:body])
-              when String
-                if FORCE_ENC
-                  params[:body].force_encoding('BINARY')
-                end
-                params[:body].length
-              else
-                0
+            params[:headers]['Content-Length'] = case params[:body]
+            when File
+              params[:body].binmode
+              File.size(params[:body])
+            when String
+              if FORCE_ENC
+                params[:body].force_encoding('BINARY')
               end
+              params[:body].length
+            else
+              0
             end
           end
 
@@ -208,7 +212,20 @@ module Excon
           socket.write(request)
 
           # write out the body
-          unless params[:body].nil?
+          if params.has_key?(:request_block)
+            while true
+              chunk = params[:request_block].call
+              if FORCE_ENC
+                chunk.force_encoding('BINARY')
+              end
+              if chunk.length > 0
+                socket.write(chunk.length.to_s(16) << CR_NL << chunk << CR_NL)
+              else
+                socket.write('0' << CR_NL << CR_NL)
+                break
+              end
+            end
+          elsif !params[:body].nil?
             if params[:body].is_a?(String)
               unless params[:body].empty?
                 socket.write(params[:body])
@@ -221,7 +238,7 @@ module Excon
           end
 
           # read the response
-          response = Excon::Response.parse(socket, params, &block)
+          response = Excon::Response.parse(socket, params)
 
           if response.headers['Connection'] == 'close'
             reset
@@ -245,7 +262,6 @@ module Excon
     end
 
     def invoke_stub(params)
-      block_given = block_given?
       params[:captures] = {:headers => {}} # setup data to hold captures
       for stub, response in Excon.stubs
         headers_match = !stub.has_key?(:headers) || stub[:headers].keys.all? do |key|
@@ -278,17 +294,14 @@ module Excon
             response
           end
 
-          # don't pass stuff into a block if there was an error
           if params[:expects] && ![*params[:expects]].include?(response_attributes[:status])
-            block_given = false
-          end
-
-          if block_given && response_attributes.has_key?(:body)
+            # don't pass stuff into a block if there was an error
+          elsif params.has_key?(:response_block) && response_attributes.has_key?(:body)
             body = response_attributes.delete(:body)
             content_length = remaining = body.bytesize
             i = 0
             while i < body.length
-              yield(body[i, CHUNK_SIZE], [remaining - CHUNK_SIZE, 0].max, content_length)
+              params[:response_block].call(body[i, CHUNK_SIZE], [remaining - CHUNK_SIZE, 0].max, content_length)
               remaining -= CHUNK_SIZE
               i += CHUNK_SIZE
             end

data/lib/excon/constants.rb

@@ -1,6 +1,6 @@
 module Excon
   unless const_defined?(:VERSION)
-    VERSION = '0.10.1'
+    VERSION = '0.11.0'
   end
 
   unless const_defined?(:CHUNK_SIZE)

data/lib/excon/response.rb

@@ -19,7 +19,6 @@ module Excon
 
     def self.parse(socket, params={})
       response = new(:status => socket.readline[9, 11].to_i)
-      block_given = block_given?
 
       until ((data = socket.readline).chop!).empty?
         key, value = data.split(/:\s*/, 2)
@@ -33,30 +32,29 @@ module Excon
 
       unless (params[:method].to_s.casecmp('HEAD') == 0) || NO_ENTITY.include?(response.status)
 
-        # don't pass stuff into a block if there was an error
-        if params[:expects] && ![*params[:expects]].include?(response.status)
-          block_given = false
-        end
+        # check to see if expects was set and matched
+        expected_status = !params.has_key?(:expects) || [*params[:expects]].include?(response.status)
 
-        if block_given
+        # if expects matched and there is a block, use it
+        if expected_status && params.has_key?(:response_block)
           if transfer_encoding_chunked
             # 2 == "/r/n".length
             while (chunk_size = socket.readline.chop!.to_i(16)) > 0
-              yield(socket.read(chunk_size + 2).chop!, nil, nil)
+              params[:response_block].call(socket.read(chunk_size + 2).chop!, nil, nil)
             end
             socket.read(2)
           elsif remaining = content_length
             remaining = content_length
             while remaining > 0
-              yield(socket.read([CHUNK_SIZE, remaining].min), [remaining - CHUNK_SIZE, 0].max, content_length)
+              params[:response_block].call(socket.read([CHUNK_SIZE, remaining].min), [remaining - CHUNK_SIZE, 0].max, content_length)
               remaining -= CHUNK_SIZE
             end
           else
             while remaining = socket.read(CHUNK_SIZE)
-              yield(remaining, remaining.length, content_length)
+              params[:response_block].call(remaining, remaining.length, content_length)
             end
           end
-        else
+        else # no block or unexpected status
           if transfer_encoding_chunked
             while (chunk_size = socket.readline.chop!.to_i(16)) > 0
               response.body << socket.read(chunk_size + 2).chop! # 2 == "/r/n".length

data/tests/bad_tests.rb

@@ -18,9 +18,9 @@ Shindo.tests('Excon bad server interaction') do
             connection = Excon.new('http://127.0.0.1:9292')
 
             body = ""
-            block = lambda {|chunk, remaining, total| body << chunk }
+            response_block = lambda {|chunk, remaining, total| body << chunk }
 
-            connection.request(:method => :get, :path => '/eof/no_content_length_and_no_chunking', &block)
+            connection.request(:method => :get, :path => '/eof/no_content_length_and_no_chunking', :response_block => response_block)
 
             body
           end

data/tests/rackups/basic.rb

@@ -0,0 +1,16 @@
+require 'sinatra'
+
+class Basic < Sinatra::Base
+  get('/content-length/:value') do |value|
+    headers("Custom" => "Foo: bar")
+    'x' * value.to_i
+  end
+
+  post('/body-sink') do
+    request.body.read.size.to_s
+  end
+
+  post('/echo') do
+    request.body.read
+  end
+end

data/tests/rackups/basic.ru

@@ -1,14 +1,3 @@
-require 'sinatra'
+require File.join(File.dirname(__FILE__), 'basic')
 
-class App < Sinatra::Base
-  get('/content-length/:value') do |value|
-    headers("Custom" => "Foo: bar")
-    'x' * value.to_i
-  end
-
-  post('/body-sink') do
-    request.body.read.size.to_s
-  end
-end
-
-run App
+run Basic

data/tests/rackups/basic_auth.ru

@@ -1,6 +1,6 @@
-require 'sinatra'
+require File.join(File.dirname(__FILE__), 'basic')
 
-class App < Sinatra::Base
+class BasicAuth < Basic
   before do
     auth ||= Rack::Auth::Basic::Request.new(request.env)
     user, pass = auth.provided? && auth.basic? && auth.credentials
@@ -9,15 +9,6 @@ class App < Sinatra::Base
       throw(:halt, [401, "Not authorized\n"])
     end
   end
-
-  get('/content-length/:value') do |value|
-    headers("Custom" => "Foo: bar")
-    'x' * value.to_i
-  end
-
-  post('/body-sink') do
-    request.body.read.size.to_s
-  end
 end
 
-run App
+run BasicAuth

data/tests/rackups/ssl.ru

@@ -1,20 +1,10 @@
 require 'openssl'
-require 'sinatra'
 require 'webrick'
 require 'webrick/https'
 
-class App < Sinatra::Base
-  get('/content-length/:value') do |value|
-    headers("Custom" => "Foo: bar")
-    'x' * value.to_i
-  end
+require File.join(File.dirname(__FILE__), 'basic')
 
-  post('/body-sink') do
-    request.body.read.size.to_s
-  end
-end
-
-Rack::Handler::WEBrick.run(App, {
+Rack::Handler::WEBrick.run(Basic, {
   :Port             => 9443,
   :SSLCertName      => [["CN", WEBrick::Utils::getservername]],
   :SSLEnable        => true,

data/tests/stub_tests.rb

@@ -32,11 +32,12 @@ Shindo.tests('Excon stubs') do
       response.status
     end
 
-    tests('request body with block given').returns('body') do
+    tests('request body with response_block given').returns('body') do
       body = ''
-      connection.request(:method => :get, :path => '/content-length/100') do |chunk, remaining_bytes, total_bytes|
+      response_block = lambda do |chunk, remaining_bytes, total_bytes|
         body << chunk
       end
+      connection.request(:method => :get, :path => '/content-length/100', :response_block => response_block)
       body
     end
 
@@ -91,11 +92,12 @@ Shindo.tests('Excon stubs') do
       response.status
     end
 
-    tests('request body with block given').returns('body') do
+    tests('request body with response block given').returns('body') do
       body = ''
-      connection.request(:body => 'body', :method => :get, :path => '/content-length/100') do |chunk, remaining_bytes, total_bytes|
+      response_block = lambda do |chunk, remaining_bytes, total_bytes|
         body << chunk
       end
+      connection.request(:body => 'body', :method => :get, :path => '/content-length/100', :response_block => response_block)
       body
     end
 
@@ -114,11 +116,12 @@ Shindo.tests('Excon stubs') do
     connection = Excon.new('http://127.0.0.1:9292', :mock => true)
     Excon.stub({}, {:body => 'x' * (Excon::CHUNK_SIZE + 1)})
 
-    test("with block") do
+    test("with response_block") do
       chunks = []
-      connection.request(:method => :get, :path => '/content-length/100') do |chunk, remaining_bytes, total_bytes|
+      response_block = lambda do |chunk, remaining_bytes, total_bytes|
         chunks << chunk
       end
+      connection.request(:method => :get, :path => '/content-length/100', :response_block => response_block)
       chunks == ['x' * Excon::CHUNK_SIZE, 'x']
     end
   end
@@ -137,9 +140,10 @@ Shindo.tests('Excon stubs') do
     test("request(:expects => 200, :method => :get, :path => '/') with block does not invoke the block since it raises an error") do
       block_called = false
       begin
-        connection.request(:expects => 200, :method => :get, :path => '/') do |_, _, _|
+        response_block = lambda do |_,_,_|
           block_called = true
         end
+        connection.request(:expects => 200, :method => :get, :path => '/', :response_block => response_block)
       rescue Excon::Errors::NotFound
       end
       !block_called

data/tests/test_helper.rb

@@ -42,7 +42,7 @@ def basic_tests(url = 'http://127.0.0.1:9292')
       response.body
     end
 
-    tests("block usage").returns(['x' * 100, 0, 100]) do
+    tests("deprecated block usage").returns(['x' * 100, 0, 100]) do
       data = []
       connection.request(:method => :get, :path => '/content-length/100') do |chunk, remaining_length, total_length|
         data = [chunk, remaining_length, total_length]
@@ -50,6 +50,15 @@ def basic_tests(url = 'http://127.0.0.1:9292')
       data
     end
 
+    tests("response_block usage").returns(['x' * 100, 0, 100]) do
+      data = []
+      response_block = lambda do |chunk, remaining_length, total_length|
+        data = [chunk, remaining_length, total_length]
+      end
+      connection.request(:method => :get, :path => '/content-length/100', :response_block => response_block)
+      data
+    end
+
   end
 
   tests('POST /body-sink') do
@@ -65,7 +74,24 @@ def basic_tests(url = 'http://127.0.0.1:9292')
       response = connection.request(:method => :post, :path => '/body-sink', :headers => { 'Content-Type' => 'text/plain' }, :body => '')
       response.body
     end
+
   end
+
+  tests('POST /echo') do
+
+    connection = Excon.new(url)
+
+    tests('request_block usage').returns('x' * 100) do
+      data = ['x'] * 100
+      request_block = lambda do
+        data.shift.to_s
+      end
+      response = connection.request(:method => :post, :path => '/echo', :request_block => request_block)
+      response.body
+    end
+
+  end
+
 end
 
 def rackup_path(*parts)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,22 +11,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000Z
+date: 2012-03-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70279372304440 !ruby/object:Gem::Requirement
+  requirement: &70247176859020 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.1.3
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279372304440
+  version_requirements: *70247176859020
 - !ruby/object:Gem::Dependency
   name: delorean
-  requirement: &70279372304000 !ruby/object:Gem::Requirement
+  requirement: &70247176858080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279372304000
+  version_requirements: *70247176858080
 - !ruby/object:Gem::Dependency
   name: open4
-  requirement: &70279372303460 !ruby/object:Gem::Requirement
+  requirement: &70247176857480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279372303460
+  version_requirements: *70247176857480
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70279372302840 !ruby/object:Gem::Requirement
+  requirement: &70247176856760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279372302840
+  version_requirements: *70247176856760
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70279372302280 !ruby/object:Gem::Requirement
+  requirement: &70247176856120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279372302280
+  version_requirements: *70247176856120
 - !ruby/object:Gem::Dependency
   name: shindo
-  requirement: &70279372301800 !ruby/object:Gem::Requirement
+  requirement: &70247176855480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279372301800
+  version_requirements: *70247176855480
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70279372301340 !ruby/object:Gem::Requirement
+  requirement: &70247176854820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279372301340
+  version_requirements: *70247176854820
 description: EXtended http(s) CONnections
 email: geemus@gmail.com
 executables: []
@@ -134,6 +134,7 @@ files:
 - tests/instrumentation_tests.rb
 - tests/proxy_tests.rb
 - tests/query_string_tests.rb
+- tests/rackups/basic.rb
 - tests/rackups/basic.ru
 - tests/rackups/basic_auth.ru
 - tests/rackups/proxy.ru
@@ -162,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2342946765188021843
+      hash: 584033928995793926
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: