typhoeus 0.1.27 → 0.1.28

data/CHANGELOG.markdown

@@ -0,0 +1,9 @@
+0.1.28
+----------------
+* Added SSL cert options for Typhoeus::Easy [GH-25, gravis]
+* Ported SSL cert options to Typhoeus::Request interface [gravis]
+* Added support for any HTTP method (purge for Varnish) [ryana]
+
+0.1.27
+------
+* Added rack as dependency, added dev dependencies to Rakefile [GH-21]

data/README.textile

@@ -204,6 +204,29 @@ Typhoeus::Request.get("https://mail.google.com/mail", :disable_ssl_peer_verifica
 *LibCurl*
 Typhoeus also has a more raw libcurl interface. These are the Easy and Multi objects. If you're into accessing just the raw libcurl style, those are your best bet.
 
+SSL Certs can be provided to the Easy interface :
+
+<pre>
+e = Typhoeus::Easy.new
+e.url = "https://example.com/action"
+s.ssl_cacert = "ca_file.cer"
+e.ssl_cert = "acert.crt"
+e.ssl_key = "akey.key"
+[...]
+e.perform
+</pre>
+
+or directly to a Typhoeus::Request :
+
+<pre>
+e = Typhoeus::Request.get("https://example.com/action",
+  :ssl_cacert => "ca_file.cer",
+  :ssl_cert => "acert.crt",
+  :ssl_key => "akey.key",
+  [...]
+end
+</pre>
+
 h2. NTLM 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.

data/VERSION

@@ -1 +1 @@
-0.1.27
+0.1.28

data/lib/typhoeus/easy.rb

@@ -1,6 +1,6 @@
 module Typhoeus
   class Easy
-    attr_reader :response_body, :response_header, :method, :headers, :url
+    attr_reader :response_body, :response_header, :method, :headers, :url, :params
     attr_accessor :start_time
 
     # These integer codes are available in curl/curl.h
@@ -25,7 +25,14 @@ module Typhoeus
       :CURLOPT_PROXY          => 10004,
       :CURLOPT_VERIFYPEER     => 64,
       :CURLOPT_NOBODY         => 44,
-      :CURLOPT_ENCODING       => 102
+      :CURLOPT_ENCODING       => 102,
+      :CURLOPT_SSLCERT        => 10025,
+      :CURLOPT_SSLCERTTYPE    => 10086,
+      :CURLOPT_SSLKEY         => 10087,
+      :CURLOPT_SSLKEYTYPE     => 10088,
+      :CURLOPT_KEYPASSWD      => 10026,
+      :CURLOPT_CAINFO         => 10065,
+      :CURLOPT_CAPATH         => 10097
     }
     INFO_VALUES = {
       :CURLINFO_RESPONSE_CODE => 2097154,
@@ -105,7 +112,7 @@ module Typhoeus
     end
 
     def supports_zlib?
-      @supports_zlib ||= !!(version.match(/zlib/))
+      !!(curl_version.match(/zlib/))
     end
 
     def request_body=(request_body)
@@ -145,7 +152,7 @@ module Typhoeus
       elsif method == :head
         set_option(OPTION_VALUES[:CURLOPT_NOBODY], 1)
       else
-        set_option(OPTION_VALUES[:CURLOPT_CUSTOMREQUEST], "DELETE")
+        set_option(OPTION_VALUES[:CURLOPT_CUSTOMREQUEST], method.to_s.upcase)
       end
     end
 
@@ -156,6 +163,7 @@ module Typhoeus
     end
 
     def params=(params)
+      @params = params
       params_string = params.keys.collect do |k|
         value = params[k]
         if value.is_a? Hash
@@ -175,10 +183,58 @@ module Typhoeus
       end
     end
 
+    # Set SSL certificate
+    # " The string should be the file name of your certificate. "
+    # The default format is "PEM" and can be changed with ssl_cert_type=
+    def ssl_cert=(cert)
+      set_option(OPTION_VALUES[:CURLOPT_SSLCERT], cert)
+    end
+
+    # Set SSL certificate type
+    # " The string should be the format of your certificate. Supported formats are "PEM" and "DER" "
+    def ssl_cert_type=(cert_type)
+      raise "Invalid ssl cert type : '#{cert_type}'..." if cert_type and !%w(PEM DER).include?(cert_type) 
+      set_option(OPTION_VALUES[:CURLOPT_SSLCERTTYPE], cert_type)
+    end
+
+    # Set SSL Key file
+    # " The string should be the file name of your private key. "
+    # The default format is "PEM" and can be changed with ssl_key_type=
+    #
+    def ssl_key=(key)
+      set_option(OPTION_VALUES[:CURLOPT_SSLKEY], key)
+    end
+
+    # Set SSL Key type
+    # " The string should be the format of your private key. Supported formats are "PEM", "DER" and "ENG". "
+    #
+    def ssl_key_type=(key_type)
+      raise "Invalid ssl key type : '#{key_type}'..." if key_type and !%w(PEM DER ENG).include?(key_type)
+      set_option(OPTION_VALUES[:CURLOPT_SSLKEYTYPE], key_type)
+    end
+
+    def ssl_key_password=(key_password)
+      set_option(OPTION_VALUES[:CURLOPT_KEYPASSWD], key_password)
+    end
+
+    # Set SSL CACERT
+    # " File holding one or more certificates to verify the peer with. "
+    #
+    def ssl_cacert=(cacert)
+      set_option(OPTION_VALUES[:CURLOPT_CAINFO], cacert)
+    end
+
+    # Set CAPATH
+    # " directory holding multiple CA certificates to verify the peer with. The certificate directory must be prepared using the openssl c_rehash utility. "
+    #
+    def ssl_capath=(capath)
+      set_option(OPTION_VALUES[:CURLOPT_CAPATH], capath)
+    end
+
     def set_option(option, value)
       if value.class == String
         easy_setopt_string(option, value)
-      else
+      elsif value
         easy_setopt_long(option, value)
       end
     end
@@ -186,7 +242,13 @@ module Typhoeus
     def perform
       set_headers()
       easy_perform()
-      response_code()
+      resp_code = response_code() 
+      if resp_code >= 200 && resp_code <= 299
+        success
+      else
+        failure
+      end
+      resp_code
     end
 
     def set_headers
@@ -262,5 +324,6 @@ module Typhoeus
     def curl_version
       version
     end
+
   end
 end

data/lib/typhoeus/hydra.rb

@@ -142,6 +142,13 @@ module Typhoeus
       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.on_success do |easy|
         queue_next

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()
       @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,8 +1,34 @@
 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, :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
+
+
     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)
+    # ** +: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
+    #
     def initialize(url, options = {})
       @method           = options[:method] || :get
       @params           = options[:params]
@@ -15,6 +41,13 @@ 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]
 
       if @method == :post
         @url = url

data/spec/typhoeus/easy_spec.rb

@@ -7,12 +7,12 @@ describe Typhoeus::Easy do
     end
 
     it "should return true if the version string has zlib" do
-      @easy.stub!(:version).and_return("libcurl/7.20.0 OpenSSL/0.9.8l zlib/1.2.3 libidn/1.16")
+      @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!(:version).and_return("libcurl/7.20.0 OpenSSL/0.9.8l libidn/1.16")
+      @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
@@ -117,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

data/spec/typhoeus/remote_spec.rb

@@ -4,7 +4,7 @@ describe Typhoeus do
   it "should be deprecated" do
     fail "This entire interface is deprecated!"
   end
-  
+
   # before(:each) do
   #   @klass = Class.new do
   #     include Typhoeus

data/typhoeus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{typhoeus}
-  s.version = "0.1.27"
+  s.version = "0.1.28"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Dix"]
-  s.date = %q{2010-05-17}
+  s.date = %q{2010-06-29}
   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"]
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
+     "CHANGELOG.markdown",
      "README.textile",
      "Rakefile",
      "VERSION",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 27
-  version: 0.1.27
+  - 28
+  version: 0.1.28
 platform: ruby
 authors: 
 - Paul Dix
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-17 00:00:00 -07:00
+date: 2010-06-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,6 +99,7 @@ extra_rdoc_files:
 - README.textile
 files: 
 - .gitignore
+- CHANGELOG.markdown
 - README.textile
 - Rakefile
 - VERSION