curb 0.8.5 → 0.9.11

data/ext/extconf.rb

@@ -59,6 +59,9 @@ def have_constant(name)
   end
 end
 
+have_constant "curlopt_tcp_keepalive"
+have_constant "curlopt_tcp_keepidle"
+have_constant "curlopt_tcp_keepintvl"
 have_constant "curlinfo_appconnect_time"
 have_constant "curlinfo_redirect_time"
 have_constant "curlinfo_response_code"
@@ -66,6 +69,7 @@ have_constant "curlinfo_filetime"
 have_constant "curlinfo_redirect_count"
 have_constant "curlinfo_os_errno"
 have_constant "curlinfo_num_connects"
+have_constant "curlinfo_cookielist"
 have_constant "curlinfo_ftp_entry_path"
 have_constant "curl_version_ssl"
 have_constant "curl_version_libz"
@@ -78,9 +82,12 @@ have_constant "curl_version_largefile"
 have_constant "curl_version_idn"
 have_constant "curl_version_sspi"
 have_constant "curl_version_conv"
+have_constant "curl_version_http2"
 have_constant "curlproxy_http"
 have_constant "curlproxy_socks4"
+have_constant "curlproxy_socks4a"
 have_constant "curlproxy_socks5"
+have_constant "curlproxy_socks5_hostname"
 have_constant "curlauth_basic"
 have_constant "curlauth_digest"
 have_constant "curlauth_gssnegotiate"
@@ -99,6 +106,12 @@ have_constant "curle_send_fail_rewind"
 have_constant "curle_ssl_engine_initfailed"
 have_constant "curle_login_denied"
 
+# older than 7.10.0
+have_constant "curlopt_nosignal"
+
+# older than 7.16.0
+have_constant "curlmopt_pipelining"
+
 # older than 7.16.3
 have_constant "curlmopt_maxconnects"
 
@@ -143,6 +156,8 @@ have_func("curl_multi_timeout")
 have_func("curl_multi_fdset")
 have_func("curl_multi_perform")
 
+have_constant "curlopt_haproxyprotocol"
+
 # constants
 have_constant "curlopt_interleavefunction"
 have_constant "curlopt_interleavedata"
@@ -207,6 +222,7 @@ have_constant "curlopt_httppost"
 have_constant "curlopt_referer"
 have_constant "curlopt_useragent"
 have_constant "curlopt_httpheader"
+have_constant "curlopt_proxyheader"
 have_constant "curlopt_http200aliases"
 have_constant "curlopt_cookie"
 have_constant "curlopt_cookiefile"
@@ -319,6 +335,12 @@ have_constant "curl_sslversion_default"
 have_constant :CURL_SSLVERSION_TLSv1
 have_constant :CURL_SSLVERSION_SSLv2
 have_constant :CURL_SSLVERSION_SSLv3
+
+# Added in 7.34.0
+have_constant :CURL_SSLVERSION_TLSv1_0
+have_constant :CURL_SSLVERSION_TLSv1_1
+have_constant :CURL_SSLVERSION_TLSv1_2
+
 have_constant "curlopt_ssl_verifypeer"
 have_constant "curlopt_cainfo"
 have_constant "curlopt_issuercert"
@@ -352,11 +374,32 @@ have_constant "curle_not_built_in"
 
 have_constant "curle_obsolete" # removed in 7.24 ?
 
+have_constant "curle_ftp_pret_failed"
+have_constant "curle_rtsp_cseq_error"
+have_constant "curle_rtsp_session_error"
+have_constant "curle_ftp_bad_file_list"
+have_constant "curle_chunk_failed"
+have_constant "curle_no_connection_available"
+have_constant "curle_ssl_pinnedpubkeynotmatch"
+have_constant "curle_ssl_invalidcertstatus"
+have_constant "curle_http2_stream"
+
 # gssapi/spnego delegation related constants
 have_constant "curlopt_gssapi_delegation"
 have_constant "curlgssapi_delegation_policy_flag"
 have_constant "curlgssapi_delegation_flag"
 
+have_constant "CURLM_ADDED_ALREADY"
+
+# added in 7.40.0
+have_constant "curlopt_unix_socket_path"
+
+# added in 7.42.0
+have_constant "curlopt_path_as_is"
+
+# added in 7.43.0
+have_constant "curlopt_pipewait"
+
 if try_compile('int main() { return 0; }','-Wall')
   $CFLAGS << ' -Wall'
 end
@@ -372,23 +415,6 @@ def test_for(name, const, src)
     end
   end
 end
-test_for("Ruby 1.9 Hash", "RUBY19_HASH", %{
-  #include <ruby.h>
-  int main() {
-    VALUE hash = rb_hash_new();
-    if( RHASH(hash)->ntbl->num_entries ) {
-      return 0;
-    }
-    return 1;
-  }
-})
-test_for("Ruby 1.9 st.h", "RUBY19_ST_H", %{
-  #include <ruby.h>
-  #include <ruby/st.h>
-  int main() {
-    return 0;
-  }
-})
 
 test_for("curl_easy_escape", "CURL_EASY_ESCAPE", %{
   #include <curl/curl.h>
@@ -400,6 +426,9 @@ test_for("curl_easy_escape", "CURL_EASY_ESCAPE", %{
 })
 
 have_func('rb_thread_blocking_region')
+have_header('ruby/thread.h') && have_func('rb_thread_call_without_gvl', 'ruby/thread.h')
+have_header('ruby/io.h')
+have_func('rb_io_stdio_file')
 
 create_header('curb_config.h')
 create_makefile('curb_core')

data/lib/curb.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'curl'

data/lib/curl/easy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Curl
   class Easy
 
@@ -6,31 +7,41 @@ module Curl
     alias body body_str
     alias head header_str
 
+    class Error < StandardError
+      attr_accessor :message, :code
+      def initialize(code, msg)
+        self.message = msg
+        self.code = code
+      end
+    end
+
     #
     # call-seq:
     #   easy.status  => String
     #
     def status
-      parts = self.header_str.split(/\s/)
-      status = []
-      parts.shift
-      while parts.size > 0 && parts.first != ''
-        status << parts.shift
-      end
-      status.join(' ')
+      # Matches the last HTTP Status - following the HTTP protocol specification 'Status-Line = HTTP-Version SP Status-Code SP (Opt:)Reason-Phrase CRLF'
+      statuses = self.header_str.scan(/HTTP\/\d(\.\d)?\s(\d+\s.*)\r\n/).map{ |match| match[1] }
+      statuses.last.strip if statuses.length > 0
     end
 
     #
     # call-seq:
     #   easy.set :sym|Fixnum, value
-    # 
+    #
     # set options on the curl easy handle see http://curl.haxx.se/libcurl/c/curl_easy_setopt.html
     #
     def set(opt,val)
       if opt.is_a?(Symbol)
-        setopt(sym2curl(opt), val)
+        option = sym2curl(opt)
       else
-        setopt(opt.to_i, val)
+        option = opt.to_i
+      end
+
+      begin
+        setopt(option, val)
+      rescue TypeError
+        raise TypeError, "Curb doesn't support setting #{opt} [##{option}] option"
       end
     end
 
@@ -56,10 +67,16 @@ module Curl
       self.multi = Curl::Multi.new if self.multi.nil?
       self.multi.add self
       ret = self.multi.perform
+      self.multi.remove self
+
+      if Curl::Multi.autoclose
+        self.multi.close
+        self.multi = nil
+      end
 
       if self.last_result != 0 && self.on_failure.nil?
-        error = Curl::Easy.error(self.last_result) 
-        raise error.first
+        error = Curl::Easy.error(self.last_result)
+        raise error.first.new(self.head)
       end
 
       ret
@@ -83,54 +100,55 @@ module Curl
     #   easy.perform
     #
     def delete=(onoff)
-      set :customrequest, onoff ? 'delete' : nil
+      set :customrequest, onoff ? 'DELETE' : nil
       onoff
     end
-    # 
+    #
     # call-seq:
-    # 
+    #
     #  easy = Curl::Easy.new("url")
+    #  easy.version = Curl::HTTP_2_0
     #  easy.version = Curl::HTTP_1_1
     #  easy.version = Curl::HTTP_1_0
     #  easy.version = Curl::HTTP_NONE
-    # 
+    #
     def version=(http_version)
       set :http_version, http_version
     end
 
-    # 
+    #
     # call-seq:
     #   easy.url = "http://some.url/"                    => "http://some.url/"
-    # 
+    #
     # Set the URL for subsequent calls to +perform+. It is acceptable
     # (and even recommended) to reuse Curl::Easy instances by reassigning
     # the URL between calls to +perform+.
-    # 
+    #
     def url=(u)
       set :url, u
     end
 
-    # 
+    #
     # call-seq:
     #   easy.proxy_url = string                          => string
-    # 
+    #
     # Set the URL of the HTTP proxy to use for subsequent calls to +perform+.
     # The URL should specify the the host name or dotted IP address. To specify
     # port number in this string, append :[port] to the end of the host name.
     # The proxy string may be prefixed with [protocol]:// since any such prefix
     # will be ignored. The proxy's port number may optionally be specified with
     # the separate option proxy_port .
-    # 
+    #
     # When you tell the library to use an HTTP proxy, libcurl will transparently
     # convert operations to HTTP even if you specify an FTP URL etc. This may have
     # an impact on what other features of the library you can use, such as
     # FTP specifics that don't work unless you tunnel through the HTTP proxy. Such
     # tunneling is activated with proxy_tunnel = true.
-    # 
+    #
     # libcurl respects the environment variables *http_proxy*, *ftp_proxy*,
     # *all_proxy* etc, if any of those is set. The proxy_url option does however
     # override any possibly set environment variables.
-    # 
+    #
     # Starting with libcurl 7.14.1, the proxy host string given in environment
     # variables can be specified the exact same way as the proxy can be set with
     # proxy_url, including protocol prefix (http://) and embedded user + password.
@@ -145,89 +163,89 @@ module Curl
       self.ssl_verify_host_integer=value
     end
 
-    # 
+    #
     # call-seq:
     #   easy.ssl_verify_host?                            => boolean
-    # 
+    #
     # Deprecated: call easy.ssl_verify_host instead
     # can be one of [0,1,2]
-    # 
+    #
     # Determine whether this Curl instance will verify that the server cert
     # is for the server it is known as.
-    # 
+    #
     def ssl_verify_host?
       ssl_verify_host.nil? ? false : (ssl_verify_host > 0)
     end
 
-    # 
+    #
     # call-seq:
     #   easy.interface = string                          => string
-    # 
+    #
     # Set the interface name to use as the outgoing network interface.
     # The name can be an interface name, an IP address or a host name.
-    # 
+    #
     def interface=(value)
       set :interface, value
     end
 
-    # 
+    #
     # call-seq:
     #   easy.userpwd = string                            => string
-    # 
+    #
     # Set the username/password string to use for subsequent calls to +perform+.
     # The supplied string should have the form "username:password"
-    # 
+    #
     def userpwd=(value)
       set :userpwd, value
     end
 
-    # 
+    #
     # call-seq:
     #   easy.proxypwd = string                           => string
-    # 
+    #
     # Set the username/password string to use for proxy connection during
     # subsequent calls to +perform+. The supplied string should have the
     # form "username:password"
-    # 
+    #
     def proxypwd=(value)
       set :proxyuserpwd, value
     end
 
-    # 
+    #
     # call-seq:
     #   easy.cookies = "name1=content1; name2=content2;" => string
-    # 
+    #
     # Set cookies to be sent by this Curl::Easy instance. The format of the string should
     # be NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie should contain.
     # Set multiple cookies in one string like this: "name1=content1; name2=content2;" etc.
-    # 
+    #
     def cookies=(value)
       set :cookie, value
     end
 
-    # 
+    #
     # call-seq:
     #   easy.cookiefile = string                         => string
-    # 
+    #
     # Set a file that contains cookies to be sent in subsequent requests by this Curl::Easy instance.
-    # 
+    #
     # *Note* that you must set enable_cookies true to enable the cookie
     # engine, or this option will be ignored.
-    # 
+    #
     def cookiefile=(value)
       set :cookiefile, value
     end
 
-    # 
+    #
     # call-seq:
     #   easy.cookiejar = string                          => string
-    # 
+    #
     # Set a cookiejar file to use for this Curl::Easy instance.
     # Cookies from the response will be written into this file.
-    # 
+    #
     # *Note* that you must set enable_cookies true to enable the cookie
     # engine, or this option will be ignored.
-    # 
+    #
     def cookiejar=(value)
       set :cookiejar, value
     end
@@ -405,35 +423,35 @@ module Curl
         c.http_delete
         c
       end
-    
+
       # call-seq:
       #   Curl::Easy.download(url, filename = url.split(/\?/).first.split(/\//).last) { |curl| ... }
-      #   
+      #
       # Stream the specified url (via perform) and save the data directly to the
-      # supplied filename (defaults to the last component of the URL path, which will 
+      # supplied filename (defaults to the last component of the URL path, which will
       # usually be the filename most simple urls).
-      # 
+      #
       # If a block is supplied, it will be passed the curl instance prior to the
       # perform call.
-      # 
+      #
       # *Note* that the semantics of the on_body handler are subtly changed when using
-      # download, to account for the automatic routing of data to the specified file: The 
+      # download, to account for the automatic routing of data to the specified file: The
       # data string is passed to the handler *before* it is written
-      # to the file, allowing the handler to perform mutative operations where 
+      # to the file, allowing the handler to perform mutative operations where
       # necessary. As usual, the transfer will be aborted if the on_body handler
-      # returns a size that differs from the data chunk size - in this case, the 
+      # returns a size that differs from the data chunk size - in this case, the
       # offending chunk will *not* be written to the file, the file will be closed,
       # and a Curl::Err::AbortedByCallbackError will be raised.
       def download(url, filename = url.split(/\?/).first.split(/\//).last, &blk)
         curl = Curl::Easy.new(url, &blk)
-        
+
         output = if filename.is_a? IO
           filename.binmode if filename.respond_to?(:binmode)
           filename
         else
           File.open(filename, 'wb')
         end
-        
+
         begin
           old_on_body = curl.on_body do |data|
             result = old_on_body ?  old_on_body.call(data) : data.length
@@ -444,7 +462,7 @@ module Curl
         ensure
           output.close rescue IOError
         end
-        
+
         return curl
       end
     end

data/lib/curl/multi.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
 module Curl
-
   class Multi
     class << self
       # call-seq:
-      #   Curl::Multi.get('url1','url2','url3','url4','url5', :follow_location => true) do|easy|
+      #   Curl::Multi.get(['url1','url2','url3','url4','url5'], :follow_location => true) do|easy|
       #     easy
       #   end
-      # 
+      #
       # Blocking call to fetch multiple url's in parallel.
       def get(urls, easy_options={}, multi_options={}, &blk)
         url_confs = []
@@ -22,13 +22,13 @@ module Curl
       #                     {:url => 'url2', :post_fields => {'field1' => 'value1', 'field2' => 'value2'}},
       #                     {:url => 'url3', :post_fields => {'field1' => 'value1', 'field2' => 'value2'}}],
       #                    { :follow_location => true, :multipart_form_post => true },
-      #                    {:pipeline => true }) do|easy|
+      #                    {:pipeline => Curl::CURLPIPE_HTTP1}) do|easy|
       #     easy_handle_on_request_complete
       #   end
-      # 
+      #
       # Blocking call to POST multiple form's in parallel.
-      # 
-      # urls_with_config: is a hash of url's pointing to the postfields to send 
+      #
+      # urls_with_config: is a hash of url's pointing to the postfields to send
       # easy_options: are a set of common options to set on all easy handles
       # multi_options: options to set on the Curl::Multi handle
       #
@@ -46,13 +46,13 @@ module Curl
       #                    {:url => 'url2', :put_data => IO.read('filepath')},
       #                    {:url => 'url3', :put_data => "maybe another string or socket?"],
       #                    {:follow_location => true},
-      #                    {:pipeline => true }) do|easy|
+      #                    {:pipeline => Curl::CURLPIPE_HTTP1}) do|easy|
       #     easy_handle_on_request_complete
       #   end
-      # 
+      #
       # Blocking call to POST multiple form's in parallel.
-      # 
-      # urls_with_config: is a hash of url's pointing to the postfields to send 
+      #
+      # urls_with_config: is a hash of url's pointing to the postfields to send
       # easy_options: are a set of common options to set on all easy handles
       # multi_options: options to set on the Curl::Multi handle
       #
@@ -74,12 +74,12 @@ module Curl
       #     :follow_location => true, :max_redirects => 3 },
       #   { :url => 'url3', :method => :put, :put_data => File.open('file.txt','rb') },
       #   { :url => 'url4', :method => :head }
-      # ], {:pipeline => true})
+      # ], {:pipeline => Curl::CURLPIPE_HTTP1})
       #
       # Blocking call to issue multiple HTTP requests with varying verb's.
       #
       # urls_with_config: is a hash of url's pointing to the easy handle options as well as the special option :method, that can by one of [:get, :post, :put, :delete, :head], when no verb is provided e.g. :method => nil -> GET is used
-      # multi_options: options for the multi handle 
+      # multi_options: options for the multi handle
       # blk: a callback, that yeilds when a handle is completed
       #
       def http(urls_with_config, multi_options={}, &blk)
@@ -92,7 +92,7 @@ module Curl
 
         # configure the multi handle
         multi_options.each { |k,v| m.send("#{k}=", v) }
-        callbacks = [:on_progress,:on_debug,:on_failure,:on_success,:on_body,:on_header]
+        callbacks = [:on_progress,:on_debug,:on_failure,:on_success,:on_redirect,:on_body,:on_header]
 
         add_free_handle = proc do|conf, easy|
           c       = conf.dup # avoid being destructive to input
@@ -128,23 +128,23 @@ module Curl
 
           # headers is a special key
           headers.each {|k,v| easy.headers[k] = v } if headers
- 
+
           #
           # use the remaining options as specific configuration to the easy handle
           # bad options should raise an undefined method error
           #
           c.each { |k,v| easy.send("#{k}=",v) }
 
-          easy.on_complete {|curl,code|
+          easy.on_complete {|curl|
             free_handles << curl
-            blk.call(curl,code,method) if blk
+            blk.call(curl,curl.response_code,method) if blk
           }
           m.add(easy)
         end
 
         max_connects.times do
           conf = urls_with_config.pop
-          add_free_handle.call conf, nil
+          add_free_handle.call(conf, nil) if conf
           break if urls_with_config.empty?
         end
 
@@ -153,7 +153,7 @@ module Curl
           if urls_with_config.size > 0 && free_handles.size > 0
             easy = free_handles.pop
             conf = urls_with_config.pop
-            add_free_handle.call conf, easy
+            add_free_handle.call(conf, easy) if conf
           end
         end
 
@@ -168,6 +168,7 @@ module Curl
           end
           free_handles = nil
         end
+
       end
 
       # call-seq:
@@ -175,7 +176,7 @@ module Curl
       # Curl::Multi.download(['http://example.com/p/a/t/h/file1.txt','http://example.com/p/a/t/h/file2.txt']){|c|}
       #
       # will create 2 new files file1.txt and file2.txt
-      # 
+      #
       # 2 files will be opened, and remain open until the call completes
       #
       # when using the :post or :put method, urls should be a hash, including the individual post fields per post
@@ -242,7 +243,45 @@ module Curl
         }
         raise errors unless errors.empty?
       end
+    end
 
+    def cancel!
+      requests.each do |_,easy|
+        remove(easy)
+      end
     end
+
+    def idle?
+      requests.empty?
+    end
+
+    def requests
+      @requests ||= {}
+    end
+
+    def add(easy)
+      return self if requests[easy.object_id]
+      requests[easy.object_id] = easy
+      _add(easy)
+      self
+    end
+
+    def remove(easy)
+      return self if !requests[easy.object_id]
+      requests.delete(easy.object_id)
+      _remove(easy)
+      self
+    end
+
+    def close
+      requests.values.each {|easy|
+        _remove(easy)
+      }
+      @requests = {}
+      _close
+      self
+    end
+
+
   end
 end

data/lib/curl.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
 require 'curb_core'
 require 'curl/easy'
 require 'curl/multi'
 require 'uri'
+require 'cgi'
 
 # expose shortcut methods
 module Curl
-  
+
   def self.http(verb, url, post_body=nil, put_data=nil, &block)
     handle = Thread.current[:curb_curl] ||= Curl::Easy.new
     handle.reset
@@ -46,18 +48,21 @@ module Curl
   end
 
   def self.urlalize(url, params={})
-    query_str = params.map {|k,v| "#{URI.escape(k.to_s)}=#{URI.escape(v.to_s)}" }.join('&')
-    if url.match(/\?/)
-      "#{url}&#{query_str}"
-    elsif query_str.size > 0
-      "#{url}?#{query_str}"
-    else
-      url
-    end
+    uri = URI(url)
+    # early return if we didn't specify any extra params
+    return uri.to_s if (params || {}).empty?
+
+    params_query = URI.encode_www_form(params || {})
+    uri.query = [uri.query.to_s, params_query].reject(&:empty?).join('&')
+    uri.to_s
   end
 
   def self.postalize(params={})
     params.respond_to?(:map) ? URI.encode_www_form(params) : (params.respond_to?(:to_s) ? params.to_s : params)
   end
 
+  def self.reset
+    Thread.current[:curb_curl] = Curl::Easy.new
+  end
+
 end