excon 0.6.0 → 0.6.1

data/README.rdoc

@@ -34,6 +34,19 @@ You can also stream responses by passing a block that will receive each chunk.
 
 These options can be combined to make pretty much any request you might need.
 
+== Proxy Support
+
+You can specify a proxy URL that Excon will use with both HTTP and HTTPS connections:
+
+  connection = Excon.new('http://geemus.com', :proxy => 'http://my.proxy:3128')
+  connection.request(:method => 'GET')
+
+The proxy URL must be fully specified, including scheme (e.g. "http://") and port.
+
+Excon will also use the environment variables "http_proxy" and "https_proxy" if they are present. "http_proxy" will be used for HTTPS connections if "https_proxy" is not set.
+
+Environment variables will take precedence over a :proxy option that has been specified in code.
+
 == HTTPS/SSL Issues
 
 By default excon will try to verify peer certificates when using ssl for https, unfortunately on some operating systems the defaults will not work. This will likely manifest itself as something like "Excon::Errors::SocketError: SSL_connect returned=1 ..."

data/changelog.txt

@@ -1,3 +1,10 @@
+0.6.1 04/05/11
+==============
+
+* add support for HTTPS proxies. thanks mrowe
+* add support for http_proxy and https_proxy ENV variables. thanks mrowe
+* fix progress for requests with blocks that are chunked or connection close
+
 0.6.0 03/30/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.6.0'
-  s.date              = '2011-03-30'
+  s.version           = '0.6.1'
+  s.date              = '2011-04-05'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long

data/lib/excon.rb

@@ -13,7 +13,7 @@ require 'excon/response'
 
 module Excon
   unless const_defined?(:VERSION)
-    VERSION = '0.6.0'
+    VERSION = '0.6.1'
   end
 
   unless const_defined?(:CHUNK_SIZE)
@@ -30,6 +30,21 @@ module Excon
     # setup ssl defaults based on platform
     @ssl_verify_peer = Config::CONFIG['host_os'] !~ /mswin|win32|dos|cygwin|mingw/i
 
+    # default mocking to off
+    @mock = false
+
+    # Status of mocking
+    def mock
+      @mock
+    end
+
+    # Change the status of mocking
+    # false is the default and works as expected
+    # true returns a value from stubs or raises
+    def mock=(new_mock)
+      @mock = new_mock
+    end
+
     # @see Connection#initialize
     # Initializes a new keep-alive session for a given remote host
     #   @param [String] url The destination URL
@@ -45,6 +60,30 @@ module Excon
       @ssl_verify_peer = new_ssl_verify_peer && true || false
     end
 
+    # push an additional stub onto the list to check for mock requests
+    #   @param [Hash<Symbol, >] request params to match against, omitted params match all
+    #   @param [Hash<Symbol, >] response params to return from matched request or block to call with params
+    def stub(request_params, response_params = nil)
+      if block_given?
+        if response_params
+          raise(ArgumentError.new("stub requires either response_params OR a block"))
+        else
+          stub = [request_params, Proc.new]
+        end
+      elsif response_params
+        stub = [request_params, response_params]
+      else
+        raise(ArgumentError.new("stub requires either response_params OR a block"))
+      end
+      stubs << stub
+      stub
+    end
+
+    # get a list of defined stubs
+    def stubs
+      @stubs ||= []
+    end
+
     # Generic non-persistent HTTP methods
     %w{connect delete get head options post put trace}.each do |method|
       eval <<-DEF

data/lib/excon/connection.rb

@@ -22,16 +22,31 @@ module Excon
       @connection = {
         :headers  => {},
         :host     => uri.host,
+        :mock     => Excon.mock,
         :path     => uri.path,
         :port     => uri.port.to_s,
         :query    => uri.query,
         :scheme   => uri.scheme
       }.merge!(params)
 
-      if params.has_key?(:proxy)
+      # use proxy from the environment if present
+      if ENV.has_key?('http_proxy')
+        @proxy = setup_proxy(ENV['http_proxy'])
+      elsif params.has_key?(:proxy)
+        @proxy = setup_proxy(params[:proxy])
+      end
+
+      if https?
+        # use https_proxy if that has been specified
+        if ENV.has_key?('https_proxy')
+          @proxy = setup_proxy(ENV['https_proxy'])
+        end
+      end
+
+      if @proxy
         @connection[:headers]['Proxy-Connection'] ||= 'Keep-Alive'
-        setup_proxy(params[:proxy]) 
       end
+
       @socket_key = '' << @connection[:host] << ':' << @connection[:port]
       reset
     end
@@ -58,14 +73,21 @@ module Excon
           params[:path].insert(0, '/')
         end
 
-        unless stubs.empty?
-          for stub, response in stubs
+        if params[:mock]
+          for stub, response in Excon.stubs
             # all specified non-headers params match and no headers were specified or all specified headers match
             if [stub.keys - [:headers]].all? {|key| stub[key] == params[key] } &&
               (!stub.has_key?(:headers) || stub[:headers].keys.all? {|key| stub[:headers][key] == params[:headers][key]})
-              return Excon::Response.new(response)
+              case response
+              when Proc
+                return Excon::Response.new(response.call(params))
+              else
+                return Excon::Response.new(response)
+              end
             end
           end
+          # if we reach here no stubs matched
+          raise(Excon::Errors::StubNotFound.new('no stubs matched ' << params.inspect))
         end
 
         # start with "METHOD /path"
@@ -144,6 +166,8 @@ module Excon
         end
 
         response
+      rescue Excon::Errors::StubNotFound => stub_not_found
+        raise(stub_not_found)
       rescue => socket_error
         reset
         raise(Excon::Errors::SocketError.new(socket_error))
@@ -174,21 +198,11 @@ module Excon
       (old_socket = sockets.delete(@socket_key)) && old_socket.close
     end
 
-    def stub(request_params, response_params)
-      stub = [request_params, response_params]
-      stubs << stub
-      stub
-    end
-
-    def stubs
-      @stubs ||= []
-    end
-
   private
     def connect
       new_socket = open_socket
 
-      if @connection[:scheme] == 'https'
+      if https?
         # create ssl context
         ssl_context = OpenSSL::SSL::SSLContext.new
 
@@ -214,15 +228,30 @@ module Excon
           ssl_context.key = OpenSSL::PKey::RSA.new(File.read(@connection[:client_key]))
         end
 
-        # open ssl socket
-        new_socket = OpenSSL::SSL::SSLSocket.new(new_socket, ssl_context)
-        new_socket.sync_close = true
-        new_socket.connect
+        new_socket = open_ssl_socket(new_socket, ssl_context)
+      end
 
-        # verify connection
-        new_socket.post_connection_check(@connection[:host])
+      new_socket
+    end
+
+    def open_ssl_socket(socket, ssl_context)
+
+      new_socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+      new_socket.sync_close = true
+
+      if @proxy
+        new_socket << "CONNECT " << @connection[:host] << ":" << @connection[:port] << HTTP_1_1
+        new_socket << "Host: " << @connection[:host] << ":" << @connection[:port] << CR_NL << CR_NL
+
+        # eat the proxy's connection response
+        while line = new_socket.readline.strip
+          break if line.empty?
+        end
       end
 
+      new_socket.connect
+      # verify connection
+      new_socket.post_connection_check(@connection[:host])
       new_socket
     end
     
@@ -242,17 +271,17 @@ module Excon
     def sockets
       Thread.current[:_excon_sockets] ||= {}
     end
-    
+
+    def https?
+      @connection[:scheme] == 'https'
+    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
-      }
+      {:host => uri.host, :port => uri.port, :scheme => uri.scheme}
     end
 
   end

data/lib/excon/errors.rb

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

data/lib/excon/response.rb

@@ -4,6 +4,14 @@ module Excon
 
     attr_accessor :body, :headers, :status
 
+    def attributes
+      {
+        :body     => body,
+        :headers  => headers,
+        :status   => status
+      }
+    end
+
     def initialize(attrs={})
       @body    = attrs[:body]    || ''
       @headers = attrs[:headers] || {}
@@ -35,16 +43,17 @@ module Excon
 
         if block_given
           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! # 2 == "/r/n".length
+              yield(socket.read(chunk_size + 2).chop!, nil, content_length)
             end
-            socket.read(2) # 2 == "/r/n".length
+            socket.read(2)
           elsif connection_close
-            yield socket.read
+            yield(socket.read, remaining, content_length)
           else
             remaining = content_length
             while remaining > 0
-              yield socket.read([CHUNK_SIZE, remaining].min), [remaining - CHUNK_SIZE, 0].max, content_length
+              yield(socket.read([CHUNK_SIZE, remaining].min), [remaining - CHUNK_SIZE, 0].max, content_length)
               remaining -= CHUNK_SIZE
             end
           end

data/tests/basic_tests.rb

@@ -1,43 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
-
 with_rackup('basic.ru') do
   Shindo.tests('Excon basics') do
-    tests('GET /content-length/100') do
-
-      connection = Excon.new('http://127.0.0.1:9292')
-      response = connection.request(:method => :get, :path => '/content-length/100')
-
-      tests('response.status').returns(200) do
-        response.status
-      end
-
-      tests("response.headers['Connection']").returns('Keep-Alive') do
-        response.headers['Connection']
-      end
-
-      tests("response.headers['Content-Length']").returns('100') do
-        response.headers['Content-Length']
-      end
-
-      tests("response.headers['Content-Type']").returns('text/html;charset=utf-8') do
-        response.headers['Content-Type']
-      end
-
-      test("Time.parse(response.headers['Date']).is_a?(Time)") do
-        Time.parse(response.headers['Date']).is_a?(Time)
-      end
-
-      test("!!(response.headers['Server'] =~ /^WEBrick/)") do
-        !!(response.headers['Server'] =~ /^WEBrick/)
-      end
-
-      tests("response.headers['Custom']").returns("Foo: bar") do
-        response.headers['Custom']
-      end
-
-      tests("response.body").returns('x' * 100) do
-        response.body
-      end
-    end
+    basic_tests
   end
 end

data/tests/proxy_tests.rb

@@ -1,64 +1,136 @@
-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
-    
+
+    tests('with proxy config from the environment') do
+      ENV['http_proxy'] = 'http://myproxy:8080'
+      ENV['https_proxy'] = 'http://mysecureproxy:8081'
+
+      tests('an http connection') do
+        connection = Excon.new('http://foo.com')
+
+        tests('connection.proxy.host').returns('myproxy') do
+          connection.proxy[:host]
+        end
+
+        tests('connection.proxy.port').returns(8080) do
+          connection.proxy[:port]
+        end
+
+        tests('connection.proxy.scheme').returns('http') do
+          connection.proxy[:scheme]
+        end
+      end
+
+      tests('an https connection') do
+        connection = Excon.new('https://secret.com')
+
+        tests('connection.proxy.host').returns('mysecureproxy') do
+          connection.proxy[:host]
+        end
+
+        tests('connection.proxy.port').returns(8081) do
+          connection.proxy[:port]
+        end
+
+        tests('connection.proxy.scheme').returns('http') do
+          connection.proxy[:scheme]
+        end
+      end
+
+      tests('http proxy from the environment overrides config') do
+        connection = Excon.new('http://foo.com', :proxy => 'http://hard.coded.proxy:6666')
+
+        tests('connection.proxy.host').returns('myproxy') do
+          connection.proxy[:host]
+        end
+
+        tests('connection.proxy.port').returns(8080) do
+          connection.proxy[:port]
+        end
+      end
+
+      ENV.delete('http_proxy')
+      ENV.delete('https_proxy')
+    end
+
+    tests('with only http_proxy config from the environment') do
+      ENV['http_proxy'] = 'http://myproxy:8080'
+      ENV.delete('https_proxy')
+
+      tests('an https connection') do
+        connection = Excon.new('https://secret.com')
+
+        tests('connection.proxy.host').returns('myproxy') do
+          connection.proxy[:host]
+        end
+
+        tests('connection.proxy.port').returns(8080) do
+          connection.proxy[:port]
+        end
+
+        tests('connection.proxy.scheme').returns('http') do
+          connection.proxy[:scheme]
+        end
+      end
+
+      ENV.delete('http_proxy')
+    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

@@ -1,60 +1,58 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
-
 with_rackup('query_string.ru') do
   Shindo.tests('Excon query string variants') do
     connection = Excon.new('http://127.0.0.1:9292')
-    
+
     tests(":query => {:foo => 'bar'}") do
 
       response = connection.request(:method => :get, :path => '/query', :query => {:foo => 'bar'})
       query_string = response.body[7..-1] # query string sent
-      
+
       tests("query string sent").returns('foo=bar') do
         query_string
       end
-      
+
     end
-    
+
     tests(":query => {:foo => nil}") do
 
       response = connection.request(:method => :get, :path => '/query', :query => {:foo => nil})
       query_string = response.body[7..-1] # query string sent
-      
+
       tests("query string sent").returns('foo') do
         query_string
       end
-      
+
     end
-    
+
     tests(":query => {:foo => 'bar', :me => nil}") do
 
       response = connection.request(:method => :get, :path => '/query', :query => {:foo => 'bar', :me => nil})
       query_string = response.body[7..-1] # query string sent
-      
+
       test("query string sent includes 'foo=bar'") do
         query_string.split('&').include?('foo=bar')
       end
-      
+
       test("query string sent includes 'me'") do
         query_string.split('&').include?('me')
       end
-      
+
     end
-    
+
     tests(":query => {:foo => 'bar', :me => 'too'}") do
 
       response = connection.request(:method => :get, :path => '/query', :query => {:foo => 'bar', :me => 'too'})
       query_string = response.body[7..-1] # query string sent
-      
+
       test("query string sent includes 'foo=bar'") do
         query_string.split('&').include?('foo=bar')
       end
-      
+
       test("query string sent includes 'me=too'") do
         query_string.split('&').include?('me=too')
       end
-      
+
     end
-    
+
   end
 end

data/tests/rackups/basic.ru

@@ -1,8 +1,8 @@
 require 'sinatra'
 
 class App < Sinatra::Base
-  get '/content-length/:value' do |value|
-    headers "Custom" => "Foo: bar"
+  get('/content-length/:value') do |value|
+    headers("Custom" => "Foo: bar")
     'x' * value.to_i
   end
 end

data/tests/rackups/proxy.ru

@@ -1,10 +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
+  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

data/tests/rackups/query_string.ru

@@ -1,8 +1,8 @@
 require 'sinatra'
 
 class App < Sinatra::Base
-  get '/query' do
-    "query: " + request.query_string
+  get('/query') do
+    "query: " << request.query_string
   end
 end
 

data/tests/rackups/thread_safety.ru

@@ -1,8 +1,8 @@
 require 'sinatra'
 
 class App < Sinatra::Base
-  get '/id/:id/wait/:wait' do |id, wait|
-    sleep wait.to_i
+  get('/id/:id/wait/:wait') do |id, wait|
+    sleep(wait.to_i)
     id.to_s
   end
 end

data/tests/stub_tests.rb

@@ -1,8 +1,24 @@
 Shindo.tests('Excon stubs') do
+  Excon.mock = true
+
+  tests("missing stub").raises(Excon::Errors::StubNotFound) do
+    connection = Excon.new('http://127.0.0.1:9292')
+    response = connection.request(:method => :get, :path => '/content-length/100')
+  end
+
+  tests("stub({})").raises(ArgumentError) do
+    Excon.stub({})
+  end
+
+  tests("stub({}, {}) {}").raises(ArgumentError) do
+    Excon.stub({}, {}) {}
+  end
+
   tests("stub({:method => :get}, {:body => 'body', :status => 200})") do
 
+    Excon.stub({:method => :get}, {:body => 'body', :status => 200})
+
     connection = Excon.new('http://127.0.0.1:9292')
-    connection.stub({:method => :get}, {:body => 'body', :status => 200})
     response = connection.request(:method => :get, :path => '/content-length/100')
 
     tests('response.body').returns('body') do
@@ -17,5 +33,39 @@ Shindo.tests('Excon stubs') do
       response.status
     end
 
+    Excon.stubs.pop
+
+  end
+
+  tests("stub({:body => 'body', :method => :get}) {|params| {:body => params[:body], :headers => params[:headers], :status => 200}}") do
+
+    Excon.stub({:body => 'body', :method => :get}) {|params| {:body => params[:body], :headers => params[:headers], :status => 200}}
+
+    connection = Excon.new('http://127.0.0.1:9292')
+    response = connection.request(:body => 'body', :method => :get, :path => '/content-length/100')
+
+    tests('response.body').returns('body') do
+      response.body
+    end
+
+    tests('response.headers').returns({'Host' => '127.0.0.1:9292'}) do
+      response.headers
+    end
+
+    tests('response.status').returns(200) do
+      response.status
+    end
+
+    Excon.stubs.pop
+
+  end
+
+  Excon.mock = false
+
+  tests('mock = false') do
+    with_rackup('basic.ru') do
+      basic_tests
+    end
   end
+
 end

data/tests/test_helper.rb

@@ -3,6 +3,46 @@ require 'bundler'
 
 Bundler.require(:default, :development)
 
+def basic_tests
+  tests('GET /content-length/100') do
+
+    connection = Excon.new('http://127.0.0.1:9292')
+    response = connection.request(:method => :get, :path => '/content-length/100')
+
+    tests('response.status').returns(200) do
+      response.status
+    end
+
+    tests("response.headers['Connection']").returns('Keep-Alive') do
+      response.headers['Connection']
+    end
+
+    tests("response.headers['Content-Length']").returns('100') do
+      response.headers['Content-Length']
+    end
+
+    tests("response.headers['Content-Type']").returns('text/html;charset=utf-8') do
+      response.headers['Content-Type']
+    end
+
+    test("Time.parse(response.headers['Date']).is_a?(Time)") do
+      Time.parse(response.headers['Date']).is_a?(Time)
+    end
+
+    test("!!(response.headers['Server'] =~ /^WEBrick/)") do
+      !!(response.headers['Server'] =~ /^WEBrick/)
+    end
+
+    tests("response.headers['Custom']").returns("Foo: bar") do
+      response.headers['Custom']
+    end
+
+    tests("response.body").returns('x' * 100) do
+      response.body
+    end
+  end
+end
+
 def rackup_path(*parts)
   File.expand_path(File.join(File.dirname(__FILE__), 'rackups', *parts))
 end

data/tests/thread_safety_tests.rb

@@ -1,5 +1,3 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
-
 with_rackup('thread_safety.ru') do
   Shindo.tests('Excon thread safety') do
     connection = Excon.new('http://127.0.0.1:9292')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: excon
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - geemus (Wesley Beary)
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-30 00:00:00 -07:00
+date: 2011-04-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: excon
-rubygems_version: 1.4.1
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 2
 summary: speed, persistence, http(s)