curb 0.9.7 → 1.0.1

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"
@@ -84,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"
@@ -152,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"
@@ -216,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"
@@ -334,6 +343,9 @@ 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"
 have_constant "curlopt_issuercert"
@@ -393,6 +405,37 @@ have_constant "curlopt_path_as_is"
 # added in 7.43.0
 have_constant "curlopt_pipewait"
 
+# 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
@@ -420,6 +463,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
 
@@ -20,7 +21,7 @@ module Curl
     #
     def status
       # 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 = 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,5 +1,5 @@
+# frozen_string_literal: true
 module Curl
-
   class Multi
     class << self
       # call-seq:
@@ -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:
@@ -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'
@@ -8,12 +9,20 @@ require 'cgi'
 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

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

data/tests/helper.rb

@@ -2,6 +2,7 @@
 # Copyright (c)2006 Ross Bamford. See LICENSE.
 $CURB_TESTING = true
 require 'uri'
+require 'stringio'
 
 $TOPDIR = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 $EXTDIR = File.join($TOPDIR, 'ext')
@@ -142,7 +143,6 @@ module TestServerMethods
   def server_setup(port=9129,servlet=TestServlet)
     @__port = port
     if (@server ||= nil).nil? and !File.exist?(locked_file)
-
       File.open(locked_file,'w') {|f| f << 'locked' }
       if TEST_SINGLE_THREADED
         rd, wr = IO.pipe
@@ -207,3 +207,81 @@ module TestServerMethods
   rescue Errno::EADDRINUSE
   end
 end
+
+
+
+# Backport for Ruby 1.8
+module Backports
+  module Ruby18
+    module URIFormEncoding
+      TBLENCWWWCOMP_ = {}
+      TBLDECWWWCOMP_ = {}
+
+      def encode_www_form_component(str)
+        if TBLENCWWWCOMP_.empty?
+          256.times do |i|
+            TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
+          end
+          TBLENCWWWCOMP_[' '] = '+'
+          TBLENCWWWCOMP_.freeze
+        end
+        str.to_s.gsub( /([^*\-.0-9A-Z_a-z])/ ) {|*| TBLENCWWWCOMP_[$1] }
+      end
+
+      def decode_www_form_component(str)
+        if TBLDECWWWCOMP_.empty?
+          256.times do |i|
+            h, l = i>>4, i&15
+            TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
+            TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
+            TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
+            TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
+          end
+          TBLDECWWWCOMP_['+'] = ' '
+          TBLDECWWWCOMP_.freeze
+        end
+
+        raise ArgumentError, "invalid %-encoding (#{str.dump})" unless /\A(?:%[[:xdigit:]]{2}|[^%]+)*\z/ =~ str
+        str.gsub( /(\+|%[[:xdigit:]]{2})/ ) {|*| TBLDECWWWCOMP_[$1] }
+      end
+
+      def encode_www_form( enum )
+        enum.map do |k,v|
+          if v.nil?
+            encode_www_form_component(k)
+          elsif v.respond_to?(:to_ary)
+            v.to_ary.map do |w|
+              str = encode_www_form_component(k)
+              unless w.nil?
+                str << '='
+                str << encode_www_form_component(w)
+              end
+            end.join('&')
+          else
+            str = encode_www_form_component(k)
+            str << '='
+            str << encode_www_form_component(v)
+          end
+        end.join('&')
+      end
+
+      WFKV_ = '(?:%\h\h|[^%#=;&])'
+      def decode_www_form(str, _)
+        return [] if str.to_s == ''
+
+        unless /\A#{WFKV_}=#{WFKV_}(?:[;&]#{WFKV_}=#{WFKV_})*\z/ =~ str
+          raise ArgumentError, "invalid data of application/x-www-form-urlencoded (#{str})"
+        end
+        ary = []
+        $&.scan(/([^=;&]+)=([^;&]*)/) do
+          ary << [decode_www_form_component($1, enc), decode_www_form_component($2, enc)]
+        end
+        ary
+      end
+    end
+  end
+end
+
+unless URI.methods.include?(:encode_www_form)
+  URI.extend(Backports::Ruby18::URIFormEncoding)
+end

data/tests/tc_curl_easy.rb

@@ -10,6 +10,74 @@ class TestCurbCurlEasy < Test::Unit::TestCase
     Curl.reset
   end
 
+  def test_nested_easy_methods
+    easy = Curl.get(TestServlet.url) {|http|
+      res = Curl.get(TestServlet.url + '/not_here')
+      assert_equal 404, res.response_code
+    }
+    assert_equal 200, easy.response_code
+  end
+
+  def test_curlopt_stderr_with_file
+    # does not work with Tempfile directly
+    path = Tempfile.new('curb_test_curlopt_stderr').path
+    File.open(path, 'w') do |file|
+      easy = Curl::Easy.new(TestServlet.url)
+      easy.verbose = true
+      easy.setopt(Curl::CURLOPT_STDERR, file)
+      easy.perform
+    end
+    output = File.read(path)
+
+    assert_match(/HTTP\/1\.1\ 200\ OK(?:\ )?/, output)
+    assert_match('Host: 127.0.0.1:9129', output)
+  end
+
+  def test_curlopt_stderr_with_io
+    path = Tempfile.new('curb_test_curlopt_stderr').path
+    fd = IO.sysopen(path, 'w')
+    io = IO.for_fd(fd)
+
+    easy = Curl::Easy.new(TestServlet.url)
+    easy.verbose = true
+    easy.setopt(Curl::CURLOPT_STDERR, io)
+    easy.perform
+
+
+    output = File.read(path)
+
+    assert_match(output, 'HTTP/1.1 200 OK')
+    assert_match(output, 'Host: 127.0.0.1:9129')
+  end
+
+  def test_curlopt_stderr_fails_with_tempdir
+    Tempfile.open('curb_test_curlopt_stderr') do |tempfile|
+      easy = Curl::Easy.new(TestServlet.url)
+
+      assert_raise(TypeError) do
+        easy.setopt(Curl::CURLOPT_STDERR, tempfile)
+      end
+    end
+  end
+
+  def test_curlopt_stderr_fails_with_stringio
+    stringio = StringIO.new
+    easy = Curl::Easy.new(TestServlet.url)
+
+    assert_raise(TypeError) do
+      easy.setopt(Curl::CURLOPT_STDERR, stringio)
+    end
+  end
+
+  def test_curlopt_stderr_fails_with_string
+    string = String.new
+    easy = Curl::Easy.new(TestServlet.url)
+
+    assert_raise(TypeError) do
+      easy.setopt(Curl::CURLOPT_STDERR, string)
+    end
+  end
+
   def test_exception
     begin
       Curl.get('NOT_FOUND_URL')
@@ -28,8 +96,6 @@ class TestCurbCurlEasy < Test::Unit::TestCase
           c = Curl.get($TEST_URL)
           assert_match(/^# DO NOT REMOVE THIS COMMENT/, c.body_str)
           assert_match(/^# DO NOT REMOVE THIS COMMENT/, c.body)
-          assert_equal "", c.header_str
-          assert_equal "", c.head
         end
       end
     end
@@ -41,7 +107,6 @@ class TestCurbCurlEasy < Test::Unit::TestCase
     assert_instance_of Curl::Easy, c = Curl::Easy.perform($TEST_URL)
     assert_match(/^# DO NOT REMOVE THIS COMMENT/, c.body_str)
     assert_match(/^# DO NOT REMOVE THIS COMMENT/, c.body)
-    assert_equal "", c.header_str
   end    
 
   def test_class_perform_02
@@ -49,7 +114,6 @@ class TestCurbCurlEasy < Test::Unit::TestCase
     assert_instance_of Curl::Easy, c = Curl::Easy.perform($TEST_URL) { |curl| curl.on_body { |d| data << d; d.length } }    
 
     assert_nil c.body_str
-    assert_equal "", c.header_str
     assert_match(/^# DO NOT REMOVE THIS COMMENT/, data)
   end    
 
@@ -144,7 +208,6 @@ class TestCurbCurlEasy < Test::Unit::TestCase
     c = Curl::Easy.new($TEST_URL)    
     assert_equal true, c.http_get
     assert_match(/^# DO NOT REMOVE THIS COMMENT/, c.body_str)
-    assert_equal "", c.header_str
   end    
 
   def test_get_02
@@ -156,7 +219,6 @@ class TestCurbCurlEasy < Test::Unit::TestCase
     assert_equal true, c.http_get    
     
     assert_nil c.body_str
-    assert_equal "", c.header_str
     assert_match(/^# DO NOT REMOVE THIS COMMENT/, data)
   end    
 
@@ -339,29 +401,69 @@ class TestCurbCurlEasy < Test::Unit::TestCase
     c.max_redirects = nil
     assert_nil c.max_redirects
   end
-  
+
+  def test_timeout_with_floats
+    c = Curl::Easy.new($TEST_URL)
+
+    c.timeout = 1.5
+    assert_equal 1500, c.timeout_ms
+    assert_equal 1.5, c.timeout
+  end
+
+  def test_timeout_with_negative
+    c = Curl::Easy.new($TEST_URL)
+
+    c.timeout = -1.5
+    assert_equal 0, c.timeout
+    assert_equal 0, c.timeout_ms
+
+    c.timeout = -4.8
+    assert_equal 0, c.timeout
+    assert_equal 0, c.timeout_ms
+  end
+
   def test_timeout_01
     c = Curl::Easy.new($TEST_URL)
-    
-    assert_nil c.timeout
-    
+
+    assert_equal 0, c.timeout
+
     c.timeout = 3
     assert_equal 3, c.timeout
-    
-    c.timeout = nil
-    assert_nil c.timeout
+
+    c.timeout = 0
+    assert_equal 0, c.timeout
   end
 
   def test_timeout_ms_01
     c = Curl::Easy.new($TEST_URL)
 
-    assert_nil c.timeout_ms
+    assert_equal 0, c.timeout_ms
 
     c.timeout_ms = 100
     assert_equal 100, c.timeout_ms
 
     c.timeout_ms = nil
-    assert_nil c.timeout_ms
+    assert_equal 0, c.timeout_ms
+  end
+
+  def test_timeout_ms_with_floats
+    c = Curl::Easy.new($TEST_URL)
+
+    c.timeout_ms = 55.5
+    assert_equal 55, c.timeout_ms
+    assert_equal 0.055, c.timeout
+  end
+
+  def test_timeout_ms_with_negative
+    c = Curl::Easy.new($TEST_URL)
+
+    c.timeout_ms = -1.5
+    assert_equal 0, c.timeout
+    assert_equal 0, c.timeout_ms
+
+    c.timeout_ms = -4.8
+    assert_equal 0, c.timeout
+    assert_equal 0, c.timeout_ms
   end
 
   def test_connect_timeout_01
@@ -608,7 +710,7 @@ class TestCurbCurlEasy < Test::Unit::TestCase
   def test_cookielist
     c = Curl::Easy.new TestServlet.url
     c.enable_cookies = true
-    c.post_body = URI.encode_www_form c: 'somename=somevalue'
+    c.post_body = URI.encode_www_form('c' => 'somename=somevalue')
     assert_nil c.cookielist
     c.perform
     assert_match(/somevalue/, c.cookielist.join(''))

data/tests/tc_curl_maxfilesize.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+class TestCurbCurlMaxFileSize < Test::Unit::TestCase
+  def setup
+    @easy = Curl::Easy.new
+  end
+
+  def test_maxfilesize
+    @easy.set(Curl::CURLOPT_MAXFILESIZE, 5000000)
+  end
+
+end