excon 0.5.8 → 0.6.0

data/README.rdoc

@@ -27,7 +27,10 @@ Both one off and persistent connections also support many other options, for exa
 
 You can also stream responses by passing a block that will receive each chunk.
 
-  Excon.get('http://geemus.com') {|chunk| p chunk }
+  Excon.get('http://geemus.com') do |chunk, remaining_bytes, total_bytes|
+    puts chunk
+    puts "Remaining: #{remaining_bytes.to_f / total_bytes}%"
+  end
 
 These options can be combined to make pretty much any request you might need.
 

data/changelog.txt

@@ -1,3 +1,10 @@
+0.6.0 03/30/11
+==============
+
+* basic support for using proxies. thanks mattsa
+* yield remaining/total bytes to streaming block. thanks nate
+* minor optimizations/cleanup
+
 0.5.8 03/24/11
 ==============
 

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.5.8'
-  s.date              = '2011-03-24'
+  s.version           = '0.6.0'
+  s.date              = '2011-03-30'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -89,8 +89,10 @@ Gem::Specification.new do |s|
     lib/excon/errors.rb
     lib/excon/response.rb
     tests/basic_tests.rb
+    tests/proxy_tests.rb
     tests/query_string_tests.rb
     tests/rackups/basic.ru
+    tests/rackups/proxy.ru
     tests/rackups/query_string.ru
     tests/rackups/thread_safety.ru
     tests/stub_tests.rb

data/lib/excon.rb

@@ -13,7 +13,7 @@ require 'excon/response'
 
 module Excon
   unless const_defined?(:VERSION)
-    VERSION = '0.5.8'
+    VERSION = '0.6.0'
   end
 
   unless const_defined?(:CHUNK_SIZE)

data/lib/excon/connection.rb

@@ -1,6 +1,6 @@
 module Excon
   class Connection
-    attr_reader :connection
+    attr_reader :connection, :proxy
 
     CR_NL     = "\r\n"
     HTTP_1_1  = " HTTP/1.1\r\n"
@@ -16,18 +16,23 @@ module Excon
     #     @option params [Fixnum] :port The port on which to connect, to the destination host
     #     @option params [Hash]   :query Default query; appended to the 'scheme://host:port/path/' in the form of '?key=value'. Will only be used if params[:query] is not supplied to Connection#request
     #     @option params [String] :scheme The protocol; 'https' causes OpenSSL to be used
+    #     @option params [String] :proxy Proxy server; e.g. 'http://myproxy.com:8888'
     def initialize(url, params = {})
       uri = URI.parse(url)
       @connection = {
         :headers  => {},
         :host     => uri.host,
         :path     => uri.path,
-        :port     => uri.port,
+        :port     => uri.port.to_s,
         :query    => uri.query,
         :scheme   => uri.scheme
       }.merge!(params)
 
-      @socket_key = '' << @connection[:host] << ':' << @connection[:port].to_s
+      if params.has_key?(:proxy)
+        @connection[:headers]['Proxy-Connection'] ||= 'Keep-Alive'
+        setup_proxy(params[:proxy]) 
+      end
+      @socket_key = '' << @connection[:host] << ':' << @connection[:port]
       reset
     end
 
@@ -46,7 +51,7 @@ module Excon
         # connection has defaults, merge in new params to override
         params = @connection.merge(params)
         params[:headers] = @connection[:headers].merge(params[:headers] || {})
-        params[:headers]['Host'] ||= '' << params[:host] << ':' << params[:port].to_s
+        params[:headers]['Host'] ||= '' << params[:host] << ':' << params[:port]
 
         # if path is empty or doesn't start with '/', insert one
         unless params[:path][0, 1] == '/'
@@ -64,7 +69,11 @@ module Excon
         end
 
         # start with "METHOD /path"
-        request = params[:method].to_s.upcase << ' ' << params[:path]
+        request = params[:method].to_s.upcase << ' '
+        if @proxy
+          request << params[:scheme] << '://' << params[:host] << ':' << params[:port]
+        end
+        request << params[:path]
 
         # add query to path, if there is one
         case params[:query]
@@ -73,15 +82,12 @@ module Excon
         when Hash
           request << '?'
           for key, values in params[:query]
-            case values
-            when nil
+            if values.nil?
               request << key.to_s << '&'
-            when Array
-              values.each do |value|
+            else
+              for value in [*values]
                 request << key.to_s << '=' << CGI.escape(value.to_s) << '&'
               end
-            else
-              request << key.to_s << '=' << CGI.escape(values.to_s) << '&'
             end
           end
           request.chop! # remove trailing '&'
@@ -180,7 +186,7 @@ module Excon
 
   private
     def connect
-      new_socket = TCPSocket.open(@connection[:host], @connection[:port])
+      new_socket = open_socket
 
       if @connection[:scheme] == 'https'
         # create ssl context
@@ -219,6 +225,15 @@ module Excon
 
       new_socket
     end
+    
+    def open_socket
+      if @proxy
+        socket = TCPSocket.open(@proxy[:host], @proxy[:port])
+      else
+        socket = TCPSocket.open(@connection[:host], @connection[:port])
+      end
+      socket
+    end
 
     def socket
       sockets[@socket_key] ||= connect
@@ -227,6 +242,18 @@ module Excon
     def sockets
       Thread.current[:_excon_sockets] ||= {}
     end
+    
+    def setup_proxy(proxy)
+      uri = URI.parse(proxy)
+      unless uri.host and uri.port and uri.scheme
+        raise Excon::Errors::ProxyParseError, "Proxy is invalid"
+      end
+      @proxy = {
+        :host     => uri.host,
+        :port     => uri.port,
+        :scheme   => uri.scheme
+      }
+    end
 
   end
 end

data/lib/excon/errors.rb

@@ -17,6 +17,8 @@ module Excon
       end
     end
 
+    class ProxyParseError < Error; end
+
     class HTTPStatusError < Error
       attr_reader :request, :response
 

data/lib/excon/response.rb

@@ -44,7 +44,7 @@ module Excon
           else
             remaining = content_length
             while remaining > 0
-              yield socket.read([CHUNK_SIZE, remaining].min)
+              yield socket.read([CHUNK_SIZE, remaining].min), [remaining - CHUNK_SIZE, 0].max, content_length
               remaining -= CHUNK_SIZE
             end
           end

data/tests/proxy_tests.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+Shindo.tests('Excon proxy support') do
+
+  tests('proxy configuration') do
+    
+    tests('no proxy') do
+      connection = Excon.new('http://foo.com')
+      
+      tests('connection.proxy').returns(nil) do
+        connection.proxy
+      end
+    end
+    
+    tests('with fully-specified proxy: https://myproxy.net:8080') do
+      connection = Excon.new('http://foo.com', :proxy => 'https://myproxy.net:8080')
+      
+      tests('connection.proxy.host').returns('myproxy.net') do
+        connection.proxy[:host]
+      end
+      
+      tests('connection.proxy.port').returns(8080) do
+        connection.proxy[:port]
+      end
+      
+      tests('connection.proxy.scheme').returns('https') do
+        connection.proxy[:scheme]
+      end
+    end
+    
+  end
+
+  with_rackup('proxy.ru') do
+    
+    tests('http proxying: http://foo.com:8080') do
+      connection = Excon.new('http://foo.com:8080', :proxy => 'http://localhost:9292')
+      response = connection.request(:method => :get, :path => '/bar', :query => {:alpha => 'kappa'})
+    
+      tests('response.status').returns(200) do
+        response.status
+      end
+      
+      # must be absolute form for proxy requests
+      tests('sent Request URI').returns('http://foo.com:8080/bar?alpha=kappa') do
+        response.headers['Sent-Request-Uri']
+      end
+      
+      tests('sent Host header').returns('foo.com:8080') do
+        response.headers['Sent-Host']
+      end
+    
+      tests('sent Proxy-Connection header').returns('Keep-Alive') do
+        response.headers['Sent-Proxy-Connection']
+      end
+    
+      tests('response.body (proxied content)').returns('proxied content') do
+        response.body
+      end
+    end
+    
+  end
+
+end
+

data/tests/query_string_tests.rb

@@ -31,11 +31,11 @@ with_rackup('query_string.ru') do
       response = connection.request(:method => :get, :path => '/query', :query => {:foo => 'bar', :me => nil})
       query_string = response.body[7..-1] # query string sent
       
-      tests("query string sent includes 'foo=bar'").returns(true) do
+      test("query string sent includes 'foo=bar'") do
         query_string.split('&').include?('foo=bar')
       end
       
-      tests("query string sent includes 'me'").returns(true) do
+      test("query string sent includes 'me'") do
         query_string.split('&').include?('me')
       end
       
@@ -46,11 +46,11 @@ with_rackup('query_string.ru') do
       response = connection.request(:method => :get, :path => '/query', :query => {:foo => 'bar', :me => 'too'})
       query_string = response.body[7..-1] # query string sent
       
-      tests("query string sent includes 'foo=bar'").returns(true) do
+      test("query string sent includes 'foo=bar'") do
         query_string.split('&').include?('foo=bar')
       end
       
-      tests("query string sent includes 'me=too'").returns(true) do
+      test("query string sent includes 'me=too'") do
         query_string.split('&').include?('me=too')
       end
       

data/tests/rackups/proxy.ru

@@ -0,0 +1,12 @@
+require 'sinatra'
+
+class App < Sinatra::Base
+  get '/bar' do
+    headers "Sent-Request-Uri" => request.env['REQUEST_URI'].to_s,
+            "Sent-Host" => request.env['HTTP_HOST'].to_s, 
+            "Sent-Proxy-Connection" => request.env['HTTP_PROXY_CONNECTION'].to_s
+    'proxied content'
+  end
+end
+
+run App

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: excon
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 5
-  - 8
-  version: 0.5.8
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - geemus (Wesley Beary)
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 -07:00
+date: 2011-03-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,8 +111,10 @@ files:
 - lib/excon/errors.rb
 - lib/excon/response.rb
 - tests/basic_tests.rb
+- tests/proxy_tests.rb
 - tests/query_string_tests.rb
 - tests/rackups/basic.ru
+- tests/rackups/proxy.ru
 - tests/rackups/query_string.ru
 - tests/rackups/thread_safety.ru
 - tests/stub_tests.rb