pooled-curb 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Angel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,28 @@
+= pooled-curb
+
+High-performance HTTP requests for a multi-threaded environment. 
+
+When consuming web services, HTTP performance can be greatly improved if you enable keep-alive 
+and the right HTTP library.
+ 
+But reusing HTTP connections can be challenging in a multi-threaded environment, where you want
+to reuse connections created from another thread, or on a single-threaded environment where several
+code points connect to the same host. 
+
+Pooled-curb helps to solve this implementing a pool of Curb (libcurl) objects and providing a 
+pleasent API to do HTTP requests through the pool. 
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Angel Faus. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pooled-curb"
+    gem.summary = %Q{High-performance HTTP requests for a multi-threaded environment}
+    gem.description = %Q{When consuming web services, HTTP performance can be greatly improved if you enable keep-alive 
+    and the right HTTP library.\nPooled-curb helps to solve this implementing a pool of Curb (libcurl) objects and providing a 
+    pleasent API to do HTTP requests through the pool.}
+    gem.email = "angel@vlex.com"
+    gem.homepage = "http://github.com/angelf/pooled-curb"
+    gem.authors = ["Angel Faus"]
+    gem.add_dependency "common-pool", ">= 0"    
+    gem.add_dependency "curb", ">= 0"    
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pooled-curb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pooled-curb.rb

@@ -0,0 +1,113 @@
+require 'common_pool'
+require 'curb'
+require 'pooled_curb_datasource'
+
+# wrapper on top of curb to ensure we reuse the Curl objects, and thus make sure we  
+# benefit from keep-alive
+#
+# Usage:
+#
+#   PooledCurb.get(url)
+#
+#   PooledCurb.post(url, {:hash => 'of', :several => 'parameters})
+#   PooledCurb.post(url, request_body)
+#
+#   PooledCurb.put(url, request_body)
+
+class PooledCurb
+
+  #NOTE: curb documentation lives in http://rubydoc.info/github/taf2/curb/
+
+  HTTP_CLIENT_POOL = CommonPool::ObjectPool.new(PooledCurbDataSource.new) {|config| config.max_active = 200 }
+  
+  def self.with_client
+    curl = HTTP_CLIENT_POOL.borrow_object
+    begin
+      yield curl
+    rescue Curl::Err::MultiBadEasyHandle
+      # obtener una nueva
+      curl = HTTP_CLIENT_POOL.borrow_object
+      retry
+    ensure
+      HTTP_CLIENT_POOL.return_object(curl)
+    end
+  end
+
+  # get the URL, returns body_str, responde_code
+  def self.get(url, timeout = 20)
+    with_client do |curl|
+      curl.timeout = timeout
+      curl.url = url
+      curl.http("GET")
+      return curl.body_str, curl.response_code
+    end
+  end
+
+  # get the URL, retrying upto max_retries times if an error is found. 
+  #
+  # When a code block is given, it will be used as a validation function
+  # for the response, otherwise and standard validation that tests that response code is 200
+  # and the body is not nil will be used
+  #
+  # for example
+  #
+  #  PooledCurb.get_with_retry(url) {|body, code| body !~ /ERROR/}
+
+  def self.get_with_retry(url, timeout = 20, max_retries = 5)
+    
+    body = nil
+    
+    max_retries.times do |ix_try|
+      
+      # If the target server is down for a very short time, a very short sleep after the third failure
+      # will help us recover the error
+      Kernel.sleep(0.2) if ix_try > 3
+
+      begin
+        body, response_code = get(url, timeout)
+
+        if block_given?
+          next unless yield body, response_code
+        else
+          next unless response_code == 200 && body.any?
+        end
+        
+        return body        
+      rescue Curl::Err::CurlError
+        # will retry
+      end
+    end
+    
+    body
+  end
+
+  # post to the URL, returns body_str, responde_code
+  #
+  # can accept a hash of parameters or a string containing the request body 
+  
+  def self.post(url, params_or_body = {}, timeout = 20)
+    with_client do |curl|
+      curl.timeout = timeout
+      curl.url = url
+      if params_or_body.kind_of?(String)
+        curl.http_post url, params_or_body
+      else
+        params = params_or_body
+        fields = params.keys.map{|param_name| Curl::PostField.content(param_name, params[param_name]) }
+        curl.http_post url, *fields
+      end
+      return curl.body_str, curl.response_code
+    end
+  end
+  
+  # put to the URL, returns body_str, responde_code
+  def self.put(url, request_body, timeout = 20)
+    with_client do |curl|
+      curl.timeout = timeout
+      curl.url = url
+      curl.http_put request_body
+      return curl.body_str, curl.response_code
+    end
+  end
+  
+end

data/lib/pooled_curb_datasource.rb

@@ -0,0 +1,20 @@
+# PooledCurbDataSource
+#
+# obtains http clients (Curl::Easy objects) through a pool. 
+#
+# esto es importante porque si reutilizamos los clientes HTTP (curb) tenemos alguna
+#
+# usage:
+#   http_client_pool = CommonPool::ObjectPool.new(PooledCurbDataSource.new)
+#   curb_client = http_client_pool.borrow_object
+#   ..
+#   http_client_pool.return_object(curb_client)
+#
+# see:
+#    http://github.com/jugend/common-pool
+
+class PooledCurbDataSource < CommonPool::PoolDataSource
+  def create_object
+    Curl::Easy.new
+  end
+end

data/pooled-curb.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pooled-curb}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Angel Faus"]
+  s.date = %q{2010-09-29}
+  s.description = %q{When consuming web services, HTTP performance can be greatly improved if you enable keep-alive 
+    and the right HTTP library.
+Pooled-curb helps to solve this implementing a pool of Curb (libcurl) objects and providing a 
+    pleasent API to do HTTP requests through the pool.}
+  s.email = %q{angel@vlex.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/pooled-curb.rb",
+     "lib/pooled_curb_datasource.rb",
+     "pooled-curb.gemspec",
+     "test/helper.rb",
+     "test/test_pooled-curb.rb"
+  ]
+  s.homepage = %q{http://github.com/angelf/pooled-curb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{High-performance HTTP requests for a multi-threaded environment}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_pooled-curb.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<common-pool>, [">= 0"])
+      s.add_runtime_dependency(%q<curb>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<common-pool>, [">= 0"])
+      s.add_dependency(%q<curb>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<common-pool>, [">= 0"])
+    s.add_dependency(%q<curb>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pooled-curb'
+
+class Test::Unit::TestCase
+end

data/test/test_pooled-curb.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPooledCurb < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: pooled-curb
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Angel Faus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-29 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: common-pool
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: curb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: |-
+  When consuming web services, HTTP performance can be greatly improved if you enable keep-alive 
+      and the right HTTP library.
+  Pooled-curb helps to solve this implementing a pool of Curb (libcurl) objects and providing a 
+      pleasent API to do HTTP requests through the pool.
+email: angel@vlex.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pooled-curb.rb
+- lib/pooled_curb_datasource.rb
+- pooled-curb.gemspec
+- test/helper.rb
+- test/test_pooled-curb.rb
+has_rdoc: true
+homepage: http://github.com/angelf/pooled-curb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: High-performance HTTP requests for a multi-threaded environment
+test_files: 
+- test/helper.rb
+- test/test_pooled-curb.rb