excon 0.2.4 → 0.2.6

data/Gemfile

@@ -1,11 +1,13 @@
 source "http://rubygems.org"
 
-group :test do
-  gem "shindo"
-  gem "tach"
+gemspec
 
-  gem "sinatra"
-  gem "rake"
-  gem "mongrel"
-  gem "open4"
+group :benchmark do
+  gem 'em-http-request'
+  gem 'httparty'
+  gem 'rest-client'
+  gem 'tach', '0.0.5'
+  gem 'typhoeus'
+  gem 'sinatra'
+  gem 'streamly_ffi'
 end

data/README.rdoc

@@ -14,7 +14,7 @@ This will return a response object, which has body, headers and status attribute
 
 This supports all the major http verbs: [connect, delete, get, head, options, post, put, trace]
 
-You can also create a connection to try and keep open across multiple requests.
+You can also create a connection to try and keep open across multiple requests (more performant!).
 
   connection = Excon.new('http://geemus.com')
   connection.request(:method => 'GET')

data/Rakefile

@@ -47,8 +47,8 @@ task :default => :test
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.libs << 'lib' << 'tests'
+  test.pattern = 'tests/**/test_*.rb'
   test.verbose = true
 end
 
@@ -56,7 +56,7 @@ desc "Generate RCov test coverage and open in your browser"
 task :coverage do
   require 'rcov'
   sh "rm -fr coverage"
-  sh "rcov test/test_*.rb"
+  sh "rcov tests/test_*.rb"
   sh "open coverage/index.html"
 end
 

data/benchmarks/concat_vs_insert.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'tach'
+
+Tach.meter(1_000_000) do
+  tach('concat') do
+    path = 'path'
+    path = '/' << path
+  end
+  tach('insert') do
+    path = 'path'
+    path.insert(0, '/')
+  end
+end
+
+# +--------+----------+
+# | tach   | total    |
+# +--------+----------+
+# | insert | 0.974036 |
+# +--------+----------+
+# | concat | 0.998904 |
+# +--------+----------+

data/benchmarks/concat_vs_interpolate.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'tach'
+
+key = 'Content-Length'
+value = '100'
+Tach.meter(1_000) do
+  tach('concat') do
+    key << ': ' << value << "\r\n"
+  end
+  tach('interpolate') do
+    "#{key}: value\r\n"
+  end
+end
+
+# +-------------+----------+
+# | tach        | total    |
+# +-------------+----------+
+# | concat      | 0.000902 |
+# +-------------+----------+
+# | interpolate | 0.019667 |
+# +-------------+----------+

data/benchmarks/cr_lf.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'tach'
+
+CR_LF = "\r\n"
+
+Tach.meter(1_000_000) do
+  tach('constant') do
+    '' << CR_LF
+  end
+  tach('string') do
+    '' << "\r\n"
+  end
+end
+
+# +----------+----------+
+# | tach     | total    |
+# +----------+----------+
+# | constant | 0.819885 |
+# +----------+----------+
+# | string   | 0.893602 |
+# +----------+----------+

data/benchmarks/excon_vs.rb

@@ -1,39 +1,138 @@
-require File.join(File.dirname(__FILE__), '..', 'lib/excon')
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'bundler'
 
-require 'benchmark'
-require 'net/http'
-require 'open-uri'
+Bundler.require(:default)
+Bundler.require(:benchmark)
+
+require 'sinatra/base'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'excon')
+
+module Excon
+  class Server < Sinatra::Base
 
-COUNT = 100
-data = "Content-Length: 100"
-Benchmark.bmbm(25) do |bench|
-  bench.report('excon') do
-    COUNT.times do
-      Excon.new('http://www.google.com').request(:method => 'GET', :path => '/')
+    def self.run
+      Rack::Handler::WEBrick.run(
+        Excon::Server.new,
+        :Port => 9292,
+        :AccessLog => [],
+        :Logger => WEBrick::Log.new(nil, WEBrick::Log::ERROR)
+      )
     end
-  end
-  bench.report('excon (persistent)') do
-    excon = Excon.new('http://www.google.com')
-    COUNT.times do
-      excon.request(:method => 'GET', :path => '/')
+
+    get '/data/:amount' do |amount|
+      'x' * amount.to_i
     end
+
+  end
+end
+
+def with_server(&block)
+  pid = Process.fork do
+    Excon::Server.run
   end
-  bench.report('net/http') do
-    COUNT.times do
-      # Net::HTTP.get('www.google.com', '/')
-      Net::HTTP.start('www.google.com') {|http| http.get('/') }
+  loop do
+    sleep(1)
+    begin
+      Excon.get('http://localhost:9292/api/foo')
+      break
+    rescue
     end
   end
-  bench.report('net/http (persistent)') do
-    Net::HTTP.start('www.google.com', 80) do |http|
-      COUNT.times do
-        http.get('/')
+  yield
+ensure
+  Process.kill(9, pid)
+end
+
+require 'em-http-request'
+require 'httparty'
+require 'net/http'
+require 'open-uri'
+require 'rest_client'
+require 'tach'
+require 'typhoeus'
+
+url = 'http://localhost:9292/data/1000'
+
+with_server do
+
+  Tach.meter(1000) do
+
+    tach('em-http-request') do
+      EventMachine.run {
+        http = EventMachine::HttpRequest.new(url).get
+
+        http.callback {
+          http.response
+          EventMachine.stop
+        }
+      }
+    end
+
+    tach('Excon') do
+      Excon.get(url).body
+    end
+
+    excon = Excon.new(url)
+    tach('Excon (persistent)') do
+      excon.request(:method => 'get').body
+    end
+
+    tach('HTTParty') do
+      HTTParty.get(url).body
+    end
+
+    tach('Net::HTTP') do
+      # Net::HTTP.get('localhost', '/data/1000', 9292)
+      Net::HTTP.start('localhost', 9292) {|http| http.get('/data/1000').body }
+    end
+
+    Net::HTTP.start('localhost', 9292) do |http|
+      tach('Net::HTTP (persistent)') do
+        http.get('/data/1000').body
       end
     end
-  end
-  bench.report('open-uri') do
-    COUNT.times do
-      open('http://www.google.com/').read
+
+    tach('open-uri') do
+      open(url).read
+    end
+
+    tach('RestClient') do
+      RestClient.get(url)
+    end
+
+    streamly = StreamlyFFI::Connection.new
+    tach('StreamlyFFI (persistent)') do
+      streamly.get(url)
+    end
+
+    tach('Typhoeus') do
+      Typhoeus::Request.get(url).body
     end
+
   end
 end
+
+# +--------------------------+----------+
+# | tach                     | total    |
+# +--------------------------+----------+
+# | Excon (persistent)       | 1.521565 |
+# +--------------------------+----------+
+# | Excon                    | 1.624180 |
+# +--------------------------+----------+
+# | Typhoeus                 | 1.918563 |
+# +--------------------------+----------+
+# | StreamlyFFI (persistent) | 1.933218 |
+# +--------------------------+----------+
+# | Net::HTTP (persistent)   | 2.418454 |
+# +--------------------------+----------+
+# | Net::HTTP                | 2.439801 |
+# +--------------------------+----------+
+# | HTTParty                 | 2.609180 |
+# +--------------------------+----------+
+# | RestClient               | 2.905853 |
+# +--------------------------+----------+
+# | open-uri                 | 2.936382 |
+# +--------------------------+----------+
+# | em-http-request          | 3.933757 |
+# +--------------------------+----------+

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.2.4'
-  s.date              = '2010-10-11'
+  s.version           = '0.2.6'
+  s.date              = '2010-11-29'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -53,6 +53,9 @@ 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('open4')
+  s.add_development_dependency('shindo', '0.1.10')
+  s.add_development_dependency('sinatra')
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE
@@ -62,6 +65,9 @@ Gem::Specification.new do |s|
     Gemfile
     README.rdoc
     Rakefile
+    benchmarks/concat_vs_insert.rb
+    benchmarks/concat_vs_interpolate.rb
+    benchmarks/cr_lf.rb
     benchmarks/excon_vs.rb
     benchmarks/headers_split_vs_match.rb
     benchmarks/strip_newline.rb

data/lib/excon.rb

@@ -1,8 +1,5 @@
-__DIR__ = File.dirname(__FILE__)
-
-$LOAD_PATH.unshift __DIR__ unless
-  $LOAD_PATH.include?(__DIR__) ||
-  $LOAD_PATH.include?(File.expand_path(__DIR__))
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'cgi'
 require 'openssl'
@@ -16,11 +13,19 @@ require 'excon/response'
 module Excon
 
   unless const_defined?(:VERSION)
-    VERSION = '0.2.4'
+    VERSION = '0.2.6'
   end
 
-  CHUNK_SIZE = 1048576 # 1 megabyte
+  unless const_defined?(:CHUNK_SIZE)
+    CHUNK_SIZE = 1048576 # 1 megabyte
+  end
 
+  # @see Connection#initialize
+  #  Initializes a new keep-alive session for a given remote host
+  #
+  #   @param [String] url The destination URL
+  #   @param [Hash<Symbol, >] params One or more option params to set on the Connection instance
+  #   @return [Connection] A new Excon::Connection instance
   def self.new(url, params = {})
     Excon::Connection.new(url, params)
   end
@@ -28,7 +33,7 @@ module Excon
   %w{connect delete get head options post put trace}.each do |method|
     eval <<-DEF
       def self.#{method}(url, params = {}, &block)
-        new(url).request(params.merge!(:method => '#{method.upcase}'), &block)
+        new(url).request(params.merge!(:method => :#{method}), &block)
       end
     DEF
   end

data/lib/excon/connection.rb

@@ -1,6 +1,21 @@
 module Excon
   class Connection
 
+    attr_reader :connection
+
+    CR_NL     = "\r\n"
+    HTTP_1_1  = " HTTP/1.1\r\n"
+
+    # Initializes a new Connection instance
+    #   @param [String] url The destination URL
+    #   @param [Hash<Symbol, >] params One or more optional params
+    #     @option params [String] :body Default text to be sent over a socket. Only used if :body absent in Connection#request params
+    #     @option params [Hash<Symbol, String>] :headers The default headers to supply in a request. Only used if params[:headers] is not supplied to Connection#request
+    #     @option params [String] :host The destination host's reachable DNS name or IP, in the form of a String
+    #     @option params [String] :path Default path; appears after 'scheme://host:port/'. Only used if params[:path] is not supplied to Connection#request
+    #     @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
     def initialize(url, params = {})
       uri = URI.parse(url)
       @connection = {
@@ -11,22 +26,44 @@ module Excon
         :query    => uri.query,
         :scheme   => uri.scheme
       }.merge!(params)
+
+      set_socket_key
     end
 
+    # Sends the supplied request to the destination host.
+    #   @yield [chunk] @see Response#self.parse
+    #   @param [Hash<Symbol, >] params One or more optional params, override defaults set in Connection.new
+    #     @option params [String] :body text to be sent over a socket
+    #     @option params [Hash<Symbol, String>] :headers The default headers to supply in a request
+    #     @option params [String] :host The destination host's reachable DNS name or IP, in the form of a String
+    #     @option params [String] :path appears after 'scheme://host:port/'
+    #     @option params [Fixnum] :port The port on which to connect, to the destination host
+    #     @option params [Hash]   :query appended to the 'scheme://host:port/path/' in the form of '?key=value'
+    #     @option params [String] :scheme The protocol; 'https' causes OpenSSL to be used
     def request(params, &block)
       begin
         params[:path] ||= @connection[:path]
         unless params[:path][0..0] == '/'
-          params[:path] = "/#{params[:path]}"
+          params[:path].insert(0, '/')
         end
-        request = "#{params[:method].upcase} #{params[:path]}?"
-        for key, values in (params[:query] || @connection[:query] || {})
-          for value in [*values]
-            request << "#{key}#{value && "=#{CGI.escape(value.to_s)}"}&"
+
+        request = params[:method].to_s.upcase << ' ' << params[:path]
+        if query = (params[:query] || @connection[:query])
+          request << '?'
+          case query
+          when String
+            request << query
+          else
+            for key, values in query
+              for value in [*values]
+                value_string = value && ('=' << CGI.escape(value.to_s))
+                request << key.to_s << value_string << '&'
+              end
+            end
+            request.chop! # remove trailing '&'
           end
         end
-        request.chop!
-        request << " HTTP/1.1\r\n"
+        request << HTTP_1_1
         params[:headers] ||= @connection[:headers]
         params[:headers]['Host'] ||= params[:host] || @connection[:host]
         params[:body] ||= @connection[:body]
@@ -43,9 +80,9 @@ module Excon
           0
         end
         for key, value in params[:headers]
-          request << "#{key}: #{value}\r\n"
+          request << key.to_s << ': ' << value.to_s << CR_NL
         end
-        request << "\r\n"
+        request << CR_NL
         socket.write(request)
 
         if params[:body]
@@ -126,7 +163,11 @@ module Excon
     end
 
     def socket_key
-      "#{@connection[:host]}:#{@connection[:port]}"
+      @connection[:socket_key]
+    end
+
+    def set_socket_key
+      @connection[:socket_key] = "#{@connection[:host]}:#{@connection[:port]}"
     end
   end
 end

data/tests/test_helper.rb

@@ -1,6 +1,7 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/excon'))
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'bundler'
 
-require 'open4'
+Bundler.require(:default, :development)
 
 def local_file(*parts)
   File.expand_path(File.join(File.dirname(__FILE__), *parts))

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - geemus (Wesley Beary)
@@ -14,10 +14,47 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-11 00:00:00 -07:00
+date: 2010-11-29 00:00:00 -08:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shindo
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 10
+        version: 0.1.10
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: EXtended http(s) CONnections
 email: geemus@gmail.com
 executables: []
@@ -30,6 +67,9 @@ files:
 - Gemfile
 - README.rdoc
 - Rakefile
+- benchmarks/concat_vs_insert.rb
+- benchmarks/concat_vs_interpolate.rb
+- benchmarks/cr_lf.rb
 - benchmarks/excon_vs.rb
 - benchmarks/headers_split_vs_match.rb
 - benchmarks/strip_newline.rb