typhoeus 0.3.3 → 0.4.0

data/lib/typhoeus/easy.rb

@@ -1,264 +1,61 @@
+require 'typhoeus/easy/ffi_helper'
+require 'typhoeus/easy/options'
+require 'typhoeus/easy/ssl'
+require 'typhoeus/easy/auth'
+require 'typhoeus/easy/proxy'
+require 'typhoeus/easy/callbacks'
+require 'typhoeus/easy/infos'
+
 module Typhoeus
   class Easy
-    attr_reader :response_body, :response_header, :method, :headers, :url, :params, :curl_return_code, :ssl_version
+    include Typhoeus::EasyFu::FFIHelper
+    include Typhoeus::EasyFu::Options
+    include Typhoeus::EasyFu::SSL
+    include Typhoeus::EasyFu::Auth
+    include Typhoeus::EasyFu::Proxy
+    include Typhoeus::EasyFu::Callbacks
+    include Typhoeus::EasyFu::Infos
+
+    OPTION_VALUES = Curl::Option.to_hash.dup
+    Curl::Option.to_hash.each {|key, value| OPTION_VALUES["CURLOPT_#{key.to_s.upcase}".to_sym] = value }
+    INFO_VALUES = Curl::Info.to_hash.dup
+    Curl::Info.to_hash.each {|key, value| INFO_VALUES["CURLINFO_#{key.to_s.upcase}".to_sym] = value }
+    AUTH_TYPES = Curl::Auth.to_hash.dup
+    Curl::Auth.to_hash.each {|key, value| AUTH_TYPES["CURLAUTH_#{key.to_s.upcase}".to_sym] = value }
+    PROXY_TYPES = Curl::Proxy.to_hash.dup
+    Curl::Proxy.to_hash.each {|key, value| PROXY_TYPES["CURLPROXY_#{key.to_s.upcase}".to_sym] = value }
+    SSL_VERSIONS = Curl::SSLVersion.to_hash.dup
+    Curl::SSLVersion.to_hash.each {|key, value| SSL_VERSIONS["CURL_SSLVERSION_#{key.to_s.upcase}".to_sym] = value }
+
+    attr_reader :url, :header_list
     attr_accessor :start_time
 
-    # These integer codes are available in curl/curl.h
-    CURLINFO_STRING = 1048576
-    OPTION_VALUES = {
-      :CURLOPT_URL            => 10002,
-      :CURLOPT_HTTPGET        => 80,
-      :CURLOPT_HTTPPOST       => 10024,
-      :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_INTERFACE      => 10000 + 62,
-      :CURLOPT_NOSIGNAL       => 99,
-      :CURLOPT_HTTPHEADER     => 10023,
-      :CURLOPT_FOLLOWLOCATION => 52,
-      :CURLOPT_MAXREDIRS      => 68,
-      :CURLOPT_HTTPAUTH       => 107,
-      :CURLOPT_USERPWD        => 10000 + 5,
-      :CURLOPT_VERBOSE        => 41,
-      :CURLOPT_PROXY          => 10004,
-      :CURLOPT_PROXYUSERPWD   => 10000 + 6,
-      :CURLOPT_PROXYTYPE      => 101,
-      :CURLOPT_PROXYAUTH      => 111,
-      :CURLOPT_VERIFYPEER     => 64,
-      :CURLOPT_VERIFYHOST    => 81,
-      :CURLOPT_NOBODY         => 44,
-      :CURLOPT_ENCODING       => 10000 + 102,
-      :CURLOPT_SSLCERT        => 10025,
-      :CURLOPT_SSLCERTTYPE    => 10086,
-      :CURLOPT_SSLKEY         => 10087,
-      :CURLOPT_SSLKEYTYPE     => 10088,
-      :CURLOPT_SSLVERSION     => 32,
-      :CURLOPT_KEYPASSWD      => 10026,
-      :CURLOPT_CAINFO         => 10065,
-      :CURLOPT_CAPATH         => 10097,
-    }
-    INFO_VALUES = {
-      :CURLINFO_RESPONSE_CODE      => 2097154,
-      :CURLINFO_TOTAL_TIME         => 3145731,
-      :CURLINFO_HTTPAUTH_AVAIL     => 0x200000 + 23,
-      :CURLINFO_EFFECTIVE_URL      => 0x100000 + 1,
-      :CURLINFO_PRIMARY_IP         => 0x100000 + 32,
-      :CURLINFO_NAMELOOKUP_TIME    => 0x300000 + 4,
-      :CURLINFO_CONNECT_TIME       => 0x300000 + 5,
-      :CURLINFO_PRETRANSFER_TIME   => 0x300000 + 6,
-      :CURLINFO_STARTTRANSFER_TIME => 0x300000 + 17,
-      :CURLINFO_APPCONNECT_TIME    => 0x300000 + 33,
-
-    }
-    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
-    }
-    PROXY_TYPES = {
-      :CURLPROXY_HTTP         => 0,
-      :CURLPROXY_HTTP_1_0     => 1,
-      :CURLPROXY_SOCKS4       => 4,
-      :CURLPROXY_SOCKS5       => 5,
-      :CURLPROXY_SOCKS4A      => 6,
-    }
-
-    SSL_VERSIONS = {
-      :CURL_SSLVERSION_DEFAULT => 0,
-      :CURL_SSLVERSION_TLSv1   => 1,
-      :CURL_SSLVERSION_SSLv2   => 2,
-      :CURL_SSLVERSION_SSLv3   => 3,
-      :default                 => 0,
-      :tlsv1                   => 1,
-      :sslv2                   => 2,
-      :sslv3                   => 3
-    }
-
     def initialize
-      @method = :get
-      @headers = {}
-
-      set_defaults
+      Curl.init
+      reset(true)
+      ObjectSpace.define_finalizer(self, self.class.finalizer(self))
     end
 
-    def set_defaults
-      # Enable encoding/compression support
-      self.encoding = ''
-      self.ssl_version = :default
+    def method
+      @method ||= :get
     end
 
-    def encoding=(encoding)
-      # Enable encoding/compression support
-      set_option(OPTION_VALUES[:CURLOPT_ENCODING], encoding)
+    def headers
+      @header ||= {}
     end
 
-    def ssl_version=(version)
-      raise "Invalid SSL version: '#{version}' supplied! Please supply one as listed in Typhoeus::Easy::SSL_VERSIONS" unless SSL_VERSIONS.has_key?(version)
-      @ssl_version = version
+    def response_body
+      @response_body ||= ""
+    end
 
-      set_option(OPTION_VALUES[:CURLOPT_SSLVERSION], SSL_VERSIONS[version])
+    def response_header
+      @response_header ||= ""
     end
 
     def headers=(hash)
       @headers = hash
     end
 
-    def interface=(interface)
-      @interface = interface
-      set_option(OPTION_VALUES[:CURLOPT_INTERFACE], interface)
-    end
-
-    def proxy=(proxy)
-      set_option(OPTION_VALUES[:CURLOPT_PROXY], proxy[:server])
-      set_option(OPTION_VALUES[:CURLOPT_PROXYTYPE], proxy[:type]) if proxy[:type]
-    end
-
-    def proxy_auth=(authinfo)
-      set_option(OPTION_VALUES[:CURLOPT_PROXYUSERPWD], "#{authinfo[:username]}:#{authinfo[:password]}")
-      set_option(OPTION_VALUES[:CURLOPT_PROXYAUTH], authinfo[:method]) if authinfo[:method]
-    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 start_transfer_time
-      get_info_double(INFO_VALUES[:CURLINFO_STARTTRANSFER_TIME])
-    end
-
-    def app_connect_time
-      get_info_double(INFO_VALUES[:CURLINFO_APPCONNECT_TIME])
-    end
-
-    def pretransfer_time
-      get_info_double(INFO_VALUES[:CURLINFO_PRETRANSFER_TIME])
-    end
-
-    def connect_time
-      get_info_double(INFO_VALUES[:CURLINFO_CONNECT_TIME])
-    end
-
-    def name_lookup_time
-      get_info_double(INFO_VALUES[:CURLINFO_NAMELOOKUP_TIME])
-    end
-
-    def effective_url
-      get_info_string(INFO_VALUES[:CURLINFO_EFFECTIVE_URL])
-    end
-
-    def primary_ip
-      get_info_string(INFO_VALUES[:CURLINFO_PRIMARY_IP])
-    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)
-      else
-        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?
-      curl_return_code == 28
-    end
-
-    def supports_zlib?
-      !!(curl_version.match(/zlib/))
-    end
-
-    def request_body=(request_body)
-      @request_body = request_body
-      if @method == :put
-        easy_set_request_body(@request_body.to_s)
-      else
-        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 disable_ssl_host_verification
-      set_option(OPTION_VALUES[:CURLOPT_VERIFYHOST], 0)
-    end
-
-    def method=(method)
-      @method = method
-      if method == :get
-        set_option(OPTION_VALUES[:CURLOPT_HTTPGET], 1)
-      elsif method == :post
-        set_option(OPTION_VALUES[:CURLOPT_HTTPPOST], 1)
-        self.post_data = ""
-      elsif method == :put
-        set_option(OPTION_VALUES[:CURLOPT_UPLOAD], 1)
-        self.request_body = @request_body.to_s
-      elsif method == :head
-        set_option(OPTION_VALUES[:CURLOPT_NOBODY], 1)
-      else
-        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_POSTFIELDSIZE], data.bytesize)
-      set_option(OPTION_VALUES[:CURLOPT_COPYPOSTFIELDS], data)
-    end
-
     def params
       @form.nil? ? {} : @form.params
     end
@@ -269,7 +66,7 @@ module Typhoeus
       if method == :post
         @form.process!
         if @form.multipart?
-          set_option(OPTION_VALUES[:CURLOPT_HTTPPOST], @form)
+          set_option(:httppost, @form)
         else
           self.post_data = @form.to_s
         end
@@ -278,68 +75,9 @@ 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 p12).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)
-      case value
-        when String
-          easy_setopt_string(option, value)
-        when Typhoeus::Form
-          easy_setopt_form(option, value)
-        else
-          easy_setopt_long(option, value) if value
-      end
-    end
-
     def perform
       set_headers()
-      easy_perform()
+      @curl_return_code = Curl.easy_perform(handle)
       resp_code = response_code()
       if resp_code >= 200 && resp_code <= 299
         success
@@ -349,65 +87,29 @@ module Typhoeus
       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 not 2xx,
-    # or curl returns an error code.
-    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
-    # or curl returns an error code
-    def failure
-      @failure.call(self) if @failure
-    end
+    def reset(fresh = nil)
+      unless fresh
+        @response_code = 0
+        @response_header = ""
+        @response_body = ""
+        @request_body = ""
 
-    def on_failure(&block)
-      @failure = block
-    end
-
-    def on_failure=(block)
-      @failure = block
-    end
-
-    def reset
-      @response_code = 0
-      @response_header = ""
-      @response_body = ""
-      @request_body = ""
-      easy_reset()
-      set_defaults
-    end
-
-    def get_info_string(option)
-      easy_getinfo_string(option)
-    end
+        if @header_list
+          Curl.slist_free_all(@header_list)
+          @header_list = nil
+        end
 
-    def get_info_long(option)
-      easy_getinfo_long(option)
-    end
+        Curl.easy_reset(handle)
+      end
 
-    def get_info_double(option)
-      easy_getinfo_double(option)
+      self.write_function = body_write_callback
+      self.header_function = header_write_callback
+      self.encoding = ''
+      self.ssl_version = :default
     end
 
-    def curl_version
-      version
+    def curl_return_code=(code)
+      @curl_return_code = (code.class == Symbol ? code : Curl::EasyCode[code])
     end
-
   end
 end