typhoeus 0.1.6 → 0.2.0

data/lib/typhoeus/easy.rb

@@ -1,8 +1,9 @@
 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
     CURLINFO_STRING = 1048576
     OPTION_VALUES = {
       :CURLOPT_URL            => 10002,
@@ -11,36 +12,89 @@ module Typhoeus
       :CURLOPT_UPLOAD         => 46,
       :CURLOPT_CUSTOMREQUEST  => 10036,
       :CURLOPT_POSTFIELDS     => 10015,
+      :CURLOPT_COPYPOSTFIELDS     => 10165,
       :CURLOPT_POSTFIELDSIZE  => 60,
       :CURLOPT_USERAGENT      => 10018,
       :CURLOPT_TIMEOUT_MS     => 155,
+      # Time-out connect operations after this amount of milliseconds.
+      # [Only works on unix-style/SIGALRM operating systems. IOW, does
+      # not work on Windows.
+      :CURLOPT_CONNECTTIMEOUT_MS  => 156,
       :CURLOPT_NOSIGNAL       => 99,
       :CURLOPT_HTTPHEADER     => 10023,
-      :CURLOPT_FOLLOWLOCATION => 52
+      :CURLOPT_FOLLOWLOCATION => 52,
+      :CURLOPT_MAXREDIRS      => 68,
+      :CURLOPT_HTTPAUTH       => 107,
+      :CURLOPT_USERPWD        => 10000 + 5,
+      :CURLOPT_VERBOSE        => 41,
+      :CURLOPT_PROXY          => 10004,
+      :CURLOPT_VERIFYPEER     => 64,
+      :CURLOPT_NOBODY         => 44,
+      :CURLOPT_ENCODING       => 10000 + 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,
-      :CURLINFO_TOTAL_TIME    => 3145731
+      :CURLINFO_TOTAL_TIME    => 3145731,
+      :CURLINFO_HTTPAUTH_AVAIL => 0x200000 + 23,
+      :CURLINFO_EFFECTIVE_URL => 0x100000 + 1
     }
-    
+    AUTH_TYPES = {
+      :CURLAUTH_BASIC         => 1,
+      :CURLAUTH_DIGEST        => 2,
+      :CURLAUTH_GSSNEGOTIATE  => 4,
+      :CURLAUTH_NTLM          => 8,
+      :CURLAUTH_DIGEST_IE     => 16,
+      :CURLAUTH_AUTO          => 16 | 8 | 4 | 2 | 1
+    }
+
     def initialize
       @method = :get
-      @post_dat_set = nil
       @headers = {}
+
+      # Enable encoding/compression support
+      set_option(OPTION_VALUES[:CURLOPT_ENCODING], '')
     end
-    
+
     def headers=(hash)
       @headers = hash
     end
-    
+
+    def proxy=(proxy)
+      set_option(OPTION_VALUES[:CURLOPT_PROXY], proxy)
+    end
+
+    def auth=(authinfo)
+      set_option(OPTION_VALUES[:CURLOPT_USERPWD], "#{authinfo[:username]}:#{authinfo[:password]}")
+      set_option(OPTION_VALUES[:CURLOPT_HTTPAUTH], authinfo[:method]) if authinfo[:method]
+    end
+
+    def auth_methods
+      get_info_long(INFO_VALUES[:CURLINFO_HTTPAUTH_AVAIL])
+    end
+
+    def verbose=(boolean)
+      set_option(OPTION_VALUES[:CURLOPT_VERBOSE], !!boolean ? 1 : 0)
+    end
+
     def total_time_taken
       get_info_double(INFO_VALUES[:CURLINFO_TOTAL_TIME])
     end
-    
+
+    def effective_url
+      get_info_string(INFO_VALUES[:CURLINFO_EFFECTIVE_URL])
+    end
+
     def response_code
       get_info_long(INFO_VALUES[:CURLINFO_RESPONSE_CODE])
     end
-    
+
     def follow_location=(boolean)
       if boolean
         set_option(OPTION_VALUES[:CURLOPT_FOLLOWLOCATION], 1)
@@ -48,17 +102,31 @@ module Typhoeus
         set_option(OPTION_VALUES[:CURLOPT_FOLLOWLOCATION], 0)
       end
     end
+
+    def max_redirects=(redirects)
+      set_option(OPTION_VALUES[:CURLOPT_MAXREDIRS], redirects)
+    end
     
+    def connect_timeout=(milliseconds)
+      @connect_timeout = milliseconds
+      set_option(OPTION_VALUES[:CURLOPT_NOSIGNAL], 1)
+      set_option(OPTION_VALUES[:CURLOPT_CONNECTTIMEOUT_MS], milliseconds)
+    end
+
     def timeout=(milliseconds)
       @timeout = milliseconds
       set_option(OPTION_VALUES[:CURLOPT_NOSIGNAL], 1)
       set_option(OPTION_VALUES[:CURLOPT_TIMEOUT_MS], milliseconds)
     end
-    
+
     def timed_out?
       @timeout && total_time_taken > @timeout && response_code == 0
     end
-    
+
+    def supports_zlib?
+      !!(curl_version.match(/zlib/))
+    end
+
     def request_body=(request_body)
       @request_body = request_body
       if @method == :put
@@ -69,16 +137,20 @@ module Typhoeus
         self.post_data = request_body
       end
     end
-    
+
     def user_agent=(user_agent)
       set_option(OPTION_VALUES[:CURLOPT_USERAGENT], user_agent)
     end
-          
+
     def url=(url)
       @url = url
       set_option(OPTION_VALUES[:CURLOPT_URL], url)
     end
-    
+
+    def disable_ssl_peer_verification
+      set_option(OPTION_VALUES[:CURLOPT_VERIFYPEER], 0)
+    end
+
     def method=(method)
       @method = method
       if method == :get
@@ -89,80 +161,137 @@ module Typhoeus
       elsif method == :put
         set_option(OPTION_VALUES[:CURLOPT_UPLOAD], 1)
         self.request_body = "" unless @request_body
+      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
-    
+
     def post_data=(data)
       @post_data_set = true
-      set_option(OPTION_VALUES[:CURLOPT_POSTFIELDS], data)
       set_option(OPTION_VALUES[:CURLOPT_POSTFIELDSIZE], data.length)
+      set_option(OPTION_VALUES[:CURLOPT_COPYPOSTFIELDS], data)
     end
-    
+
     def params=(params)
+      @params = params
       params_string = params.keys.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)}
+          value.keys.collect {|sk| Typhoeus::Utils.escape("#{k}[#{sk}]") + "=" + Typhoeus::Utils.escape(value[sk].to_s)}
         elsif value.is_a? Array
-          key = Rack::Utils.escape(k.to_s)
-          value.collect { |v| "#{key}=#{Rack::Utils.escape(v.to_s)}" }.join('&')
+          key = Typhoeus::Utils.escape(k.to_s)
+          value.collect { |v| "#{key}=#{Typhoeus::Utils.escape(v.to_s)}" }.join('&')
         else
-          "#{Rack::Utils.escape(k.to_s)}=#{Rack::Utils.escape(params[k].to_s)}"
+          "#{Typhoeus::Utils.escape(k.to_s)}=#{Typhoeus::Utils.escape(params[k].to_s)}"
         end
       end.flatten.join("&")
-      
+
       if method == :post
         self.post_data = params_string
       else
         self.url = "#{url}?#{params_string}"
       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
-    
+
     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
       headers.each_pair do |key, value|
         easy_add_header("#{key}: #{value}")
       end
       easy_set_headers() unless headers.empty?
     end
-    
+
     # gets called when finished and response code is 200-299
     def success
       @success.call(self) if @success
     end
-    
+
     def on_success(&block)
       @success = block
     end
-    
+
     def on_success=(block)
       @success = block
     end
-    
+
     # gets called when finished and response code is 300-599
     def failure
       @failure.call(self) if @failure
     end
-    
+
     def on_failure(&block)
       @failure = block
     end
-    
+
     def on_failure=(block)
       @failure = block
     end
@@ -170,20 +299,20 @@ module Typhoeus
     def retries
       @retries ||= 0
     end
-    
+
     def increment_retries
       @retries ||= 0
       @retries += 1
     end
-    
+
     def max_retries
       @max_retries ||= 40
     end
-    
+
     def max_retries?
       retries >= max_retries
     end
-    
+
     def reset
       @retries = 0
       @response_code = 0
@@ -191,21 +320,22 @@ module Typhoeus
       @response_body = ""
       easy_reset()
     end
-    
+
     def get_info_string(option)
       easy_getinfo_string(option)
     end
-    
+
     def get_info_long(option)
       easy_getinfo_long(option)
     end
-    
+
     def get_info_double(option)
       easy_getinfo_double(option)
     end
-    
+
     def curl_version
       version
     end
+
   end
 end

data/lib/typhoeus/hydra/callbacks.rb

@@ -0,0 +1,24 @@
+module Typhoeus
+  class Hydra
+    module Callbacks
+      def self.extended(base)
+        class << base
+          attr_accessor :global_hooks
+        end
+        base.global_hooks = Hash.new { |h, k| h[k] = [] }
+      end
+
+      def after_request_before_on_complete(&block)
+        global_hooks[:after_request_before_on_complete] << block
+      end
+
+      def run_global_hooks_for(name, request)
+        global_hooks[name].each { |hook| hook.call(request) }
+      end
+
+      def clear_global_hooks
+        global_hooks.clear
+      end
+    end
+  end
+end

data/lib/typhoeus/hydra/connect_options.rb

@@ -0,0 +1,45 @@
+module Typhoeus
+  class Hydra
+    class NetConnectNotAllowedError < StandardError; end
+
+    module ConnectOptions
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # This method checks to see if we should raise an error on
+      # a request.
+      #
+      # @raises NetConnectNotAllowedError
+      def check_allow_net_connect!(request)
+        if !Typhoeus::Hydra.allow_net_connect? and (!Typhoeus::Hydra.ignore_localhost? or !request.localhost?)
+          raise NetConnectNotAllowedError, "Real HTTP requests are not allowed. Unregistered request: #{request.inspect}"
+        end
+      end
+      private :check_allow_net_connect!
+
+      module ClassMethods
+        def self.extended(base)
+          class << base
+            attr_accessor :allow_net_connect
+            attr_accessor :ignore_localhost
+          end
+          base.allow_net_connect = true
+          base.ignore_localhost = false
+        end
+
+        # Returns whether we allow external HTTP connections.
+        # Useful for mocking/tests.
+        #
+        # @return [boolean] true/false
+        def allow_net_connect?
+          allow_net_connect
+        end
+
+        def ignore_localhost?
+          ignore_localhost
+        end
+      end
+    end
+  end
+end

data/lib/typhoeus/hydra/stubbing.rb

@@ -0,0 +1,52 @@
+module Typhoeus
+  class Hydra
+    module Stubbing
+      module SharedMethods
+        def stub(method, url, options = {})
+          stubs << HydraMock.new(url, method, options)
+          stubs.last
+        end
+
+        def clear_stubs
+          self.stubs = []
+        end
+
+        def find_stub_from_request(request)
+          stubs.detect { |stub| stub.matches?(request) }
+        end
+
+        def self.extended(base)
+          class << base
+            attr_accessor :stubs
+          end
+          base.stubs = []
+        end
+      end
+
+      def self.included(base)
+        base.extend(SharedMethods)
+        base.class_eval do
+          attr_accessor :stubs
+        end
+      end
+
+      def assign_to_stub(request)
+        m = find_stub_from_request(request)
+
+        # Fallback to global stubs.
+        m ||= self.class.find_stub_from_request(request)
+
+        if m
+          m.add_request(request)
+          @active_stubs << m
+          m
+        else
+          nil
+        end
+      end
+      private :assign_to_stub
+
+      include SharedMethods
+    end
+  end
+end