curb 0.9.2 → 0.9.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c2d299f9e0dce739a74ea53589cc402c4dc2ae2b
-  data.tar.gz: efd8d73f02b9da758c3861a93489e78bb770e4af
+SHA256:
+  metadata.gz: ecd73a0ad8d98960321b8d523e25bad95ff25e8900e8acb187051ca40c7a1cba
+  data.tar.gz: c154996d92946fe83fa12d695b073d5026e4a55e92efd177bfad021461f2b313
 SHA512:
-  metadata.gz: 364eed3e88338d6c1c7fc8028181b82e945d8d605d171d470d319a434ad7198a2900fe600e4870ac2acc680a35df4e4506471d923cee020d707888168920276d
-  data.tar.gz: ad15467a00c66ee255ed5a605ed48426400a12901e673181c873cf56c7e793534b4b17304cd75b02fd7c15d8e51e2b7a6f1bd24e5dc36c3ffc35096ef6c1b030
+  metadata.gz: 48854a4f0d77befe0e81b31a3d39e826b2ef65d58d0226b617a355ba8d063ab4998853a8709ae6d2e3c4629c09ff987099398a1c884b76d95dcf956d941fc660
+  data.tar.gz: 3291675a74eb40f42d936bb65689da7d5f295e038ed019482d2cf115ba878232ce4e40aeb125d0fe786b5e82428320938ff3c75592a5c54a2d51fbe8589a0931

data/README.markdown

@@ -7,19 +7,35 @@ Curb (probably CUrl-RuBy or something) provides Ruby-language bindings for the
 libcurl(3), a fully-featured client-side URL transfer library.
 cURL and libcurl live at [http://curl.haxx.se/](http://curl.haxx.se/) .
 
-Curb is a work-in-progress, and currently only supports libcurl's 'easy' and 'multi' modes.
+Curb is a work-in-progress, and currently only supports libcurl's `easy` and `multi` modes.
 
 ## License
 
-Curb is copyright (c)2006 Ross Bamford, and released under the terms of the 
-Ruby license. See the LICENSE file for the gory details. 
+Curb is copyright (c)2006 Ross Bamford, and released under the terms of the
+Ruby license. See the LICENSE file for the gory details.
 
 ## You will need
 
-* A working Ruby installation (1.8+, tested with 1.8.6, 1.8.7, 1.9.1, and 1.9.2)
-* A working (lib)curl installation, with development stuff (7.5+, tested with 7.19.x)
+* A working Ruby installation (`1.8.7+` will work but `2.1+` preferred)
+* A working libcurl development installation
+(Ideally one of the versions listed in the compatibility chart below that maps to your `curb` version)
 * A sane build environment (e.g. gcc, make)
 
+## Version Compatibility chart
+
+A **non-exhaustive** set of compatibility versions of the libcurl library
+with this gem are as follows. (Note that these are only the ones that have been
+tested and reported to work across a variety of platforms / rubies)
+
+| Gem Version | Release Date | libcurl versions |
+| ----------- | -----------  | ---------------- |
+| 0.9.8       | Jan 2019     | 7.58 - 7.63      |
+| 0.9.7       | Nov 2018     | 7.56 - 7.60      |
+| 0.9.6       | May 2018     | 7.51 - 7.59      |
+| 0.9.5       | May 2018     | 7.51 - 7.59      |
+| 0.9.4       | Aug 2017     | 7.41 - 7.58      |
+| 0.9.3       | Apr 2016     | 7.26 - 7.58      |
+
 ## Installation...
 
 ... will usually be as simple as:
@@ -30,19 +46,23 @@ On Windows, make sure you're using the [DevKit](http://rubyinstaller.org/downloa
 the [development version of libcurl](http://curl.haxx.se/gknw.net/7.39.0/dist-w32/curl-7.39.0-devel-mingw32.zip). Unzip, then run this in your command
 line (alter paths to your curl location, but remember to use forward slashes):
 
-    gem install curb --platform=ruby -- --with-curl-lib=C:/curl-7.39.0-devel-mingw32/bin --with-curl-include=C:/curl-7.39.0-devel-mingw32/include
+    gem install curb --platform=ruby -- --with-curl-lib=C:/curl-7.39.0-devel-mingw32/lib --with-curl-include=C:/curl-7.39.0-devel-mingw32/include
+    
+Note that with Windows moving from one method of compiling to another as of Ruby `2.4` (DevKit -> MYSYS2),
+the usage of Ruby `2.4+` with this gem on windows is unlikely to work. It is advised to use the
+latest version of Ruby 2.3 available [HERE](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.3.3.exe)
 
-Or, if you downloaded the archive:  
+Or, if you downloaded the archive:
 
-    $ rake install 
+    $ rake compile && rake install
 
 If you have a weird setup, you might need extconf options. In this case, pass
 them like so:
 
-    $ rake install EXTCONF_OPTS='--with-curl-dir=/path/to/libcurl --prefix=/what/ever'
-  
+    $ rake compile EXTCONF_OPTS='--with-curl-dir=/path/to/libcurl --prefix=/what/ever' && rake install
+
 Curb is tested only on GNU/Linux x86 and Mac OSX - YMMV on other platforms.
-If you do use another platform and experience problems, or if you can 
+If you do use another platform and experience problems, or if you can
 expand on the above instructions, please report the issue at http://github.com/taf2/curb/issues
 
 On Ubuntu, the dependencies can be satisfied by installing the following packages:
@@ -52,7 +72,7 @@ On Ubuntu, the dependencies can be satisfied by installing the following package
 On RedHat:
 
     $ sudo yum install ruby-devel libcurl-devel openssl-devel
-    
+
 Curb has fairly extensive RDoc comments in the source. You can build the
 documentation with:
 
@@ -65,6 +85,12 @@ Curb provides two classes:
 * `Curl::Easy` - simple API, for day-to-day tasks.
 * `Curl::Multi` - more advanced API, for operating on multiple URLs simultaneously.
 
+To use either, you will need to require the curb gem:
+
+```ruby
+require 'curb'
+```
+
 ### Super simple API (less typing)
 
 ```ruby
@@ -74,7 +100,7 @@ puts http.body_str
 http = Curl.post("http://www.google.com/", {:foo => "bar"})
 puts http.body_str
 
-http = Curl.get("http://www.google.com/") do|http|
+http = Curl.get("http://www.google.com/") do |http|
   http.headers['Cookie'] = 'foo=1;bar=2'
 end
 puts http.body_str
@@ -98,7 +124,7 @@ puts c.body_str
 ### Additional config:
 
 ```ruby
-Curl::Easy.perform("http://www.google.co.uk") do |curl| 
+Curl::Easy.perform("http://www.google.co.uk") do |curl|
   curl.headers["User-Agent"] = "myapp-0.0"
   curl.verbose = true
 end
@@ -107,7 +133,7 @@ end
 Same thing, more manual:
 
 ```ruby
-c = Curl::Easy.new("http://www.google.co.uk") do |curl| 
+c = Curl::Easy.new("http://www.google.co.uk") do |curl|
   curl.headers["User-Agent"] = "myapp-0.0"
   curl.verbose = true
 end
@@ -128,9 +154,9 @@ c.perform
 ### HTTP "insecure" SSL connections (like curl -k, --insecure) to avoid Curl::Err::SSLCACertificateError:
 
 ```ruby
-    c = Curl::Easy.new("http://github.com/")
-    c.ssl_verify_peer = false
-    c.perform
+c = Curl::Easy.new("https://github.com/")
+c.ssl_verify_peer = false
+c.perform
 ```
 
 ### Supplying custom handlers:
@@ -188,7 +214,7 @@ puts (c.body_str.include? "You are using HTTP/2 right now!") ? "HTTP/2" : "HTTP/
 # make multiple GET requests
 easy_options = {:follow_location => true}
 # Use Curl::CURLPIPE_MULTIPLEX for HTTP/2 multiplexing
-multi_options = {:pipeline => Curl::CURLPIPE_HTTP1} 
+multi_options = {:pipeline => Curl::CURLPIPE_HTTP1}
 
 Curl::Multi.get(['url1','url2','url3','url4','url5'], easy_options, multi_options) do|easy|
   # do something interesting with the easy response

data/Rakefile

@@ -2,11 +2,6 @@
 # 
 require 'rake/clean'
 require 'rake/testtask'
-begin
-  require 'rdoc/task'
-rescue LoadError => e
-  require 'rake/rdoctask'
-end
 
 CLEAN.include '**/*.o'
 CLEAN.include "**/*.#{(defined?(RbConfig) ? RbConfig : Config)::MAKEFILE_CONFIG['DLEXT']}"
@@ -15,6 +10,22 @@ CLOBBER.include '**/*.log'
 CLOBBER.include '**/Makefile'
 CLOBBER.include '**/extconf.h'
 
+# Not available for really old rubies, but that's ok.
+begin
+  require 'pry'
+rescue LoadError
+  puts "Failed to load pry."
+end
+
+# Load support ruby and rake files (in this order)
+Dir.glob('tasks/*.rb').each { |r| load r}
+Dir.glob('tasks/*.rake').each { |r| load r}
+
+desc 'Print Ruby major version (ie "2_5")'
+task :ruby_version do
+  print current_ruby_major
+end
+
 def announce(msg='')
   $stderr.puts msg
 end
@@ -43,12 +54,11 @@ end
 make_program = (/mswin/ =~ RUBY_PLATFORM) ? 'nmake' : 'make'
 MAKECMD = ENV['MAKE_CMD'] || make_program
 MAKEOPTS = ENV['MAKE_OPTS'] || ''
-
 CURB_SO = "ext/curb_core.#{(defined?(RbConfig) ? RbConfig : Config)::MAKEFILE_CONFIG['DLEXT']}"
 
 file 'ext/Makefile' => 'ext/extconf.rb' do
   Dir.chdir('ext') do
-    ruby "extconf.rb #{ENV['EXTCONF_OPTS']}"
+    shell('ruby', 'extconf.rb', ENV['EXTCONF_OPTS'].to_s, live_stdout: STDOUT)
   end
 end
 
@@ -89,12 +99,12 @@ if ENV['RELTEST']
 else
   task :alltests => [:unittests, :bugtests]
 end
-                    
+
 Rake::TestTask.new(:unittests) do |t|
   t.test_files = FileList['tests/tc_*.rb']
   t.verbose = false
 end
-                          
+
 Rake::TestTask.new(:bugtests) do |t|
   t.test_files = FileList['tests/bug_*.rb']
   t.verbose = false
@@ -136,6 +146,12 @@ end
 
 desc "Publish the RDoc documentation to project web site"
 task :doc_upload => [ :doc ] do
+  begin
+    require 'rdoc/task'
+  rescue LoadError => e
+    require 'rake/rdoctask'
+  end
+
   if ENV['RELTEST']
     announce "Release Task Testing, skipping doc upload"
   else    
@@ -170,7 +186,7 @@ else
     spec_source = File.read File.join(File.dirname(__FILE__),'curb.gemspec')
     spec = nil
     # see: http://gist.github.com/16215
-    Thread.new { spec = eval("$SAFE = 3\n#{spec_source}") }.join
+    Thread.new { spec = eval("#{spec_source}") }.join
     spec.validate
     Gem::Package.build(spec)
   end

data/ext/banned.h

@@ -0,0 +1,32 @@
+#ifndef BANNED_H
+#define BANNED_H
+
+/*
+ * This header lists functions that have been banned from our code base,
+ * because they're too easy to misuse (and even if used correctly,
+ * complicate audits). Including this header turns them into compile-time
+ * errors.
+ */
+
+#define BANNED(func) sorry_##func##_is_a_banned_function
+
+#undef strcpy
+#define strcpy(x,y) BANNED(strcpy)
+#undef strcat
+#define strcat(x,y) BANNED(strcat)
+#undef strncpy
+#define strncpy(x,y,n) BANNED(strncpy)
+#undef strncat
+#define strncat(x,y,n) BANNED(strncat)
+
+#undef sprintf
+#undef vsprintf
+#ifdef HAVE_VARIADIC_MACROS
+#define sprintf(...) BANNED(sprintf)
+#define vsprintf(...) BANNED(vsprintf)
+#else
+#define sprintf(buf,fmt,arg) BANNED(sprintf)
+#define vsprintf(buf,fmt,arg) BANNED(sprintf)
+#endif
+
+#endif /* BANNED_H */

data/ext/curb.c

@@ -272,15 +272,15 @@ void Init_curb_core() {
   /* Passed to on_debug handler to indicate that the data is protocol data sent to the peer. */
   rb_define_const(mCurl, "CURLINFO_DATA_OUT", LONG2NUM(CURLINFO_DATA_OUT));
 
-#ifdef HAVE_CURLFTPMETHOD_MULTICWD 
+#ifdef HAVE_CURLFTPMETHOD_MULTICWD
   rb_define_const(mCurl, "CURL_MULTICWD",  LONG2NUM(CURLFTPMETHOD_MULTICWD));
 #endif
 
-#ifdef HAVE_CURLFTPMETHOD_NOCWD 
+#ifdef HAVE_CURLFTPMETHOD_NOCWD
   rb_define_const(mCurl, "CURL_NOCWD",     LONG2NUM(CURLFTPMETHOD_NOCWD));
 #endif
 
-#ifdef HAVE_CURLFTPMETHOD_SINGLECWD 
+#ifdef HAVE_CURLFTPMETHOD_SINGLECWD
   rb_define_const(mCurl, "CURL_SINGLECWD", LONG2NUM(CURLFTPMETHOD_SINGLECWD));
 #endif
 
@@ -296,9 +296,15 @@ void Init_curb_core() {
   rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1",   LONG2NUM(CURL_SSLVERSION_TLSv1));
   rb_define_const(mCurl, "CURL_SSLVERSION_SSLv2",   LONG2NUM(CURL_SSLVERSION_SSLv2));
   rb_define_const(mCurl, "CURL_SSLVERSION_SSLv3",   LONG2NUM(CURL_SSLVERSION_SSLv3));
+#if HAVE_CURL_SSLVERSION_TLSV1_0
   rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_0",   LONG2NUM(CURL_SSLVERSION_TLSv1_0));
+#endif
+#if HAVE_CURL_SSLVERSION_TLSV1_1
   rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_1",   LONG2NUM(CURL_SSLVERSION_TLSv1_1));
+#endif
+#if HAVE_CURL_SSLVERSION_TLSV1_2
   rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_2",   LONG2NUM(CURL_SSLVERSION_TLSv1_2));
+#endif
 
   rb_define_const(mCurl, "CURL_USESSL_CONTROL", LONG2NUM(CURB_FTPSSL_CONTROL));
   rb_define_const(mCurl, "CURL_USESSL_NONE", LONG2NUM(CURB_FTPSSL_NONE));
@@ -309,9 +315,15 @@ void Init_curb_core() {
   rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1",   LONG2NUM(-1));
   rb_define_const(mCurl, "CURL_SSLVERSION_SSLv2",   LONG2NUM(-1));
   rb_define_const(mCurl, "CURL_SSLVERSION_SSLv3",   LONG2NUM(-1));
+#if HAVE_CURL_SSLVERSION_TLSv1_0
   rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_0", LONG2NUM(-1));
+#endif
+#if HAVE_CURL_SSLVERSION_TLSv1_1
   rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_1", LONG2NUM(-1));
+#endif
+#if HAVE_CURL_SSLVERSION_TLSv1_2
   rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_2", LONG2NUM(-1));
+#endif
 
   rb_define_const(mCurl, "CURL_USESSL_CONTROL", LONG2NUM(-1));
   rb_define_const(mCurl, "CURL_USESSL_NONE", LONG2NUM(-1));
@@ -340,6 +352,13 @@ void Init_curb_core() {
   rb_define_const(mCurl, "CURLPROXY_SOCKS5", LONG2NUM(-2));
 #endif
 
+  /* When passed to Curl::Easy#proxy_type , indicates that the proxy is a SOCKS5 proxy (and that the proxy should resolve the hostname). (libcurl >= 7.17.2) */
+#ifdef HAVE_CURLPROXY_SOCKS5_HOSTNAME
+  rb_define_const(mCurl, "CURLPROXY_SOCKS5_HOSTNAME", LONG2NUM(CURLPROXY_SOCKS5_HOSTNAME));
+#else
+  rb_define_const(mCurl, "CURLPROXY_SOCKS5_HOSTNAME", LONG2NUM(-2));
+#endif
+
   /* When passed to Curl::Easy#http_auth_types or Curl::Easy#proxy_auth_types, directs libcurl to use Basic authentication. */
 #ifdef HAVE_CURLAUTH_BASIC
   rb_define_const(mCurl, "CURLAUTH_BASIC", LONG2NUM(CURLAUTH_BASIC));
@@ -386,6 +405,9 @@ void Init_curb_core() {
   CURB_DEFINE(CURLOPT_HEADER);
   CURB_DEFINE(CURLOPT_NOPROGRESS);
   CURB_DEFINE(CURLOPT_NOSIGNAL);
+#if HAVE_CURLOPT_PATH_AS_IS
+  CURB_DEFINE(CURLOPT_PATH_AS_IS);
+#endif
   CURB_DEFINE(CURLOPT_WRITEFUNCTION);
   CURB_DEFINE(CURLOPT_WRITEDATA);
   CURB_DEFINE(CURLOPT_READFUNCTION);
@@ -570,6 +592,9 @@ void Init_curb_core() {
   CURB_DEFINE(CURLOPT_REFERER);
   CURB_DEFINE(CURLOPT_USERAGENT);
   CURB_DEFINE(CURLOPT_HTTPHEADER);
+#if HAVE_CURLOPT_PROXYHEADER
+  CURB_DEFINE(CURLOPT_PROXYHEADER);
+#endif
 #if HAVE_CURLOPT_HTTP200ALIASES
   CURB_DEFINE(CURLOPT_HTTP200ALIASES);
 #endif
@@ -594,6 +619,9 @@ void Init_curb_core() {
 #if LIBCURL_VERSION_NUM >= 0x072100 /* 7.33.0 */
     CURB_DEFINE(CURL_HTTP_VERSION_2_0);
 #endif
+#if LIBCURL_VERSION_NUM >= 0x072f00 /* 7.47.0 */
+    CURB_DEFINE(CURL_HTTP_VERSION_2TLS);
+#endif
 #if HAVE_CURLOPT_IGNORE_CONTENT_LENGTH
   CURB_DEFINE(CURLOPT_IGNORE_CONTENT_LENGTH);
 #endif
@@ -1008,6 +1036,20 @@ void Init_curb_core() {
   CURB_DEFINE(CURLOPT_UNIX_SOCKET_PATH);
 #endif
 
+#if HAVE_CURLOPT_PIPEWAIT
+  CURB_DEFINE(CURLOPT_PIPEWAIT);
+#endif
+
+#if HAVE_CURLOPT_TCP_KEEPALIVE
+  CURB_DEFINE(CURLOPT_TCP_KEEPALIVE);
+  CURB_DEFINE(CURLOPT_TCP_KEEPIDLE);
+  CURB_DEFINE(CURLOPT_TCP_KEEPINTVL);
+#endif
+
+#if HAVE_CURLOPT_HAPROXYPROTOCOL
+  CURB_DEFINE(CURLOPT_HAPROXYPROTOCOL);
+#endif
+
 #if LIBCURL_VERSION_NUM >= 0x072B00 /* 7.43.0 */
   CURB_DEFINE(CURLPIPE_NOTHING);
   CURB_DEFINE(CURLPIPE_HTTP1);

data/ext/curb.h

@@ -9,8 +9,16 @@
 #define __CURB_H
 
 #include <ruby.h>
+
+#ifdef HAVE_RUBY_IO_H
+#include "ruby/io.h"
+#else
+#include "rubyio.h" // ruby 1.8
+#endif
+
 #include <curl/curl.h>
 
+#include "banned.h"
 #include "curb_config.h"
 #include "curb_easy.h"
 #include "curb_errors.h"
@@ -20,11 +28,11 @@
 #include "curb_macros.h"
 
 // These should be managed from the Rake 'release' task.
-#define CURB_VERSION   "0.9.2"
-#define CURB_VER_NUM   902
+#define CURB_VERSION   "0.9.11"
+#define CURB_VER_NUM   9011
 #define CURB_VER_MAJ   0
-#define CURB_VER_MIN   2
-#define CURB_VER_MIC   0
+#define CURB_VER_MIN   9
+#define CURB_VER_MIC   11
 #define CURB_VER_PATCH 0