typhoeus 0.1.30 → 0.1.31

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+0.1.31
+------
+* Fixed bug in setting compression encoding [morhekil]
+* Exposed authentication control methods through Request interface [morhekil]
+
 0.1.30
 -----------
 * Exposed CURLOPT_CONNECTTIMEOUT_MS to Requests [balexis]

data/README.textile

@@ -183,9 +183,8 @@ hydra.stub(:get, "http://localhost:3000/users")
 *Basic Authentication*
 
 <pre>
-require 'base64'
 response = Typhoeus::Request.get("http://twitter.com/statuses/followers.json",
-                                 :headers => {"Authorization" => "Basic #{Base64.b64encode("#{username}:#{password}")}"})
+                                 :username => username, :password => password)
 </pre>
 
 *SSL*
@@ -227,9 +226,9 @@ e = Typhoeus::Request.get("https://example.com/action",
 end
 </pre>
 
-h2. NTLM authentication
+h2. Advanced authentication
 
-Thanks for the authentication piece and this description go to Oleg Ivanov (morhekil). The major reason to start this fork was the need to perform NTLM authentication in Ruby. Now you can do it via Typhoeus::Easy interface using the following API.
+Thanks for the authentication piece and this description go to Oleg Ivanov (morhekil). The major reason to start this fork was the need to perform NTLM authentication in Ruby, and other libcurl's authentications method were made possible as a result. Now you can do it via Typhoeus::Easy interface using the following API.
 
 <pre>
 e = Typhoeus::Easy.new
@@ -251,6 +250,22 @@ The following authentication types are available:
 * CURLAUTH_GSSNEGOTIATE
 * CURLAUTH_NTLM
 * CURLAUTH_DIGEST_IE
+* CURLAUTH_AUTO
+
+The last one (CURLAUTH_AUTO) is really a combination of all previous methods and is provided by Typhoeus for convenience. When you set authentication to auto, Typhoeus will retrieve the given URL first and examine it's headers to confirm what auth types are supported by the server. The it will select the strongest of available auth methods and will send the second request using the selected authentication method.
+
+*Authentication via the quick request interface*
+
+There's also an easy way to perform any kind of authentication via the quick request interface:
+
+<pre>
+e = Typhoeus::Request.get("http://example.com",
+  :username => 'username',
+  :password => 'password',
+  :method => :ntlm)
+</pre>
+
+All methods listed above is available in a shorter form - :basic, :digest, :gssnegotiate, :ntlm, :digest_ie, :auto.
 
 *Query of available auth types*
 
@@ -266,7 +281,13 @@ e = Typhoeus::Easy.new
 e.verbose = 1
 </pre>
 
-Please note that libcurl prints it's output to the console, so you'll need to run your scripts from the console to see the debug info.
+or using the quick request:
+
+<pre>
+e = Typhoeus::Request.get("http://example.com", :verbose => true)
+</pre>
+
+Just remember that libcurl prints it's debug output to the console (to STDERR), so you'll need to run your scripts from the console to see it.
 
 h2. Benchmarks
 

data/VERSION

@@ -1 +1 @@
-0.1.30
+0.1.31

data/lib/typhoeus/easy.rb

@@ -30,7 +30,7 @@ module Typhoeus
       :CURLOPT_PROXY          => 10004,
       :CURLOPT_VERIFYPEER     => 64,
       :CURLOPT_NOBODY         => 44,
-      :CURLOPT_ENCODING       => 102,
+      :CURLOPT_ENCODING       => 10000 + 102,
       :CURLOPT_SSLCERT        => 10025,
       :CURLOPT_SSLCERTTYPE    => 10086,
       :CURLOPT_SSLKEY         => 10087,
@@ -50,14 +50,16 @@ module Typhoeus
       :CURLAUTH_DIGEST        => 2,
       :CURLAUTH_GSSNEGOTIATE  => 4,
       :CURLAUTH_NTLM          => 8,
-      :CURLAUTH_DIGEST_IE     => 16
+      :CURLAUTH_DIGEST_IE     => 16,
+      :CURLAUTH_AUTO          => 16 | 8 | 4 | 2 | 1
     }
 
     def initialize
       @method = :get
       @headers = {}
 
-      set_option(OPTION_VALUES[:CURLOPT_ENCODING], 'zlib') if supports_zlib?
+      # Enable encoding/compression support
+      set_option(OPTION_VALUES[:CURLOPT_ENCODING], '')
     end
 
     def headers=(hash)

data/lib/typhoeus/hydra.rb

@@ -132,6 +132,12 @@ module Typhoeus
       @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?

data/lib/typhoeus/request.rb

@@ -1,6 +1,7 @@
 module Typhoeus
   class Request
-    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
+    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
 
@@ -29,6 +30,9 @@ module Typhoeus
     # ** +:ssl_cacert
     # ** +:ssl_capath
     # ** +:verbose
+    # ** +:username
+    # ** +:password
+    # ** +:auth_method
     #
     def initialize(url, options = {})
       @method           = options[:method] || :get
@@ -51,6 +55,9 @@ module Typhoeus
       @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

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

@@ -232,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

data/spec/typhoeus/request_spec.rb

@@ -160,6 +160,32 @@ describe Typhoeus::Request do
     request.call_handlers
     good.should be_true
   end
+  
+  describe "authentication" do
+    
+    it "should allow to set username and password" do
+      auth = { :username => 'foo', :password => 'bar' }
+      e = Typhoeus::Request.get(
+        "http://localhost:3001/auth_basic/#{auth[:username]}/#{auth[:password]}",
+        auth
+      )
+      e.code.should == 200
+    end
+
+    it "should allow to set authentication method" do
+      auth = {
+        :username => 'username',
+        :password => 'password',
+        :auth_method => :ntlm
+      }
+      e = Typhoeus::Request.get(
+        "http://localhost:3001/auth_ntlm",
+        auth
+      )
+      e.code.should == 200
+    end
+
+  end
 
   describe "retry" do
     it "should take a retry option"

data/typhoeus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{typhoeus}
-  s.version = "0.1.30"
+  s.version = "0.1.31"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Dix"]
-  s.date = %q{2010-07-15}
+  s.date = %q{2010-07-16}
   s.description = %q{Like a modern code version of the mythical beast with 100 serpent heads, Typhoeus runs HTTP requests in parallel while cleanly encapsulating handling logic.}
   s.email = %q{paul@pauldix.net}
   s.extensions = ["ext/typhoeus/extconf.rb"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 30
-  version: 0.1.30
+  - 31
+  version: 0.1.31
 platform: ruby
 authors: 
 - Paul Dix
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-15 00:00:00 -07:00
+date: 2010-07-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency