curb 0.9.3 → 1.0.2

data/ext/curb_postfield.c

@@ -195,9 +195,9 @@ void curl_postfield_free(ruby_curl_postfield *rbcpf) {
 
 /*
  * call-seq:
- *   Curl::PostField.content(name, content) => #<Curl::PostField...>
- *   Curl::PostField.content(name, content, content_type = nil) => #<Curl::PostField...>
- *   Curl::PostField.content(name, content_type = nil) { |field| ... } => #<Curl::PostField...>
+ *   Curl::PostField.content(name, content) => #<Curl::PostField...>
+ *   Curl::PostField.content(name, content, content_type = nil) => #<Curl::PostField...>
+ *   Curl::PostField.content(name, content_type = nil) { |field| ... } => #<Curl::PostField...>
  * 
  * Create a new Curl::PostField, supplying the field name, content,
  * and, optionally, Content-type (curl will attempt to determine this if
@@ -241,9 +241,9 @@ static VALUE ruby_curl_postfield_new_content(int argc, VALUE *argv, VALUE klass)
 
 /*
  * call-seq:
- *   Curl::PostField.file(name, local_file_name) => #&lt;Curl::PostField...&gt;
- *   Curl::PostField.file(name, local_file_name, remote_file_name = local_file_name) => #&lt;Curl::PostField...&gt;
- *   Curl::PostField.file(name, remote_file_name) { |field| ... } => #&lt;Curl::PostField...&gt;
+ *   Curl::PostField.file(name, local_file_name) => #<Curl::PostField...>
+ *   Curl::PostField.file(name, local_file_name, remote_file_name = local_file_name) => #<Curl::PostField...>
+ *   Curl::PostField.file(name, remote_file_name) { |field| ... } => #<Curl::PostField...>
  * 
  * Create a new Curl::PostField for a file upload field, supplying the local filename
  * to read from, and optionally the remote filename (defaults to the local name).
@@ -399,7 +399,7 @@ static VALUE ruby_curl_postfield_remote_file_get(VALUE self) {
 
 /*
  * call-seq:
- *   field.set_content_proc { |field| ... }           => &lt;old proc&gt;
+ *   field.set_content_proc { |field| ... }           => <old proc>
  * 
  * Set a content proc for this field. This proc will be called during the
  * perform to supply the content for this field, overriding any setting
@@ -498,6 +498,8 @@ void init_curb_postfield() {
   
   cCurlPostField = rb_define_class_under(mCurl, "PostField", rb_cObject);
 
+  rb_undef_alloc_func(cCurlPostField);
+
   /* Class methods */
   rb_define_singleton_method(cCurlPostField, "content", ruby_curl_postfield_new_content, -1);
   rb_define_singleton_method(cCurlPostField, "file", ruby_curl_postfield_new_file, -1);

data/ext/curb_upload.c

@@ -72,6 +72,7 @@ VALUE ruby_curl_upload_offset_get(VALUE self) {
 /* =================== INIT LIB =====================*/
 void init_curb_upload() {
   cCurlUpload = rb_define_class_under(mCurl, "Upload", rb_cObject);
+  rb_undef_alloc_func(cCurlUpload);
   rb_define_singleton_method(cCurlUpload, "new", ruby_curl_upload_new, 0);
   rb_define_method(cCurlUpload, "stream=", ruby_curl_upload_stream_set, 1);
   rb_define_method(cCurlUpload, "stream", ruby_curl_upload_stream_get, 0);

data/ext/extconf.rb

@@ -18,6 +18,8 @@ elsif !have_library('curl') or !have_header('curl/curl.h')
   fail <<-EOM
   Can't find libcurl or curl/curl.h
 
+  Make sure development libs (ie libcurl4-openssl-dev) are installed on the system.
+
   Try passing --with-curl-dir or --with-curl-lib and --with-curl-include
   options to extconf.
   EOM
@@ -59,6 +61,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 +71,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"
@@ -83,6 +89,7 @@ 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"
@@ -101,6 +108,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"
 
@@ -145,6 +158,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"
@@ -209,6 +224,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"
@@ -318,14 +334,17 @@ have_constant "curlopt_sslengine"
 have_constant "curlopt_sslengine_default"
 have_constant "curlopt_sslversion"
 have_constant "curl_sslversion_default"
-have_constant "curl_sslversion_tlsv1"
-have_constant "curl_sslversion_sslv2"
-have_constant "curl_sslversion_sslv3"
+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 :CURL_SSLVERSION_TLSv1_0
+have_constant :CURL_SSLVERSION_TLSv1_1
+have_constant :CURL_SSLVERSION_TLSv1_2
+
+# Added in 7.52.0
+have_constant :CURL_SSLVERSION_TLSv1_3
 
 have_constant "curlopt_ssl_verifypeer"
 have_constant "curlopt_cainfo"
@@ -360,6 +379,16 @@ 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"
@@ -370,6 +399,45 @@ 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"
+
+have_constant "curlopt_proxy_ssl_verifyhost"
+
+# protocol constants
+have_constant "curlproto_all"
+have_constant "curlproto_dict"
+have_constant "curlproto_file"
+have_constant "curlproto_ftp"
+have_constant "curlproto_ftps"
+have_constant "curlproto_gopher"
+have_constant "curlproto_http"
+have_constant "curlproto_https"
+have_constant "curlproto_imap"
+have_constant "curlproto_imaps"
+have_constant "curlproto_ldap"
+have_constant "curlproto_ldaps"
+have_constant "curlproto_pop3"
+have_constant "curlproto_pop3s"
+have_constant "curlproto_rtmp"
+have_constant "curlproto_rtmpe"
+have_constant "curlproto_rtmps"
+have_constant "curlproto_rtmpt"
+have_constant "curlproto_rtmpte"
+have_constant "curlproto_rtmpts"
+have_constant "curlproto_rtsp"
+have_constant "curlproto_scp"
+have_constant "curlproto_sftp"
+have_constant "curlproto_smb"
+have_constant "curlproto_smbs"
+have_constant "curlproto_smtp"
+have_constant "curlproto_smtps"
+have_constant "curlproto_telnet"
+have_constant "curlproto_tftp"
+
 if try_compile('int main() { return 0; }','-Wall')
   $CFLAGS << ' -Wall'
 end
@@ -397,6 +465,8 @@ 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
 
@@ -19,9 +20,9 @@ module Curl
     #   easy.status  => String
     #
     def status
-      # Matches the last HTTP Status - following the HTTP protocol specification 'Status-Line = HTTP-Version SP Status-Code SP Reason-Phrase CRLF'
-      statuses = self.header_str.scan(/HTTP\/\d\.\d\s(\d+\s.*)\r\n/).map{ |match|  match[0] }
-      statuses.last.strip
+      # 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.to_s.scan(/HTTP\/\d(\.\d)?\s(\d+\s.*)\r\n/).map {|match| match[1] }
+      statuses.last.strip if statuses.length > 0
     end
 
     #
@@ -68,9 +69,15 @@ module Curl
       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.new(error.last)
+        (err_class, err_summary) = Curl::Easy.error(self.last_result)
+        err_detail = self.last_error
+        raise err_class.new([err_summary, err_detail].compact.join(": "))
       end
 
       ret
@@ -314,7 +321,7 @@ module Curl
 
       #
       # call-seq:
-      #   Curl::Easy.perform(url) { |easy| ... }           => #<Curl::Easy...>
+      #   Curl::Easy.perform(url) { |easy| ... }           => #<Curl::Easy...>
       #
       # Convenience method that creates a new Curl::Easy instance with
       # the specified URL and calls the general +perform+ method, before returning
@@ -332,7 +339,7 @@ module Curl
 
       #
       # call-seq:
-      #   Curl::Easy.http_get(url) { |easy| ... }          => #&lt;Curl::Easy...&gt;
+      #   Curl::Easy.http_get(url) { |easy| ... }          => #<Curl::Easy...>
       #
       # Convenience method that creates a new Curl::Easy instance with
       # the specified URL and calls +http_get+, before returning the new instance.
@@ -349,7 +356,7 @@ module Curl
 
       #
       # call-seq:
-      #   Curl::Easy.http_head(url) { |easy| ... }         => #&lt;Curl::Easy...&gt;
+      #   Curl::Easy.http_head(url) { |easy| ... }         => #<Curl::Easy...>
       #
       # Convenience method that creates a new Curl::Easy instance with
       # the specified URL and calls +http_head+, before returning the new instance.
@@ -403,7 +410,7 @@ module Curl
 
       #
       # call-seq:
-      #   Curl::Easy.http_delete(url) { |easy| ... }       => #&lt;Curl::Easy...&gt;
+      #   Curl::Easy.http_delete(url) { |easy| ... }       => #<Curl::Easy...>
       #
       # Convenience method that creates a new Curl::Easy instance with
       # the specified URL and calls +http_delete+, before returning the new instance.

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|
       #     easy
       #   end
-      # 
+      #
       # Blocking call to fetch multiple url's in parallel.
       def get(urls, easy_options={}, multi_options={}, &blk)
         url_confs = []
@@ -25,10 +25,10 @@ module Curl
       #                    {: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
       #
@@ -49,10 +49,10 @@ module Curl
       #                    {: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
       #
@@ -79,7 +79,7 @@ module Curl
       # 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)
@@ -128,7 +128,7 @@ 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
@@ -144,7 +144,7 @@ module Curl
 
         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,3 +1,4 @@
+# frozen_string_literal: true
 require 'curb_core'
 require 'curl/easy'
 require 'curl/multi'
@@ -6,14 +7,22 @@ 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
+    if Thread.current[:curb_curl_yielding]
+      handle = Curl::Easy.new # we can't reuse this
+    else
+      handle = Thread.current[:curb_curl] ||= Curl::Easy.new
+      handle.reset
+    end
     handle.url = url
     handle.post_body = post_body if post_body
     handle.put_data = put_data if put_data
-    yield handle if block_given?
+    if block_given?
+      Thread.current[:curb_curl_yielding] = true
+      yield handle
+      Thread.current[:curb_curl_yielding] = false
+    end
     handle.http(verb)
     handle
   end
@@ -47,14 +56,13 @@ module Curl
   end
 
   def self.urlalize(url, params={})
-    query_str = params.map {|k,v| "#{URI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join('&')
-    if url.match(/\?/) && query_str.size > 0
-      "#{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={})

data/tests/bug_crash_on_debug.rb

@@ -20,11 +20,21 @@ class BugCrashOnDebug < Test::Unit::TestCase
     end
     puts 'b'
     c = Curl::Easy.new('http://127.0.0.1:9999/test')
-    c.on_debug do|x|
-      puts x.inspect
-      raise "error" # this will get swallowed
+    did_raise = false
+    did_call = false
+    begin
+      c.on_success do|x|
+        puts x.inspect
+        did_call = true
+        raise "error" # this will get swallowed
+      end
+      c.perform
+    rescue => e
+      did_raise = true
     end
-    c.perform
+    puts c.response_code
+    assert did_raise
+    assert did_call
     puts 'c'
   ensure
     puts 'd'

data/tests/bug_crash_on_progress.rb

@@ -28,7 +28,8 @@ class BugCrashOnDebug < Test::Unit::TestCase
     assert_equal 'Curl::Err::AbortedByCallbackError', e.class.to_s
     c.close
   ensure
-    server.shutdown
+    server&.shutdown
+    thread&.exit
   end
 
   def test_on_progress_abort
@@ -67,7 +68,8 @@ class BugCrashOnDebug < Test::Unit::TestCase
     assert_equal 'Curl::Err::AbortedByCallbackError', e.class.to_s
     c.close
   ensure
-    server.shutdown
+    server&.shutdown
+    thread&.exit
   end
 
 end

data/tests/bug_follow_redirect_288.rb

@@ -0,0 +1,91 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+require 'webrick'
+class ::WEBrick::HTTPServer ; def access_log(config, req, res) ; end ; end
+class ::WEBrick::BasicLog ; def log(level, data) ; end ; end
+
+class BugFollowRedirect288 < Test::Unit::TestCase
+  def test_follow_redirect_with_no_redirect
+    server = WEBrick::HTTPServer.new( :Port => 9999 )
+    server.mount_proc("/test") do|req,res|
+      res.body = "hi"
+      res['Content-Type'] = "text/html"
+    end
+    server.mount_proc("/redirect_to_test") do|req,res|
+      res.set_redirect(WEBrick::HTTPStatus::TemporaryRedirect, "/test")
+    end
+
+    thread = Thread.new(server) do|srv|
+      srv.start
+    end
+
+    c = Curl::Easy.new('http://127.0.0.1:9999/test')
+    did_call_redirect = false
+    c.on_redirect do|x|
+      did_call_redirect = true
+    end
+    c.perform
+
+    assert !did_call_redirect, "should reach this point redirect should not have been called"
+
+    c = Curl::Easy.new('http://127.0.0.1:9999/test')
+    did_call_redirect = false
+    c.on_redirect do|x|
+      did_call_redirect = true
+    end
+    c.follow_location = true
+    c.perform
+
+    assert_equal 0, c.redirect_count
+    assert !did_call_redirect, "should reach this point redirect should not have been called"
+
+    c = Curl::Easy.new('http://127.0.0.1:9999/redirect_to_test')
+    did_call_redirect = false
+    c.on_redirect do|x|
+      did_call_redirect = true
+    end
+    c.perform
+    assert_equal 307, c.response_code
+
+    assert did_call_redirect, "we should have called on_redirect"
+
+    c = Curl::Easy.new('http://127.0.0.1:9999/redirect_to_test')
+    did_call_redirect = false
+    c.follow_location = true
+    # NOTE: while this API is not supported by libcurl e.g. there is no redirect function callback in libcurl we could 
+    # add support in ruby for this by executing this callback if redirect_count is greater than 0 at the end of a request in curb_multi.c
+    c.on_redirect do|x|
+      did_call_redirect = true
+    end
+    c.perform
+    assert_equal 1, c.redirect_count
+    assert_equal 200, c.response_code
+
+    assert did_call_redirect, "we should have called on_redirect"
+
+    c.url = 'http://127.0.0.1:9999/test'
+    c.perform
+    assert_equal 0, c.redirect_count
+    assert_equal 200, c.response_code
+
+    did_raise = false
+    begin
+      c = Curl::Easy.new('http://127.0.0.1:9999/redirect_to_test')
+      did_call_redirect = false
+      c.on_redirect do|x|
+        raise "raise"
+        did_call_redirect = true
+      end
+      c.perform
+    rescue => e
+      did_raise = true
+    end
+    assert did_raise
+    assert_equal 307, c.response_code
+
+  ensure
+    server.stop
+    thread.join
+
+  end
+
+end

data/tests/bug_issue277.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+
+require 'curb'
+
+class BugIssue102 < Test::Unit::TestCase
+
+  def test_gc_closewait
+		100.times do
+			responses = {}
+			requests = ["http://www.google.co.uk/", "http://www.ruby-lang.org/"]
+			m = Curl::Multi.new
+			# add a few easy handles
+			requests.each do |url|
+				responses[url] = ""
+				c = Curl::Easy.new(url) do|curl|
+					curl.follow_location = true
+					curl.on_body{|data| responses[url] << data; data.size }
+					curl.on_success {|easy| #puts "success, add more easy handles"
+          }
+				end
+				m.add(c)
+			end
+
+			m.perform do
+				#puts "idling... can do some work here"
+			end
+      GC.start
+		end
+	end
+
+end