typhoeus 0.1.24 → 0.1.31

data/lib/typhoeus/hydra.rb

@@ -130,17 +130,33 @@ module Typhoeus
 
     def get_easy_object(request)
       @running_requests += 1
+
       easy = @easy_pool.pop || Easy.new
+      easy.verbose          = request.verbose
+      if request.username || request.password
+        auth = { :username => request.username, :password => request.password }
+        auth[:method] = Typhoeus::Easy::AUTH_TYPES["CURLAUTH_#{request.auth_method.to_s.upcase}".to_sym] if request.auth_method
+        easy.auth = auth
+      end
       easy.url          = request.url
       easy.method       = request.method
       easy.params       = request.params  if request.method == :post && !request.params.nil?
       easy.headers      = request.headers if request.headers
       easy.request_body = request.body    if request.body
       easy.timeout      = request.timeout if request.timeout
+      easy.connect_timeout = request.connect_timeout if request.connect_timeout
       easy.follow_location = request.follow_location if request.follow_location
       easy.max_redirects = request.max_redirects if request.max_redirects
       easy.proxy = request.proxy if request.proxy
       easy.disable_ssl_peer_verification if request.disable_ssl_peer_verification
+      easy.ssl_cert         = request.ssl_cert
+      easy.ssl_cert_type    = request.ssl_cert_type
+      easy.ssl_key          = request.ssl_key
+      easy.ssl_key_type     = request.ssl_key_type
+      easy.ssl_key_password = request.ssl_key_password
+      easy.ssl_cacert       = request.ssl_cacert
+      easy.ssl_capath       = request.ssl_capath
+      easy.verbose          = request.verbose
 
       easy.on_success do |easy|
         queue_next
@@ -192,6 +208,7 @@ module Typhoeus
                    :headers => easy.response_header,
                    :body    => easy.response_body,
                    :time    => easy.total_time_taken,
+                   :effective_url => easy.effective_url,
                    :request => request)
     end
     private :response_from_easy

data/lib/typhoeus/multi.rb

@@ -9,19 +9,20 @@ module Typhoeus
     def remove(easy)
       multi_remove_handle(easy)
     end
-    
+
     def add(easy)
+      easy.set_headers() if easy.headers.empty?
       @easy_handles << easy
       multi_add_handle(easy)
     end
-    
+
     def perform()
       while active_handle_count > 0 do
         multi_perform
       end
       reset_easy_handles
     end
-    
+
     def cleanup()
       multi_cleanup
     end

data/lib/typhoeus/request.rb

@@ -1,13 +1,45 @@
 module Typhoeus
   class Request
-    attr_accessor :method, :params, :body, :headers, :timeout, :user_agent, :response, :cache_timeout, :follow_location, :max_redirects, :proxy, :disable_ssl_peer_verification
+    attr_accessor :method, :params, :body, :headers, :connect_timeout, :timeout, :user_agent, :response, :cache_timeout, :follow_location, :max_redirects, :proxy, :disable_ssl_peer_verification, :ssl_cert, :ssl_cert_type, :ssl_key, :ssl_key_type, :ssl_key_password, :ssl_cacert, :ssl_capath, :verbose, :username, :password,
+:auth_method
+
     attr_reader   :url
 
+    # Initialize a new Request
+    #
+    # Options:
+    # * +url+ : Endpoint (URL) of the request
+    # * +options+   : A hash containing options among :
+    # ** +:method+  : :get (default) / :post / :put
+    # ** +:params+  : params as a Hash
+    # ** +:body+
+    # ** +:timeout+ : timeout (ms)
+    # ** +:connect_timeout+ : connect timeout (ms)
+    # ** +:headers+  : headers as Hash
+    # ** +:user_agent+ : user agent (string)
+    # ** +:cache_timeout+ : cache timeout (ms)
+    # ** +:follow_location
+    # ** +:max_redirects
+    # ** +:proxy
+    # ** +:disable_ssl_peer_verification
+    # ** +:ssl_cert
+    # ** +:ssl_cert_type
+    # ** +:ssl_key
+    # ** +:ssl_key_type
+    # ** +:ssl_key_password
+    # ** +:ssl_cacert
+    # ** +:ssl_capath
+    # ** +:verbose
+    # ** +:username
+    # ** +:password
+    # ** +:auth_method
+    #
     def initialize(url, options = {})
       @method           = options[:method] || :get
       @params           = options[:params]
       @body             = options[:body]
       @timeout          = options[:timeout]
+      @connect_timeout  = options[:connect_timeout]
       @headers          = options[:headers] || {}
       @user_agent       = options[:user_agent] || Typhoeus::USER_AGENT
       @cache_timeout    = options[:cache_timeout]
@@ -15,6 +47,17 @@ module Typhoeus
       @max_redirects    = options[:max_redirects]
       @proxy            = options[:proxy]
       @disable_ssl_peer_verification = options[:disable_ssl_peer_verification]
+      @ssl_cert         = options[:ssl_cert]
+      @ssl_cert_type    = options[:ssl_cert_type]
+      @ssl_key          = options[:ssl_key]
+      @ssl_key_type     = options[:ssl_key_type]
+      @ssl_key_password = options[:ssl_key_password]
+      @ssl_cacert       = options[:ssl_cacert]
+      @ssl_capath       = options[:ssl_capath]
+      @verbose          = options[:verbose]
+      @username         = options[:username]
+      @password         = options[:password]
+      @auth_method      = options[:auth_method]
 
       if @method == :post
         @url = url
@@ -42,7 +85,7 @@ module Typhoeus
     end
 
     def params_string
-      params.keys.sort.collect do |k|
+      params.keys.sort { |a, b| a.to_s <=> b.to_s }.collect do |k|
         value = params[k]
         if value.is_a? Hash
           value.keys.collect {|sk| Rack::Utils.escape("#{k}[#{sk}]") + "=" + Rack::Utils.escape(value[sk].to_s)}

data/lib/typhoeus/response.rb

@@ -3,8 +3,9 @@ module Typhoeus
     attr_accessor :request
     attr_reader :code, :headers, :body, :time,
                 :requested_url, :requested_remote_method,
-                :requested_http_method, :start_time
-    
+                :requested_http_method, :start_time,
+                :effective_url
+
     def initialize(params = {})
       @code                  = params[:code]
       @headers               = params[:headers]
@@ -14,8 +15,9 @@ module Typhoeus
       @requested_http_method = params[:requested_http_method]
       @start_time            = params[:start_time]
       @request               = params[:request]
+      @effective_url         = params[:effective_url]
     end
-    
+
     def headers_hash
       headers.split("\n").map {|o| o.strip}.inject({}) do |hash, o|
         if o.empty?
@@ -30,16 +32,16 @@ module Typhoeus
           else
             hash[key] = value
           end
-          
+
           hash
         end
       end
     end
-    
+
     def success?
       @code >= 200 && @code < 300
     end
-    
+
     def modified?
       @code != 304
     end

data/lib/typhoeus/service.rb

@@ -0,0 +1,20 @@
+module Typhoeus
+  class Service
+    def initialize(host, port)
+      @host = host
+      @port = port
+    end
+    
+    def get(resource, params)
+    end
+    
+    def put(resource, params)
+    end
+    
+    def post(resource, params)
+    end
+    
+    def delete(resource, params)
+    end
+  end
+end

data/lib/typhoeus.rb

@@ -14,7 +14,7 @@ require 'typhoeus/request'
 require 'typhoeus/hydra'
 
 module Typhoeus
-  VERSION = "0.1.24"
+  VERSION = File.read(File.dirname(__FILE__) + "/../VERSION").chomp
 
   def self.easy_object_pool
     @easy_objects ||= []

data/profilers/valgrind.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# go to ext/typhoeus and run ruby extconf.rb && make before running
+# this.
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../ext")
+require File.dirname(__FILE__) + "/../lib/typhoeus"
+
+klass = Class.new { include Typhoeus }
+
+loops = ENV['LOOPS'].to_i
+url = ARGV.first || (raise "requires URL!")
+
+loops.times do |i|
+  puts "On loop #{i}" if i % 10 == 0
+  results = []
+  5.times do
+    results << klass.get(url)
+  end
+ 
+  # fire requests
+  results[0].code
+end
+
+puts "Ran #{loops} loops on #{url}!"

data/spec/fixtures/result_set.xml

@@ -0,0 +1,60 @@
+<result_set>
+  <ttl>20</ttl>
+  <result>
+    <id>1</id>
+    <name>hello</name>
+    <description>
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+    </description>
+  </result>
+  <result>
+    <id>2</id>
+    <name>hello</name>
+    <description>
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+    </description>
+  </result>
+  <result>
+    <id>3</id>
+    <name>hello</name>
+    <description>
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+      this is a long description for a text field of some kind.
+    </description>
+  </result>
+</result_set>

data/spec/servers/app.rb

@@ -2,6 +2,7 @@
 require 'rubygems'
 require 'sinatra'
 require 'json'
+require 'zlib'
 
 @@fail_count = 0
 get '/fail/:number' do
@@ -43,11 +44,21 @@ get '/auth_ntlm' do
   # we're just checking for the existence if NTLM auth header here. It's validation
   # is too troublesome and really doesn't bother is much, it's up to libcurl to make
   # it valid
+  response['WWW-Authenticate'] = 'NTLM'
   is_ntlm_auth = /^NTLM/ =~ request.env['HTTP_AUTHORIZATION']
   true if is_ntlm_auth
   throw(:halt, [401, "Not authorized\n"]) if !is_ntlm_auth
 end
 
+get '/gzipped' do
+  req_env = request.env.to_json
+  z = Zlib::Deflate.new
+  gzipped_env = z.deflate(req_env, Zlib::FINISH)
+  z.close
+  response['Content-Encoding'] = 'gzip'
+  gzipped_env
+end
+
 get '/**' do
   sleep params["delay"].to_i if params.has_key?("delay")
   request.env.merge!(:body => request.body.read).to_json

data/spec/typhoeus/easy_spec.rb

@@ -1,6 +1,22 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe Typhoeus::Easy do  
+describe Typhoeus::Easy do
+  describe "#supports_zlib" do
+    before(:each) do
+      @easy = Typhoeus::Easy.new
+    end
+
+    it "should return true if the version string has zlib" do
+      @easy.stub!(:curl_version).and_return("libcurl/7.20.0 OpenSSL/0.9.8l zlib/1.2.3 libidn/1.16")
+      @easy.supports_zlib?.should be_true
+    end
+
+    it "should return false if the version string doesn't have zlib" do
+      @easy.stub!(:curl_version).and_return("libcurl/7.20.0 OpenSSL/0.9.8l libidn/1.16")
+      @easy.supports_zlib?.should be_false
+    end
+  end
+
   describe "options" do
     it "should not follow redirects if not instructed to" do
       e = Typhoeus::Easy.new
@@ -101,6 +117,14 @@ describe Typhoeus::Easy do
     end
   end
 
+  describe "purge" do
+    it "should set custom request to purge" do
+      easy = Typhoeus::Easy.new
+      easy.should_receive(:set_option).with(Typhoeus::Easy::OPTION_VALUES[:CURLOPT_CUSTOMREQUEST], "PURGE").once
+      easy.method = :purge
+    end
+  end
+
   describe "head" do
     it "should perform a head" do
       easy = Typhoeus::Easy.new
@@ -208,5 +232,18 @@ describe Typhoeus::Easy do
       easy.response_code.should == 200
       easy.response_body.should include("this is a body!")
     end
-  end  
+  end
+  
+  describe "encoding/compression support" do
+    
+    it "should send valid encoding headers and decode the response" do
+      easy = Typhoeus::Easy.new
+      easy.url = "http://localhost:3002/gzipped"
+      easy.method = :get
+      easy.perform
+      easy.response_code.should == 200
+      JSON.parse(easy.response_body)["HTTP_ACCEPT_ENCODING"].should == "deflate, gzip"
+    end
+    
+  end
 end